mikeerickson
4/4/2014 - 11:17 PM
APIGuy.php
APIGuy.php
<?php
// This class was automatically generated by build task
// You should not change it manually as it will be overwritten on next build
// @codingStandardsIgnoreFile
use \Codeception\Maybe;
use Codeception\Module\PhpBrowser;
use Codeception\Module\REST;
use Codeception\Module\ApiHelper;
/**
* Inherited methods
* @method void execute($callable)
* @method void wantToTest($text)
* @method void wantTo($text)
* @method void expectTo($prediction)
* @method void expect($prediction)
* @method void amGoingTo($argumentation)
* @method void am($role)
* @method void lookForwardTo($achieveValue)
* @method void offsetGet($offset)
* @method void offsetSet($offset, $value)
* @method void offsetExists($offset)
* @method void offsetUnset($offset)
*/
class ApiGuy extends \Codeception\AbstractGuy
{
/**
* 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
* <?php
* $I->submitForm('#login', array('login' => 'davert', 'password' => '123456'));
*
* ```
*
* For sample Sign Up form:
*
* ``` html
* <form action="/sign_up">
* Login: <input type="text" name="user[login]" /><br/>
* Password: <input type="password" name="user[password]" /><br/>
* Do you agree to out terms? <input type="checkbox" name="user[agree]" /><br/>
* Select pricing plan <select name="plan"><option value="1">Free</option><option value="2" selected="selected">Paid</option></select>
* <input type="submit" value="Submit" />
* </form>
* ```
* I can write this:
*
* ``` php
* <?php
* $I->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\Module\PhpBrowser::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.
* ----------------------------------------------
*
* 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
* <?php
* $I->sendAjaxPostRequest('/updateSettings', array('notifications' => true)); // POST
* $I->sendAjaxGetRequest('/updateSettings', array('notifications' => true)); // GET
*
* ```
*
* @param $uri
* @param $params
* @see Codeception\Module\PhpBrowser::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.
* ----------------------------------------------
*
* 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\Module\PhpBrowser::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 an ajax request with specified method and params.
*
* Example:
*
* You need to perform an ajax request specifying the HTTP method.
*
* ``` php
* <?php
* $I->sendAjaxRequest('PUT', /posts/7', array('title' => 'new title');
*
* ```
*
* @param $method
* @param $uri
* @param $params
* @see Codeception\Module\PhpBrowser::sendAjaxRequest()
* @return \Codeception\Maybe
*/
public function sendAjaxRequest($method, $uri, $params = null) {
$this->scenario->addStep(new \Codeception\Step\Action('sendAjaxRequest', 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\Module\PhpBrowser::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\Module\PhpBrowser::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 response code equals to provided value.
*
* @param $code
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Module\REST::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 response code equals to provided value.
*
* @param $code
* @see Codeception\Module\REST::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.
* ----------------------------------------------
*
* Adds HTTP authentication via username/password.
*
* @param $username
* @param $password
* @see Codeception\Module\REST::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.
* ----------------------------------------------
*
* Low-level API method.
* If Codeception commands are not enough, use [Guzzle HTTP Client](http://guzzlephp.org/) methods directly
*
* Example:
*
* ``` php
* <?php
* // from the official Guzzle manual
* $I->amGoingTo('Sign all requests with OAuth');
* $I->executeInGuzzle(function (\Guzzle\Http\Client $client) {
* $client->addSubscriber(new Guzzle\Plugin\Oauth\OauthPlugin(array(
* 'consumer_key' => '***',
* 'consumer_secret' => '***',
* 'token' => '***',
* 'token_secret' => '***'
* )));
* });
* ?>
* ```
*
* It is not recommended to use this command on a regular basis.
* If Codeception lacks important Guzzle Client methods, implement them and submit patches.
*
* @param callable $function
* @see Codeception\Module\PhpBrowser::executeInGuzzle()
* @return \Codeception\Maybe
*/
public function executeInGuzzle($function) {
$this->scenario->addStep(new \Codeception\Step\Action('executeInGuzzle', 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
* <?php
* $I->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\Module\PhpBrowser::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
* <?php
* $I->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\Module\PhpBrowser::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
* <?php
* $I->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\Module\PhpBrowser::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
* <?php
* $I->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\Module\PhpBrowser::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.
* ----------------------------------------------
*
* Opens the page.
*
* @param $page
* @see Codeception\Util\Mink::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.
* ----------------------------------------------
*
* Sets 'url' configuration parameter to hosts subdomain.
* It does not open a page on subdomain. Use `amOnPage` for that
*
* ``` php
* <?php
* // If config is: 'http://mysite.com'
* // or config is: 'http://www.mysite.com'
* // or config is: 'http://company.mysite.com'
*
* $I->amOnSubdomain('user');
* $I->amOnPage('/');
* // moves to http://user.mysite.com/
* ?>
* ```
* @param $subdomain
* @return mixed
* @see Codeception\Util\Mink::amOnSubdomain()
* @return \Codeception\Maybe
*/
public function amOnSubdomain($subdomain) {
$this->scenario->addStep(new \Codeception\Step\Condition('amOnSubdomain', 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.
* ----------------------------------------------
*
* @param string $text
* @param string $selector
*
* @return void
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::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.
* ----------------------------------------------
*
* @param string $text
* @param string $selector
*
* @return void
* @see Codeception\Util\Mink::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.
* ----------------------------------------------
*
* Check if current page contains the text specified.
* Specify the css selector to match only specific region.
*
* Examples:
*
* ``` php
* <?php
* $I->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\Mink::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
* <?php
* $I->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\Mink::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.
* ----------------------------------------------
*
* Checks if there is a link with text specified.
* Specify url to match link with exact this url.
*
* Examples:
*
* ``` php
* <?php
* $I->seeLink('Logout'); // matches <a href="#">Logout</a>
* $I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
* ?>
* ```
*
* @param $text
* @param null $url
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::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
* <?php
* $I->seeLink('Logout'); // matches <a href="#">Logout</a>
* $I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
* ?>
* ```
*
* @param $text
* @param null $url
* @see Codeception\Util\Mink::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
* <?php
* $I->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\Mink::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
* <?php
* $I->dontSeeLink('Logout'); // I suppose user is not logged in
* ?>
* ```
*
* @param $text
* @param null $url
* @see Codeception\Util\Mink::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.
* ----------------------------------------------
*
* 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
* <?php
* // simple link
* $I->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\Mink::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.
* ----------------------------------------------
*
* Checks if element exists on a page, matching it by CSS or XPath
*
* ``` php
* <?php
* $I->seeElement('.error');
* $I->seeElement('//form/input[1]');
* ?>
* ```
* @param $selector
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::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
* <?php
* $I->seeElement('.error');
* $I->seeElement('//form/input[1]');
* ?>
* ```
* @param $selector
* @see Codeception\Util\Mink::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
* <?php
* $I->dontSeeElement('.error');
* $I->dontSeeElement('//form/input[1]');
* ?>
* ```
* @param $selector
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::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
* <?php
* $I->dontSeeElement('.error');
* $I->dontSeeElement('//form/input[1]');
* ?>
* ```
* @param $selector
* @see Codeception\Util\Mink::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.
* ----------------------------------------------
*
* Reloads current page
* @see Codeception\Util\Mink::reloadPage()
* @return \Codeception\Maybe
*/
public function reloadPage() {
$this->scenario->addStep(new \Codeception\Step\Action('reloadPage', 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.
* ----------------------------------------------
*
* Moves back in history
* @see Codeception\Util\Mink::moveBack()
* @return \Codeception\Maybe
*/
public function moveBack() {
$this->scenario->addStep(new \Codeception\Step\Action('moveBack', 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.
* ----------------------------------------------
*
* Moves forward in history
* @see Codeception\Util\Mink::moveForward()
* @return \Codeception\Maybe
*/
public function moveForward() {
$this->scenario->addStep(new \Codeception\Step\Action('moveForward', 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
* <?php
* $I->fillField("//input[@type='text']", "Hello World!");
* ?>
* ```
*
* @param $field
* @param $value
* @see Codeception\Util\Mink::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
* <?php
* $I->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
* <?php
* $I->selectOption('Which OS do you use?', array('Windows','Linux'));
* ?>
* ```
*
* @param $select
* @param $option
* @see Codeception\Util\Mink::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
* <?php
* $I->checkOption('#agree');
* ?>
* ```
*
* @param $option
* @see Codeception\Util\Mink::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
* <?php
* $I->uncheckOption('#notify');
* ?>
* ```
*
* @param $option
* @see Codeception\Util\Mink::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.
* ----------------------------------------------
*
* Checks that current uri contains a value
*
* ``` php
* <?php
* // to match: /home/dashboard
* $I->seeInCurrentUrl('home');
* // to match: /users/1
* $I->seeInCurrentUrl('/users/');
* ?>
* ```
*
* @param $uri
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::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
* <?php
* // to match: /home/dashboard
* $I->seeInCurrentUrl('home');
* // to match: /users/1
* $I->seeInCurrentUrl('/users/');
* ?>
* ```
*
* @param $uri
* @see Codeception\Util\Mink::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
* <?php
* $I->dontSeeInCurrentUrl('/users/');
* ?>
* ```
*
* @param $uri
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::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
* <?php
* $I->dontSeeInCurrentUrl('/users/');
* ?>
* ```
*
* @param $uri
* @see Codeception\Util\Mink::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
* <?php
* // to match root url
* $I->seeCurrentUrlEquals('/');
* ?>
* ```
*
* @param $uri
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::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
* <?php
* // to match root url
* $I->seeCurrentUrlEquals('/');
* ?>
* ```
*
* @param $uri
* @see Codeception\Util\Mink::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
* <?php
* // current url is not root
* $I->dontSeeCurrentUrlEquals('/');
* ?>
* ```
*
* @param $uri
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::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
* <?php
* // current url is not root
* $I->dontSeeCurrentUrlEquals('/');
* ?>
* ```
*
* @param $uri
* @see Codeception\Util\Mink::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
* <?php
* // to match root url
* $I->seeCurrentUrlMatches('~$/users/(\d+)~');
* ?>
* ```
*
* @param $uri
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::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
* <?php
* // to match root url
* $I->seeCurrentUrlMatches('~$/users/(\d+)~');
* ?>
* ```
*
* @param $uri
* @see Codeception\Util\Mink::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
* <?php
* // to match root url
* $I->dontSeeCurrentUrlMatches('~$/users/(\d+)~');
* ?>
* ```
*
* @param $uri
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::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
* <?php
* // to match root url
* $I->dontSeeCurrentUrlMatches('~$/users/(\d+)~');
* ?>
* ```
*
* @param $uri
* @see Codeception\Util\Mink::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.
* ----------------------------------------------
*
* Checks that cookie is set.
*
* @param $cookie
* @return mixed
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::seeCookie()
* @return \Codeception\Maybe
*/
public function canSeeCookie($cookie) {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeCookie', 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 cookie is set.
*
* @param $cookie
* @return mixed
* @see Codeception\Util\Mink::seeCookie()
* @return \Codeception\Maybe
*/
public function seeCookie($cookie) {
$this->scenario->addStep(new \Codeception\Step\Assertion('seeCookie', 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 cookie doesn't exist
*
* @param $cookie
* @return mixed
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::dontSeeCookie()
* @return \Codeception\Maybe
*/
public function cantSeeCookie($cookie) {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeCookie', 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 cookie doesn't exist
*
* @param $cookie
* @return mixed
* @see Codeception\Util\Mink::dontSeeCookie()
* @return \Codeception\Maybe
*/
public function dontSeeCookie($cookie) {
$this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeCookie', 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.
* ----------------------------------------------
*
* Sets a cookie.
*
* @param $cookie
* @param $value
* @return mixed
* @see Codeception\Util\Mink::setCookie()
* @return \Codeception\Maybe
*/
public function setCookie($cookie, $value) {
$this->scenario->addStep(new \Codeception\Step\Action('setCookie', 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.
* ----------------------------------------------
*
* Unsets cookie
*
* @param $cookie
* @return mixed
* @see Codeception\Util\Mink::resetCookie()
* @return \Codeception\Maybe
*/
public function resetCookie($cookie) {
$this->scenario->addStep(new \Codeception\Step\Action('resetCookie', 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.
* ----------------------------------------------
*
* Grabs a cookie value.
*
* @param $cookie
* @return mixed
* @see Codeception\Util\Mink::grabCookie()
* @return \Codeception\Maybe
*/
public function grabCookie($cookie) {
$this->scenario->addStep(new \Codeception\Step\Action('grabCookie', 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
* <?php
* $user_id = $I->grabFromCurrentUrl('~$/user/(\d+)/~');
* $uri = $I->grabFromCurrentUrl();
* ?>
* ```
*
* @param null $uri
* @internal param $url
* @return mixed
* @see Codeception\Util\Mink::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.
* ----------------------------------------------
*
* Attaches file from Codeception data directory to upload field.
*
* Example:
*
* ``` php
* <?php
* // file is stored in 'tests/_data/prices.xls'
* $I->attachFile('input[@type="file"]', 'prices.xls');
* ?>
* ```
*
* @param $field
* @param $filename
* @see Codeception\Util\Mink::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.
* ----------------------------------------------
*
* Checks if option is selected in select field.
*
* ``` php
* <?php
* $I->seeOptionIsSelected('#form input[name=payment]', 'Visa');
* ?>
* ```
*
* @param $selector
* @param $optionText
* @return mixed
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::seeOptionIsSelected()
* @return \Codeception\Maybe
*/
public function canSeeOptionIsSelected($select, $text) {
$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
* <?php
* $I->seeOptionIsSelected('#form input[name=payment]', 'Visa');
* ?>
* ```
*
* @param $selector
* @param $optionText
* @return mixed
* @see Codeception\Util\Mink::seeOptionIsSelected()
* @return \Codeception\Maybe
*/
public function seeOptionIsSelected($select, $text) {
$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
* <?php
* $I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
* ?>
* ```
*
* @param $selector
* @param $optionText
* @return mixed
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::dontSeeOptionIsSelected()
* @return \Codeception\Maybe
*/
public function cantSeeOptionIsSelected($select, $text) {
$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
* <?php
* $I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
* ?>
* ```
*
* @param $selector
* @param $optionText
* @return mixed
* @see Codeception\Util\Mink::dontSeeOptionIsSelected()
* @return \Codeception\Maybe
*/
public function dontSeeOptionIsSelected($select, $text) {
$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.
* ----------------------------------------------
*
* Checks that an input field or textarea contains value.
* Field is matched either by label or CSS or Xpath
*
* Example:
*
* ``` php
* <?php
* $I->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\Mink::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
* <?php
* $I->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\Mink::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
* <?php
* $I->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\Mink::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
* <?php
* $I->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\Mink::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.
* ----------------------------------------------
*
* Finds and returns text contents of element.
* Element is searched by CSS selector, XPath or matcher by regex.
*
* Example:
*
* ``` php
* <?php
* $heading = $I->grabTextFrom('h1');
* $heading = $I->grabTextFrom('descendant-or-self::h1');
* $value = $I->grabTextFrom('~<input value=(.*?)]~sgi');
* ?>
* ```
*
* @param $cssOrXPathOrRegex
* @return mixed
* @see Codeception\Util\Mink::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
* <?php
* $name = $I->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\Mink::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 that page title contains text.
*
* ``` php
* <?php
* $I->seeInTitle('Blog - Post #1');
* ?>
* ```
*
* @param $title
* @return mixed
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Util\Mink::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
* <?php
* $I->seeInTitle('Blog - Post #1');
* ?>
* ```
*
* @param $title
* @return mixed
* @see Codeception\Util\Mink::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\Mink::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\Mink::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();
}
/**
* This method is generated.
* Documentation taken from corresponding module.
* ----------------------------------------------
*
*
* @see Codeception\Module::getName()
* @return \Codeception\Maybe
*/
public function getName() {
$this->scenario->addStep(new \Codeception\Step\Action('getName', 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.
* ----------------------------------------------
*
* Sets HTTP header
*
* @param $name
* @param $value
* @see Codeception\Module\REST::haveHttpHeader()
* @return \Codeception\Maybe
*/
public function haveHttpHeader($name, $value) {
$this->scenario->addStep(new \Codeception\Step\Action('haveHttpHeader', 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 over the given HTTP header and (optionally)
* its value, asserting that are there
*
* @param $name
* @param $value
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Module\REST::seeHttpHeader()
* @return \Codeception\Maybe
*/
public function canSeeHttpHeader($name, $value = null) {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeHttpHeader', 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 over the given HTTP header and (optionally)
* its value, asserting that are there
*
* @param $name
* @param $value
* @see Codeception\Module\REST::seeHttpHeader()
* @return \Codeception\Maybe
*/
public function seeHttpHeader($name, $value = null) {
$this->scenario->addStep(new \Codeception\Step\Assertion('seeHttpHeader', 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 over the given HTTP header and (optionally)
* its value, asserting that are not there
*
* @param $name
* @param $value
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Module\REST::dontSeeHttpHeader()
* @return \Codeception\Maybe
*/
public function cantSeeHttpHeader($name, $value = null) {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeHttpHeader', 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 over the given HTTP header and (optionally)
* its value, asserting that are not there
*
* @param $name
* @param $value
* @see Codeception\Module\REST::dontSeeHttpHeader()
* @return \Codeception\Maybe
*/
public function dontSeeHttpHeader($name, $value = null) {
$this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeHttpHeader', 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 http response header is received only once.
* HTTP RFC2616 allows multiple response headers with the same name.
* You can check that you didn't accidentally sent the same header twice.
*
* ``` php
* <?php
* $I->seeHttpHeaderOnce('Cache-Control');
* ?>>
* ```
*
* @param $name
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Module\REST::seeHttpHeaderOnce()
* @return \Codeception\Maybe
*/
public function canSeeHttpHeaderOnce($name) {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeHttpHeaderOnce', 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 http response header is received only once.
* HTTP RFC2616 allows multiple response headers with the same name.
* You can check that you didn't accidentally sent the same header twice.
*
* ``` php
* <?php
* $I->seeHttpHeaderOnce('Cache-Control');
* ?>>
* ```
*
* @param $name
* @see Codeception\Module\REST::seeHttpHeaderOnce()
* @return \Codeception\Maybe
*/
public function seeHttpHeaderOnce($name) {
$this->scenario->addStep(new \Codeception\Step\Assertion('seeHttpHeaderOnce', 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.
* ----------------------------------------------
*
* Returns the value of the specified header name
*
* @param $name
* @param Boolean $first Whether to return the first value or all header values
*
* @return string|array The first header value if $first is true, an array of values otherwise
* @see Codeception\Module\REST::grabHttpHeader()
* @return \Codeception\Maybe
*/
public function grabHttpHeader($name, $first = null) {
$this->scenario->addStep(new \Codeception\Step\Action('grabHttpHeader', 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.
* ----------------------------------------------
*
* Adds Digest authentication via username/password.
*
* @param $username
* @param $password
* @see Codeception\Module\REST::amDigestAuthenticated()
* @return \Codeception\Maybe
*/
public function amDigestAuthenticated($username, $password) {
$this->scenario->addStep(new \Codeception\Step\Condition('amDigestAuthenticated', 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.
* ----------------------------------------------
*
* Sends a POST request to given uri.
*
* Parameters and files (as array of filenames) can be provided.
*
* @param $url
* @param array $params
* @param array $files
* @see Codeception\Module\REST::sendPOST()
* @return \Codeception\Maybe
*/
public function sendPOST($url, $params = null, $files = null) {
$this->scenario->addStep(new \Codeception\Step\Action('sendPOST', 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.
* ----------------------------------------------
*
* Sends a HEAD request to given uri.
*
* @param $url
* @param array $params
* @see Codeception\Module\REST::sendHEAD()
* @return \Codeception\Maybe
*/
public function sendHEAD($url, $params = null) {
$this->scenario->addStep(new \Codeception\Step\Action('sendHEAD', 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.
* ----------------------------------------------
*
* Sends an OPTIONS request to given uri.
*
* @param $url
* @param array $params
* @see Codeception\Module\REST::sendOPTIONS()
* @return \Codeception\Maybe
*/
public function sendOPTIONS($url, $params = null) {
$this->scenario->addStep(new \Codeception\Step\Action('sendOPTIONS', 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.
* ----------------------------------------------
*
* Sends a GET request to given uri.
*
* @param $url
* @param array $params
* @see Codeception\Module\REST::sendGET()
* @return \Codeception\Maybe
*/
public function sendGET($url, $params = null) {
$this->scenario->addStep(new \Codeception\Step\Action('sendGET', 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.
* ----------------------------------------------
*
* Sends PUT request to given uri.
*
* @param $url
* @param array $params
* @param array $files
* @see Codeception\Module\REST::sendPUT()
* @return \Codeception\Maybe
*/
public function sendPUT($url, $params = null, $files = null) {
$this->scenario->addStep(new \Codeception\Step\Action('sendPUT', 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.
* ----------------------------------------------
*
* Sends PATCH request to given uri.
*
* @param $url
* @param array $params
* @param array $files
* @see Codeception\Module\REST::sendPATCH()
* @return \Codeception\Maybe
*/
public function sendPATCH($url, $params = null, $files = null) {
$this->scenario->addStep(new \Codeception\Step\Action('sendPATCH', 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.
* ----------------------------------------------
*
* Sends DELETE request to given uri.
*
* @param $url
* @param array $params
* @param array $files
* @see Codeception\Module\REST::sendDELETE()
* @return \Codeception\Maybe
*/
public function sendDELETE($url, $params = null, $files = null) {
$this->scenario->addStep(new \Codeception\Step\Action('sendDELETE', 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.
* ----------------------------------------------
*
* Sends LINK request to given uri.
*
* @param $url
* @param array $linkEntries (entry is array with keys "uri" and "link-param")
*
* @link http://tools.ietf.org/html/rfc2068#section-19.6.2.4
*
* @author samva.ua@gmail.com
* @see Codeception\Module\REST::sendLINK()
* @return \Codeception\Maybe
*/
public function sendLINK($url, $linkEntries) {
$this->scenario->addStep(new \Codeception\Step\Action('sendLINK', 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.
* ----------------------------------------------
*
* Sends UNLINK request to given uri.
*
* @param $url
* @param array $linkEntries (entry is array with keys "uri" and "link-param")
*
* @link http://tools.ietf.org/html/rfc2068#section-19.6.2.4
*
* @author samva.ua@gmail.com
* @see Codeception\Module\REST::sendUNLINK()
* @return \Codeception\Maybe
*/
public function sendUNLINK($url, $linkEntries) {
$this->scenario->addStep(new \Codeception\Step\Action('sendUNLINK', 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 whether last response was valid JSON.
* This is done with json_last_error function.
*
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Module\REST::seeResponseIsJson()
* @return \Codeception\Maybe
*/
public function canSeeResponseIsJson() {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeResponseIsJson', 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 whether last response was valid JSON.
* This is done with json_last_error function.
*
* @see Codeception\Module\REST::seeResponseIsJson()
* @return \Codeception\Maybe
*/
public function seeResponseIsJson() {
$this->scenario->addStep(new \Codeception\Step\Assertion('seeResponseIsJson', 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 whether last response was valid XML.
* This is done with libxml_get_last_error function.
*
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Module\REST::seeResponseIsXml()
* @return \Codeception\Maybe
*/
public function canSeeResponseIsXml() {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeResponseIsXml', 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 whether last response was valid XML.
* This is done with libxml_get_last_error function.
*
* @see Codeception\Module\REST::seeResponseIsXml()
* @return \Codeception\Maybe
*/
public function seeResponseIsXml() {
$this->scenario->addStep(new \Codeception\Step\Assertion('seeResponseIsXml', 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 whether the last response contains text.
*
* @param $text
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Module\REST::seeResponseContains()
* @return \Codeception\Maybe
*/
public function canSeeResponseContains($text) {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeResponseContains', 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 whether the last response contains text.
*
* @param $text
* @see Codeception\Module\REST::seeResponseContains()
* @return \Codeception\Maybe
*/
public function seeResponseContains($text) {
$this->scenario->addStep(new \Codeception\Step\Assertion('seeResponseContains', 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 whether last response do not contain text.
*
* @param $text
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Module\REST::dontSeeResponseContains()
* @return \Codeception\Maybe
*/
public function cantSeeResponseContains($text) {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeResponseContains', 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 whether last response do not contain text.
*
* @param $text
* @see Codeception\Module\REST::dontSeeResponseContains()
* @return \Codeception\Maybe
*/
public function dontSeeResponseContains($text) {
$this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeResponseContains', 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 whether the last JSON response contains provided array.
* The response is converted to array with json_decode($response, true)
* Thus, JSON is represented by associative array.
* This method matches that response array contains provided array.
*
* Examples:
*
* ``` php
* <?php
* // response: {name: john, email: john@gmail.com}
* $I->seeResponseContainsJson(array('name' => 'john'));
*
* // response {user: john, profile: { email: john@gmail.com }}
* $I->seeResponseContainsJson(array('email' => 'john@gmail.com'));
*
* ?>
* ```
*
* This method recursively checks if one array can be found inside of another.
*
* @param array $json
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Module\REST::seeResponseContainsJson()
* @return \Codeception\Maybe
*/
public function canSeeResponseContainsJson($json = null) {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeResponseContainsJson', 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 whether the last JSON response contains provided array.
* The response is converted to array with json_decode($response, true)
* Thus, JSON is represented by associative array.
* This method matches that response array contains provided array.
*
* Examples:
*
* ``` php
* <?php
* // response: {name: john, email: john@gmail.com}
* $I->seeResponseContainsJson(array('name' => 'john'));
*
* // response {user: john, profile: { email: john@gmail.com }}
* $I->seeResponseContainsJson(array('email' => 'john@gmail.com'));
*
* ?>
* ```
*
* This method recursively checks if one array can be found inside of another.
*
* @param array $json
* @see Codeception\Module\REST::seeResponseContainsJson()
* @return \Codeception\Maybe
*/
public function seeResponseContainsJson($json = null) {
$this->scenario->addStep(new \Codeception\Step\Assertion('seeResponseContainsJson', 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.
* ----------------------------------------------
*
* Returns current response so that it can be used in next scenario steps.
*
* Example:
*
* ``` php
* <?php
* $user_id = $I->grabResponse();
* $I->sendPUT('/user', array('id' => $user_id, 'name' => 'davert'));
* ?>
* ```
*
* @version 1.1
* @return string
* @see Codeception\Module\REST::grabResponse()
* @return \Codeception\Maybe
*/
public function grabResponse() {
$this->scenario->addStep(new \Codeception\Step\Action('grabResponse', 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.
* ----------------------------------------------
*
* Returns data from the current JSON response using specified path
* so that it can be used in next scenario steps
*
* Example:
*
* ``` php
* <?php
* $user_id = $I->grabDataFromJsonResponse('user.user_id');
* $I->sendPUT('/user', array('id' => $user_id, 'name' => 'davert'));
* ?>
* ```
*
* @param string $path
*
* @since 1.1.2
* @return string
*
* @author tiger.seo@gmail.com
* @see Codeception\Module\REST::grabDataFromJsonResponse()
* @return \Codeception\Maybe
*/
public function grabDataFromJsonResponse($path) {
$this->scenario->addStep(new \Codeception\Step\Action('grabDataFromJsonResponse', 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.
* ----------------------------------------------
*
* Opposite to seeResponseContainsJson
*
* @param array $json
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Module\REST::dontSeeResponseContainsJson()
* @return \Codeception\Maybe
*/
public function cantSeeResponseContainsJson($json = null) {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeResponseContainsJson', 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.
* ----------------------------------------------
*
* Opposite to seeResponseContainsJson
*
* @param array $json
* @see Codeception\Module\REST::dontSeeResponseContainsJson()
* @return \Codeception\Maybe
*/
public function dontSeeResponseContainsJson($json = null) {
$this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeResponseContainsJson', 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 response is exactly the same as provided.
*
* @param $response
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Module\REST::seeResponseEquals()
* @return \Codeception\Maybe
*/
public function canSeeResponseEquals($response) {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('seeResponseEquals', 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 response is exactly the same as provided.
*
* @param $response
* @see Codeception\Module\REST::seeResponseEquals()
* @return \Codeception\Maybe
*/
public function seeResponseEquals($response) {
$this->scenario->addStep(new \Codeception\Step\Assertion('seeResponseEquals', 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 not equal to provided value.
*
* @param $code
* Conditional Assertion: Test won't be stopped on fail
* @see Codeception\Module\REST::dontSeeResponseCodeIs()
* @return \Codeception\Maybe
*/
public function cantSeeResponseCodeIs($code) {
$this->scenario->addStep(new \Codeception\Step\ConditionalAssertion('dontSeeResponseCodeIs', 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 not equal to provided value.
*
* @param $code
* @see Codeception\Module\REST::dontSeeResponseCodeIs()
* @return \Codeception\Maybe
*/
public function dontSeeResponseCodeIs($code) {
$this->scenario->addStep(new \Codeception\Step\Assertion('dontSeeResponseCodeIs', func_get_args()));
if ($this->scenario->running()) {
$result = $this->scenario->runStep();
return new Maybe($result);
}
return new Maybe();
}
}