WebDriverSearchContext.php 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?php
  2. // Copyright 2004-present Facebook. All Rights Reserved.
  3. //
  4. // Licensed under the Apache License, Version 2.0 (the "License");
  5. // you may not use this file except in compliance with the License.
  6. // You may obtain a copy of the License at
  7. //
  8. // http://www.apache.org/licenses/LICENSE-2.0
  9. //
  10. // Unless required by applicable law or agreed to in writing, software
  11. // distributed under the License is distributed on an "AS IS" BASIS,
  12. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. // See the License for the specific language governing permissions and
  14. // limitations under the License.
  15. namespace Facebook\WebDriver;
  16. /**
  17. * The interface for WebDriver and WebDriverElement which is able to search for
  18. * WebDriverElement inside.
  19. */
  20. interface WebDriverSearchContext
  21. {
  22. /**
  23. * Find the first WebDriverElement within this element using the given
  24. * mechanism.
  25. *
  26. * @param WebDriverBy $locator
  27. * @return WebDriverElement NoSuchElementException is thrown in
  28. * HttpCommandExecutor if no element is found.
  29. * @see WebDriverBy
  30. */
  31. public function findElement(WebDriverBy $locator);
  32. /**
  33. * Find all WebDriverElements within this element using the given mechanism.
  34. *
  35. * @param WebDriverBy $locator
  36. * @return WebDriverElement[] A list of all WebDriverElements, or an empty array if
  37. * nothing matches
  38. * @see WebDriverBy
  39. */
  40. public function findElements(WebDriverBy $locator);
  41. }