xref: /plugin/combo/vendor/php-webdriver/webdriver/lib/WebDriverSearchContext.php (revision 04fd306c7c155fa133ebb3669986875d65988276)
1*04fd306cSNickeau<?php
2*04fd306cSNickeau
3*04fd306cSNickeaunamespace Facebook\WebDriver;
4*04fd306cSNickeau
5*04fd306cSNickeau/**
6*04fd306cSNickeau * The interface for WebDriver and WebDriverElement which is able to search for
7*04fd306cSNickeau * WebDriverElement inside.
8*04fd306cSNickeau */
9*04fd306cSNickeauinterface WebDriverSearchContext
10*04fd306cSNickeau{
11*04fd306cSNickeau    /**
12*04fd306cSNickeau     * Find the first WebDriverElement within this element using the given
13*04fd306cSNickeau     * mechanism.
14*04fd306cSNickeau     *
15*04fd306cSNickeau     * @param WebDriverBy $locator
16*04fd306cSNickeau     * @return WebDriverElement NoSuchElementException is thrown in
17*04fd306cSNickeau     *    HttpCommandExecutor if no element is found.
18*04fd306cSNickeau     * @see WebDriverBy
19*04fd306cSNickeau     */
20*04fd306cSNickeau    public function findElement(WebDriverBy $locator);
21*04fd306cSNickeau
22*04fd306cSNickeau    /**
23*04fd306cSNickeau     * Find all WebDriverElements within this element using the given mechanism.
24*04fd306cSNickeau     *
25*04fd306cSNickeau     * @param WebDriverBy $locator
26*04fd306cSNickeau     * @return WebDriverElement[] A list of all WebDriverElements, or an empty array if
27*04fd306cSNickeau     *    nothing matches
28*04fd306cSNickeau     * @see WebDriverBy
29*04fd306cSNickeau     */
30*04fd306cSNickeau    public function findElements(WebDriverBy $locator);
31*04fd306cSNickeau}
32