WebDriverBy.php 3.43 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
<?php
// Copyright 2004-present Facebook. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

namespace Facebook\WebDriver;

/**
 * The basic 8 mechanisms supported by webdriver to locate a web element.
 * ie. 'class name', 'css selector', 'id', 'name', 'link text',
 *     'partial link text', 'tag name' and 'xpath'.
 *
 * @see WebDriver::findElement, WebDriverElement::findElement
 */
class WebDriverBy
{
    /**
     * @var string
     */
    private $mechanism;
    /**
     * @var string
     */
    private $value;

    protected function __construct($mechanism, $value)
    {
        $this->mechanism = $mechanism;
        $this->value = $value;
    }

    /**
     * @return string
     */
    public function getMechanism()
    {
        return $this->mechanism;
    }

    /**
     * @return string
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Locates elements whose class name contains the search value; compound class
     * names are not permitted.
     *
     * @param string $class_name
     * @return static
     */
    public static function className($class_name)
    {
        return new static('class name', $class_name);
    }

    /**
     * Locates elements matching a CSS selector.
     *
     * @param string $css_selector
     * @return static
     */
    public static function cssSelector($css_selector)
    {
        return new static('css selector', $css_selector);
    }

    /**
     * Locates elements whose ID attribute matches the search value.
     *
     * @param string $id
     * @return static
     */
    public static function id($id)
    {
        return new static('id', $id);
    }

    /**
     * Locates elements whose NAME attribute matches the search value.
     *
     * @param string $name
     * @return static
     */
    public static function name($name)
    {
        return new static('name', $name);
    }

    /**
     * Locates anchor elements whose visible text matches the search value.
     *
     * @param string $link_text
     * @return static
     */
    public static function linkText($link_text)
    {
        return new static('link text', $link_text);
    }

    /**
     * Locates anchor elements whose visible text partially matches the search
     * value.
     *
     * @param string $partial_link_text
     * @return static
     */
    public static function partialLinkText($partial_link_text)
    {
        return new static('partial link text', $partial_link_text);
    }

    /**
     * Locates elements whose tag name matches the search value.
     *
     * @param string $tag_name
     * @return static
     */
    public static function tagName($tag_name)
    {
        return new static('tag name', $tag_name);
    }

    /**
     * Locates elements matching an XPath expression.
     *
     * @param string $xpath
     * @return static
     */
    public static function xpath($xpath)
    {
        return new static('xpath', $xpath);
    }
}