scenario->addStep(new \Codeception\Step\Condition('amInPath', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Opens a file and stores it's content. * * Usage: * * ``` php * openFile('composer.json'); * $I->seeInThisFile('codeception/codeception'); * ?> * ``` * * @param $filename * @see Codeception\Module\Filesystem::openFile() * @return \Codeception\Maybe */ public function openFile($filename) { $this->scenario->addStep(new \Codeception\Step\Action('openFile', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Deletes a file * * ``` php * deleteFile('composer.lock'); * ?> * ``` * * @param $filename * @see Codeception\Module\Filesystem::deleteFile() * @return \Codeception\Maybe */ public function deleteFile($filename) { $this->scenario->addStep(new \Codeception\Step\Action('deleteFile', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Deletes directory with all subdirectories * * ``` php * deleteDir('vendor'); * ?> * ``` * * @param $dirname * @see Codeception\Module\Filesystem::deleteDir() * @return \Codeception\Maybe */ public function deleteDir($dirname) { $this->scenario->addStep(new \Codeception\Step\Action('deleteDir', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Copies directory with all contents * * ``` php * copyDir('vendor','old_vendor'); * ?> * ``` * * @param $src * @param $dst * @see Codeception\Module\Filesystem::copyDir() * @return \Codeception\Maybe */ public function copyDir($src, $dst) { $this->scenario->addStep(new \Codeception\Step\Action('copyDir', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks If opened file has `text` in it. * * Usage: * * ``` php * openFile('composer.json'); * $I->seeInThisFile('codeception/codeception'); * ?> * ``` * * @param $text * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Module\Filesystem::seeInThisFile() * @return \Codeception\Maybe */ public function canSeeInThisFile($text) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeInThisFile', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks If opened file has `text` in it. * * Usage: * * ``` php * openFile('composer.json'); * $I->seeInThisFile('codeception/codeception'); * ?> * ``` * * @param $text * @see Codeception\Module\Filesystem::seeInThisFile() * @return \Codeception\Maybe */ public function seeInThisFile($text) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeInThisFile', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks the strict matching of file contents. * Unlike `seeInThisFile` will fail if file has something more then expected lines. * Better to use with HEREDOC strings. * Matching is done after removing "\r" chars from file content. * * ``` php * openFile('process.pid'); * $I->seeFileContentsEqual('3192'); * ?> * ``` * * @param $text * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Module\Filesystem::seeFileContentsEqual() * @return \Codeception\Maybe */ public function canSeeFileContentsEqual($text) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeFileContentsEqual', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks the strict matching of file contents. * Unlike `seeInThisFile` will fail if file has something more then expected lines. * Better to use with HEREDOC strings. * Matching is done after removing "\r" chars from file content. * * ``` php * openFile('process.pid'); * $I->seeFileContentsEqual('3192'); * ?> * ``` * * @param $text * @see Codeception\Module\Filesystem::seeFileContentsEqual() * @return \Codeception\Maybe */ public function seeFileContentsEqual($text) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeFileContentsEqual', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks If opened file doesn't contain `text` in it * * ``` php * openFile('composer.json'); * $I->dontSeeInThisFile('codeception/codeception'); * ?> * ``` * * @param $text * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Module\Filesystem::dontSeeInThisFile() * @return \Codeception\Maybe */ public function cantSeeInThisFile($text) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeInThisFile', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks If opened file doesn't contain `text` in it * * ``` php * openFile('composer.json'); * $I->dontSeeInThisFile('codeception/codeception'); * ?> * ``` * * @param $text * @see Codeception\Module\Filesystem::dontSeeInThisFile() * @return \Codeception\Maybe */ public function dontSeeInThisFile($text) { $this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeInThisFile', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Deletes a file * @see Codeception\Module\Filesystem::deleteThisFile() * @return \Codeception\Maybe */ public function deleteThisFile() { $this->scenario->addStep(new \Codeception\Step\Action('deleteThisFile', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if file exists in path. * Opens a file when it's exists * * ``` php * seeFileFound('UserModel.php','app/models'); * ?> * ``` * * @param $filename * @param string $path * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Module\Filesystem::seeFileFound() * @return \Codeception\Maybe */ public function canSeeFileFound($filename, $path = null) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeFileFound', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if file exists in path. * Opens a file when it's exists * * ``` php * seeFileFound('UserModel.php','app/models'); * ?> * ``` * * @param $filename * @param string $path * @see Codeception\Module\Filesystem::seeFileFound() * @return \Codeception\Maybe */ public function seeFileFound($filename, $path = null) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeFileFound', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Erases directory contents * * ``` php * cleanDir('logs'); * ?> * ``` * * @param $dirname * @see Codeception\Module\Filesystem::cleanDir() * @return \Codeception\Maybe */ public function cleanDir($dirname) { $this->scenario->addStep(new \Codeception\Step\Action('cleanDir', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Authenticates user for HTTP_AUTH * * @param $username * @param $password * @see Codeception\Util\Framework::amHttpAuthenticated() * @return \Codeception\Maybe */ public function amHttpAuthenticated($username, $password) { $this->scenario->addStep(new \Codeception\Step\Condition('amHttpAuthenticated', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Opens the page. * Requires relative uri as parameter * * Example: * * ``` php * amOnPage('/'); * // opens /register page * $I->amOnPage('/register'); * ?> * ``` * * @param $page * @see Codeception\Util\Framework::amOnPage() * @return \Codeception\Maybe */ public function amOnPage($page) { $this->scenario->addStep(new \Codeception\Step\Condition('amOnPage', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Perform a click on link or button. * Link or button are found by their names or CSS selector. * Submits a form if button is a submit type. * * If link is an image it's found by alt attribute value of image. * If button is image button is found by it's value * If link or button can't be found by name they are searched by CSS selector. * * The second parameter is a context: CSS or XPath locator to narrow the search. * * Examples: * * ``` php * click('Logout'); * // button of form * $I->click('Submit'); * // CSS button * $I->click('#form input[type=submit]'); * // XPath * $I->click('//form/*[@type=submit]') * // link in context * $I->click('Logout', '#nav'); * ?> * ``` * @param $link * @param $context * @see Codeception\Util\Framework::click() * @return \Codeception\Maybe */ public function click($link, $context = null) { $this->scenario->addStep(new \Codeception\Step\Action('click', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Check if current page contains the text specified. * Specify the css selector to match only specific region. * * Examples: * * ``` php * see('Logout'); // I can suppose user is logged in * $I->see('Sign Up','h1'); // I can suppose it's a signup page * $I->see('Sign Up','//body/h1'); // with XPath * ?> * ``` * * @param $text * @param null $selector * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::see() * @return \Codeception\Maybe */ public function canSee($text, $selector = null) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('see', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Check if current page contains the text specified. * Specify the css selector to match only specific region. * * Examples: * * ``` php * see('Logout'); // I can suppose user is logged in * $I->see('Sign Up','h1'); // I can suppose it's a signup page * $I->see('Sign Up','//body/h1'); // with XPath * ?> * ``` * * @param $text * @param null $selector * @see Codeception\Util\Framework::see() * @return \Codeception\Maybe */ public function see($text, $selector = null) { $this->scenario->addStep(new \Codeception\Step\Assertion('see', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Check if current page doesn't contain the text specified. * Specify the css selector to match only specific region. * * Examples: * * ```php * dontSee('Login'); // I can suppose user is already logged in * $I->dontSee('Sign Up','h1'); // I can suppose it's not a signup page * $I->dontSee('Sign Up','//body/h1'); // with XPath * ?> * ``` * * @param $text * @param null $selector * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::dontSee() * @return \Codeception\Maybe */ public function cantSee($text, $selector = null) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSee', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Check if current page doesn't contain the text specified. * Specify the css selector to match only specific region. * * Examples: * * ```php * dontSee('Login'); // I can suppose user is already logged in * $I->dontSee('Sign Up','h1'); // I can suppose it's not a signup page * $I->dontSee('Sign Up','//body/h1'); // with XPath * ?> * ``` * * @param $text * @param null $selector * @see Codeception\Util\Framework::dontSee() * @return \Codeception\Maybe */ public function dontSee($text, $selector = null) { $this->scenario->addStep(new \Codeception\Step\Assertion('dontSee', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if there is a link with text specified. * Specify url to match link with exact this url. * * Examples: * * ``` php * seeLink('Logout'); // matches Logout * $I->seeLink('Logout','/logout'); // matches Logout * ?> * ``` * * @param $text * @param null $url * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::seeLink() * @return \Codeception\Maybe */ public function canSeeLink($text, $url = null) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeLink', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if there is a link with text specified. * Specify url to match link with exact this url. * * Examples: * * ``` php * seeLink('Logout'); // matches Logout * $I->seeLink('Logout','/logout'); // matches Logout * ?> * ``` * * @param $text * @param null $url * @see Codeception\Util\Framework::seeLink() * @return \Codeception\Maybe */ public function seeLink($text, $url = null) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeLink', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if page doesn't contain the link with text specified. * Specify url to narrow the results. * * Examples: * * ``` php * dontSeeLink('Logout'); // I suppose user is not logged in * ?> * ``` * * @param $text * @param null $url * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::dontSeeLink() * @return \Codeception\Maybe */ public function cantSeeLink($text, $url = null) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeLink', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if page doesn't contain the link with text specified. * Specify url to narrow the results. * * Examples: * * ``` php * dontSeeLink('Logout'); // I suppose user is not logged in * ?> * ``` * * @param $text * @param null $url * @see Codeception\Util\Framework::dontSeeLink() * @return \Codeception\Maybe */ public function dontSeeLink($text, $url = null) { $this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeLink', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that current uri contains a value * * ``` php * seeInCurrentUrl('home'); * // to match: /users/1 * $I->seeInCurrentUrl('/users/'); * ?> * ``` * * @param $uri * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::seeInCurrentUrl() * @return \Codeception\Maybe */ public function canSeeInCurrentUrl($uri) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeInCurrentUrl', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that current uri contains a value * * ``` php * seeInCurrentUrl('home'); * // to match: /users/1 * $I->seeInCurrentUrl('/users/'); * ?> * ``` * * @param $uri * @see Codeception\Util\Framework::seeInCurrentUrl() * @return \Codeception\Maybe */ public function seeInCurrentUrl($uri) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeInCurrentUrl', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that current uri does not contain a value * * ``` php * dontSeeInCurrentUrl('/users/'); * ?> * ``` * * @param $uri * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::dontSeeInCurrentUrl() * @return \Codeception\Maybe */ public function cantSeeInCurrentUrl($uri) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeInCurrentUrl', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that current uri does not contain a value * * ``` php * dontSeeInCurrentUrl('/users/'); * ?> * ``` * * @param $uri * @see Codeception\Util\Framework::dontSeeInCurrentUrl() * @return \Codeception\Maybe */ public function dontSeeInCurrentUrl($uri) { $this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeInCurrentUrl', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that current url is equal to value. * Unlike `seeInCurrentUrl` performs a strict check. * * ``` php * seeCurrentUrlEquals('/'); * ?> * ``` * * @param $uri * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::seeCurrentUrlEquals() * @return \Codeception\Maybe */ public function canSeeCurrentUrlEquals($uri) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlEquals', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that current url is equal to value. * Unlike `seeInCurrentUrl` performs a strict check. * * ``` php * seeCurrentUrlEquals('/'); * ?> * ``` * * @param $uri * @see Codeception\Util\Framework::seeCurrentUrlEquals() * @return \Codeception\Maybe */ public function seeCurrentUrlEquals($uri) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeCurrentUrlEquals', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that current url is not equal to value. * Unlike `dontSeeInCurrentUrl` performs a strict check. * * ``` php * dontSeeCurrentUrlEquals('/'); * ?> * ``` * * @param $uri * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::dontSeeCurrentUrlEquals() * @return \Codeception\Maybe */ public function cantSeeCurrentUrlEquals($uri) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlEquals', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that current url is not equal to value. * Unlike `dontSeeInCurrentUrl` performs a strict check. * * ``` php * dontSeeCurrentUrlEquals('/'); * ?> * ``` * * @param $uri * @see Codeception\Util\Framework::dontSeeCurrentUrlEquals() * @return \Codeception\Maybe */ public function dontSeeCurrentUrlEquals($uri) { $this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeCurrentUrlEquals', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that current url is matches a RegEx value * * ``` php * seeCurrentUrlMatches('~$/users/(\d+)~'); * ?> * ``` * * @param $uri * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::seeCurrentUrlMatches() * @return \Codeception\Maybe */ public function canSeeCurrentUrlMatches($uri) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlMatches', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that current url is matches a RegEx value * * ``` php * seeCurrentUrlMatches('~$/users/(\d+)~'); * ?> * ``` * * @param $uri * @see Codeception\Util\Framework::seeCurrentUrlMatches() * @return \Codeception\Maybe */ public function seeCurrentUrlMatches($uri) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeCurrentUrlMatches', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that current url does not match a RegEx value * * ``` php * dontSeeCurrentUrlMatches('~$/users/(\d+)~'); * ?> * ``` * * @param $uri * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::dontSeeCurrentUrlMatches() * @return \Codeception\Maybe */ public function cantSeeCurrentUrlMatches($uri) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlMatches', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that current url does not match a RegEx value * * ``` php * dontSeeCurrentUrlMatches('~$/users/(\d+)~'); * ?> * ``` * * @param $uri * @see Codeception\Util\Framework::dontSeeCurrentUrlMatches() * @return \Codeception\Maybe */ public function dontSeeCurrentUrlMatches($uri) { $this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeCurrentUrlMatches', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Takes a parameters from current URI by RegEx. * If no url provided returns full URI. * * ``` php * grabFromCurrentUrl('~$/user/(\d+)/~'); * $uri = $I->grabFromCurrentUrl(); * ?> * ``` * * @param null $uri * @internal param $url * @return mixed * @see Codeception\Util\Framework::grabFromCurrentUrl() * @return \Codeception\Maybe */ public function grabFromCurrentUrl($uri = null) { $this->scenario->addStep(new \Codeception\Step\Action('grabFromCurrentUrl', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Assert if the specified checkbox is checked. * Use css selector or xpath to match. * * Example: * * ``` 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. * $I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]'); * ?> * ``` * * @param $checkbox * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::seeCheckboxIsChecked() * @return \Codeception\Maybe */ public function canSeeCheckboxIsChecked($checkbox) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeCheckboxIsChecked', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Assert if the specified checkbox is checked. * Use css selector or xpath to match. * * Example: * * ``` 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. * $I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]'); * ?> * ``` * * @param $checkbox * @see Codeception\Util\Framework::seeCheckboxIsChecked() * @return \Codeception\Maybe */ public function seeCheckboxIsChecked($checkbox) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeCheckboxIsChecked', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Assert if the specified checkbox is unchecked. * Use css selector or xpath to match. * * Example: * * ``` 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. * ?> * ``` * * @param $checkbox * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::dontSeeCheckboxIsChecked() * @return \Codeception\Maybe */ public function cantSeeCheckboxIsChecked($checkbox) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeCheckboxIsChecked', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Assert if the specified checkbox is unchecked. * Use css selector or xpath to match. * * Example: * * ``` 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. * ?> * ``` * * @param $checkbox * @see Codeception\Util\Framework::dontSeeCheckboxIsChecked() * @return \Codeception\Maybe */ public function dontSeeCheckboxIsChecked($checkbox) { $this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeCheckboxIsChecked', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that an input field or textarea contains value. * Field is matched either by label or CSS or Xpath * * Example: * * ``` php * seeInField('Body','Type your comment here'); * $I->seeInField('form textarea[name=body]','Type your comment here'); * $I->seeInField('form input[type=hidden]','hidden_value'); * $I->seeInField('#searchform input','Search'); * $I->seeInField('//form/*[@name=search]','Search'); * ?> * ``` * * @param $field * @param $value * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::seeInField() * @return \Codeception\Maybe */ public function canSeeInField($field, $value) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeInField', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that an input field or textarea contains value. * Field is matched either by label or CSS or Xpath * * Example: * * ``` php * seeInField('Body','Type your comment here'); * $I->seeInField('form textarea[name=body]','Type your comment here'); * $I->seeInField('form input[type=hidden]','hidden_value'); * $I->seeInField('#searchform input','Search'); * $I->seeInField('//form/*[@name=search]','Search'); * ?> * ``` * * @param $field * @param $value * @see Codeception\Util\Framework::seeInField() * @return \Codeception\Maybe */ public function seeInField($field, $value) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeInField', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that an input field or textarea doesn't contain value. * Field is matched either by label or CSS or Xpath * Example: * * ``` php * dontSeeInField('Body','Type your comment here'); * $I->dontSeeInField('form textarea[name=body]','Type your comment here'); * $I->dontSeeInField('form input[type=hidden]','hidden_value'); * $I->dontSeeInField('#searchform input','Search'); * $I->dontSeeInField('//form/*[@name=search]','Search'); * ?> * ``` * * @param $field * @param $value * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::dontSeeInField() * @return \Codeception\Maybe */ public function cantSeeInField($field, $value) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeInField', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that an input field or textarea doesn't contain value. * Field is matched either by label or CSS or Xpath * Example: * * ``` php * dontSeeInField('Body','Type your comment here'); * $I->dontSeeInField('form textarea[name=body]','Type your comment here'); * $I->dontSeeInField('form input[type=hidden]','hidden_value'); * $I->dontSeeInField('#searchform input','Search'); * $I->dontSeeInField('//form/*[@name=search]','Search'); * ?> * ``` * * @param $field * @param $value * @see Codeception\Util\Framework::dontSeeInField() * @return \Codeception\Maybe */ public function dontSeeInField($field, $value) { $this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeInField', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Submits a form located on page. * Specify the form by it's css or xpath selector. * Fill the form fields values as array. * * Skipped fields will be filled by their values from page. * You don't need to click the 'Submit' button afterwards. * This command itself triggers the request to form's action. * * Examples: * * ``` php * submitForm('#login', array('login' => 'davert', 'password' => '123456')); * * ``` * * For sample Sign Up form: * * ``` html *
* Login:
* Password:
* Do you agree to out terms?
* Select pricing plan * *
* ``` * I can write this: * * ``` php * submitForm('#userForm', array('user' => array('login' => 'Davert', 'password' => '123456', 'agree' => true))); * * ``` * Note, that pricing plan will be set to Paid, as it's selected on page. * * @param $selector * @param $params * @see Codeception\Util\Framework::submitForm() * @return \Codeception\Maybe */ public function submitForm($selector, $params) { $this->scenario->addStep(new \Codeception\Step\Action('submitForm', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Fills a text field or textarea with value. * * Example: * * ``` php * fillField("//input[@type='text']", "Hello World!"); * ?> * ``` * * @param $field * @param $value * @see Codeception\Util\Framework::fillField() * @return \Codeception\Maybe */ public function fillField($field, $value) { $this->scenario->addStep(new \Codeception\Step\Action('fillField', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Selects an option in select tag or in radio button group. * * Example: * * ``` php * selectOption('form select[name=account]', 'Premium'); * $I->selectOption('form input[name=payment]', 'Monthly'); * $I->selectOption('//form/select[@name=account]', 'Monthly'); * ?> * ``` * * Can select multiple options if second argument is array: * * ``` php * selectOption('Which OS do you use?', array('Windows','Linux')); * ?> * ``` * * @param $select * @param $option * @see Codeception\Util\Framework::selectOption() * @return \Codeception\Maybe */ public function selectOption($select, $option) { $this->scenario->addStep(new \Codeception\Step\Action('selectOption', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Ticks a checkbox. * For radio buttons use `selectOption` method. * * Example: * * ``` php * checkOption('#agree'); * ?> * ``` * * @param $option * @see Codeception\Util\Framework::checkOption() * @return \Codeception\Maybe */ public function checkOption($option) { $this->scenario->addStep(new \Codeception\Step\Action('checkOption', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Unticks a checkbox. * * Example: * * ``` php * uncheckOption('#notify'); * ?> * ``` * * @param $option * @see Codeception\Util\Framework::uncheckOption() * @return \Codeception\Maybe */ public function uncheckOption($option) { $this->scenario->addStep(new \Codeception\Step\Action('uncheckOption', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Attaches file from Codeception data directory to upload field. * * Example: * * ``` php * attachFile('input[@type="file"]', 'prices.xls'); * ?> * ``` * * @param $field * @param $filename * @see Codeception\Util\Framework::attachFile() * @return \Codeception\Maybe */ public function attachFile($field, $filename) { $this->scenario->addStep(new \Codeception\Step\Action('attachFile', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * If your page triggers an ajax request, you can perform it manually. * This action sends a GET ajax request with specified params. * * See ->sendAjaxPostRequest for examples. * * @param $uri * @param $params * @see Codeception\Util\Framework::sendAjaxGetRequest() * @return \Codeception\Maybe */ public function sendAjaxGetRequest($uri, $params = null) { $this->scenario->addStep(new \Codeception\Step\Action('sendAjaxGetRequest', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * If your page triggers an ajax request, you can perform it manually. * This action sends a POST ajax request with specified params. * Additional params can be passed as array. * * Example: * * Imagine that by clicking checkbox you trigger ajax request which updates user settings. * We emulate that click by running this ajax request manually. * * ``` php * sendAjaxPostRequest('/updateSettings', array('notifications' => true); // POST * $I->sendAjaxGetRequest('/updateSettings', array('notifications' => true); // GET * * ``` * * @param $uri * @param $params * @see Codeception\Util\Framework::sendAjaxPostRequest() * @return \Codeception\Maybe */ public function sendAjaxPostRequest($uri, $params = null) { $this->scenario->addStep(new \Codeception\Step\Action('sendAjaxPostRequest', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Finds and returns text contents of element. * Element is searched by CSS selector, XPath or matcher by regex. * * Example: * * ``` php * grabTextFrom('h1'); * $heading = $I->grabTextFrom('descendant-or-self::h1'); * $value = $I->grabTextFrom('~ * ``` * * @param $cssOrXPathOrRegex * @return mixed * @see Codeception\Util\Framework::grabTextFrom() * @return \Codeception\Maybe */ public function grabTextFrom($cssOrXPathOrRegex) { $this->scenario->addStep(new \Codeception\Step\Action('grabTextFrom', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Finds and returns field and returns it's value. * Searches by field name, then by CSS, then by XPath * * Example: * * ``` php * grabValueFrom('Name'); * $name = $I->grabValueFrom('input[name=username]'); * $name = $I->grabValueFrom('descendant-or-self::form/descendant::input[@name = 'username']'); * ?> * ``` * * @param $field * @return mixed * @see Codeception\Util\Framework::grabValueFrom() * @return \Codeception\Maybe */ public function grabValueFrom($field) { $this->scenario->addStep(new \Codeception\Step\Action('grabValueFrom', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if element exists on a page, matching it by CSS or XPath * * ``` php * seeElement('.error'); * $I->seeElement('//form/input[1]'); * ?> * ``` * @param $selector * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::seeElement() * @return \Codeception\Maybe */ public function canSeeElement($selector) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeElement', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if element exists on a page, matching it by CSS or XPath * * ``` php * seeElement('.error'); * $I->seeElement('//form/input[1]'); * ?> * ``` * @param $selector * @see Codeception\Util\Framework::seeElement() * @return \Codeception\Maybe */ public function seeElement($selector) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeElement', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if element does not exist (or is visible) on a page, matching it by CSS or XPath * * Example: * * ``` php * dontSeeElement('.error'); * $I->dontSeeElement('//form/input[1]'); * ?> * ``` * @param $selector * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::dontSeeElement() * @return \Codeception\Maybe */ public function cantSeeElement($selector) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeElement', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if element does not exist (or is visible) on a page, matching it by CSS or XPath * * Example: * * ``` php * dontSeeElement('.error'); * $I->dontSeeElement('//form/input[1]'); * ?> * ``` * @param $selector * @see Codeception\Util\Framework::dontSeeElement() * @return \Codeception\Maybe */ public function dontSeeElement($selector) { $this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeElement', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if option is selected in select field. * * ``` php * seeOptionIsSelected('#form input[name=payment]', 'Visa'); * ?> * ``` * * @param $selector * @param $optionText * @return mixed * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::seeOptionIsSelected() * @return \Codeception\Maybe */ public function canSeeOptionIsSelected($select, $optionText) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeOptionIsSelected', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if option is selected in select field. * * ``` php * seeOptionIsSelected('#form input[name=payment]', 'Visa'); * ?> * ``` * * @param $selector * @param $optionText * @return mixed * @see Codeception\Util\Framework::seeOptionIsSelected() * @return \Codeception\Maybe */ public function seeOptionIsSelected($select, $optionText) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeOptionIsSelected', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if option is not selected in select field. * * ``` php * dontSeeOptionIsSelected('#form input[name=payment]', 'Visa'); * ?> * ``` * * @param $selector * @param $optionText * @return mixed * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::dontSeeOptionIsSelected() * @return \Codeception\Maybe */ public function cantSeeOptionIsSelected($select, $optionText) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeOptionIsSelected', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks if option is not selected in select field. * * ``` php * dontSeeOptionIsSelected('#form input[name=payment]', 'Visa'); * ?> * ``` * * @param $selector * @param $optionText * @return mixed * @see Codeception\Util\Framework::dontSeeOptionIsSelected() * @return \Codeception\Maybe */ public function dontSeeOptionIsSelected($select, $optionText) { $this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeOptionIsSelected', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Asserts that current page has 404 response status code. * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::seePageNotFound() * @return \Codeception\Maybe */ public function canSeePageNotFound() { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seePageNotFound', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Asserts that current page has 404 response status code. * @see Codeception\Util\Framework::seePageNotFound() * @return \Codeception\Maybe */ public function seePageNotFound() { $this->scenario->addStep(new \Codeception\Step\Assertion('seePageNotFound', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that response code is equal to value provided. * * @param $code * @return mixed * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::seeResponseCodeIs() * @return \Codeception\Maybe */ public function canSeeResponseCodeIs($code) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIs', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that response code is equal to value provided. * * @param $code * @return mixed * @see Codeception\Util\Framework::seeResponseCodeIs() * @return \Codeception\Maybe */ public function seeResponseCodeIs($code) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeResponseCodeIs', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that page title contains text. * * ``` php * seeInTitle('Blog - Post #1'); * ?> * ``` * * @param $title * @return mixed * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::seeInTitle() * @return \Codeception\Maybe */ public function canSeeInTitle($title) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeInTitle', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that page title contains text. * * ``` php * seeInTitle('Blog - Post #1'); * ?> * ``` * * @param $title * @return mixed * @see Codeception\Util\Framework::seeInTitle() * @return \Codeception\Maybe */ public function seeInTitle($title) { $this->scenario->addStep(new \Codeception\Step\Assertion('seeInTitle', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that page title does not contain text. * * @param $title * @return mixed * Conditional Assertion: Test won't be stopped on fail * @see Codeception\Util\Framework::dontSeeInTitle() * @return \Codeception\Maybe */ public function cantSeeInTitle($title) { $this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeInTitle', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } /** * This method is generated. * Documentation taken from corresponding module. * ---------------------------------------------- * * Checks that page title does not contain text. * * @param $title * @return mixed * @see Codeception\Util\Framework::dontSeeInTitle() * @return \Codeception\Maybe */ public function dontSeeInTitle($title) { $this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeInTitle', func_get_args())); if ($this->scenario->running()) { $result = $this->scenario->runStep(); return new Maybe($result); } return new Maybe(); } }