Home`
+ * - ``
+ *
+ * For checking the raw source code, use `seeInSource()`.
*
* @param $text
* @param null $selector
@@ -262,16 +291,29 @@ trait FunctionalTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Checks that the current page doesn't contain the text specified.
+ * Checks that the current page doesn't contain the text specified (case insensitive).
* Give a locator as the second parameter to match a specific region.
*
* ```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
- * ?>
+ * $I->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
* ```
+ *
+ * Note that the search is done after stripping all HTML tags from the body,
+ * so `$I->dontSee('strong')` will fail on strings like:
+ *
+ * - `
`
+ * - ``
+ *
+ * But will ignore strings like:
+ *
+ * - `
Home`
+ * - ``
+ *
+ * For checking the raw source code, use `seeInSource()`.
*
* @param $text
* @param null $selector
@@ -284,16 +326,29 @@ trait FunctionalTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Checks that the current page doesn't contain the text specified.
+ * Checks that the current page doesn't contain the text specified (case insensitive).
* Give a locator as the second parameter to match a specific region.
*
* ```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
- * ?>
+ * $I->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
* ```
+ *
+ * Note that the search is done after stripping all HTML tags from the body,
+ * so `$I->dontSee('strong')` will fail on strings like:
+ *
+ * - `
I am Stronger than thou
`
+ * - ``
+ *
+ * But will ignore strings like:
+ *
+ * - `
Home`
+ * - `
Home`
+ * - ``
+ *
+ * For checking the raw source code, use `seeInSource()`.
*
* @param $text
* @param null $selector
@@ -304,6 +359,80 @@ trait FunctionalTesterActions
}
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the current page contains the given string in its
+ * raw source code.
+ *
+ * ``` php
+ * seeInSource('
Green eggs & ham
');
+ * ```
+ *
+ * @param $raw
+ * Conditional Assertion: Test won't be stopped on fail
+ * @see \Codeception\Lib\InnerBrowser::seeInSource()
+ */
+ public function canSeeInSource($raw) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInSource', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the current page contains the given string in its
+ * raw source code.
+ *
+ * ``` php
+ * seeInSource('Green eggs & ham
');
+ * ```
+ *
+ * @param $raw
+ * @see \Codeception\Lib\InnerBrowser::seeInSource()
+ */
+ public function seeInSource($raw) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInSource', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the current page contains the given string in its
+ * raw source code.
+ *
+ * ```php
+ * dontSeeInSource('Green eggs & ham
');
+ * ```
+ *
+ * @param $raw
+ * Conditional Assertion: Test won't be stopped on fail
+ * @see \Codeception\Lib\InnerBrowser::dontSeeInSource()
+ */
+ public function cantSeeInSource($raw) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInSource', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the current page contains the given string in its
+ * raw source code.
+ *
+ * ```php
+ * dontSeeInSource('Green eggs & ham
');
+ * ```
+ *
+ * @param $raw
+ * @see \Codeception\Lib\InnerBrowser::dontSeeInSource()
+ */
+ public function dontSeeInSource($raw) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInSource', func_get_args()));
+ }
+
+
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
@@ -1076,13 +1205,25 @@ trait FunctionalTesterActions
* Submits the given form on the page, optionally with the given form
* values. Give the form fields values as an array.
*
- * Skipped fields will be filled by their values from the page.
+ * Although this function can be used as a short-hand version of
+ * `fillField()`, `selectOption()`, `click()` etc. it has some important
+ * differences:
+ *
+ * * Only field *names* may be used, not CSS/XPath selectors nor field labels
+ * * If a field is sent to this function that does *not* exist on the page,
+ * it will silently be added to the HTTP request. This is helpful for testing
+ * some types of forms, but be aware that you will *not* get an exception
+ * like you would if you called `fillField()` or `selectOption()` with
+ * a missing field.
+ *
+ * Fields that are not provided will be filled by their values from the page,
+ * or from any previous calls to `fillField()`, `selectOption()` etc.
* You don't need to click the 'Submit' button afterwards.
* This command itself triggers the request to form's action.
*
- * You can optionally specify what button's value to include
- * in the request with the last parameter as an alternative to
- * explicitly setting its value in the second parameter, as
+ * You can optionally specify which button's value to include
+ * in the request with the last parameter (as an alternative to
+ * explicitly setting its value in the second parameter), as
* button values are not otherwise included in the request.
*
* Examples:
@@ -1156,7 +1297,8 @@ trait FunctionalTesterActions
* );
* ```
*
- * Pair this with seeInFormFields for quick testing magic.
+ * This function works well when paired with `seeInFormFields()`
+ * for quickly testing CRUD interfaces and form validation logic.
*
* ``` php
* true,
* // ...
* ];
- * $I->submitForm('//form[@id=my-form]', $form, 'submitButton');
+ * $I->submitForm('#my-form', $form, 'submitButton');
* // $I->amOnPage('/path/to/form-page') may be needed
- * $I->seeInFormFields('//form[@id=my-form]', $form);
- * ?>
+ * $I->seeInFormFields('#my-form', $form);
* ```
*
* Parameter values can be set to arrays for multiple input fields
* of the same name, or multi-select combo boxes. For checkboxes,
- * either the string value can be used, or boolean values which will
+ * you can use either the string value or boolean `true`/`false` which will
* be replaced by the checkbox's value in the DOM.
*
* ``` php
@@ -1183,7 +1324,7 @@ trait FunctionalTesterActions
* 'field1' => 'value',
* 'checkbox' => [
* 'value of first checkbox',
- * 'value of second checkbox,
+ * 'value of second checkbox',
* ],
* 'otherCheckboxes' => [
* true,
@@ -1195,27 +1336,29 @@ trait FunctionalTesterActions
* 'second option value'
* ]
* ]);
- * ?>
* ```
*
* Mixing string and boolean values for a checkbox's value is not supported
* and may produce unexpected results.
*
- * Field names ending in "[]" must be passed without the trailing square
+ * Field names ending in `[]` must be passed without the trailing square
* bracket characters, and must contain an array for its value. This allows
* submitting multiple values with the same name, consider:
*
* ```php
+ * submitForm('#my-form', [
* 'field[]' => 'value',
- * 'field[]' => 'another value', // 'field[]' is already a defined key
+ * 'field[]' => 'another value', // 'field[]' is already a defined key
* ]);
* ```
*
* The solution is to pass an array value:
*
* ```php
- * // this way both values are submitted
+ * submitForm('#my-form', [
* 'field' => [
* 'value',
@@ -2017,6 +2160,19 @@ trait FunctionalTesterActions
}
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Moves back in history.
+ *
+ * @param int $numberOfSteps (default value 1)
+ * @see \Codeception\Lib\InnerBrowser::moveBack()
+ */
+ public function moveBack($numberOfSteps = null) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('moveBack', func_get_args()));
+ }
+
+
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
@@ -2116,16 +2272,78 @@ trait FunctionalTesterActions
*
* ``` php
* expectEvents('App\MyEvent');
- * $I->expectEvents('App\MyEvent', 'App\MyOtherEvent');
- * $I->expectEvents(['App\MyEvent', 'App\MyOtherEvent']);
+ * $I->seeEventTriggered('App\MyEvent');
+ * $I->seeEventTriggered(new App\Events\MyEvent());
+ * $I->seeEventTriggered('App\MyEvent', 'App\MyOtherEvent');
+ * $I->seeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
* ?>
* ```
* @param $events
- * @see \Codeception\Module\Laravel5::expectEvents()
+ * Conditional Assertion: Test won't be stopped on fail
+ * @see \Codeception\Module\Laravel5::seeEventTriggered()
*/
- public function expectEvents($events) {
- return $this->getScenario()->runStep(new \Codeception\Step\Action('expectEvents', func_get_args()));
+ public function canSeeEventTriggered($events) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeEventTriggered', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Make sure events fired during the test.
+ *
+ * ``` php
+ * seeEventTriggered('App\MyEvent');
+ * $I->seeEventTriggered(new App\Events\MyEvent());
+ * $I->seeEventTriggered('App\MyEvent', 'App\MyOtherEvent');
+ * $I->seeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
+ * ?>
+ * ```
+ * @param $events
+ * @see \Codeception\Module\Laravel5::seeEventTriggered()
+ */
+ public function seeEventTriggered($events) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeEventTriggered', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Make sure events did not fire during the test.
+ *
+ * ``` php
+ * dontSeeEventTriggered('App\MyEvent');
+ * $I->dontSeeEventTriggered(new App\Events\MyEvent());
+ * $I->dontSeeEventTriggered('App\MyEvent', 'App\MyOtherEvent');
+ * $I->dontSeeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
+ * ?>
+ * ```
+ * @param $events
+ * Conditional Assertion: Test won't be stopped on fail
+ * @see \Codeception\Module\Laravel5::dontSeeEventTriggered()
+ */
+ public function cantSeeEventTriggered($events) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeEventTriggered', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Make sure events did not fire during the test.
+ *
+ * ``` php
+ * dontSeeEventTriggered('App\MyEvent');
+ * $I->dontSeeEventTriggered(new App\Events\MyEvent());
+ * $I->dontSeeEventTriggered('App\MyEvent', 'App\MyOtherEvent');
+ * $I->dontSeeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
+ * ?>
+ * ```
+ * @param $events
+ * @see \Codeception\Module\Laravel5::dontSeeEventTriggered()
+ */
+ public function dontSeeEventTriggered($events) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeEventTriggered', func_get_args()));
}
@@ -2149,6 +2367,41 @@ trait FunctionalTesterActions
}
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that current url matches route
+ *
+ * ``` php
+ * seeCurrentRouteIs('posts.index');
+ * ?>
+ * ```
+ * @param $routeName
+ * Conditional Assertion: Test won't be stopped on fail
+ * @see \Codeception\Module\Laravel5::seeCurrentRouteIs()
+ */
+ public function canSeeCurrentRouteIs($routeName) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentRouteIs', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that current url matches route
+ *
+ * ``` php
+ * seeCurrentRouteIs('posts.index');
+ * ?>
+ * ```
+ * @param $routeName
+ * @see \Codeception\Module\Laravel5::seeCurrentRouteIs()
+ */
+ public function seeCurrentRouteIs($routeName) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentRouteIs', func_get_args()));
+ }
+
+
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
@@ -2169,43 +2422,6 @@ trait FunctionalTesterActions
}
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Checks that current url matches route
- *
- * ``` php
- * seeCurrentRouteIs('posts.index');
- * ?>
- * ```
- * @param $route
- * @param array $params
- * Conditional Assertion: Test won't be stopped on fail
- * @see \Codeception\Module\Laravel5::seeCurrentRouteIs()
- */
- public function canSeeCurrentRouteIs($route, $params = null) {
- return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentRouteIs', func_get_args()));
- }
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Checks that current url matches route
- *
- * ``` php
- * seeCurrentRouteIs('posts.index');
- * ?>
- * ```
- * @param $route
- * @param array $params
- * @see \Codeception\Module\Laravel5::seeCurrentRouteIs()
- */
- public function seeCurrentRouteIs($route, $params = null) {
- return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentRouteIs', func_get_args()));
- }
-
-
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
@@ -2218,11 +2434,10 @@ trait FunctionalTesterActions
* ```
*
* @param $action
- * @param array $params
* Conditional Assertion: Test won't be stopped on fail
* @see \Codeception\Module\Laravel5::seeCurrentActionIs()
*/
- public function canSeeCurrentActionIs($action, $params = null) {
+ public function canSeeCurrentActionIs($action) {
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentActionIs', func_get_args()));
}
/**
@@ -2237,10 +2452,9 @@ trait FunctionalTesterActions
* ```
*
* @param $action
- * @param array $params
* @see \Codeception\Module\Laravel5::seeCurrentActionIs()
*/
- public function seeCurrentActionIs($action, $params = null) {
+ public function seeCurrentActionIs($action) {
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentActionIs', func_get_args()));
}
@@ -2408,14 +2622,14 @@ trait FunctionalTesterActions
*
* Assert that specific form error messages are set in the view.
*
- * Useful for validation messages e.g.
- * return `Redirect::to('register')->withErrors($validator);`
- *
- * Example of Usage
+ * This method calls `seeFormErrorMessage` for each entry in the `$bindings` array.
*
* ``` php
* seeFormErrorMessages(array('username'=>'Invalid Username'));
+ * $I->seeFormErrorMessages([
+ * 'username' => 'Invalid Username',
+ * 'password' => null,
+ * ]);
* ?>
* ```
* @param array $bindings
@@ -2430,14 +2644,14 @@ trait FunctionalTesterActions
*
* Assert that specific form error messages are set in the view.
*
- * Useful for validation messages e.g.
- * return `Redirect::to('register')->withErrors($validator);`
- *
- * Example of Usage
+ * This method calls `seeFormErrorMessage` for each entry in the `$bindings` array.
*
* ``` php
* seeFormErrorMessages(array('username'=>'Invalid Username'));
+ * $I->seeFormErrorMessages([
+ * 'username' => 'Invalid Username',
+ * 'password' => null,
+ * ]);
* ?>
* ```
* @param array $bindings
@@ -2451,48 +2665,50 @@ trait FunctionalTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Assert that specific form error message is set in the view.
+ * Assert that a specific form error message is set in the view.
*
- * Useful for validation messages and generally messages array
- * e.g.
- * return `Redirect::to('register')->withErrors($validator);`
+ * If you want to assert that there is a form error message for a specific key
+ * but don't care about the actual error message you can omit `$expectedErrorMessage`.
*
- * Example of Usage
+ * If you do pass `$expectedErrorMessage`, this method checks if the actual error message for a key
+ * contains `$expectedErrorMessage`.
*
* ``` php
* seeFormErrorMessage('username');
* $I->seeFormErrorMessage('username', 'Invalid Username');
* ?>
* ```
* @param string $key
- * @param string $errorMessage
+ * @param string|null $expectedErrorMessage
* Conditional Assertion: Test won't be stopped on fail
* @see \Codeception\Module\Laravel5::seeFormErrorMessage()
*/
- public function canSeeFormErrorMessage($key, $errorMessage) {
+ public function canSeeFormErrorMessage($key, $expectedErrorMessage = null) {
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeFormErrorMessage', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Assert that specific form error message is set in the view.
+ * Assert that a specific form error message is set in the view.
*
- * Useful for validation messages and generally messages array
- * e.g.
- * return `Redirect::to('register')->withErrors($validator);`
+ * If you want to assert that there is a form error message for a specific key
+ * but don't care about the actual error message you can omit `$expectedErrorMessage`.
*
- * Example of Usage
+ * If you do pass `$expectedErrorMessage`, this method checks if the actual error message for a key
+ * contains `$expectedErrorMessage`.
*
* ``` php
* seeFormErrorMessage('username');
* $I->seeFormErrorMessage('username', 'Invalid Username');
* ?>
* ```
* @param string $key
- * @param string $errorMessage
+ * @param string|null $expectedErrorMessage
* @see \Codeception\Module\Laravel5::seeFormErrorMessage()
*/
- public function seeFormErrorMessage($key, $errorMessage) {
+ public function seeFormErrorMessage($key, $expectedErrorMessage = null) {
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeFormErrorMessage', func_get_args()));
}
@@ -2504,8 +2720,6 @@ trait FunctionalTesterActions
* Takes either an object that implements the User interface or
* an array of credentials.
*
- * Example of Usage
- *
* ``` php
* getScenario()->runStep(new \Codeception\Step\Action('grabRecord', func_get_args()));
}
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Use Laravel's model factory to create a model.
+ * Can only be used with Laravel 5.1 and later.
+ *
+ * ``` php
+ * haveModel('App\User');
+ * $I->haveModel('App\User', ['name' => 'John Doe']);
+ * $I->haveModel('App\User', [], 'admin');
+ * $I->haveModel('App\User', [], 'admin', 3);
+ * ?>
+ * ```
+ *
+ * @see http://laravel.com/docs/5.1/testing#model-factories
+ * @param string $model
+ * @param array $attributes
+ * @param string $name
+ * @param int $times
+ * @return mixed
+ * @see \Codeception\Module\Laravel5::haveModel()
+ */
+ public function haveModel($model, $attributes = null, $name = null, $times = null) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('haveModel', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Use Laravel's model factory to create a model.
+ * Can only be used with Laravel 5.1 and later.
+ *
+ * ``` php
+ * createModel('App\User');
+ * $I->createModel('App\User', ['name' => 'John Doe']);
+ * $I->createModel('App\User', [], 'admin');
+ * $I->createModel('App\User', [], 'admin', 3);
+ * ?>
+ * ```
+ *
+ * @see http://laravel.com/docs/5.1/testing#model-factories
+ * @param string $model
+ * @param array $attributes
+ * @param string $name
+ * @param int $times
+ * @return mixed
+ * @see \Codeception\Module\Laravel5::createModel()
+ */
+ public function createModel($model, $attributes = null, $name = null, $times = null) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('createModel', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Use Laravel's model factory to make a model.
+ * Can only be used with Laravel 5.1 and later.
+ *
+ * ``` php
+ * makeModel('App\User');
+ * $I->makeModel('App\User', ['name' => 'John Doe']);
+ * $I->makeModel('App\User', [], 'admin');
+ * $I->makeModel('App\User', [], 'admin', 3);
+ * ?>
+ * ```
+ *
+ * @see http://laravel.com/docs/5.1/testing#model-factories
+ * @param string $model
+ * @param array $attributes
+ * @param string $name
+ * @param int $times
+ * @return mixed
+ * @see \Codeception\Module\Laravel5::makeModel()
+ */
+ public function makeModel($model, $attributes = null, $name = null, $times = null) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('makeModel', func_get_args()));
+ }
}