diff --git a/src/Lib/Interfaces/Web.php b/src/Lib/Interfaces/Web.php index 2771022..d0f8a88 100644 --- a/src/Lib/Interfaces/Web.php +++ b/src/Lib/Interfaces/Web.php @@ -9,7 +9,7 @@ interface Web /** * Opens the page for the given relative URI. * - * ``` php + * ```php * amOnPage('/'); @@ -25,7 +25,7 @@ public function amOnPage(string $page): void; * You can specify a specific HTML element (via CSS or XPath) as the second * parameter to only search within that element. * - * ``` php + * ```php * see('Logout'); // I can suppose user is logged in * $I->see('Sign Up', 'h1'); // I can suppose it's a signup page @@ -85,7 +85,7 @@ public function dontSee(string $text, $selector = null): void; * Checks that the current page contains the given string in its * raw source code. * - * ``` php + * ```php * seeInSource('

Green eggs & ham

'); * ``` @@ -131,7 +131,7 @@ public function dontSeeInSource(string $raw): void; * * Examples: * - * ``` php + * ```php * submitForm('#login', [ * 'login' => 'davert', @@ -168,7 +168,7 @@ public function dontSeeInSource(string $raw): void; * * You could write the following to submit it: * - * ``` php + * ```php * submitForm( * '#userForm', @@ -208,7 +208,7 @@ public function dontSeeInSource(string $raw): void; * This function works well when paired with `seeInFormFields()` * for quickly testing CRUD interfaces and form validation logic. * - * ``` php + * ```php * 'value', @@ -226,7 +226,7 @@ public function dontSeeInSource(string $raw): void; * you can use either the string value or boolean `true`/`false` which will * be replaced by the checkbox's value in the DOM. * - * ``` php + * ```php * submitForm('#my-form', [ * 'field1' => 'value', @@ -288,7 +288,7 @@ public function submitForm($selector, array $params, string $button = null): voi * * Note that if the locator matches a button of type `submit`, the form will be submitted. * - * ``` php + * ```php * click('Logout'); @@ -311,7 +311,7 @@ public function click($link, $context = null): void; * Checks that there's a link with the specified text. * Give a full URL as the second parameter to match links with that exact URL. * - * ``` php + * ```php * seeLink('Logout'); // matches Logout * $I->seeLink('Logout','/logout'); // matches Logout @@ -323,7 +323,7 @@ public function seeLink(string $text, string $url = null): void; * Checks that the page doesn't contain a link with the given string. * If the second parameter is given, only links with a matching "href" attribute will be checked. * - * ``` php + * ```php * dontSeeLink('Logout'); // I suppose user is not logged in * $I->dontSeeLink('Checkout now', '/store/cart.php'); @@ -334,7 +334,7 @@ public function dontSeeLink(string $text, string $url = ''): void; /** * Checks that current URI contains the given string. * - * ``` php + * ```php * seeInCurrentUrl('home'); @@ -348,7 +348,7 @@ public function seeInCurrentUrl(string $uri): void; * Checks that the current URL is equal to the given string. * Unlike `seeInCurrentUrl`, this only matches the full URL. * - * ``` php + * ```php * seeCurrentUrlEquals('/'); @@ -359,7 +359,7 @@ public function seeCurrentUrlEquals(string $uri): void; /** * Checks that the current URL matches the given regular expression. * - * ``` php + * ```php * seeCurrentUrlMatches('~^/users/(\d+)~'); @@ -370,7 +370,7 @@ public function seeCurrentUrlMatches(string $uri): void; /** * Checks that the current URI doesn't contain the given string. * - * ``` php + * ```php * dontSeeInCurrentUrl('/users/'); * ``` @@ -381,7 +381,7 @@ public function dontSeeInCurrentUrl(string $uri): void; * Checks that the current URL doesn't equal the given string. * Unlike `dontSeeInCurrentUrl`, this only matches the full URL. * - * ``` php + * ```php * dontSeeCurrentUrlEquals('/'); @@ -392,7 +392,7 @@ public function dontSeeCurrentUrlEquals(string $uri): void; /** * Checks that current url doesn't match the given regular expression. * - * ``` php + * ```php * dontSeeCurrentUrlMatches('~^/users/(\d+)~'); @@ -404,7 +404,7 @@ public function dontSeeCurrentUrlMatches(string $uri): void; * Executes the given regular expression against the current URI and returns the first capturing group. * If no parameters are provided, the full URI is returned. * - * ``` php + * ```php * grabFromCurrentUrl('~^/user/(\d+)/~'); * $uri = $I->grabFromCurrentUrl(); @@ -415,7 +415,7 @@ public function grabFromCurrentUrl(string $uri = null): mixed; /** * Checks that the specified checkbox is checked. * - * ``` php + * ```php * seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user agreed to terms, If there is only one checkbox in form. @@ -427,7 +427,7 @@ public function seeCheckboxIsChecked($checkbox): void; /** * Check that the specified checkbox is unchecked. * - * ``` php + * ```php * dontSeeCheckboxIsChecked('#agree'); // I suppose user didn't agree to terms * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user didn't check the first checkbox in form. @@ -439,7 +439,7 @@ public function dontSeeCheckboxIsChecked($checkbox): void; * Checks that the given input field or textarea *equals* (i.e. not just contains) the given value. * Fields are matched by label text, the "name" attribute, CSS, or XPath. * - * ``` php + * ```php * seeInField('Body','Type your comment here'); * $I->seeInField('form textarea[name=body]','Type your comment here'); @@ -457,7 +457,7 @@ public function seeInField($field, $value): void; * Checks that an input field or textarea doesn't contain the given value. * For fuzzy locators, the field is matched by label text, CSS and XPath. * - * ``` php + * ```php * dontSeeInField('Body','Type your comment here'); * $I->dontSeeInField('form textarea[name=body]','Type your comment here'); @@ -474,7 +474,7 @@ public function dontSeeInField($field, $value): void; * Checks if the array of form parameters (name => value) are set on the form matched with the * passed selector. * - * ``` php + * ```php * seeInFormFields('form[name=myform]', [ * 'input1' => 'value', @@ -485,7 +485,7 @@ public function dontSeeInField($field, $value): void; * For multi-select elements, or to check values of multiple elements with the same name, an * array may be passed: * - * ``` php + * ```php * seeInFormFields('.form-class', [ * 'multiselect' => [ @@ -501,7 +501,7 @@ public function dontSeeInField($field, $value): void; * * Additionally, checkbox values can be checked with a boolean. * - * ``` php + * ```php * seeInFormFields('#form-id', [ * 'checkbox1' => true, // passes if checked @@ -511,7 +511,7 @@ public function dontSeeInField($field, $value): void; * * Pair this with submitForm for quick testing magic. * - * ``` php + * ```php * 'value', @@ -530,7 +530,7 @@ public function seeInFormFields($formSelector, array $params): void; * Checks if the array of form parameters (name => value) are not set on the form matched with * the passed selector. * - * ``` php + * ```php * dontSeeInFormFields('form[name=myform]', [ * 'input1' => 'non-existent value', @@ -541,7 +541,7 @@ public function seeInFormFields($formSelector, array $params): void; * To check that an element hasn't been assigned any one of many values, an array can be passed * as the value: * - * ``` php + * ```php * dontSeeInFormFields('.form-class', [ * 'fieldName' => [ @@ -553,7 +553,7 @@ public function seeInFormFields($formSelector, array $params): void; * * Additionally, checkbox values can be checked with a boolean. * - * ``` php + * ```php * dontSeeInFormFields('#form-id', [ * 'checkbox1' => true, // fails if checked @@ -566,7 +566,7 @@ public function dontSeeInFormFields($formSelector, array $params): void; /** * Selects an option in a select tag or in radio button group. * - * ``` php + * ```php * selectOption('form select[name=account]', 'Premium'); * $I->selectOption('form input[name=payment]', 'Monthly'); @@ -575,14 +575,14 @@ public function dontSeeInFormFields($formSelector, array $params): void; * * Provide an array for the second argument to select multiple options: * - * ``` php + * ```php * selectOption('Which OS do you use?', ['Windows', 'Linux']); * ``` * * Or provide an associative array for the second argument to specifically define which selection method should be used: * - * ``` php + * ```php * selectOption('Which OS do you use?', ['text' => 'Windows']); // Only search by text 'Windows' * $I->selectOption('Which OS do you use?', ['value' => 'windows']); // Only search by value 'windows' @@ -593,7 +593,7 @@ public function selectOption($select, $option): void; /** * Ticks a checkbox. For radio buttons, use the `selectOption` method instead. * - * ``` php + * ```php * checkOption('#agree'); * ``` @@ -603,7 +603,7 @@ public function checkOption($option): void; /** * Unticks a checkbox. * - * ``` php + * ```php * uncheckOption('#notify'); * ``` @@ -613,7 +613,7 @@ public function uncheckOption($option): void; /** * Fills a text field or textarea with the given string. * - * ``` php + * ```php * fillField("//input[@type='text']", "Hello World!"); * $I->fillField(['name' => 'email'], 'jon@example.com'); @@ -624,7 +624,7 @@ public function fillField($field, $value): void; /** * Attaches a file relative to the Codeception `_data` directory to the given file upload field. * - * ``` php + * ```php * attachFile('input[@type="file"]', 'prices.xls'); @@ -637,7 +637,7 @@ public function attachFile($field, string $filename): void; * If a fuzzy locator is used, the element is found using CSS, XPath, * and by matching the full page source by regular expression. * - * ``` php + * ```php * grabTextFrom('h1'); * $heading = $I->grabTextFrom('descendant-or-self::h1'); @@ -650,7 +650,7 @@ public function grabTextFrom($cssOrXPathOrRegex): mixed; * Finds the value for the given form field. * If a fuzzy locator is used, the field is found by field name, CSS, and XPath. * - * ``` php + * ```php * grabValueFrom('Name'); * $name = $I->grabValueFrom('input[name=username]'); @@ -664,7 +664,7 @@ public function grabValueFrom($field): mixed; * Grabs the value of the given attribute value from the given element. * Fails if element is not found. * - * ``` php + * ```php * grabAttributeFrom('#tooltip', 'title'); * ``` @@ -699,7 +699,7 @@ public function grabMultiple($cssOrXpath, string $attribute = null): array; * You can also specify expected attributes of this element. * Only works if `` tag is present. * - * ``` php + * ```php * seeElement('.error'); * $I->seeElement('//form/input[1]'); @@ -716,7 +716,7 @@ public function seeElement($selector, array $attributes = []): void; * Checks that the given element is invisible or not present on the page. * You can also specify expected attributes of this element. * - * ``` php + * ```php * dontSeeElement('.error'); * $I->dontSeeElement('//form/input[1]'); @@ -729,7 +729,7 @@ public function dontSeeElement($selector, array $attributes = []): void; /** * Checks that there are a certain number of elements matched by the given locator on the page. * - * ``` php + * ```php * seeNumberOfElements('tr', 10); * $I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements @@ -742,7 +742,7 @@ public function seeNumberOfElements($selector, array|int $expected): void; /** * Checks that the given option is selected. * - * ``` php + * ```php * seeOptionIsSelected('#form input[name=payment]', 'Visa'); * ``` @@ -754,7 +754,7 @@ public function seeOptionIsSelected($selector, string $optionText); /** * Checks that the given option is not selected. * - * ``` php + * ```php * dontSeeOptionIsSelected('#form input[name=payment]', 'Visa'); * ``` @@ -766,7 +766,7 @@ public function dontSeeOptionIsSelected($selector, string $optionText); /** * Checks that the page title contains the given string. * - * ``` php + * ```php * seeInTitle('Blog - Post #1'); * ``` @@ -786,7 +786,7 @@ public function dontSeeInTitle(string $title); * Checks that a cookie with the given name is set. * You can set additional cookie params like `domain`, `path` as array passed in last argument. * - * ``` php + * ```php * seeCookie('PHPSESSID'); * ``` @@ -807,7 +807,7 @@ public function dontSeeCookie(string $cookie, array $params = []); * Sets a cookie with the given name and value. * You can set additional cookie params like `domain`, `path`, `expires`, `secure` in array passed as last argument. * - * ``` php + * ```php * setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3'); * ```