ElementInterface.php in Zircon Profile 8.0

Namespace

Behat\Mink\Element

File

vendor/behat/mink/src/Element/ElementInterface.php

<?php

/*
 * This file is part of the Mink package.
 * (c) Konstantin Kudryashov <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Behat\Mink\Element;

use Behat\Mink\Session;

/**
 * Element interface.
 *
 * @author Konstantin Kudryashov <[e-mail]>
 */
interface ElementInterface {

  /**
   * Returns XPath for handled element.
   *
   * @return string
   */
  public function getXpath();

  /**
   * Returns element's session.
   *
   * @return Session
   *
   * @deprecated Accessing the session from the element is deprecated as of 1.6 and will be impossible in 2.0.
   */
  public function getSession();

  /**
   * Checks whether element with specified selector exists inside the current element.
   *
   * @param string       $selector selector engine name
   * @param string|array $locator  selector locator
   *
   * @return Boolean
   *
   * @see ElementInterface::findAll for the supported selectors
   */
  public function has($selector, $locator);

  /**
   * Checks if an element still exists in the DOM.
   *
   * @return bool
   */
  public function isValid();

  /**
   * Waits for an element(-s) to appear and returns it.
   *
   * @param int|float $timeout  Maximal allowed waiting time in seconds.
   * @param callable  $callback Callback, which result is both used as waiting condition and returned.
   *                            Will receive reference to `this element` as first argument.
   *
   * @return mixed
   *
   * @throws \InvalidArgumentException When invalid callback given.
   */
  public function waitFor($timeout, $callback);

  /**
   * Finds first element with specified selector inside the current element.
   *
   * @param string       $selector selector engine name
   * @param string|array $locator  selector locator
   *
   * @return NodeElement|null
   *
   * @see ElementInterface::findAll for the supported selectors
   */
  public function find($selector, $locator);

  /**
   * Finds all elements with specified selector inside the current element.
   *
   * Valid selector engines are named, xpath, css, named_partial and named_exact.
   *
   * 'named' is a pseudo selector engine which prefers an exact match but
   * will return a partial match if no exact match is found.
   * 'xpath' is a pseudo selector engine supported by SelectorsHandler.
   *
   * More selector engines can be registered in the SelectorsHandler.
   *
   * @param string       $selector selector engine name
   * @param string|array $locator  selector locator
   *
   * @return NodeElement[]
   *
   * @see NamedSelector for the locators supported by the named selectors
   */
  public function findAll($selector, $locator);

  /**
   * Returns element text (inside tag).
   *
   * @return string
   */
  public function getText();

  /**
   * Returns element inner html.
   *
   * @return string
   */
  public function getHtml();

}

Interfaces

Name	Description
ElementInterface	Element interface.