diff --git a/bin/setup-wp.php b/bin/setup-wp.php
index c9cc99d83..2e9c37f5b 100644
--- a/bin/setup-wp.php
+++ b/bin/setup-wp.php
@@ -1,6 +1,7 @@
load();
+$mysqlServer = new MysqlServer(
+ codecept_output_dir('_mysql_server'),
+ $_ENV['WORDPRESS_DB_LOCALHOST_PORT'],
+ $_ENV['WORDPRESS_DB_NAME'],
+ $_ENV['WORDPRESS_DB_USER'],
+ $_ENV['WORDPRESS_DB_PASSWORD']
+);
+$mysqlServer->start();
+
$wpRootDir = $env['WORDPRESS_ROOT_DIR'];
echo "Checking WordPress directory $wpRootDir ...\n";
diff --git a/codeception.dist.yml b/codeception.dist.yml
index b1602a48e..5fac29b7b 100644
--- a/codeception.dist.yml
+++ b/codeception.dist.yml
@@ -22,7 +22,7 @@ extensions:
- "lucatume\\WPBrowser\\Extension\\EventDispatcherBridge"
- "lucatume\\WPBrowser\\Extension\\BuiltInServerController"
- "lucatume\\WPBrowser\\Extension\\ChromeDriverController"
- - "lucatume\\WPBrowser\\Extension\\DockerComposeController"
+ - "lucatume\\WPBrowser\\Extension\\MysqlServerController"
- "lucatume\\WPBrowser\\Extension\\IsolationSupport"
config:
"lucatume\\WPBrowser\\Extension\\BuiltInServerController":
@@ -35,6 +35,11 @@ extensions:
"lucatume\\WPBrowser\\Extension\\DockerComposeController":
compose-file: docker-compose.yml
env-file: tests/.env
+ "lucatume\\WPBrowser\\Extension\\MysqlServerController":
+ port: '%WORDPRESS_DB_LOCALHOST_PORT%'
+ database: '%WORDPRESS_DB_NAME%'
+ user: '%WORDPRESS_DB_USER%'
+ password: '%WORDPRESS_DB_PASSWORD%'
commands:
- "lucatume\\WPBrowser\\Command\\RunOriginal"
- "lucatume\\WPBrowser\\Command\\RunAll"
diff --git a/tests/_support/_generated/AcceptanceTesterActions.php b/tests/_support/_generated/AcceptanceTesterActions.php
index 49eda7a32..343b43f2b 100644
--- a/tests/_support/_generated/AcceptanceTesterActions.php
+++ b/tests/_support/_generated/AcceptanceTesterActions.php
@@ -1,9 +1,9 @@
-getScenario()->runStep(new \Codeception\Step\Action('setHeader', func_get_args()));
+ public function setHeader($name, $value) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('setHeader', func_get_args()));
}
@@ -103,10 +106,13 @@ public function setHeader(string $name, string $value): void {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Authenticates user for HTTP_AUTH
+ *
+ * @param string $username
+ * @param string $password
* @see \Codeception\Module\PhpBrowser::amHttpAuthenticated()
*/
- public function amHttpAuthenticated($username, $password): void {
- $this->getScenario()->runStep(new \Codeception\Step\Condition('amHttpAuthenticated', func_get_args()));
+ public function amHttpAuthenticated($username, $password) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Condition('amHttpAuthenticated', func_get_args()));
}
@@ -119,11 +125,12 @@ public function amHttpAuthenticated($username, $password): void {
* amOnUrl('https://codeception.com');
* $I->amOnPage('/quickstart'); // moves to https://codeception.com/quickstart
+ * ?>
* ```
* @see \Codeception\Module\PhpBrowser::amOnUrl()
*/
- public function amOnUrl($url): void {
- $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnUrl', func_get_args()));
+ public function amOnUrl($url) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnUrl', func_get_args()));
}
@@ -135,19 +142,23 @@ public function amOnUrl($url): void {
*
* ``` php
* amOnSubdomain('user');
* $I->amOnPage('/');
- * // moves to https://user.mysite.com/
+ * // moves to http://user.mysite.com/
+ * ?>
* ```
*
+ * @param $subdomain
+ *
+ * @return mixed
* @see \Codeception\Module\PhpBrowser::amOnSubdomain()
*/
- public function amOnSubdomain($subdomain): void {
- $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnSubdomain', func_get_args()));
+ public function amOnSubdomain($subdomain) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnSubdomain', func_get_args()));
}
@@ -155,7 +166,7 @@ public function amOnSubdomain($subdomain): void {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Low-level API method.
- * If Codeception commands are not enough, use [Guzzle HTTP Client](https://guzzlephp.org/) methods directly
+ * If Codeception commands are not enough, use [Guzzle HTTP Client](http://guzzlephp.org/) methods directly
*
* Example:
*
@@ -164,11 +175,13 @@ public function amOnSubdomain($subdomain): void {
* $I->executeInGuzzle(function (\GuzzleHttp\Client $client) {
* $client->get('/get', ['query' => ['foo' => 'bar']]);
* });
+ * ?>
* ```
*
* 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 Closure $function
* @return mixed
* @see \Codeception\Module\PhpBrowser::executeInGuzzle()
*/
@@ -205,8 +218,8 @@ public function executeInGuzzle(\Closure $function) {
* requests
* @see \Codeception\Lib\InnerBrowser::haveHttpHeader()
*/
- public function haveHttpHeader(string $name, string $value): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('haveHttpHeader', func_get_args()));
+ public function haveHttpHeader($name, $value) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('haveHttpHeader', func_get_args()));
}
@@ -229,8 +242,8 @@ public function haveHttpHeader(string $name, string $value): void {
* @param string $name the name of the header to delete.
* @see \Codeception\Lib\InnerBrowser::deleteHeader()
*/
- public function deleteHeader(string $name): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('deleteHeader', func_get_args()));
+ public function deleteHeader($name) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('deleteHeader', func_get_args()));
}
@@ -246,10 +259,12 @@ public function deleteHeader(string $name): void {
* // opens /register page
* $I->amOnPage('/register');
* ```
+ *
+ * @param string $page
* @see \Codeception\Lib\InnerBrowser::amOnPage()
*/
- public function amOnPage(string $page): void {
- $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnPage', func_get_args()));
+ public function amOnPage($page) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnPage', func_get_args()));
}
@@ -280,12 +295,15 @@ public function amOnPage(string $page): void {
* $I->click('Logout', '#nav');
* // using strict locator
* $I->click(['link' => 'Login']);
+ * ?>
* ```
- * @param string|array $link
+ *
+ * @param $link
+ * @param $context
* @see \Codeception\Lib\InnerBrowser::click()
*/
- public function click($link, $context = NULL): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('click', func_get_args()));
+ public function click($link, $context = NULL) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('click', func_get_args()));
}
@@ -319,11 +337,12 @@ public function click($link, $context = NULL): void {
*
* For checking the raw source code, use `seeInSource()`.
*
+ * @param string $text
* @param array|string $selector optional
* @see \Codeception\Lib\InnerBrowser::see()
*/
- public function see(string $text, $selector = NULL): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('see', func_get_args()));
+ public function see($text, $selector = NULL) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('see', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -356,11 +375,12 @@ public function see(string $text, $selector = NULL): void {
*
* For checking the raw source code, use `seeInSource()`.
*
+ * @param string $text
* @param array|string $selector optional
* @see \Codeception\Lib\InnerBrowser::see()
*/
- public function canSee(string $text, $selector = NULL): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('see', func_get_args()));
+ public function canSee($text, $selector = NULL) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('see', func_get_args()));
}
@@ -392,11 +412,12 @@ public function canSee(string $text, $selector = NULL): void {
*
* For checking the raw source code, use `seeInSource()`.
*
+ * @param string $text
* @param array|string $selector optional
* @see \Codeception\Lib\InnerBrowser::dontSee()
*/
- public function dontSee(string $text, $selector = NULL): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSee', func_get_args()));
+ public function dontSee($text, $selector = NULL) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSee', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -427,11 +448,12 @@ public function dontSee(string $text, $selector = NULL): void {
*
* For checking the raw source code, use `seeInSource()`.
*
+ * @param string $text
* @param array|string $selector optional
* @see \Codeception\Lib\InnerBrowser::dontSee()
*/
- public function cantSee(string $text, $selector = NULL): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSee', func_get_args()));
+ public function cantSee($text, $selector = NULL) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSee', func_get_args()));
}
@@ -445,10 +467,12 @@ public function cantSee(string $text, $selector = NULL): void {
* seeInSource('
Green eggs & ham
');
* ```
+ *
+ * @param $raw
* @see \Codeception\Lib\InnerBrowser::seeInSource()
*/
- public function seeInSource(string $raw): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInSource', func_get_args()));
+ public function seeInSource($raw) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInSource', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -461,10 +485,12 @@ public function seeInSource(string $raw): void {
* seeInSource('
Green eggs & ham
');
* ```
+ *
+ * @param $raw
* @see \Codeception\Lib\InnerBrowser::seeInSource()
*/
- public function canSeeInSource(string $raw): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInSource', func_get_args()));
+ public function canSeeInSource($raw) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInSource', func_get_args()));
}
@@ -478,10 +504,12 @@ public function canSeeInSource(string $raw): void {
* dontSeeInSource('
Green eggs & ham
');
* ```
+ *
+ * @param $raw
* @see \Codeception\Lib\InnerBrowser::dontSeeInSource()
*/
- public function dontSeeInSource(string $raw): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInSource', func_get_args()));
+ public function dontSeeInSource($raw) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInSource', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -494,10 +522,12 @@ public function dontSeeInSource(string $raw): void {
* dontSeeInSource('
Green eggs & ham
');
* ```
+ *
+ * @param $raw
* @see \Codeception\Lib\InnerBrowser::dontSeeInSource()
*/
- public function cantSeeInSource(string $raw): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInSource', func_get_args()));
+ public function cantSeeInSource($raw) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInSource', func_get_args()));
}
@@ -511,11 +541,15 @@ public function cantSeeInSource(string $raw): void {
* seeLink('Logout'); // matches Logout
* $I->seeLink('Logout','/logout'); // matches Logout
+ * ?>
* ```
+ *
+ * @param string $text
+ * @param string $url optional
* @see \Codeception\Lib\InnerBrowser::seeLink()
*/
- public function seeLink(string $text, ?string $url = NULL): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeLink', func_get_args()));
+ public function seeLink($text, $url = NULL) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeLink', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -528,11 +562,15 @@ public function seeLink(string $text, ?string $url = NULL): void {
* seeLink('Logout'); // matches Logout
* $I->seeLink('Logout','/logout'); // matches Logout
+ * ?>
* ```
+ *
+ * @param string $text
+ * @param string $url optional
* @see \Codeception\Lib\InnerBrowser::seeLink()
*/
- public function canSeeLink(string $text, ?string $url = NULL): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeLink', func_get_args()));
+ public function canSeeLink($text, $url = NULL) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeLink', func_get_args()));
}
@@ -546,11 +584,15 @@ public function canSeeLink(string $text, ?string $url = NULL): void {
* dontSeeLink('Logout'); // I suppose user is not logged in
* $I->dontSeeLink('Checkout now', '/store/cart.php');
+ * ?>
* ```
+ *
+ * @param string $text
+ * @param string $url optional
* @see \Codeception\Lib\InnerBrowser::dontSeeLink()
*/
- public function dontSeeLink(string $text, string $url = ""): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeLink', func_get_args()));
+ public function dontSeeLink($text, $url = "") {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeLink', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -563,11 +605,15 @@ public function dontSeeLink(string $text, string $url = ""): void {
* dontSeeLink('Logout'); // I suppose user is not logged in
* $I->dontSeeLink('Checkout now', '/store/cart.php');
+ * ?>
* ```
+ *
+ * @param string $text
+ * @param string $url optional
* @see \Codeception\Lib\InnerBrowser::dontSeeLink()
*/
- public function cantSeeLink(string $text, string $url = ""): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeLink', func_get_args()));
+ public function cantSeeLink($text, $url = "") {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeLink', func_get_args()));
}
@@ -582,11 +628,14 @@ public function cantSeeLink(string $text, string $url = ""): void {
* $I->seeInCurrentUrl('home');
* // to match: /users/1
* $I->seeInCurrentUrl('/users/');
+ * ?>
* ```
+ *
+ * @param string $uri
* @see \Codeception\Lib\InnerBrowser::seeInCurrentUrl()
*/
- public function seeInCurrentUrl(string $uri): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInCurrentUrl', func_get_args()));
+ public function seeInCurrentUrl($uri) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInCurrentUrl', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -600,11 +649,14 @@ public function seeInCurrentUrl(string $uri): void {
* $I->seeInCurrentUrl('home');
* // to match: /users/1
* $I->seeInCurrentUrl('/users/');
+ * ?>
* ```
+ *
+ * @param string $uri
* @see \Codeception\Lib\InnerBrowser::seeInCurrentUrl()
*/
- public function canSeeInCurrentUrl(string $uri): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInCurrentUrl', func_get_args()));
+ public function canSeeInCurrentUrl($uri) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInCurrentUrl', func_get_args()));
}
@@ -616,11 +668,14 @@ public function canSeeInCurrentUrl(string $uri): void {
* ``` php
* dontSeeInCurrentUrl('/users/');
+ * ?>
* ```
+ *
+ * @param string $uri
* @see \Codeception\Lib\InnerBrowser::dontSeeInCurrentUrl()
*/
- public function dontSeeInCurrentUrl(string $uri): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInCurrentUrl', func_get_args()));
+ public function dontSeeInCurrentUrl($uri) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInCurrentUrl', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -631,11 +686,14 @@ public function dontSeeInCurrentUrl(string $uri): void {
* ``` php
* dontSeeInCurrentUrl('/users/');
+ * ?>
* ```
+ *
+ * @param string $uri
* @see \Codeception\Lib\InnerBrowser::dontSeeInCurrentUrl()
*/
- public function cantSeeInCurrentUrl(string $uri): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInCurrentUrl', func_get_args()));
+ public function cantSeeInCurrentUrl($uri) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInCurrentUrl', func_get_args()));
}
@@ -649,11 +707,14 @@ public function cantSeeInCurrentUrl(string $uri): void {
* seeCurrentUrlEquals('/');
+ * ?>
* ```
+ *
+ * @param string $uri
* @see \Codeception\Lib\InnerBrowser::seeCurrentUrlEquals()
*/
- public function seeCurrentUrlEquals(string $uri): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlEquals', func_get_args()));
+ public function seeCurrentUrlEquals($uri) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlEquals', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -666,11 +727,14 @@ public function seeCurrentUrlEquals(string $uri): void {
* seeCurrentUrlEquals('/');
+ * ?>
* ```
+ *
+ * @param string $uri
* @see \Codeception\Lib\InnerBrowser::seeCurrentUrlEquals()
*/
- public function canSeeCurrentUrlEquals(string $uri): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlEquals', func_get_args()));
+ public function canSeeCurrentUrlEquals($uri) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlEquals', func_get_args()));
}
@@ -684,11 +748,14 @@ public function canSeeCurrentUrlEquals(string $uri): void {
* dontSeeCurrentUrlEquals('/');
+ * ?>
* ```
+ *
+ * @param string $uri
* @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlEquals()
*/
- public function dontSeeCurrentUrlEquals(string $uri): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeCurrentUrlEquals', func_get_args()));
+ public function dontSeeCurrentUrlEquals($uri) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeCurrentUrlEquals', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -701,11 +768,14 @@ public function dontSeeCurrentUrlEquals(string $uri): void {
* dontSeeCurrentUrlEquals('/');
+ * ?>
* ```
+ *
+ * @param string $uri
* @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlEquals()
*/
- public function cantSeeCurrentUrlEquals(string $uri): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlEquals', func_get_args()));
+ public function cantSeeCurrentUrlEquals($uri) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlEquals', func_get_args()));
}
@@ -718,11 +788,14 @@ public function cantSeeCurrentUrlEquals(string $uri): void {
* seeCurrentUrlMatches('~^/users/(\d+)~');
+ * ?>
* ```
+ *
+ * @param string $uri
* @see \Codeception\Lib\InnerBrowser::seeCurrentUrlMatches()
*/
- public function seeCurrentUrlMatches(string $uri): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlMatches', func_get_args()));
+ public function seeCurrentUrlMatches($uri) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlMatches', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -734,11 +807,14 @@ public function seeCurrentUrlMatches(string $uri): void {
* seeCurrentUrlMatches('~^/users/(\d+)~');
+ * ?>
* ```
+ *
+ * @param string $uri
* @see \Codeception\Lib\InnerBrowser::seeCurrentUrlMatches()
*/
- public function canSeeCurrentUrlMatches(string $uri): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlMatches', func_get_args()));
+ public function canSeeCurrentUrlMatches($uri) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlMatches', func_get_args()));
}
@@ -751,11 +827,14 @@ public function canSeeCurrentUrlMatches(string $uri): void {
* dontSeeCurrentUrlMatches('~^/users/(\d+)~');
+ * ?>
* ```
+ *
+ * @param string $uri
* @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlMatches()
*/
- public function dontSeeCurrentUrlMatches(string $uri): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeCurrentUrlMatches', func_get_args()));
+ public function dontSeeCurrentUrlMatches($uri) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeCurrentUrlMatches', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -767,11 +846,14 @@ public function dontSeeCurrentUrlMatches(string $uri): void {
* dontSeeCurrentUrlMatches('~^/users/(\d+)~');
+ * ?>
* ```
+ *
+ * @param string $uri
* @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlMatches()
*/
- public function cantSeeCurrentUrlMatches(string $uri): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlMatches', func_get_args()));
+ public function cantSeeCurrentUrlMatches($uri) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlMatches', func_get_args()));
}
@@ -785,11 +867,15 @@ public function cantSeeCurrentUrlMatches(string $uri): void {
* grabFromCurrentUrl('~^/user/(\d+)/~');
* $uri = $I->grabFromCurrentUrl();
+ * ?>
* ```
- * @see \Codeception\Lib\InnerBrowser::grabFromCurrentUrl()
+ *
+ * @param string $uri optional
+ *
* @return mixed
+ * @see \Codeception\Lib\InnerBrowser::grabFromCurrentUrl()
*/
- public function grabFromCurrentUrl(?string $uri = NULL) {
+ public function grabFromCurrentUrl($uri = NULL) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFromCurrentUrl', func_get_args()));
}
@@ -804,11 +890,14 @@ public function grabFromCurrentUrl(?string $uri = NULL) {
* $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\Lib\InnerBrowser::seeCheckboxIsChecked()
*/
- public function seeCheckboxIsChecked($checkbox): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCheckboxIsChecked', func_get_args()));
+ public function seeCheckboxIsChecked($checkbox) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCheckboxIsChecked', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -821,11 +910,14 @@ public function seeCheckboxIsChecked($checkbox): void {
* $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\Lib\InnerBrowser::seeCheckboxIsChecked()
*/
- public function canSeeCheckboxIsChecked($checkbox): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCheckboxIsChecked', func_get_args()));
+ public function canSeeCheckboxIsChecked($checkbox) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCheckboxIsChecked', func_get_args()));
}
@@ -838,11 +930,14 @@ public function canSeeCheckboxIsChecked($checkbox): void {
* 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\Lib\InnerBrowser::dontSeeCheckboxIsChecked()
*/
- public function dontSeeCheckboxIsChecked($checkbox): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeCheckboxIsChecked', func_get_args()));
+ public function dontSeeCheckboxIsChecked($checkbox) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeCheckboxIsChecked', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -854,11 +949,14 @@ public function dontSeeCheckboxIsChecked($checkbox): void {
* 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\Lib\InnerBrowser::dontSeeCheckboxIsChecked()
*/
- public function cantSeeCheckboxIsChecked($checkbox): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCheckboxIsChecked', func_get_args()));
+ public function cantSeeCheckboxIsChecked($checkbox) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCheckboxIsChecked', func_get_args()));
}
@@ -876,13 +974,15 @@ public function cantSeeCheckboxIsChecked($checkbox): void {
* $I->seeInField('#searchform input','Search');
* $I->seeInField('//form/*[@name=search]','Search');
* $I->seeInField(['name' => 'search'], 'Search');
+ * ?>
* ```
*
- * @param string|array $field
+ * @param $field
+ * @param $value
* @see \Codeception\Lib\InnerBrowser::seeInField()
*/
- public function seeInField($field, $value): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInField', func_get_args()));
+ public function seeInField($field, $value) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInField', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -899,13 +999,15 @@ public function seeInField($field, $value): void {
* $I->seeInField('#searchform input','Search');
* $I->seeInField('//form/*[@name=search]','Search');
* $I->seeInField(['name' => 'search'], 'Search');
+ * ?>
* ```
*
- * @param string|array $field
+ * @param $field
+ * @param $value
* @see \Codeception\Lib\InnerBrowser::seeInField()
*/
- public function canSeeInField($field, $value): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInField', func_get_args()));
+ public function canSeeInField($field, $value) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInField', func_get_args()));
}
@@ -923,12 +1025,15 @@ public function canSeeInField($field, $value): void {
* $I->dontSeeInField('#searchform input','Search');
* $I->dontSeeInField('//form/*[@name=search]','Search');
* $I->dontSeeInField(['name' => 'search'], 'Search');
+ * ?>
* ```
- * @param string|array $field
+ *
+ * @param $field
+ * @param $value
* @see \Codeception\Lib\InnerBrowser::dontSeeInField()
*/
- public function dontSeeInField($field, $value): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInField', func_get_args()));
+ public function dontSeeInField($field, $value) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInField', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -945,12 +1050,15 @@ public function dontSeeInField($field, $value): void {
* $I->dontSeeInField('#searchform input','Search');
* $I->dontSeeInField('//form/*[@name=search]','Search');
* $I->dontSeeInField(['name' => 'search'], 'Search');
+ * ?>
* ```
- * @param string|array $field
+ *
+ * @param $field
+ * @param $value
* @see \Codeception\Lib\InnerBrowser::dontSeeInField()
*/
- public function cantSeeInField($field, $value): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInField', func_get_args()));
+ public function cantSeeInField($field, $value) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInField', func_get_args()));
}
@@ -966,6 +1074,7 @@ public function cantSeeInField($field, $value): void {
* 'input1' => 'value',
* 'input2' => 'other value',
* ]);
+ * ?>
* ```
*
* For multi-select elements, or to check values of multiple elements with the same name, an
@@ -983,6 +1092,7 @@ public function cantSeeInField($field, $value): void {
* 'another checked value',
* ],
* ]);
+ * ?>
* ```
*
* Additionally, checkbox values can be checked with a boolean.
@@ -993,6 +1103,7 @@ public function cantSeeInField($field, $value): void {
* 'checkbox1' => true, // passes if checked
* 'checkbox2' => false, // passes if unchecked
* ]);
+ * ?>
* ```
*
* Pair this with submitForm for quick testing magic.
@@ -1005,14 +1116,18 @@ public function cantSeeInField($field, $value): void {
* 'checkbox1' => true,
* // ...
* ];
- * $I->submitForm('//form[@id=my-form]', string $form, 'submitButton');
+ * $I->submitForm('//form[@id=my-form]', $form, 'submitButton');
* // $I->amOnPage('/path/to/form-page') may be needed
- * $I->seeInFormFields('//form[@id=my-form]', string $form);
+ * $I->seeInFormFields('//form[@id=my-form]', $form);
+ * ?>
* ```
+ *
+ * @param $formSelector
+ * @param $params
* @see \Codeception\Lib\InnerBrowser::seeInFormFields()
*/
- public function seeInFormFields($formSelector, array $params): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInFormFields', func_get_args()));
+ public function seeInFormFields($formSelector, array $params) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInFormFields', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -1027,6 +1142,7 @@ public function seeInFormFields($formSelector, array $params): void {
* 'input1' => 'value',
* 'input2' => 'other value',
* ]);
+ * ?>
* ```
*
* For multi-select elements, or to check values of multiple elements with the same name, an
@@ -1044,6 +1160,7 @@ public function seeInFormFields($formSelector, array $params): void {
* 'another checked value',
* ],
* ]);
+ * ?>
* ```
*
* Additionally, checkbox values can be checked with a boolean.
@@ -1054,6 +1171,7 @@ public function seeInFormFields($formSelector, array $params): void {
* 'checkbox1' => true, // passes if checked
* 'checkbox2' => false, // passes if unchecked
* ]);
+ * ?>
* ```
*
* Pair this with submitForm for quick testing magic.
@@ -1066,14 +1184,18 @@ public function seeInFormFields($formSelector, array $params): void {
* 'checkbox1' => true,
* // ...
* ];
- * $I->submitForm('//form[@id=my-form]', string $form, 'submitButton');
+ * $I->submitForm('//form[@id=my-form]', $form, 'submitButton');
* // $I->amOnPage('/path/to/form-page') may be needed
- * $I->seeInFormFields('//form[@id=my-form]', string $form);
+ * $I->seeInFormFields('//form[@id=my-form]', $form);
+ * ?>
* ```
+ *
+ * @param $formSelector
+ * @param $params
* @see \Codeception\Lib\InnerBrowser::seeInFormFields()
*/
- public function canSeeInFormFields($formSelector, array $params): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInFormFields', func_get_args()));
+ public function canSeeInFormFields($formSelector, array $params) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInFormFields', func_get_args()));
}
@@ -1089,6 +1211,7 @@ public function canSeeInFormFields($formSelector, array $params): void {
* 'input1' => 'non-existent value',
* 'input2' => 'other non-existent value',
* ]);
+ * ?>
* ```
*
* To check that an element hasn't been assigned any one of many values, an array can be passed
@@ -1102,6 +1225,7 @@ public function canSeeInFormFields($formSelector, array $params): void {
* 'And this value shouldn\'t be set',
* ],
* ]);
+ * ?>
* ```
*
* Additionally, checkbox values can be checked with a boolean.
@@ -1112,11 +1236,15 @@ public function canSeeInFormFields($formSelector, array $params): void {
* 'checkbox1' => true, // fails if checked
* 'checkbox2' => false, // fails if unchecked
* ]);
+ * ?>
* ```
+ *
+ * @param $formSelector
+ * @param $params
* @see \Codeception\Lib\InnerBrowser::dontSeeInFormFields()
*/
- public function dontSeeInFormFields($formSelector, array $params): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInFormFields', func_get_args()));
+ public function dontSeeInFormFields($formSelector, array $params) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInFormFields', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -1131,6 +1259,7 @@ public function dontSeeInFormFields($formSelector, array $params): void {
* 'input1' => 'non-existent value',
* 'input2' => 'other non-existent value',
* ]);
+ * ?>
* ```
*
* To check that an element hasn't been assigned any one of many values, an array can be passed
@@ -1144,6 +1273,7 @@ public function dontSeeInFormFields($formSelector, array $params): void {
* 'And this value shouldn\'t be set',
* ],
* ]);
+ * ?>
* ```
*
* Additionally, checkbox values can be checked with a boolean.
@@ -1154,11 +1284,15 @@ public function dontSeeInFormFields($formSelector, array $params): void {
* 'checkbox1' => true, // fails if checked
* 'checkbox2' => false, // fails if unchecked
* ]);
+ * ?>
* ```
+ *
+ * @param $formSelector
+ * @param $params
* @see \Codeception\Lib\InnerBrowser::dontSeeInFormFields()
*/
- public function cantSeeInFormFields($formSelector, array $params): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInFormFields', func_get_args()));
+ public function cantSeeInFormFields($formSelector, array $params) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInFormFields', func_get_args()));
}
@@ -1335,10 +1469,14 @@ public function cantSeeInFormFields($formSelector, array $params): void {
* ]
* ]);
* ```
+ *
+ * @param $selector
+ * @param $params
+ * @param $button
* @see \Codeception\Lib\InnerBrowser::submitForm()
*/
- public function submitForm($selector, array $params, ?string $button = NULL): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('submitForm', func_get_args()));
+ public function submitForm($selector, array $params, $button = NULL) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('submitForm', func_get_args()));
}
@@ -1351,11 +1489,15 @@ public function submitForm($selector, array $params, ?string $button = NULL): vo
* fillField("//input[@type='text']", "Hello World!");
* $I->fillField(['name' => 'email'], 'jon@example.com');
+ * ?>
* ```
+ *
+ * @param $field
+ * @param $value
* @see \Codeception\Lib\InnerBrowser::fillField()
*/
- public function fillField($field, $value): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('fillField', func_get_args()));
+ public function fillField($field, $value) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('fillField', func_get_args()));
}
@@ -1369,6 +1511,7 @@ public function fillField($field, $value): void {
* $I->selectOption('form select[name=account]', 'Premium');
* $I->selectOption('form input[name=payment]', 'Monthly');
* $I->selectOption('//form/select[@name=account]', 'Monthly');
+ * ?>
* ```
*
* Provide an array for the second argument to select multiple options:
@@ -1376,6 +1519,7 @@ public function fillField($field, $value): void {
* ``` php
* selectOption('Which OS do you use?', array('Windows','Linux'));
+ * ?>
* ```
*
* Or provide an associative array for the second argument to specifically define which selection method should be used:
@@ -1384,11 +1528,15 @@ public function fillField($field, $value): void {
* selectOption('Which OS do you use?', array('text' => 'Windows')); // Only search by text 'Windows'
* $I->selectOption('Which OS do you use?', array('value' => 'windows')); // Only search by value 'windows'
+ * ?>
* ```
+ *
+ * @param $select
+ * @param $option
* @see \Codeception\Lib\InnerBrowser::selectOption()
*/
- public function selectOption($select, $option): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('selectOption', func_get_args()));
+ public function selectOption($select, $option) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('selectOption', func_get_args()));
}
@@ -1400,11 +1548,14 @@ public function selectOption($select, $option): void {
* ``` php
* checkOption('#agree');
+ * ?>
* ```
+ *
+ * @param $option
* @see \Codeception\Lib\InnerBrowser::checkOption()
*/
- public function checkOption($option): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('checkOption', func_get_args()));
+ public function checkOption($option) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('checkOption', func_get_args()));
}
@@ -1416,11 +1567,14 @@ public function checkOption($option): void {
* ``` php
* uncheckOption('#notify');
+ * ?>
* ```
+ *
+ * @param $option
* @see \Codeception\Lib\InnerBrowser::uncheckOption()
*/
- public function uncheckOption($option): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('uncheckOption', func_get_args()));
+ public function uncheckOption($option) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('uncheckOption', func_get_args()));
}
@@ -1433,11 +1587,15 @@ public function uncheckOption($option): void {
* attachFile('input[@type="file"]', 'prices.xls');
+ * ?>
* ```
+ *
+ * @param $field
+ * @param $filename
* @see \Codeception\Lib\InnerBrowser::attachFile()
*/
- public function attachFile($field, string $filename): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('attachFile', func_get_args()));
+ public function attachFile($field, $filename) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('attachFile', func_get_args()));
}
@@ -1446,10 +1604,13 @@ public function attachFile($field, string $filename): void {
*
* Sends an ajax GET request with the passed parameters.
* See `sendAjaxPostRequest()`
+ *
+ * @param $uri
+ * @param $params
* @see \Codeception\Lib\InnerBrowser::sendAjaxGetRequest()
*/
- public function sendAjaxGetRequest(string $uri, array $params = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxGetRequest', func_get_args()));
+ public function sendAjaxGetRequest($uri, $params = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxGetRequest', func_get_args()));
}
@@ -1474,10 +1635,13 @@ public function sendAjaxGetRequest(string $uri, array $params = []): void {
* 'category' => 'miscellaneous',
* ]]);
* ```
+ *
+ * @param string $uri
+ * @param array $params
* @see \Codeception\Lib\InnerBrowser::sendAjaxPostRequest()
*/
- public function sendAjaxPostRequest(string $uri, array $params = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxPostRequest', func_get_args()));
+ public function sendAjaxPostRequest($uri, $params = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxPostRequest', func_get_args()));
}
@@ -1491,10 +1655,14 @@ public function sendAjaxPostRequest(string $uri, array $params = []): void {
* sendAjaxRequest('PUT', '/posts/7', ['title' => 'new title']);
* ```
+ *
+ * @param $method
+ * @param $uri
+ * @param array $params
* @see \Codeception\Lib\InnerBrowser::sendAjaxRequest()
*/
- public function sendAjaxRequest(string $method, string $uri, array $params = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxRequest', func_get_args()));
+ public function sendAjaxRequest($method, $uri, $params = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxRequest', func_get_args()));
}
@@ -1510,10 +1678,12 @@ public function sendAjaxRequest(string $method, string $uri, array $params = [])
* $I->makeHtmlSnapshot();
* // saved to: tests/_output/debug/2017-05-26_14-24-11_4b3403665fea6.html
* ```
+ *
+ * @param null $name
* @see \Codeception\Lib\InnerBrowser::makeHtmlSnapshot()
*/
- public function makeHtmlSnapshot(?string $name = NULL): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('makeHtmlSnapshot', func_get_args()));
+ public function makeHtmlSnapshot($name = NULL) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('makeHtmlSnapshot', func_get_args()));
}
@@ -1529,9 +1699,13 @@ public function makeHtmlSnapshot(?string $name = NULL): void {
* $heading = $I->grabTextFrom('h1');
* $heading = $I->grabTextFrom('descendant-or-self::h1');
* $value = $I->grabTextFrom('~
* ```
- * @see \Codeception\Lib\InnerBrowser::grabTextFrom()
+ *
+ * @param $cssOrXPathOrRegex
+ *
* @return mixed
+ * @see \Codeception\Lib\InnerBrowser::grabTextFrom()
*/
public function grabTextFrom($cssOrXPathOrRegex) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabTextFrom', func_get_args()));
@@ -1547,11 +1721,17 @@ public function grabTextFrom($cssOrXPathOrRegex) {
* ``` php
* grabAttributeFrom('#tooltip', 'title');
+ * ?>
* ```
- * @see \Codeception\Lib\InnerBrowser::grabAttributeFrom()
+ *
+ *
+ * @param $cssOrXpath
+ * @param $attribute
+ *
* @return mixed
+ * @see \Codeception\Lib\InnerBrowser::grabAttributeFrom()
*/
- public function grabAttributeFrom($cssOrXpath, string $attribute) {
+ public function grabAttributeFrom($cssOrXpath, $attribute) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabAttributeFrom', func_get_args()));
}
@@ -1575,12 +1755,15 @@ public function grabAttributeFrom($cssOrXpath, string $attribute) {
*
* // would return ['#first', '#second', '#third']
* $aLinks = $I->grabMultiple('a', 'href');
+ * ?>
* ```
*
+ * @param $cssOrXpath
+ * @param $attribute
* @return string[]
* @see \Codeception\Lib\InnerBrowser::grabMultiple()
*/
- public function grabMultiple($cssOrXpath, ?string $attribute = NULL): array {
+ public function grabMultiple($cssOrXpath, $attribute = NULL) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabMultiple', func_get_args()));
}
@@ -1588,18 +1771,10 @@ public function grabMultiple($cssOrXpath, ?string $attribute = NULL): array {
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Finds the value for the given form field.
- * If a fuzzy locator is used, the field is found by field name, CSS, and XPath.
+ * @param $field
*
- * ``` php
- * grabValueFrom('Name');
- * $name = $I->grabValueFrom('input[name=username]');
- * $name = $I->grabValueFrom('descendant-or-self::form/descendant::input[@name = 'username']');
- * $name = $I->grabValueFrom(['name' => 'username']);
- * ```
+ * @return array|mixed|null|string
* @see \Codeception\Lib\InnerBrowser::grabValueFrom()
- * @return mixed
*/
public function grabValueFrom($field) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabValueFrom', func_get_args()));
@@ -1615,12 +1790,17 @@ public function grabValueFrom($field) {
* ``` php
* setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
+ * ?>
* ```
*
- * @return mixed|void
+ * @param $name
+ * @param $val
+ * @param array $params
+ *
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::setCookie()
*/
- public function setCookie($name, $val, $params = []) {
+ public function setCookie($name, $val, array $params = []) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('setCookie', func_get_args()));
}
@@ -1631,10 +1811,14 @@ public function setCookie($name, $val, $params = []) {
* Grabs a cookie value.
* You can set additional cookie params like `domain`, `path` in array passed as last argument.
* If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
- * @see \Codeception\Lib\InnerBrowser::grabCookie()
+ *
+ * @param $cookie
+ *
+ * @param array $params
* @return mixed
+ * @see \Codeception\Lib\InnerBrowser::grabCookie()
*/
- public function grabCookie(string $cookie, array $params = []) {
+ public function grabCookie($cookie, array $params = []) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabCookie', func_get_args()));
}
@@ -1648,7 +1832,7 @@ public function grabCookie(string $cookie, array $params = []) {
* @return string Current page source code.
* @see \Codeception\Lib\InnerBrowser::grabPageSource()
*/
- public function grabPageSource(): string {
+ public function grabPageSource() {
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabPageSource', func_get_args()));
}
@@ -1662,12 +1846,15 @@ public function grabPageSource(): string {
* ``` php
* seeCookie('PHPSESSID');
+ * ?>
* ```
*
- * @return mixed|void
+ * @param $cookie
+ * @param array $params
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::seeCookie()
*/
- public function seeCookie($cookie, $params = []) {
+ public function seeCookie($cookie, array $params = []) {
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCookie', func_get_args()));
}
/**
@@ -1680,12 +1867,15 @@ public function seeCookie($cookie, $params = []) {
* ``` php
* seeCookie('PHPSESSID');
+ * ?>
* ```
*
- * @return mixed|void
+ * @param $cookie
+ * @param array $params
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::seeCookie()
*/
- public function canSeeCookie($cookie, $params = []) {
+ public function canSeeCookie($cookie, array $params = []) {
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCookie', func_get_args()));
}
@@ -1696,10 +1886,13 @@ public function canSeeCookie($cookie, $params = []) {
* Checks that there isn't a cookie with the given name.
* You can set additional cookie params like `domain`, `path` as array passed in last argument.
*
- * @return mixed|void
+ * @param $cookie
+ *
+ * @param array $params
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::dontSeeCookie()
*/
- public function dontSeeCookie($cookie, $params = []) {
+ public function dontSeeCookie($cookie, array $params = []) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeCookie', func_get_args()));
}
/**
@@ -1709,10 +1902,13 @@ public function dontSeeCookie($cookie, $params = []) {
* Checks that there isn't a cookie with the given name.
* You can set additional cookie params like `domain`, `path` as array passed in last argument.
*
- * @return mixed|void
+ * @param $cookie
+ *
+ * @param array $params
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::dontSeeCookie()
*/
- public function cantSeeCookie($cookie, $params = []) {
+ public function cantSeeCookie($cookie, array $params = []) {
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCookie', func_get_args()));
}
@@ -1723,10 +1919,13 @@ public function cantSeeCookie($cookie, $params = []) {
* Unsets cookie with the given name.
* You can set additional cookie params like `domain`, `path` in array passed as last argument.
*
- * @return mixed|void
+ * @param $cookie
+ *
+ * @param array $params
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::resetCookie()
*/
- public function resetCookie($cookie, $params = []) {
+ public function resetCookie($cookie, array $params = []) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('resetCookie', func_get_args()));
}
@@ -1736,7 +1935,6 @@ public function resetCookie($cookie, $params = []) {
*
* Checks that the given element exists on the page and is visible.
* You can also specify expected attributes of this element.
- * Only works if `` tag is present.
*
* ``` php
* seeElement(['css' => 'form input'], ['name' => 'login']);
+ * ?>
* ```
+ *
+ * @param $selector
+ * @param array $attributes
+ * @return
* @see \Codeception\Lib\InnerBrowser::seeElement()
*/
- public function seeElement($selector, array $attributes = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeElement', func_get_args()));
+ public function seeElement($selector, $attributes = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeElement', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -1759,7 +1962,6 @@ public function seeElement($selector, array $attributes = []): void {
* [!] Conditional Assertion: Test won't be stopped on fail
* Checks that the given element exists on the page and is visible.
* You can also specify expected attributes of this element.
- * Only works if `` tag is present.
*
* ``` php
* seeElement(['css' => 'form input'], ['name' => 'login']);
+ * ?>
* ```
+ *
+ * @param $selector
+ * @param array $attributes
+ * @return
* @see \Codeception\Lib\InnerBrowser::seeElement()
*/
- public function canSeeElement($selector, array $attributes = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeElement', func_get_args()));
+ public function canSeeElement($selector, $attributes = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeElement', func_get_args()));
}
@@ -1790,11 +1997,15 @@ public function canSeeElement($selector, array $attributes = []): void {
* $I->dontSeeElement('//form/input[1]');
* $I->dontSeeElement('input', ['name' => 'login']);
* $I->dontSeeElement('input', ['value' => '123456']);
+ * ?>
* ```
+ *
+ * @param $selector
+ * @param array $attributes
* @see \Codeception\Lib\InnerBrowser::dontSeeElement()
*/
- public function dontSeeElement($selector, array $attributes = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeElement', func_get_args()));
+ public function dontSeeElement($selector, $attributes = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeElement', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -1809,11 +2020,15 @@ public function dontSeeElement($selector, array $attributes = []): void {
* $I->dontSeeElement('//form/input[1]');
* $I->dontSeeElement('input', ['name' => 'login']);
* $I->dontSeeElement('input', ['value' => '123456']);
+ * ?>
* ```
+ *
+ * @param $selector
+ * @param array $attributes
* @see \Codeception\Lib\InnerBrowser::dontSeeElement()
*/
- public function cantSeeElement($selector, array $attributes = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeElement', func_get_args()));
+ public function cantSeeElement($selector, $attributes = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeElement', func_get_args()));
}
@@ -1826,13 +2041,14 @@ public function cantSeeElement($selector, array $attributes = []): void {
* seeNumberOfElements('tr', 10);
* $I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements
+ * ?>
* ```
- *
- * @param int|int[] $expected
+ * @param $selector
+ * @param mixed $expected int or int[]
* @see \Codeception\Lib\InnerBrowser::seeNumberOfElements()
*/
- public function seeNumberOfElements($selector, $expected): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumberOfElements', func_get_args()));
+ public function seeNumberOfElements($selector, $expected) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumberOfElements', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -1844,13 +2060,14 @@ public function seeNumberOfElements($selector, $expected): void {
* seeNumberOfElements('tr', 10);
* $I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements
+ * ?>
* ```
- *
- * @param int|int[] $expected
+ * @param $selector
+ * @param mixed $expected int or int[]
* @see \Codeception\Lib\InnerBrowser::seeNumberOfElements()
*/
- public function canSeeNumberOfElements($selector, $expected): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumberOfElements', func_get_args()));
+ public function canSeeNumberOfElements($selector, $expected) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumberOfElements', func_get_args()));
}
@@ -1862,9 +2079,13 @@ public function canSeeNumberOfElements($selector, $expected): void {
* ``` php
* seeOptionIsSelected('#form input[name=payment]', 'Visa');
+ * ?>
* ```
*
- * @return mixed|void
+ * @param $selector
+ * @param $optionText
+ *
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::seeOptionIsSelected()
*/
public function seeOptionIsSelected($selector, $optionText) {
@@ -1879,9 +2100,13 @@ public function seeOptionIsSelected($selector, $optionText) {
* ``` php
* seeOptionIsSelected('#form input[name=payment]', 'Visa');
+ * ?>
* ```
*
- * @return mixed|void
+ * @param $selector
+ * @param $optionText
+ *
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::seeOptionIsSelected()
*/
public function canSeeOptionIsSelected($selector, $optionText) {
@@ -1897,9 +2122,13 @@ public function canSeeOptionIsSelected($selector, $optionText) {
* ``` php
* dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
+ * ?>
* ```
*
- * @return mixed|void
+ * @param $selector
+ * @param $optionText
+ *
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::dontSeeOptionIsSelected()
*/
public function dontSeeOptionIsSelected($selector, $optionText) {
@@ -1914,9 +2143,13 @@ public function dontSeeOptionIsSelected($selector, $optionText) {
* ``` php
* dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
+ * ?>
* ```
*
- * @return mixed|void
+ * @param $selector
+ * @param $optionText
+ *
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::dontSeeOptionIsSelected()
*/
public function cantSeeOptionIsSelected($selector, $optionText) {
@@ -1930,8 +2163,8 @@ public function cantSeeOptionIsSelected($selector, $optionText) {
* Asserts that current page has 404 response status code.
* @see \Codeception\Lib\InnerBrowser::seePageNotFound()
*/
- public function seePageNotFound(): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seePageNotFound', func_get_args()));
+ public function seePageNotFound() {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seePageNotFound', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -1940,8 +2173,8 @@ public function seePageNotFound(): void {
* Asserts that current page has 404 response status code.
* @see \Codeception\Lib\InnerBrowser::seePageNotFound()
*/
- public function canSeePageNotFound(): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seePageNotFound', func_get_args()));
+ public function canSeePageNotFound() {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seePageNotFound', func_get_args()));
}
@@ -1957,10 +2190,12 @@ public function canSeePageNotFound(): void {
* // recommended \Codeception\Util\HttpCode
* $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
* ```
+ *
+ * @param int $code
* @see \Codeception\Lib\InnerBrowser::seeResponseCodeIs()
*/
- public function seeResponseCodeIs(int $code): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIs', func_get_args()));
+ public function seeResponseCodeIs($code) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIs', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -1975,10 +2210,12 @@ public function seeResponseCodeIs(int $code): void {
* // recommended \Codeception\Util\HttpCode
* $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
* ```
+ *
+ * @param int $code
* @see \Codeception\Lib\InnerBrowser::seeResponseCodeIs()
*/
- public function canSeeResponseCodeIs(int $code): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIs', func_get_args()));
+ public function canSeeResponseCodeIs($code) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIs', func_get_args()));
}
@@ -1986,20 +2223,26 @@ public function canSeeResponseCodeIs(int $code): void {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Checks that response code is between a certain range. Between actually means [from <= CODE <= to]
+ *
+ * @param int $from
+ * @param int $to
* @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsBetween()
*/
- public function seeResponseCodeIsBetween(int $from, int $to): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsBetween', func_get_args()));
+ public function seeResponseCodeIsBetween($from, $to) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsBetween', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
* [!] Conditional Assertion: Test won't be stopped on fail
* Checks that response code is between a certain range. Between actually means [from <= CODE <= to]
+ *
+ * @param int $from
+ * @param int $to
* @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsBetween()
*/
- public function canSeeResponseCodeIsBetween(int $from, int $to): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsBetween', func_get_args()));
+ public function canSeeResponseCodeIsBetween($from, $to) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsBetween', func_get_args()));
}
@@ -2015,10 +2258,11 @@ public function canSeeResponseCodeIsBetween(int $from, int $to): void {
* // recommended \Codeception\Util\HttpCode
* $I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
* ```
+ * @param int $code
* @see \Codeception\Lib\InnerBrowser::dontSeeResponseCodeIs()
*/
- public function dontSeeResponseCodeIs(int $code): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeResponseCodeIs', func_get_args()));
+ public function dontSeeResponseCodeIs($code) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeResponseCodeIs', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -2033,10 +2277,11 @@ public function dontSeeResponseCodeIs(int $code): void {
* // recommended \Codeception\Util\HttpCode
* $I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
* ```
+ * @param int $code
* @see \Codeception\Lib\InnerBrowser::dontSeeResponseCodeIs()
*/
- public function cantSeeResponseCodeIs(int $code): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeResponseCodeIs', func_get_args()));
+ public function cantSeeResponseCodeIs($code) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeResponseCodeIs', func_get_args()));
}
@@ -2046,8 +2291,8 @@ public function cantSeeResponseCodeIs(int $code): void {
* Checks that the response code 2xx
* @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsSuccessful()
*/
- public function seeResponseCodeIsSuccessful(): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsSuccessful', func_get_args()));
+ public function seeResponseCodeIsSuccessful() {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsSuccessful', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -2056,8 +2301,8 @@ public function seeResponseCodeIsSuccessful(): void {
* Checks that the response code 2xx
* @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsSuccessful()
*/
- public function canSeeResponseCodeIsSuccessful(): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsSuccessful', func_get_args()));
+ public function canSeeResponseCodeIsSuccessful() {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsSuccessful', func_get_args()));
}
@@ -2067,8 +2312,8 @@ public function canSeeResponseCodeIsSuccessful(): void {
* Checks that the response code 3xx
* @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsRedirection()
*/
- public function seeResponseCodeIsRedirection(): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsRedirection', func_get_args()));
+ public function seeResponseCodeIsRedirection() {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsRedirection', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -2077,8 +2322,8 @@ public function seeResponseCodeIsRedirection(): void {
* Checks that the response code 3xx
* @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsRedirection()
*/
- public function canSeeResponseCodeIsRedirection(): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsRedirection', func_get_args()));
+ public function canSeeResponseCodeIsRedirection() {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsRedirection', func_get_args()));
}
@@ -2088,8 +2333,8 @@ public function canSeeResponseCodeIsRedirection(): void {
* Checks that the response code is 4xx
* @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsClientError()
*/
- public function seeResponseCodeIsClientError(): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsClientError', func_get_args()));
+ public function seeResponseCodeIsClientError() {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsClientError', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -2098,8 +2343,8 @@ public function seeResponseCodeIsClientError(): void {
* Checks that the response code is 4xx
* @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsClientError()
*/
- public function canSeeResponseCodeIsClientError(): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsClientError', func_get_args()));
+ public function canSeeResponseCodeIsClientError() {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsClientError', func_get_args()));
}
@@ -2109,8 +2354,8 @@ public function canSeeResponseCodeIsClientError(): void {
* Checks that the response code is 5xx
* @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsServerError()
*/
- public function seeResponseCodeIsServerError(): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsServerError', func_get_args()));
+ public function seeResponseCodeIsServerError() {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsServerError', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -2119,8 +2364,8 @@ public function seeResponseCodeIsServerError(): void {
* Checks that the response code is 5xx
* @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsServerError()
*/
- public function canSeeResponseCodeIsServerError(): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsServerError', func_get_args()));
+ public function canSeeResponseCodeIsServerError() {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsServerError', func_get_args()));
}
@@ -2132,9 +2377,12 @@ public function canSeeResponseCodeIsServerError(): void {
* ``` php
* seeInTitle('Blog - Post #1');
+ * ?>
* ```
*
- * @return mixed|void
+ * @param $title
+ *
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::seeInTitle()
*/
public function seeInTitle($title) {
@@ -2149,9 +2397,12 @@ public function seeInTitle($title) {
* ``` php
* seeInTitle('Blog - Post #1');
+ * ?>
* ```
*
- * @return mixed|void
+ * @param $title
+ *
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::seeInTitle()
*/
public function canSeeInTitle($title) {
@@ -2164,7 +2415,9 @@ public function canSeeInTitle($title) {
*
* Checks that the page title does not contain the given string.
*
- * @return mixed|void
+ * @param $title
+ *
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::dontSeeInTitle()
*/
public function dontSeeInTitle($title) {
@@ -2176,7 +2429,9 @@ public function dontSeeInTitle($title) {
* [!] Conditional Assertion: Test won't be stopped on fail
* Checks that the page title does not contain the given string.
*
- * @return mixed|void
+ * @param $title
+ *
+ * @return mixed
* @see \Codeception\Lib\InnerBrowser::dontSeeInTitle()
*/
public function cantSeeInTitle($title) {
@@ -2199,10 +2454,12 @@ public function cantSeeInTitle($title) {
* # switch to iframe
* $I->switchToIframe("another_frame");
* ```
+ *
+ * @param string $name
* @see \Codeception\Lib\InnerBrowser::switchToIframe()
*/
- public function switchToIframe(string $name): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('switchToIframe', func_get_args()));
+ public function switchToIframe($name) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('switchToIframe', func_get_args()));
}
@@ -2214,8 +2471,8 @@ public function switchToIframe(string $name): void {
* @param int $numberOfSteps (default value 1)
* @see \Codeception\Lib\InnerBrowser::moveBack()
*/
- public function moveBack(int $numberOfSteps = 1): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('moveBack', func_get_args()));
+ public function moveBack($numberOfSteps = 1) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('moveBack', func_get_args()));
}
@@ -2230,8 +2487,8 @@ public function moveBack(int $numberOfSteps = 1): void {
* ```
* @see \Codeception\Lib\InnerBrowser::setServerParameters()
*/
- public function setServerParameters(array $params): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('setServerParameters', func_get_args()));
+ public function setServerParameters(array $params) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('setServerParameters', func_get_args()));
}
@@ -2243,10 +2500,12 @@ public function setServerParameters(array $params): void {
* ```php
* $I->haveServerParameter('name', 'value');
* ```
+ * @param string $name
+ * @param string $value
* @see \Codeception\Lib\InnerBrowser::haveServerParameter()
*/
- public function haveServerParameter(string $name, string $value): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('haveServerParameter', func_get_args()));
+ public function haveServerParameter($name, $value) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('haveServerParameter', func_get_args()));
}
@@ -2259,10 +2518,11 @@ public function haveServerParameter(string $name, string $value): void {
* stopFollowingRedirects();
* ```
+ *
* @see \Codeception\Lib\InnerBrowser::stopFollowingRedirects()
*/
- public function stopFollowingRedirects(): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('stopFollowingRedirects', func_get_args()));
+ public function stopFollowingRedirects() {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('stopFollowingRedirects', func_get_args()));
}
@@ -2275,10 +2535,11 @@ public function stopFollowingRedirects(): void {
* startFollowingRedirects();
* ```
+ *
* @see \Codeception\Lib\InnerBrowser::startFollowingRedirects()
*/
- public function startFollowingRedirects(): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('startFollowingRedirects', func_get_args()));
+ public function startFollowingRedirects() {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('startFollowingRedirects', func_get_args()));
}
@@ -2291,10 +2552,11 @@ public function startFollowingRedirects(): void {
* followRedirect();
* ```
+ *
* @see \Codeception\Lib\InnerBrowser::followRedirect()
*/
- public function followRedirect(): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('followRedirect', func_get_args()));
+ public function followRedirect() {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('followRedirect', func_get_args()));
}
@@ -2307,10 +2569,12 @@ public function followRedirect(): void {
* setMaxRedirects(2);
* ```
+ *
+ * @param int $maxRedirects
* @see \Codeception\Lib\InnerBrowser::setMaxRedirects()
*/
- public function setMaxRedirects(int $maxRedirects): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('setMaxRedirects', func_get_args()));
+ public function setMaxRedirects($maxRedirects) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('setMaxRedirects', func_get_args()));
}
@@ -3033,9 +3297,9 @@ public function canSeeThemeActivated(string $slug): void {
* $insertedId = $I->haveSiteMetaInDatabase(2, 'foo', ['bar' => 'baz']);
* ```
*
- * @param int $blogId The blog ID.
+ * @param int $blogId The blog ID.
* @param string $string The meta key.
- * @param mixed $value The meta value.
+ * @param mixed $value The meta value.
*
* @return int The inserted row ID.
* @see \lucatume\WPBrowser\Module\WPDb::haveSiteMetaInDatabase()
@@ -3082,7 +3346,7 @@ public function grabSiteMetaFromDatabase(int $blogId, string $key, bool $single)
* $type = $I->grabPostFieldFromDatabase(1, 'post_type');
* ```
*
- * @param int $postId The post ID.
+ * @param int $postId The post ID.
* @param string $field The post field to get the value for.
*
* @return mixed The value of the post field.
@@ -3392,14 +3656,14 @@ public function cantSeePostMetaInDatabase(array $criteria): void {
* $I->seePostWithTermInDatabase($postId, $fiction['term_taxonomy_id']);
* ```
*
- * @param int $post_id The post ID.
- * @param int $term_taxonomy_id The term `term_id` or `term_taxonomy_id`; if the `$taxonomy` argument is
+ * @param int $post_id The post ID.
+ * @param int $term_taxonomy_id The term `term_id` or `term_taxonomy_id`; if the `$taxonomy` argument is
* passed this parameter will be interpreted as a `term_id`, else as a
* `term_taxonomy_id`.
- * @param int|null $term_order The order the term applies to the post, defaults to `null` to not use
+ * @param int|null $term_order The order the term applies to the post, defaults to `null` to not use
* the
* term order.
- * @param string|null $taxonomy The taxonomy the `term_id` is for; if passed this parameter will be used
+ * @param string|null $taxonomy The taxonomy the `term_id` is for; if passed this parameter will be used
* to build a `taxonomy_term_id` from the `term_id`.
*
*
@@ -3424,14 +3688,14 @@ public function seePostWithTermInDatabase(int $post_id, int $term_taxonomy_id, ?
* $I->seePostWithTermInDatabase($postId, $fiction['term_taxonomy_id']);
* ```
*
- * @param int $post_id The post ID.
- * @param int $term_taxonomy_id The term `term_id` or `term_taxonomy_id`; if the `$taxonomy` argument is
+ * @param int $post_id The post ID.
+ * @param int $term_taxonomy_id The term `term_id` or `term_taxonomy_id`; if the `$taxonomy` argument is
* passed this parameter will be interpreted as a `term_id`, else as a
* `term_taxonomy_id`.
- * @param int|null $term_order The order the term applies to the post, defaults to `null` to not use
+ * @param int|null $term_order The order the term applies to the post, defaults to `null` to not use
* the
* term order.
- * @param string|null $taxonomy The taxonomy the `term_id` is for; if passed this parameter will be used
+ * @param string|null $taxonomy The taxonomy the `term_id` is for; if passed this parameter will be used
* to build a `taxonomy_term_id` from the `term_id`.
*
*
@@ -3636,7 +3900,7 @@ public function grabPostsTableName(): string {
* ```
*
* @param string $tableName The table to fetch the last insertion for.
- * @param string $idColumn The column that is used, in the table, to uniquely identify
+ * @param string $idColumn The column that is used, in the table, to uniquely identify
* items.
*
* @return int The last insertion id.
@@ -3666,8 +3930,8 @@ public function grabLatestEntryByFromDatabase(string $tableName, string $idColum
* }
* ```
*
- * @param int $postId The post ID.
- * @param string $meta_key The meta key.
+ * @param int $postId The post ID.
+ * @param string $meta_key The meta key.
* @param mixed $meta_value The value to insert in the database, objects and arrays will be serialized.
*
* @return int The inserted meta `meta_id`.
@@ -3766,8 +4030,8 @@ public function grabTermsTableName(): string {
* ]);
* ```
*
- * @param string $name The term name, e.g. "Fuzzy".
- * @param string $taxonomy The term taxonomy
+ * @param string $name The term name, e.g. "Fuzzy".
+ * @param string $taxonomy The term taxonomy
* @param array $overrides An array of values to override the default ones.
*
* @return array An array containing `term_id` and `term_taxonomy_id` of the inserted term.
@@ -3818,8 +4082,8 @@ public function grabTermTaxonomyTableName(): string {
* }
* ```
*
- * @param int $term_id The ID of the term to insert the meta for.
- * @param string $meta_key The key of the meta to insert.
+ * @param int $term_id The ID of the term to insert the meta for.
+ * @param string $meta_key The key of the meta to insert.
* @param mixed $meta_value The value of the meta to insert, if serializable it will be serialized.
*
* @return int The inserted term meta `meta_id`.
@@ -3891,9 +4155,9 @@ public function grabTermTaxonomyIdFromDatabase(array $criteria) {
* $I->haveTermRelationshipInDatabase($bookId, $fictionId);
* ```
*
- * @param int $object_id A post ID, a user ID or anything that can be assigned a taxonomy term.
+ * @param int $object_id A post ID, a user ID or anything that can be assigned a taxonomy term.
* @param int $term_taxonomy_id The `term_taxonomy_id` of the term and taxonomy to create a relation with.
- * @param int $term_order Defaults to `0`.
+ * @param int $term_order Defaults to `0`.
* @see \lucatume\WPBrowser\Module\WPDb::haveTermRelationshipInDatabase()
*/
public function haveTermRelationshipInDatabase(int $object_id, int $term_taxonomy_id, int $term_order = 0): void {
@@ -4397,7 +4661,7 @@ public function dontHaveLinkInDatabase(array $criteria): void {
*
* @param array $criteria An associative array of the column names and values to use as deletion
* criteria.
- * @param string $table The table name.
+ * @param string $table The table name.
* @see \lucatume\WPBrowser\Module\WPDb::dontHaveInDatabase()
*/
public function dontHaveInDatabase(string $table, array $criteria): void {
@@ -4481,9 +4745,9 @@ public function dontHaveUserMetaInDatabase(array $criteria): void {
* $I->grabUserMetaFromDatabase($userId, 'api_data');
* ```
*
- * @param int $userId The ID of th user to get the meta for.
+ * @param int $userId The ID of th user to get the meta for.
* @param string $meta_key The meta key to fetch the value for.
- * @param bool $single Whether to return a single value or an array of values.
+ * @param bool $single Whether to return a single value or an array of values.
*
* @return array|mixed An array of the different meta key values or a single value if `$single` is set
* to `true`.
@@ -4507,8 +4771,8 @@ public function grabUserMetaFromDatabase(int $userId, string $meta_key, bool $si
* $I->grabAllFromDatabase($books, 'title', ['genre' => 'fiction']);
* ```
*
- * @param string $table The table to grab the values from.
- * @param string $column The column to fetch.
+ * @param string $table The table to grab the values from.
+ * @param string $column The column to fetch.
* @param array $criteria The search criteria.
*
* @return array> An array of results.
@@ -4537,7 +4801,7 @@ public function grabAllFromDatabase(string $table, string $column, array $criter
* ```
*
* @param string $transient The transient name.
- * @param mixed $value The transient value.
+ * @param mixed $value The transient value.
*
* @return int The inserted option `option_id`.
* @see \lucatume\WPBrowser\Module\WPDb::haveTransientInDatabase()
@@ -4562,7 +4826,7 @@ public function haveTransientInDatabase(string $transient, $value): int {
*
* @param string $option_name The option name.
* @param mixed $option_value The option value; if an array or object it will be serialized.
- * @param string $autoload Whether the option should be autoloaded by WordPress or not.
+ * @param string $autoload Whether the option should be autoloaded by WordPress or not.
*
* @return int The inserted option `option_id`
* @see \lucatume\WPBrowser\Module\WPDb::haveOptionInDatabase()
@@ -4604,7 +4868,7 @@ public function dontHaveTransientInDatabase(string $transient): void {
* $I->dontHaveOptionInDatabase('bar', 'baz');
* ```
*
- * @param string $key The option name.
+ * @param string $key The option name.
* @param mixed $value If set the option will only be removed if its value matches the passed one.
* @see \lucatume\WPBrowser\Module\WPDb::dontHaveOptionInDatabase()
*/
@@ -4625,7 +4889,7 @@ public function dontHaveOptionInDatabase(string $key, $value = NULL): void {
* $fooCountOptionId = $I->haveSiteOptionInDatabase('foo_count','23');
* ```
*
- * @param string $key The name of the option to insert.
+ * @param string $key The name of the option to insert.
* @param mixed $value The value to insert for the option.
*
* @return int The inserted option `option_id`.
@@ -4662,8 +4926,6 @@ public function useMainBlog(): void {
*
* This has nothing to do with WordPress `switch_to_blog` function, this code will affect the table prefixes used.
*
- * @param int $blogId The ID of the blog to use.
- * @throws ModuleException If the blog ID is not an integer greater than or equal to 0.
* @example
* ```php
* // Switch to the blog with ID 23.
@@ -4673,6 +4935,8 @@ public function useMainBlog(): void {
* // Switch to the main blog using this method.
* $I->useBlog(1);
* ```
+ * @param int $blogId The ID of the blog to use.
+ * @throws ModuleException If the blog ID is not an integer greater than or equal to 0.
* @see \lucatume\WPBrowser\Module\WPDb::useBlog()
*/
public function useBlog(int $blogId = 1): void {
@@ -4685,11 +4949,6 @@ public function useBlog(int $blogId = 1): void {
*
* Gets the blog URL from the Blog ID.
*
- * @param int $blogId The ID of the blog to get the URL for.
- *
- * @return string The blog URL.
- * @throws ModuleException If the blog ID is not found in the database.
- *
* @example
* ```php
* // Get the URL for the main blog.
@@ -4697,6 +4956,11 @@ public function useBlog(int $blogId = 1): void {
* // Get the URL for the blog with ID 23.
* $blog23Url = $I->grabBlogUrl(23);
* ```
+ * @param int $blogId The ID of the blog to get the URL for.
+ *
+ * @return string The blog URL.
+ * @throws ModuleException If the blog ID is not found in the database.
+ *
* @see \lucatume\WPBrowser\Module\WPDb::grabBlogUrl()
*/
public function grabBlogUrl(int $blogId = 1): string {
@@ -4717,7 +4981,7 @@ public function grabBlogUrl(int $blogId = 1): string {
* $I->dontHaveSiteOptionInDatabase('foo_count', 23);
* ```
*
- * @param string $key The option name.
+ * @param string $key The option name.
* @param mixed $value If set the option will only be removed it its value matches the specified one.
* @see \lucatume\WPBrowser\Module\WPDb::dontHaveSiteOptionInDatabase()
*/
@@ -4739,7 +5003,7 @@ public function dontHaveSiteOptionInDatabase(string $key, $value = NULL): void {
* $I->haveSiteTransientInDatabase('api_data', ['user' => 'luca', 'token' => '11ae3ijns-j83']);
* ```
*
- * @param string $key The key of the site transient to insert, w/o the `_site_transient_` prefix.
+ * @param string $key The key of the site transient to insert, w/o the `_site_transient_` prefix.
* @param mixed $value The value to insert; if serializable the value will be serialized.
*
* @return int The inserted transient `option_id`
@@ -4842,7 +5106,7 @@ public function grabSiteTransientFromDatabase(string $key) {
* $I->seeSiteSiteTransientInDatabase('total_counts', 23);
* ```
*
- * @param string $key The name of the transient to check for, w/o the `_site_transient_` prefix.
+ * @param string $key The name of the transient to check for, w/o the `_site_transient_` prefix.
* @param mixed $value If provided then the assertion will include the value.
*
* @throws JsonException
@@ -4865,7 +5129,7 @@ public function seeSiteSiteTransientInDatabase(string $key, $value = NULL): void
* $I->seeSiteSiteTransientInDatabase('total_counts', 23);
* ```
*
- * @param string $key The name of the transient to check for, w/o the `_site_transient_` prefix.
+ * @param string $key The name of the transient to check for, w/o the `_site_transient_` prefix.
* @param mixed $value If provided then the assertion will include the value.
*
* @throws JsonException
@@ -5005,7 +5269,7 @@ public function canSeeSiteOptionInDatabase($criteriaOrName, $value = NULL): void
* `Post Title - 1` for the second one and so on.
* The same applies to meta values as well.
*
- * @param int $count The number of posts to insert.
+ * @param int $count The number of posts to insert.
*
* @return array An array of the inserted post IDs.
*
@@ -5074,7 +5338,7 @@ public function canSeeTermInDatabase(array $criteria): void {
* ```
*
* @param array $criteria An array of search criteria.
- * @param bool $purgeMeta Whether the terms meta should be purged along side with the meta or not.
+ * @param bool $purgeMeta Whether the terms meta should be purged along side with the meta or not.
*
* @throws Exception If there's an issue removing the rows.
* @see \lucatume\WPBrowser\Module\WPDb::dontHaveTermInDatabase()
@@ -5170,8 +5434,8 @@ public function cantSeeTermInDatabase(array $criteria): void {
* $I->haveManyCommentsInDatabase(3, $postId, ['comment_content' => 'Comment {{n}}']);
* ```
*
- * @param int $count The number of comments to insert.
- * @param int $comment_post_ID The comment parent post ID.
+ * @param int $count The number of comments to insert.
+ * @param int $comment_post_ID The comment parent post ID.
* @param array $overrides An associative array to override the defaults.
*
* @return array An array containing the inserted comments IDs.
@@ -5192,7 +5456,7 @@ public function haveManyCommentsInDatabase(int $count, int $comment_post_ID, arr
* $I->haveCommentInDatabase($postId, ['comment_content' => 'Test Comment', 'comment_karma' => 23]);
* ```
*
- * @param int $comment_post_ID The id of the post the comment refers to.
+ * @param int $comment_post_ID The id of the post the comment refers to.
* @param array $data The comment data overriding default and random generated values.
*
* @return int The inserted comment `comment_id`.
@@ -5218,8 +5482,8 @@ public function haveCommentInDatabase(int $comment_post_ID, array $data = []): i
* $I->haveCommentMetaInDatabase($commentId, 'api_data', $apiData);
* ```
*
- * @param int $comment_id The ID of the comment to insert the meta for.
- * @param string $meta_key The key of the comment meta to insert.
+ * @param int $comment_id The ID of the comment to insert the meta for.
+ * @param string $meta_key The key of the comment meta to insert.
* @param mixed $meta_value The value of the meta to insert, if serializable it will be serialized.
*
* @return int The inserted comment meta ID.
@@ -5264,7 +5528,7 @@ public function grabCommentmetaTableName(): string {
* $draftsCount = $I->countRowsInDatabase($postsTable, ['post_status' => 'draft']);
* ```
*
- * @param string $table The table to count the rows in.
+ * @param string $table The table to count the rows in.
* @param array $criteria Search criteria, if empty all table rows will be counted.
*
* @return int The number of table rows matching the search criteria.
@@ -5286,7 +5550,7 @@ public function countRowsInDatabase(string $table, array $criteria = []): int {
* ```
*
* @param array $criteria An array of search criteria.
- * @param bool $purgeMeta If set to `true` then the meta for the comment will be purged too.
+ * @param bool $purgeMeta If set to `true` then the meta for the comment will be purged too.
*
*
* @throws Exception In case of incoherent query criteria.
@@ -5353,7 +5617,7 @@ public function dontHaveCommentMetaInDatabase(array $criteria): void {
* $linkIds = $I->haveManyLinksInDatabase(3, ['link_url' => 'http://example.org/test-{{n}}']);
* ```
*
- * @param int $count The number of links to insert.
+ * @param int $count The number of links to insert.
* @param array $overrides Overrides for the default arguments.
*
* @return array An array of inserted `link_id`s.
@@ -5422,9 +5686,9 @@ public function grabLinksTableName(): string {
* );
* ```
*
- * @param int $count The number of users to insert.
- * @param string $user_login The user login name.
- * @param string $role The user role.
+ * @param int $count The number of users to insert.
+ * @param string $user_login The user login name.
+ * @param string $role The user role.
* @param array $overrides An array of values to override the default ones.
*
* @return array An array of user IDs.
@@ -5473,14 +5737,14 @@ public function haveManyUsersInDatabase(int $count, string $user_login, string $
* $userId = $I->haveUserInDatabase('luca', '');
* ```
*
- * @param string|array $role The user role slug(s), e.g. `administrator` or `['author', 'editor']`;
+ * @param string|array $role The user role slug(s), e.g. `administrator` or `['author', 'editor']`;
* defaults to `subscriber`. If more than one role is specified, then the
* first role in the list will be the user primary role and the
* `wp_user_level` will be set to that role.
* @param array $overrides An associative array of column names and values overriding defaults
* in the `users` and `usermeta` table.
*
- * @param string $user_login The user login name.
+ * @param string $user_login The user login name.
*
* @return int The inserted user ID.
*
@@ -5571,7 +5835,7 @@ public function grabUsersTableName(): string {
* );
* ```
*
- * @param int $userId The ID of the user to set the capabilities of.
+ * @param int $userId The ID of the user to set the capabilities of.
* @param string|array|array> $role Either a role string (e.g.
* `administrator`),an associative array of blog
* IDs/roles for a multisite installation (e.g. `[1
@@ -5597,9 +5861,9 @@ public function haveUserCapabilitiesInDatabase(int $userId, $role): array {
* $I->haveUserMetaInDatabase($userId, 'karma', 23);
* ```
*
- * @param int $userId The user ID.
- * @param string $meta_key The meta key to set the value for.
- * @param mixed $meta_value Either a single value or an array of values; objects will be serialized while array of
+ * @param int $userId The user ID.
+ * @param string $meta_key The meta key to set the value for.
+ * @param mixed $meta_value Either a single value or an array of values; objects will be serialized while array of
* values will trigger the insertion of multiple rows.
*
* @return array An array of inserted `umeta_id`s.
@@ -5644,7 +5908,7 @@ public function grabUsermetaTableName(): string {
* $I->haveUserLevelsInDatabase($userId, $moreThanAnEditorLessThanAnAdmin);
* ```
*
- * @param int $userId The ID of the user to set the
+ * @param int $userId The ID of the user to set the
* level for.
* @param string|array|array|array> $role Either a user role (e.g.
* `editor`), a list of user
@@ -5677,9 +5941,9 @@ public function haveUserLevelsInDatabase(int $userId, $role): array {
* $termTaxonomyIds = array_column($terms, 1);
* ```
*
- * @param int $count The number of terms to insert.
- * @param string $name The term name template, can include the `{{n}}` placeholder.
- * @param string $taxonomy The taxonomy to insert the terms for.
+ * @param int $count The number of terms to insert.
+ * @param string $name The term name template, can include the `{{n}}` placeholder.
+ * @param string $taxonomy The taxonomy to insert the terms for.
* @param array $overrides An associative array of default overrides.
*
* @return array> An array of arrays containing `term_id` and `term_taxonomy_id` of the inserted terms.
@@ -6086,11 +6350,11 @@ public function grabBlogsTableName(): string {
* }
* ```
*
- * @param int $count The number of blogs to create.
+ * @param int $count The number of blogs to create.
*
* @param array $overrides An array of values to override the default ones; `{{n}}` will be replaced
* by the count.
- * @param bool $subdomain Whether the new blogs should be created as a subdomain or subfolder.
+ * @param bool $subdomain Whether the new blogs should be created as a subdomain or subfolder.
*
* @return array An array of inserted blogs `blog_id`s.
* @throws JsonException
@@ -6115,9 +6379,9 @@ public function haveManyBlogsInDatabase(int $count, array $overrides = [], bool
* $blogId = $I->haveBlogInDatabase('test', ['administrator' => $userId], false);
* ```
*
- * @param string $domainOrPath The subdomain or the path to the be used for the blog.
+ * @param string $domainOrPath The subdomain or the path to the be used for the blog.
* @param array $overrides An array of values to override the defaults.
- * @param bool $subdomain Whether the new blog should be created as a subdomain (`true`)
+ * @param bool $subdomain Whether the new blog should be created as a subdomain (`true`)
* or subfolder (`true`)
*
* @return int The inserted blog `blog_id`.
@@ -6168,8 +6432,8 @@ public function getSiteDomain(): string {
* ```
*
* @param array $criteria An array of search criteria to find the blog rows in the blogs table.
- * @param bool $removeTables Remove the blog tables.
- * @param bool $removeUploads Remove the blog uploads; requires the `WPFilesystem` module.
+ * @param bool $removeTables Remove the blog tables.
+ * @param bool $removeUploads Remove the blog uploads; requires the `WPFilesystem` module.
*
* @throws JsonException If there's any issue debugging the query.
* @see \lucatume\WPBrowser\Module\WPDb::dontHaveBlogInDatabase()
@@ -6282,10 +6546,10 @@ public function cantSeeBlogInDatabase(array $criteria): void {
* $I->useTheme('acme', 'acme', 'Acme Theme');
* ```
*
- * @param string $stylesheet The theme stylesheet slug, e.g. `twentysixteen`.
- * @param string|null $template The theme template slug, e.g. `twentysixteen`, defaults to `$stylesheet`.
+ * @param string $stylesheet The theme stylesheet slug, e.g. `twentysixteen`.
+ * @param string|null $template The theme template slug, e.g. `twentysixteen`, defaults to `$stylesheet`.
*
- * @param string|null $themeName The theme name, e.g. `Acme`, defaults to the "title" version of
+ * @param string|null $themeName The theme name, e.g. `Acme`, defaults to the "title" version of
* `$stylesheet`.
* @see \lucatume\WPBrowser\Module\WPDb::useTheme()
*/
@@ -6304,8 +6568,8 @@ public function useTheme(string $stylesheet, ?string $template = NULL, ?string $
* list($termId, $termTaxId) = $I->haveMenuInDatabase('test', 'sidebar');
* ```
*
- * @param string $slug The menu slug.
- * @param string $location The theme menu location the menu will be assigned to.
+ * @param string $slug The menu slug.
+ * @param string $location The theme menu location the menu will be assigned to.
* @param array $overrides An array of values to override the defaults.
*
* @return array An array containing the created menu `term_id` and `term_taxonomy_id`.
@@ -6329,11 +6593,11 @@ public function haveMenuInDatabase(string $slug, string $location, array $overri
* $I->haveMenuItemInDatabase('test', 'Test two', 1);
* ```
*
- * @param string $title The menu item title.
- * @param int|null $menuOrder An optional menu order, `1` based.
- * @param array $meta An associative array that will be prefixed with `_menu_item_` for the item
+ * @param string $title The menu item title.
+ * @param int|null $menuOrder An optional menu order, `1` based.
+ * @param array $meta An associative array that will be prefixed with `_menu_item_` for the item
* post meta.
- * @param string $menuSlug The menu slug the item should be added to.
+ * @param string $menuSlug The menu slug the item should be added to.
*
* @return int The menu item post `ID`
* @throws ModuleException If there's an issue inserting the database row.
@@ -6400,15 +6664,15 @@ public function canSeeTermRelationshipInDatabase(array $criteria): void {
*
* Requires the WPFilesystem module.
*
- * @param string|int $date Either a string supported by the `strtotime` function or a UNIX
+ * @param string|int $date Either a string supported by the `strtotime` function or a UNIX
* timestamp that should be used to build the "year/time" uploads
* sub-folder structure.
- * @param array $overrides An associative array of values overriding the default ones.
+ * @param array $overrides An associative array of values overriding the default ones.
* @param array>|null $imageSizes An associative array in the format [ =>
* [,]] to override the image sizes created by
* default.
*
- * @param string $file The absolute path to the attachment file.
+ * @param string $file The absolute path to the attachment file.
*
* @return int The post ID of the inserted attachment.
*
@@ -6545,12 +6809,12 @@ public function cantSeeAttachmentInDatabase(array $criteria): void {
* $I->dontHaveAttachmentInDatabase($thumbnailId, true, true);
* ```
*
- * @param bool $purgeMeta If set to `true` then the meta for the attachment will be purged too.
- * @param bool $removeFiles Remove all files too, requires the `WPFilesystem` module to be loaded in
+ * @param bool $purgeMeta If set to `true` then the meta for the attachment will be purged too.
+ * @param bool $removeFiles Remove all files too, requires the `WPFilesystem` module to be loaded in
* the suite.
*
*
- * @param array $criteria An array of search criteria to find the attachment post in the posts
+ * @param array $criteria An array of search criteria to find the attachment post in the posts
* table.
*
* @throws ModuleRequireException If the WPFilesystem module is not loaded in the suite and the `$removeFiles`
@@ -6645,7 +6909,7 @@ public function grabAttachmentMetadata(int $attachmentPostId): array {
* ```
*
* @param array $criteria An array of search criteria.
- * @param bool $purgeMeta If set to `true` then the meta for the post will be purged too.
+ * @param bool $purgeMeta If set to `true` then the meta for the post will be purged too.
* @see \lucatume\WPBrowser\Module\WPDb::dontHavePostInDatabase()
*/
public function dontHavePostInDatabase(array $criteria, bool $purgeMeta = true): void {
@@ -6684,7 +6948,7 @@ public function dontHavePostMetaInDatabase(array $criteria): void {
* ```
*
* @param string $userEmail The email of the user to remove.
- * @param bool $purgeMeta Whether the user meta should be purged alongside the user or not.
+ * @param bool $purgeMeta Whether the user meta should be purged alongside the user or not.
*
* @return array An array of the deleted user(s) ID(s)
*
@@ -6734,7 +6998,7 @@ public function grabTablePrefix(): string {
* ```
*
* @param int|string $userIdOrLogin The user ID or login name.
- * @param bool $purgeMeta Whether the user meta should be purged alongside the user or not.
+ * @param bool $purgeMeta Whether the user meta should be purged alongside the user or not.
* @see \lucatume\WPBrowser\Module\WPDb::dontHaveUserInDatabase()
*/
public function dontHaveUserInDatabase($userIdOrLogin, bool $purgeMeta = true): void {
@@ -6772,9 +7036,9 @@ public function grabUserIdFromDatabase(string $userLogin) {
* $thumbnail_id = $I->grabPostMetaFromDatabase($postId, '_thumbnail_id', true);
* ```
*
- * @param int $postId The post ID.
+ * @param int $postId The post ID.
* @param string $metaKey The key of the meta to retrieve.
- * @param bool $single Whether to return a single meta value or an array of all available meta values.
+ * @param bool $single Whether to return a single meta value or an array of all available meta values.
*
* @return mixed|array Either a single meta value or an array of all the available meta values.
* @see \lucatume\WPBrowser\Module\WPDb::grabPostMetaFromDatabase()
@@ -6794,7 +7058,7 @@ public function grabPostMetaFromDatabase(int $postId, string $metaKey, bool $sin
* $blogOptionTable = $I->grabBlogTableName($blogId, 'option');
* ```
*
- * @param int $blogId The blog ID.
+ * @param int $blogId The blog ID.
* @param string $table The table name, without table prefix.
*
* @return string The full blog table name, including the table prefix or an empty string
@@ -6934,14 +7198,14 @@ public function grabBlogPath(int $blogId): string {
* $I->dontSeePostWithTermInDatabase($postId, $nonFiction['term_taxonomy_id], );
* ```
*
- * @param int $post_id The post ID.
- * @param int $term_taxonomy_id The term `term_id` or `term_taxonomy_id`; if the `$taxonomy` argument is
+ * @param int $post_id The post ID.
+ * @param int $term_taxonomy_id The term `term_id` or `term_taxonomy_id`; if the `$taxonomy` argument is
* passed this parameter will be interpreted as a `term_id`, else as a
* `term_taxonomy_id`.
- * @param int|null $term_order The order the term applies to the post, defaults to `null` to not use
+ * @param int|null $term_order The order the term applies to the post, defaults to `null` to not use
* the
* term order.
- * @param string|null $taxonomy The taxonomy the `term_id` is for; if passed this parameter will be used
+ * @param string|null $taxonomy The taxonomy the `term_id` is for; if passed this parameter will be used
* to build a `taxonomy_term_id` from the `term_id`.
*
*
@@ -6967,14 +7231,14 @@ public function dontSeePostWithTermInDatabase(int $post_id, int $term_taxonomy_i
* $I->dontSeePostWithTermInDatabase($postId, $nonFiction['term_taxonomy_id], );
* ```
*
- * @param int $post_id The post ID.
- * @param int $term_taxonomy_id The term `term_id` or `term_taxonomy_id`; if the `$taxonomy` argument is
+ * @param int $post_id The post ID.
+ * @param int $term_taxonomy_id The term `term_id` or `term_taxonomy_id`; if the `$taxonomy` argument is
* passed this parameter will be interpreted as a `term_id`, else as a
* `term_taxonomy_id`.
- * @param int|null $term_order The order the term applies to the post, defaults to `null` to not use
+ * @param int|null $term_order The order the term applies to the post, defaults to `null` to not use
* the
* term order.
- * @param string|null $taxonomy The taxonomy the `term_id` is for; if passed this parameter will be used
+ * @param string|null $taxonomy The taxonomy the `term_id` is for; if passed this parameter will be used
* to build a `taxonomy_term_id` from the `term_id`.
*
*
@@ -6998,7 +7262,7 @@ public function cantSeePostWithTermInDatabase(int $post_id, int $term_taxonomy_i
* $I->havePostThumbnailInDatabase($postId, $attachmentId);
* ```
*
- * @param int $postId The post ID to assign the thumbnail (featured image) to.
+ * @param int $postId The post ID to assign the thumbnail (featured image) to.
* @param int $thumbnailId The post ID of the attachment.
*
* @return int The inserted meta id.
@@ -7243,7 +7507,6 @@ public function canSeeTransientInDatabase(string $name, $value = NULL): void {
* @return void
*
* @throws JsonException|ModuleException
- *
* @see \lucatume\WPBrowser\Module\WPDb::dontSeeSiteTransientInDatabase()
*/
public function dontSeeSiteTransientInDatabase(string $transient, $value = NULL): void {
@@ -7266,7 +7529,6 @@ public function dontSeeSiteTransientInDatabase(string $transient, $value = NULL)
* @return void
*
* @throws JsonException|ModuleException
- *
* @see \lucatume\WPBrowser\Module\WPDb::dontSeeSiteTransientInDatabase()
*/
public function cantSeeSiteTransientInDatabase(string $transient, $value = NULL): void {
@@ -7290,7 +7552,6 @@ public function cantSeeSiteTransientInDatabase(string $transient, $value = NULL)
* @param string $transient The transient name.
* @return void
* @throws JsonException|ModuleException
- *
* @see \lucatume\WPBrowser\Module\WPDb::seeSiteTransientInDatabase()
*/
public function seeSiteTransientInDatabase(string $transient, $value = NULL): void {
@@ -7313,7 +7574,6 @@ public function seeSiteTransientInDatabase(string $transient, $value = NULL): vo
* @param string $transient The transient name.
* @return void
* @throws JsonException|ModuleException
- *
* @see \lucatume\WPBrowser\Module\WPDb::seeSiteTransientInDatabase()
*/
public function canSeeSiteTransientInDatabase(string $transient, $value = NULL): void {
@@ -7333,12 +7593,12 @@ public function canSeeSiteTransientInDatabase(string $transient, $value = NULL):
* $I->seeNumRecords(30, 'books'); //executed on db_books database
* //All the next queries will be on db_books
* ```
- *
+ * @param $databaseKey
* @throws ModuleConfigException
* @see \Codeception\Module\Db::amConnectedToDatabase()
*/
- public function amConnectedToDatabase(string $databaseKey): void {
- $this->getScenario()->runStep(new \Codeception\Step\Condition('amConnectedToDatabase', func_get_args()));
+ public function amConnectedToDatabase($databaseKey) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Condition('amConnectedToDatabase', func_get_args()));
}
@@ -7375,28 +7635,34 @@ public function amConnectedToDatabase(string $databaseKey): void {
* exception on failure.
*
* @param $databaseKey
- * @param ActionSequence|array|callable $actions
+ * @param \Codeception\Util\ActionSequence|array|callable $actions
* @throws ModuleConfigException
* @see \Codeception\Module\Db::performInDatabase()
*/
- public function performInDatabase($databaseKey, $actions): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('performInDatabase', func_get_args()));
+ public function performInDatabase($databaseKey, $actions) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('performInDatabase', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Inserts an SQL record into a database. This record will be erased after the test,
- * unless you've configured "skip_cleanup_if_failed", and the test fails.
+ * Inserts an SQL record into a database. This record will be erased after the test,
+ * unless you've configured "skip_cleanup_if_failed", and the test fails.
*
* ```php
* haveInDatabase('users', array('name' => 'miles', 'email' => 'miles@davis.com'));
+ * ?>
* ```
+ *
+ * @param string $table
+ * @param array $data
+ *
+ * @return integer $id
* @see \Codeception\Module\Db::haveInDatabase()
*/
- public function haveInDatabase(string $table, array $data): int {
+ public function haveInDatabase($table, array $data) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('haveInDatabase', func_get_args()));
}
@@ -7422,10 +7688,14 @@ public function haveInDatabase(string $table, array $data): int {
* ```
*
* Supported operators: `<`, `>`, `>=`, `<=`, `!=`, `like`.
+ *
+ *
+ * @param string $table
+ * @param array $criteria
* @see \Codeception\Module\Db::seeInDatabase()
*/
- public function seeInDatabase(string $table, array $criteria = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInDatabase', func_get_args()));
+ public function seeInDatabase($table, $criteria = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInDatabase', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -7449,10 +7719,14 @@ public function seeInDatabase(string $table, array $criteria = []): void {
* ```
*
* Supported operators: `<`, `>`, `>=`, `<=`, `!=`, `like`.
+ *
+ *
+ * @param string $table
+ * @param array $criteria
* @see \Codeception\Module\Db::seeInDatabase()
*/
- public function canSeeInDatabase(string $table, array $criteria = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInDatabase', func_get_args()));
+ public function canSeeInDatabase($table, $criteria = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInDatabase', func_get_args()));
}
@@ -7464,6 +7738,7 @@ public function canSeeInDatabase(string $table, array $criteria = []): void {
* ```php
* seeNumRecords(1, 'users', ['name' => 'davert'])
+ * ?>
* ```
*
* @param int $expectedNumber Expected number
@@ -7471,8 +7746,8 @@ public function canSeeInDatabase(string $table, array $criteria = []): void {
* @param array $criteria Search criteria [Optional]
* @see \Codeception\Module\Db::seeNumRecords()
*/
- public function seeNumRecords(int $expectedNumber, string $table, array $criteria = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumRecords', func_get_args()));
+ public function seeNumRecords($expectedNumber, $table, array $criteria = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumRecords', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -7483,6 +7758,7 @@ public function seeNumRecords(int $expectedNumber, string $table, array $criteri
* ```php
* seeNumRecords(1, 'users', ['name' => 'davert'])
+ * ?>
* ```
*
* @param int $expectedNumber Expected number
@@ -7490,8 +7766,8 @@ public function seeNumRecords(int $expectedNumber, string $table, array $criteri
* @param array $criteria Search criteria [Optional]
* @see \Codeception\Module\Db::seeNumRecords()
*/
- public function canSeeNumRecords(int $expectedNumber, string $table, array $criteria = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumRecords', func_get_args()));
+ public function canSeeNumRecords($expectedNumber, $table, array $criteria = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumRecords', func_get_args()));
}
@@ -7518,10 +7794,13 @@ public function canSeeNumRecords(int $expectedNumber, string $table, array $crit
* ```
*
* Supported operators: `<`, `>`, `>=`, `<=`, `!=`, `like`.
+ *
+ * @param string $table
+ * @param array $criteria
* @see \Codeception\Module\Db::dontSeeInDatabase()
*/
- public function dontSeeInDatabase(string $table, array $criteria = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInDatabase', func_get_args()));
+ public function dontSeeInDatabase($table, $criteria = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInDatabase', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -7547,10 +7826,13 @@ public function dontSeeInDatabase(string $table, array $criteria = []): void {
* ```
*
* Supported operators: `<`, `>`, `>=`, `<=`, `!=`, `like`.
+ *
+ * @param string $table
+ * @param array $criteria
* @see \Codeception\Module\Db::dontSeeInDatabase()
*/
- public function cantSeeInDatabase(string $table, array $criteria = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInDatabase', func_get_args()));
+ public function cantSeeInDatabase($table, $criteria = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInDatabase', func_get_args()));
}
@@ -7564,9 +7846,15 @@ public function cantSeeInDatabase(string $table, array $criteria = []): void {
* grabColumnFromDatabase('users', 'email', array('name' => 'RebOOter'));
* ```
+ *
+ * @param string $table
+ * @param string $column
+ * @param array $criteria
+ *
+ * @return array
* @see \Codeception\Module\Db::grabColumnFromDatabase()
*/
- public function grabColumnFromDatabase(string $table, string $column, array $criteria = []): array {
+ public function grabColumnFromDatabase($table, $column, array $criteria = []) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabColumnFromDatabase', func_get_args()));
}
@@ -7585,79 +7873,24 @@ public function grabColumnFromDatabase(string $table, string $column, array $cri
*
* ```php
* grabFromDatabase('posts', 'num_comments', ['num_comments >=' => 100]);
- * $mail = $I->grabFromDatabase('users', 'email', ['email like' => 'miles%']);
+ * $post = $I->grabFromDatabase('posts', ['num_comments >=' => 100]);
+ * $user = $I->grabFromDatabase('users', ['email like' => 'miles%']);
* ```
*
* Supported operators: `<`, `>`, `>=`, `<=`, `!=`, `like`.
*
+ * @param string $table
+ * @param string $column
+ * @param array $criteria
+ *
* @return mixed Returns a single column value or false
* @see \Codeception\Module\Db::grabFromDatabase()
*/
- public function grabFromDatabase(string $table, string $column, array $criteria = []) {
+ public function grabFromDatabase($table, $column, $criteria = []) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFromDatabase', func_get_args()));
}
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Fetches a whole entry from a database.
- * Make the test fail if the entry is not found.
- * Provide table name, desired column and criteria.
- *
- * ``` php
- * grabEntryFromDatabase('users', array('name' => 'Davert'));
- * ```
- * Comparison expressions can be used as well:
- *
- * ```php
- * grabEntryFromDatabase('posts', ['num_comments >=' => 100]);
- * $user = $I->grabEntryFromDatabase('users', ['email like' => 'miles%']);
- * ```
- *
- * Supported operators: `<`, `>`, `>=`, `<=`, `!=`, `like`.
- *
- * @return array Returns a single entry value
- * @throws PDOException|Exception
- * @see \Codeception\Module\Db::grabEntryFromDatabase()
- */
- public function grabEntryFromDatabase(string $table, array $criteria = []): array {
- return $this->getScenario()->runStep(new \Codeception\Step\Action('grabEntryFromDatabase', func_get_args()));
- }
-
-
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Fetches a set of entries from a database.
- * Provide table name and criteria.
- *
- * ``` php
- * grabEntriesFromDatabase('users', array('name' => 'Davert'));
- * ```
- * Comparison expressions can be used as well:
- *
- * ```php
- * grabEntriesFromDatabase('posts', ['num_comments >=' => 100]);
- * $user = $I->grabEntriesFromDatabase('users', ['email like' => 'miles%']);
- * ```
- *
- * Supported operators: `<`, `>`, `>=`, `<=`, `!=`, `like`.
- *
- * @return array> Returns an array of all matched rows
- * @throws PDOException|Exception
- * @see \Codeception\Module\Db::grabEntriesFromDatabase()
- */
- public function grabEntriesFromDatabase(string $table, array $criteria = []): array {
- return $this->getScenario()->runStep(new \Codeception\Step\Action('grabEntriesFromDatabase', func_get_args()));
- }
-
-
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
@@ -7665,10 +7898,11 @@ public function grabEntriesFromDatabase(string $table, array $criteria = []): ar
*
* @param string $table Table name
* @param array $criteria Search criteria [Optional]
+ *
* @return int
* @see \Codeception\Module\Db::grabNumRecords()
*/
- public function grabNumRecords(string $table, array $criteria = []): int {
+ public function grabNumRecords($table, array $criteria = []) {
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabNumRecords', func_get_args()));
}
@@ -7681,11 +7915,16 @@ public function grabNumRecords(string $table, array $criteria = []): int {
* ```php
* updateInDatabase('users', array('isAdmin' => true), array('email' => 'miles@davis.com'));
+ * ?>
* ```
+ *
+ * @param string $table
+ * @param array $data
+ * @param array $criteria
* @see \Codeception\Module\Db::updateInDatabase()
*/
- public function updateInDatabase(string $table, array $data, array $criteria = []): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('updateInDatabase', func_get_args()));
+ public function updateInDatabase($table, array $data, array $criteria = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('updateInDatabase', func_get_args()));
}
@@ -7700,13 +7939,13 @@ public function updateInDatabase(string $table, array $data, array $criteria = [
* $I->seeFileFound('shop.log');
* ```
*
- * @param string|null $path The path, relative to the site uploads folder.
+ * @param string|int|null $path The path, relative to the site uploads folder.
*
*
* @throws Exception If the path is a date string and is not parsable by the `strtotime` function.
* @see \lucatume\WPBrowser\Module\WPFilesystem::amInUploadsPath()
*/
- public function amInUploadsPath(?string $path = NULL): void {
+ public function amInUploadsPath($path = NULL): void {
$this->getScenario()->runStep(new \Codeception\Step\Condition('amInUploadsPath', func_get_args()));
}
@@ -8964,9 +9203,12 @@ public function makeUploadsDir(string $path): string {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a directory exists.
+ *
+ * @param string $directory
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertDirectoryExists()
*/
- public function assertDirectoryExists(string $directory, string $message = "") {
+ public function assertDirectoryExists($directory, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDirectoryExists', func_get_args()));
}
@@ -8976,10 +9218,12 @@ public function assertDirectoryExists(string $directory, string $message = "") {
*
* Enters a directory In local filesystem.
* Project root directory is used by default
+ *
+ * @param string $path
* @see \Codeception\Module\Filesystem::amInPath()
*/
- public function amInPath(string $path): void {
- $this->getScenario()->runStep(new \Codeception\Step\Condition('amInPath', func_get_args()));
+ public function amInPath($path) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Condition('amInPath', func_get_args()));
}
@@ -8994,11 +9238,14 @@ public function amInPath(string $path): void {
* openFile('composer.json');
* $I->seeInThisFile('codeception/codeception');
+ * ?>
* ```
+ *
+ * @param string $filename
* @see \Codeception\Module\Filesystem::openFile()
*/
- public function openFile(string $filename): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('openFile', func_get_args()));
+ public function openFile($filename) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('openFile', func_get_args()));
}
@@ -9010,11 +9257,14 @@ public function openFile(string $filename): void {
* ``` php
* deleteFile('composer.lock');
+ * ?>
* ```
+ *
+ * @param string $filename
* @see \Codeception\Module\Filesystem::deleteFile()
*/
- public function deleteFile(string $filename): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('deleteFile', func_get_args()));
+ public function deleteFile($filename) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('deleteFile', func_get_args()));
}
@@ -9026,11 +9276,14 @@ public function deleteFile(string $filename): void {
* ``` php
* deleteDir('vendor');
+ * ?>
* ```
+ *
+ * @param string $dirname
* @see \Codeception\Module\Filesystem::deleteDir()
*/
- public function deleteDir(string $dirname): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('deleteDir', func_get_args()));
+ public function deleteDir($dirname) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('deleteDir', func_get_args()));
}
@@ -9042,11 +9295,15 @@ public function deleteDir(string $dirname): void {
* ``` php
* copyDir('vendor','old_vendor');
+ * ?>
* ```
+ *
+ * @param string $src
+ * @param string $dst
* @see \Codeception\Module\Filesystem::copyDir()
*/
- public function copyDir(string $src, string $dst): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('copyDir', func_get_args()));
+ public function copyDir($src, $dst) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('copyDir', func_get_args()));
}
@@ -9061,11 +9318,14 @@ public function copyDir(string $src, string $dst): void {
* openFile('composer.json');
* $I->seeInThisFile('codeception/codeception');
+ * ?>
* ```
+ *
+ * @param string $text
* @see \Codeception\Module\Filesystem::seeInThisFile()
*/
- public function seeInThisFile(string $text): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInThisFile', func_get_args()));
+ public function seeInThisFile($text) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInThisFile', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -9079,11 +9339,14 @@ public function seeInThisFile(string $text): void {
* openFile('composer.json');
* $I->seeInThisFile('codeception/codeception');
+ * ?>
* ```
+ *
+ * @param string $text
* @see \Codeception\Module\Filesystem::seeInThisFile()
*/
- public function canSeeInThisFile(string $text): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInThisFile', func_get_args()));
+ public function canSeeInThisFile($text) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInThisFile', func_get_args()));
}
@@ -9098,13 +9361,14 @@ public function canSeeInThisFile(string $text): void {
* openFile('composer.json');
* $I->seeNumberNewLines(5);
+ * ?>
* ```
*
* @param int $number New lines
* @see \Codeception\Module\Filesystem::seeNumberNewLines()
*/
- public function seeNumberNewLines(int $number): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumberNewLines', func_get_args()));
+ public function seeNumberNewLines($number) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumberNewLines', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -9118,13 +9382,14 @@ public function seeNumberNewLines(int $number): void {
* openFile('composer.json');
* $I->seeNumberNewLines(5);
+ * ?>
* ```
*
* @param int $number New lines
* @see \Codeception\Module\Filesystem::seeNumberNewLines()
*/
- public function canSeeNumberNewLines(int $number): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumberNewLines', func_get_args()));
+ public function canSeeNumberNewLines($number) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumberNewLines', func_get_args()));
}
@@ -9132,20 +9397,24 @@ public function canSeeNumberNewLines(int $number): void {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Checks that contents of currently opened file matches $regex
+ *
+ * @param string $regex
* @see \Codeception\Module\Filesystem::seeThisFileMatches()
*/
- public function seeThisFileMatches(string $regex): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeThisFileMatches', func_get_args()));
+ public function seeThisFileMatches($regex) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeThisFileMatches', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
* [!] Conditional Assertion: Test won't be stopped on fail
* Checks that contents of currently opened file matches $regex
+ *
+ * @param string $regex
* @see \Codeception\Module\Filesystem::seeThisFileMatches()
*/
- public function canSeeThisFileMatches(string $regex): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeThisFileMatches', func_get_args()));
+ public function canSeeThisFileMatches($regex) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeThisFileMatches', func_get_args()));
}
@@ -9161,11 +9430,14 @@ public function canSeeThisFileMatches(string $regex): void {
* openFile('process.pid');
* $I->seeFileContentsEqual('3192');
+ * ?>
* ```
+ *
+ * @param string $text
* @see \Codeception\Module\Filesystem::seeFileContentsEqual()
*/
- public function seeFileContentsEqual(string $text): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeFileContentsEqual', func_get_args()));
+ public function seeFileContentsEqual($text) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeFileContentsEqual', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -9180,11 +9452,14 @@ public function seeFileContentsEqual(string $text): void {
* openFile('process.pid');
* $I->seeFileContentsEqual('3192');
+ * ?>
* ```
+ *
+ * @param string $text
* @see \Codeception\Module\Filesystem::seeFileContentsEqual()
*/
- public function canSeeFileContentsEqual(string $text): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeFileContentsEqual', func_get_args()));
+ public function canSeeFileContentsEqual($text) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeFileContentsEqual', func_get_args()));
}
@@ -9197,11 +9472,14 @@ public function canSeeFileContentsEqual(string $text): void {
* openFile('composer.json');
* $I->dontSeeInThisFile('codeception/codeception');
+ * ?>
* ```
+ *
+ * @param string $text
* @see \Codeception\Module\Filesystem::dontSeeInThisFile()
*/
- public function dontSeeInThisFile(string $text): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInThisFile', func_get_args()));
+ public function dontSeeInThisFile($text) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInThisFile', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -9213,11 +9491,14 @@ public function dontSeeInThisFile(string $text): void {
* openFile('composer.json');
* $I->dontSeeInThisFile('codeception/codeception');
+ * ?>
* ```
+ *
+ * @param string $text
* @see \Codeception\Module\Filesystem::dontSeeInThisFile()
*/
- public function cantSeeInThisFile(string $text): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInThisFile', func_get_args()));
+ public function cantSeeInThisFile($text) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInThisFile', func_get_args()));
}
@@ -9227,8 +9508,8 @@ public function cantSeeInThisFile(string $text): void {
* Deletes a file
* @see \Codeception\Module\Filesystem::deleteThisFile()
*/
- public function deleteThisFile(): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('deleteThisFile', func_get_args()));
+ public function deleteThisFile() {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('deleteThisFile', func_get_args()));
}
@@ -9241,11 +9522,15 @@ public function deleteThisFile(): void {
* ``` php
* seeFileFound('UserModel.php','app/models');
+ * ?>
* ```
+ *
+ * @param string $filename
+ * @param string $path
* @see \Codeception\Module\Filesystem::seeFileFound()
*/
- public function seeFileFound(string $filename, string $path = ""): void {
- $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeFileFound', func_get_args()));
+ public function seeFileFound($filename, $path = "") {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeFileFound', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
@@ -9257,11 +9542,15 @@ public function seeFileFound(string $filename, string $path = ""): void {
* ``` php
* seeFileFound('UserModel.php','app/models');
+ * ?>
* ```
+ *
+ * @param string $filename
+ * @param string $path
* @see \Codeception\Module\Filesystem::seeFileFound()
*/
- public function canSeeFileFound(string $filename, string $path = ""): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeFileFound', func_get_args()));
+ public function canSeeFileFound($filename, $path = "") {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeFileFound', func_get_args()));
}
@@ -9269,20 +9558,26 @@ public function canSeeFileFound(string $filename, string $path = ""): void {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Checks if file does not exist in path
+ *
+ * @param string $filename
+ * @param string $path
* @see \Codeception\Module\Filesystem::dontSeeFileFound()
*/
- public function dontSeeFileFound(string $filename, string $path = ""): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeFileFound', func_get_args()));
+ public function dontSeeFileFound($filename, $path = "") {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeFileFound', func_get_args()));
}
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
* [!] Conditional Assertion: Test won't be stopped on fail
* Checks if file does not exist in path
+ *
+ * @param string $filename
+ * @param string $path
* @see \Codeception\Module\Filesystem::dontSeeFileFound()
*/
- public function cantSeeFileFound(string $filename, string $path = ""): void {
- $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeFileFound', func_get_args()));
+ public function cantSeeFileFound($filename, $path = "") {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeFileFound', func_get_args()));
}
@@ -9294,11 +9589,14 @@ public function cantSeeFileFound(string $filename, string $path = ""): void {
* ``` php
* cleanDir('logs');
+ * ?>
* ```
+ *
+ * @param string $dirname
* @see \Codeception\Module\Filesystem::cleanDir()
*/
- public function cleanDir(string $dirname): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('cleanDir', func_get_args()));
+ public function cleanDir($dirname) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('cleanDir', func_get_args()));
}
@@ -9306,10 +9604,13 @@ public function cleanDir(string $dirname): void {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Saves contents to file
+ *
+ * @param string $filename
+ * @param string $contents
* @see \Codeception\Module\Filesystem::writeToFile()
*/
- public function writeToFile(string $filename, string $contents): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('writeToFile', func_get_args()));
+ public function writeToFile($filename, $contents) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('writeToFile', func_get_args()));
}
@@ -9328,6 +9629,41 @@ public function reconfigureWPDb(array $configurationOverrides): void {
}
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Handles and checks exception called inside callback function.
+ * Either exception class name or exception instance should be provided.
+ *
+ * ```php
+ * expectException(MyException::class, function() {
+ * $this->doSomethingBad();
+ * });
+ *
+ * $I->expectException(new MyException(), function() {
+ * $this->doSomethingBad();
+ * });
+ * ```
+ * If you want to check message or exception code, you can pass them with exception instance:
+ * ```php
+ * expectException(new MyException("Don't do bad things"), function() {
+ * $this->doSomethingBad();
+ * });
+ * ```
+ *
+ * @deprecated Use expectThrowable() instead
+ * @param \Exception|string $exception
+ * @param callable $callback
+ * @see \Codeception\Module\Asserts::expectException()
+ */
+ public function expectException($exception, $callback) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('expectException', func_get_args()));
+ }
+
+
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
@@ -9354,10 +9690,11 @@ public function reconfigureWPDb(array $configurationOverrides): void {
* ```
*
* @param \Throwable|string $throwable
+ * @param callable $callback
* @see \Codeception\Module\Asserts::expectThrowable()
*/
- public function expectThrowable($throwable, callable $callback): void {
- $this->getScenario()->runStep(new \Codeception\Step\Action('expectThrowable', func_get_args()));
+ public function expectThrowable($throwable, $callback) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('expectThrowable', func_get_args()));
}
@@ -9365,9 +9702,12 @@ public function expectThrowable($throwable, callable $callback): void {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a file does not exist.
+ *
+ * @param string $filename
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileNotExists()
*/
- public function assertFileNotExists(string $filename, string $message = "") {
+ public function assertFileNotExists($filename, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileNotExists', func_get_args()));
}
@@ -9377,11 +9717,12 @@ public function assertFileNotExists(string $filename, string $message = "") {
*
* Asserts that a value is greater than or equal to another value.
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertGreaterOrEquals()
*/
- public function assertGreaterOrEquals($expected, $actual, string $message = "") {
+ public function assertGreaterOrEquals($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertGreaterOrEquals', func_get_args()));
}
@@ -9391,10 +9732,11 @@ public function assertGreaterOrEquals($expected, $actual, string $message = "")
*
* Asserts that a variable is empty.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsEmpty()
*/
- public function assertIsEmpty($actual, string $message = "") {
+ public function assertIsEmpty($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsEmpty', func_get_args()));
}
@@ -9404,11 +9746,12 @@ public function assertIsEmpty($actual, string $message = "") {
*
* Asserts that a value is smaller than or equal to another value.
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertLessOrEquals()
*/
- public function assertLessOrEquals($expected, $actual, string $message = "") {
+ public function assertLessOrEquals($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertLessOrEquals', func_get_args()));
}
@@ -9417,9 +9760,13 @@ public function assertLessOrEquals($expected, $actual, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string does not match a given regular expression.
+ *
+ * @param string $pattern
+ * @param string $string
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotRegExp()
*/
- public function assertNotRegExp(string $pattern, string $string, string $message = "") {
+ public function assertNotRegExp($pattern, $string, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotRegExp', func_get_args()));
}
@@ -9428,9 +9775,13 @@ public function assertNotRegExp(string $pattern, string $string, string $message
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string matches a given regular expression.
+ *
+ * @param string $pattern
+ * @param string $string
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertRegExp()
*/
- public function assertRegExp(string $pattern, string $string, string $message = "") {
+ public function assertRegExp($pattern, $string, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertRegExp', func_get_args()));
}
@@ -9440,10 +9791,12 @@ public function assertRegExp(string $pattern, string $string, string $message =
*
* Evaluates a PHPUnit\Framework\Constraint matcher object.
*
- * @param mixed $value
+ * @param $value
+ * @param Constraint $constraint
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertThatItsNot()
*/
- public function assertThatItsNot($value, \PHPUnit\Framework\Constraint\Constraint $constraint, string $message = "") {
+ public function assertThatItsNot($value, $constraint, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertThatItsNot', func_get_args()));
}
@@ -9454,10 +9807,11 @@ public function assertThatItsNot($value, \PHPUnit\Framework\Constraint\Constrain
* Asserts that an array has a specified key.
*
* @param int|string $key
- * @param array|\ArrayAccess $array
+ * @param array|ArrayAccess $array
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertArrayHasKey()
*/
- public function assertArrayHasKey($key, $array, string $message = "") {
+ public function assertArrayHasKey($key, $array, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertArrayHasKey', func_get_args()));
}
@@ -9468,10 +9822,11 @@ public function assertArrayHasKey($key, $array, string $message = "") {
* Asserts that an array does not have a specified key.
*
* @param int|string $key
- * @param array|\ArrayAccess $array
+ * @param array|ArrayAccess $array
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertArrayNotHasKey()
*/
- public function assertArrayNotHasKey($key, $array, string $message = "") {
+ public function assertArrayNotHasKey($key, $array, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertArrayNotHasKey', func_get_args()));
}
@@ -9480,9 +9835,13 @@ public function assertArrayNotHasKey($key, $array, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a class has a specified attribute.
+ *
+ * @param string $attributeName
+ * @param string $className
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertClassHasAttribute()
*/
- public function assertClassHasAttribute(string $attributeName, string $className, string $message = "") {
+ public function assertClassHasAttribute($attributeName, $className, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertClassHasAttribute', func_get_args()));
}
@@ -9491,9 +9850,13 @@ public function assertClassHasAttribute(string $attributeName, string $className
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a class has a specified static attribute.
+ *
+ * @param string $attributeName
+ * @param string $className
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertClassHasStaticAttribute()
*/
- public function assertClassHasStaticAttribute(string $attributeName, string $className, string $message = "") {
+ public function assertClassHasStaticAttribute($attributeName, $className, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertClassHasStaticAttribute', func_get_args()));
}
@@ -9502,9 +9865,13 @@ public function assertClassHasStaticAttribute(string $attributeName, string $cla
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a class does not have a specified attribute.
+ *
+ * @param string $attributeName
+ * @param string $className
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertClassNotHasAttribute()
*/
- public function assertClassNotHasAttribute(string $attributeName, string $className, string $message = "") {
+ public function assertClassNotHasAttribute($attributeName, $className, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertClassNotHasAttribute', func_get_args()));
}
@@ -9513,9 +9880,13 @@ public function assertClassNotHasAttribute(string $attributeName, string $classN
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a class does not have a specified static attribute.
+ *
+ * @param string $attributeName
+ * @param string $className
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertClassNotHasStaticAttribute()
*/
- public function assertClassNotHasStaticAttribute(string $attributeName, string $className, string $message = "") {
+ public function assertClassNotHasStaticAttribute($attributeName, $className, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertClassNotHasStaticAttribute', func_get_args()));
}
@@ -9525,10 +9896,12 @@ public function assertClassNotHasStaticAttribute(string $attributeName, string $
*
* Asserts that a haystack contains a needle.
*
- * @param mixed $needle
+ * @param $needle
+ * @param $haystack
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertContains()
*/
- public function assertContains($needle, iterable $haystack, string $message = "") {
+ public function assertContains($needle, $haystack, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertContains', func_get_args()));
}
@@ -9536,10 +9909,12 @@ public function assertContains($needle, iterable $haystack, string $message = ""
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * @param mixed $needle
+ * @param $needle
+ * @param $haystack
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertContainsEquals()
*/
- public function assertContainsEquals($needle, iterable $haystack, string $message = "") {
+ public function assertContainsEquals($needle, $haystack, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertContainsEquals', func_get_args()));
}
@@ -9548,9 +9923,14 @@ public function assertContainsEquals($needle, iterable $haystack, string $messag
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a haystack contains only values of a given type.
+ *
+ * @param string $type
+ * @param $haystack
+ * @param bool|null $isNativeType
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertContainsOnly()
*/
- public function assertContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = NULL, string $message = "") {
+ public function assertContainsOnly($type, $haystack, $isNativeType = NULL, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertContainsOnly', func_get_args()));
}
@@ -9559,9 +9939,13 @@ public function assertContainsOnly(string $type, iterable $haystack, ?bool $isNa
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a haystack contains only instances of a given class name.
+ *
+ * @param string $className
+ * @param $haystack
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertContainsOnlyInstancesOf()
*/
- public function assertContainsOnlyInstancesOf(string $className, iterable $haystack, string $message = "") {
+ public function assertContainsOnlyInstancesOf($className, $haystack, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertContainsOnlyInstancesOf', func_get_args()));
}
@@ -9571,10 +9955,12 @@ public function assertContainsOnlyInstancesOf(string $className, iterable $hayst
*
* Asserts the number of elements of an array, Countable or Traversable.
*
- * @param \Countable|iterable $haystack
+ * @param int $expectedCount
+ * @param Countable|iterable $haystack
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertCount()
*/
- public function assertCount(int $expectedCount, $haystack, string $message = "") {
+ public function assertCount($expectedCount, $haystack, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertCount', func_get_args()));
}
@@ -9583,9 +9969,12 @@ public function assertCount(int $expectedCount, $haystack, string $message = "")
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a directory does not exist.
+ *
+ * @param string $directory
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertDirectoryDoesNotExist()
*/
- public function assertDirectoryDoesNotExist(string $directory, string $message = "") {
+ public function assertDirectoryDoesNotExist($directory, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDirectoryDoesNotExist', func_get_args()));
}
@@ -9594,9 +9983,12 @@ public function assertDirectoryDoesNotExist(string $directory, string $message =
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a directory exists and is not readable.
+ *
+ * @param string $directory
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertDirectoryIsNotReadable()
*/
- public function assertDirectoryIsNotReadable(string $directory, string $message = "") {
+ public function assertDirectoryIsNotReadable($directory, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDirectoryIsNotReadable', func_get_args()));
}
@@ -9605,9 +9997,12 @@ public function assertDirectoryIsNotReadable(string $directory, string $message
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a directory exists and is not writable.
+ *
+ * @param string $directory
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertDirectoryIsNotWritable()
*/
- public function assertDirectoryIsNotWritable(string $directory, string $message = "") {
+ public function assertDirectoryIsNotWritable($directory, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDirectoryIsNotWritable', func_get_args()));
}
@@ -9616,9 +10011,12 @@ public function assertDirectoryIsNotWritable(string $directory, string $message
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a directory exists and is readable.
+ *
+ * @param string $directory
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertDirectoryIsReadable()
*/
- public function assertDirectoryIsReadable(string $directory, string $message = "") {
+ public function assertDirectoryIsReadable($directory, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDirectoryIsReadable', func_get_args()));
}
@@ -9627,9 +10025,12 @@ public function assertDirectoryIsReadable(string $directory, string $message = "
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a directory exists and is writable.
+ *
+ * @param string $directory
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertDirectoryIsWritable()
*/
- public function assertDirectoryIsWritable(string $directory, string $message = "") {
+ public function assertDirectoryIsWritable($directory, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDirectoryIsWritable', func_get_args()));
}
@@ -9638,9 +10039,13 @@ public function assertDirectoryIsWritable(string $directory, string $message = "
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string does not match a given regular expression.
+ *
+ * @param string $pattern
+ * @param string $string
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertDoesNotMatchRegularExpression()
*/
- public function assertDoesNotMatchRegularExpression(string $pattern, string $string, string $message = "") {
+ public function assertDoesNotMatchRegularExpression($pattern, $string, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDoesNotMatchRegularExpression', func_get_args()));
}
@@ -9650,10 +10055,11 @@ public function assertDoesNotMatchRegularExpression(string $pattern, string $str
*
* Asserts that a variable is empty.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertEmpty()
*/
- public function assertEmpty($actual, string $message = "") {
+ public function assertEmpty($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertEmpty', func_get_args()));
}
@@ -9663,11 +10069,12 @@ public function assertEmpty($actual, string $message = "") {
*
* Asserts that two variables are equal.
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertEquals()
*/
- public function assertEquals($expected, $actual, string $message = "") {
+ public function assertEquals($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertEquals', func_get_args()));
}
@@ -9677,11 +10084,12 @@ public function assertEquals($expected, $actual, string $message = "") {
*
* Asserts that two variables are equal (canonicalizing).
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertEqualsCanonicalizing()
*/
- public function assertEqualsCanonicalizing($expected, $actual, string $message = "") {
+ public function assertEqualsCanonicalizing($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertEqualsCanonicalizing', func_get_args()));
}
@@ -9691,11 +10099,12 @@ public function assertEqualsCanonicalizing($expected, $actual, string $message =
*
* Asserts that two variables are equal (ignoring case).
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertEqualsIgnoringCase()
*/
- public function assertEqualsIgnoringCase($expected, $actual, string $message = "") {
+ public function assertEqualsIgnoringCase($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertEqualsIgnoringCase', func_get_args()));
}
@@ -9705,11 +10114,13 @@ public function assertEqualsIgnoringCase($expected, $actual, string $message = "
*
* Asserts that two variables are equal (with delta).
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param float $delta
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertEqualsWithDelta()
*/
- public function assertEqualsWithDelta($expected, $actual, float $delta, string $message = "") {
+ public function assertEqualsWithDelta($expected, $actual, $delta, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertEqualsWithDelta', func_get_args()));
}
@@ -9719,10 +10130,11 @@ public function assertEqualsWithDelta($expected, $actual, float $delta, string $
*
* Asserts that a condition is false.
*
- * @param mixed $condition
+ * @param $condition
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFalse()
*/
- public function assertFalse($condition, string $message = "") {
+ public function assertFalse($condition, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFalse', func_get_args()));
}
@@ -9731,9 +10143,12 @@ public function assertFalse($condition, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a file does not exist.
+ *
+ * @param string $filename
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileDoesNotExist()
*/
- public function assertFileDoesNotExist(string $filename, string $message = "") {
+ public function assertFileDoesNotExist($filename, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileDoesNotExist', func_get_args()));
}
@@ -9742,9 +10157,13 @@ public function assertFileDoesNotExist(string $filename, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the contents of one file is equal to the contents of another file.
+ *
+ * @param string $expected
+ * @param string $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileEquals()
*/
- public function assertFileEquals(string $expected, string $actual, string $message = "") {
+ public function assertFileEquals($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileEquals', func_get_args()));
}
@@ -9753,9 +10172,13 @@ public function assertFileEquals(string $expected, string $actual, string $messa
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the contents of one file is equal to the contents of another file (canonicalizing).
+ *
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileEqualsCanonicalizing()
*/
- public function assertFileEqualsCanonicalizing(string $expected, string $actual, string $message = "") {
+ public function assertFileEqualsCanonicalizing($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileEqualsCanonicalizing', func_get_args()));
}
@@ -9764,9 +10187,13 @@ public function assertFileEqualsCanonicalizing(string $expected, string $actual,
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the contents of one file is equal to the contents of another file (ignoring case).
+ *
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileEqualsIgnoringCase()
*/
- public function assertFileEqualsIgnoringCase(string $expected, string $actual, string $message = "") {
+ public function assertFileEqualsIgnoringCase($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileEqualsIgnoringCase', func_get_args()));
}
@@ -9775,9 +10202,12 @@ public function assertFileEqualsIgnoringCase(string $expected, string $actual, s
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a file exists.
+ *
+ * @param string $filename
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileExists()
*/
- public function assertFileExists(string $filename, string $message = "") {
+ public function assertFileExists($filename, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileExists', func_get_args()));
}
@@ -9786,9 +10216,12 @@ public function assertFileExists(string $filename, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a file exists and is not readable.
+ *
+ * @param string $file
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileIsNotReadable()
*/
- public function assertFileIsNotReadable(string $file, string $message = "") {
+ public function assertFileIsNotReadable($file, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileIsNotReadable', func_get_args()));
}
@@ -9797,9 +10230,12 @@ public function assertFileIsNotReadable(string $file, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a file exists and is not writable.
+ *
+ * @param string $file
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileIsNotWritable()
*/
- public function assertFileIsNotWritable(string $file, string $message = "") {
+ public function assertFileIsNotWritable($file, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileIsNotWritable', func_get_args()));
}
@@ -9808,9 +10244,12 @@ public function assertFileIsNotWritable(string $file, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a file exists and is readable.
+ *
+ * @param string $file
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileIsReadable()
*/
- public function assertFileIsReadable(string $file, string $message = "") {
+ public function assertFileIsReadable($file, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileIsReadable', func_get_args()));
}
@@ -9819,9 +10258,12 @@ public function assertFileIsReadable(string $file, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a file exists and is writable.
+ *
+ * @param string $file
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileIsWritable()
*/
- public function assertFileIsWritable(string $file, string $message = "") {
+ public function assertFileIsWritable($file, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileIsWritable', func_get_args()));
}
@@ -9830,9 +10272,13 @@ public function assertFileIsWritable(string $file, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the contents of one file is not equal to the contents of another file.
+ *
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileNotEquals()
*/
- public function assertFileNotEquals(string $expected, string $actual, string $message = "") {
+ public function assertFileNotEquals($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileNotEquals', func_get_args()));
}
@@ -9841,9 +10287,13 @@ public function assertFileNotEquals(string $expected, string $actual, string $me
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).
+ *
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileNotEqualsCanonicalizing()
*/
- public function assertFileNotEqualsCanonicalizing(string $expected, string $actual, string $message = "") {
+ public function assertFileNotEqualsCanonicalizing($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileNotEqualsCanonicalizing', func_get_args()));
}
@@ -9852,9 +10302,13 @@ public function assertFileNotEqualsCanonicalizing(string $expected, string $actu
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the contents of one file is not equal to the contents of another file (ignoring case).
+ *
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFileNotEqualsIgnoringCase()
*/
- public function assertFileNotEqualsIgnoringCase(string $expected, string $actual, string $message = "") {
+ public function assertFileNotEqualsIgnoringCase($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileNotEqualsIgnoringCase', func_get_args()));
}
@@ -9864,10 +10318,11 @@ public function assertFileNotEqualsIgnoringCase(string $expected, string $actual
*
* Asserts that a variable is finite.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertFinite()
*/
- public function assertFinite($actual, string $message = "") {
+ public function assertFinite($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFinite', func_get_args()));
}
@@ -9877,11 +10332,12 @@ public function assertFinite($actual, string $message = "") {
*
* Asserts that a value is greater than another value.
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertGreaterThan()
*/
- public function assertGreaterThan($expected, $actual, string $message = "") {
+ public function assertGreaterThan($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertGreaterThan', func_get_args()));
}
@@ -9891,11 +10347,12 @@ public function assertGreaterThan($expected, $actual, string $message = "") {
*
* Asserts that a value is greater than or equal to another value.
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertGreaterThanOrEqual()
*/
- public function assertGreaterThanOrEqual($expected, $actual, string $message = "") {
+ public function assertGreaterThanOrEqual($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertGreaterThanOrEqual', func_get_args()));
}
@@ -9905,10 +10362,11 @@ public function assertGreaterThanOrEqual($expected, $actual, string $message = "
*
* Asserts that a variable is infinite.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertInfinite()
*/
- public function assertInfinite($actual, string $message = "") {
+ public function assertInfinite($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertInfinite', func_get_args()));
}
@@ -9918,10 +10376,12 @@ public function assertInfinite($actual, string $message = "") {
*
* Asserts that a variable is of a given type.
*
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertInstanceOf()
*/
- public function assertInstanceOf(string $expected, $actual, string $message = "") {
+ public function assertInstanceOf($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertInstanceOf', func_get_args()));
}
@@ -9931,10 +10391,11 @@ public function assertInstanceOf(string $expected, $actual, string $message = ""
*
* Asserts that a variable is of type array.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsArray()
*/
- public function assertIsArray($actual, string $message = "") {
+ public function assertIsArray($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsArray', func_get_args()));
}
@@ -9944,10 +10405,11 @@ public function assertIsArray($actual, string $message = "") {
*
* Asserts that a variable is of type bool.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsBool()
*/
- public function assertIsBool($actual, string $message = "") {
+ public function assertIsBool($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsBool', func_get_args()));
}
@@ -9957,10 +10419,11 @@ public function assertIsBool($actual, string $message = "") {
*
* Asserts that a variable is of type callable.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsCallable()
*/
- public function assertIsCallable($actual, string $message = "") {
+ public function assertIsCallable($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsCallable', func_get_args()));
}
@@ -9970,10 +10433,11 @@ public function assertIsCallable($actual, string $message = "") {
*
* Asserts that a variable is of type resource and is closed.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsClosedResource()
*/
- public function assertIsClosedResource($actual, string $message = "") {
+ public function assertIsClosedResource($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsClosedResource', func_get_args()));
}
@@ -9983,10 +10447,11 @@ public function assertIsClosedResource($actual, string $message = "") {
*
* Asserts that a variable is of type float.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsFloat()
*/
- public function assertIsFloat($actual, string $message = "") {
+ public function assertIsFloat($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsFloat', func_get_args()));
}
@@ -9996,10 +10461,11 @@ public function assertIsFloat($actual, string $message = "") {
*
* Asserts that a variable is of type int.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsInt()
*/
- public function assertIsInt($actual, string $message = "") {
+ public function assertIsInt($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsInt', func_get_args()));
}
@@ -10009,10 +10475,11 @@ public function assertIsInt($actual, string $message = "") {
*
* Asserts that a variable is of type iterable.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsIterable()
*/
- public function assertIsIterable($actual, string $message = "") {
+ public function assertIsIterable($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsIterable', func_get_args()));
}
@@ -10022,10 +10489,11 @@ public function assertIsIterable($actual, string $message = "") {
*
* Asserts that a variable is not of type array.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotArray()
*/
- public function assertIsNotArray($actual, string $message = "") {
+ public function assertIsNotArray($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotArray', func_get_args()));
}
@@ -10035,10 +10503,11 @@ public function assertIsNotArray($actual, string $message = "") {
*
* Asserts that a variable is not of type bool.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotBool()
*/
- public function assertIsNotBool($actual, string $message = "") {
+ public function assertIsNotBool($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotBool', func_get_args()));
}
@@ -10048,10 +10517,11 @@ public function assertIsNotBool($actual, string $message = "") {
*
* Asserts that a variable is not of type callable.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotCallable()
*/
- public function assertIsNotCallable($actual, string $message = "") {
+ public function assertIsNotCallable($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotCallable', func_get_args()));
}
@@ -10061,10 +10531,11 @@ public function assertIsNotCallable($actual, string $message = "") {
*
* Asserts that a variable is not of type resource.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotClosedResource()
*/
- public function assertIsNotClosedResource($actual, string $message = "") {
+ public function assertIsNotClosedResource($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotClosedResource', func_get_args()));
}
@@ -10074,10 +10545,11 @@ public function assertIsNotClosedResource($actual, string $message = "") {
*
* Asserts that a variable is not of type float.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotFloat()
*/
- public function assertIsNotFloat($actual, string $message = "") {
+ public function assertIsNotFloat($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotFloat', func_get_args()));
}
@@ -10087,10 +10559,11 @@ public function assertIsNotFloat($actual, string $message = "") {
*
* Asserts that a variable is not of type int.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotInt()
*/
- public function assertIsNotInt($actual, string $message = "") {
+ public function assertIsNotInt($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotInt', func_get_args()));
}
@@ -10100,10 +10573,11 @@ public function assertIsNotInt($actual, string $message = "") {
*
* Asserts that a variable is not of type iterable.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotIterable()
*/
- public function assertIsNotIterable($actual, string $message = "") {
+ public function assertIsNotIterable($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotIterable', func_get_args()));
}
@@ -10113,10 +10587,11 @@ public function assertIsNotIterable($actual, string $message = "") {
*
* Asserts that a variable is not of type numeric.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotNumeric()
*/
- public function assertIsNotNumeric($actual, string $message = "") {
+ public function assertIsNotNumeric($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotNumeric', func_get_args()));
}
@@ -10126,10 +10601,11 @@ public function assertIsNotNumeric($actual, string $message = "") {
*
* Asserts that a variable is not of type object.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotObject()
*/
- public function assertIsNotObject($actual, string $message = "") {
+ public function assertIsNotObject($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotObject', func_get_args()));
}
@@ -10138,9 +10614,12 @@ public function assertIsNotObject($actual, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a file/dir exists and is not readable.
+ *
+ * @param string $filename
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotReadable()
*/
- public function assertIsNotReadable(string $filename, string $message = "") {
+ public function assertIsNotReadable($filename, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotReadable', func_get_args()));
}
@@ -10150,10 +10629,11 @@ public function assertIsNotReadable(string $filename, string $message = "") {
*
* Asserts that a variable is not of type resource.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotResource()
*/
- public function assertIsNotResource($actual, string $message = "") {
+ public function assertIsNotResource($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotResource', func_get_args()));
}
@@ -10163,10 +10643,11 @@ public function assertIsNotResource($actual, string $message = "") {
*
* Asserts that a variable is not of type scalar.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotScalar()
*/
- public function assertIsNotScalar($actual, string $message = "") {
+ public function assertIsNotScalar($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotScalar', func_get_args()));
}
@@ -10176,10 +10657,11 @@ public function assertIsNotScalar($actual, string $message = "") {
*
* Asserts that a variable is not of type string.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotString()
*/
- public function assertIsNotString($actual, string $message = "") {
+ public function assertIsNotString($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotString', func_get_args()));
}
@@ -10188,9 +10670,12 @@ public function assertIsNotString($actual, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a file/dir exists and is not writable.
+ *
+ * @param $filename
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNotWritable()
*/
- public function assertIsNotWritable(string $filename, string $message = "") {
+ public function assertIsNotWritable($filename, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotWritable', func_get_args()));
}
@@ -10200,10 +10685,11 @@ public function assertIsNotWritable(string $filename, string $message = "") {
*
* Asserts that a variable is of type numeric.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsNumeric()
*/
- public function assertIsNumeric($actual, string $message = "") {
+ public function assertIsNumeric($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNumeric', func_get_args()));
}
@@ -10213,10 +10699,11 @@ public function assertIsNumeric($actual, string $message = "") {
*
* Asserts that a variable is of type object.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsObject()
*/
- public function assertIsObject($actual, string $message = "") {
+ public function assertIsObject($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsObject', func_get_args()));
}
@@ -10225,9 +10712,12 @@ public function assertIsObject($actual, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a file/dir is readable.
+ *
+ * @param $filename
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsReadable()
*/
- public function assertIsReadable(string $filename, string $message = "") {
+ public function assertIsReadable($filename, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsReadable', func_get_args()));
}
@@ -10237,10 +10727,11 @@ public function assertIsReadable(string $filename, string $message = "") {
*
* Asserts that a variable is of type resource.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsResource()
*/
- public function assertIsResource($actual, string $message = "") {
+ public function assertIsResource($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsResource', func_get_args()));
}
@@ -10250,10 +10741,11 @@ public function assertIsResource($actual, string $message = "") {
*
* Asserts that a variable is of type scalar.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsScalar()
*/
- public function assertIsScalar($actual, string $message = "") {
+ public function assertIsScalar($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsScalar', func_get_args()));
}
@@ -10263,10 +10755,11 @@ public function assertIsScalar($actual, string $message = "") {
*
* Asserts that a variable is of type string.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsString()
*/
- public function assertIsString($actual, string $message = "") {
+ public function assertIsString($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsString', func_get_args()));
}
@@ -10275,9 +10768,12 @@ public function assertIsString($actual, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a file/dir exists and is writable.
+ *
+ * @param $filename
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertIsWritable()
*/
- public function assertIsWritable(string $filename, string $message = "") {
+ public function assertIsWritable($filename, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsWritable', func_get_args()));
}
@@ -10286,9 +10782,12 @@ public function assertIsWritable(string $filename, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string is a valid JSON string.
+ *
+ * @param string $actualJson
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertJson()
*/
- public function assertJson(string $actualJson, string $message = "") {
+ public function assertJson($actualJson, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJson', func_get_args()));
}
@@ -10297,9 +10796,13 @@ public function assertJson(string $actualJson, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that two JSON files are equal.
+ *
+ * @param string $expectedFile
+ * @param string $actualFile
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertJsonFileEqualsJsonFile()
*/
- public function assertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile, string $message = "") {
+ public function assertJsonFileEqualsJsonFile($expectedFile, $actualFile, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJsonFileEqualsJsonFile', func_get_args()));
}
@@ -10308,9 +10811,13 @@ public function assertJsonFileEqualsJsonFile(string $expectedFile, string $actua
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that two JSON files are not equal.
+ *
+ * @param string $expectedFile
+ * @param string $actualFile
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertJsonFileNotEqualsJsonFile()
*/
- public function assertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile, string $message = "") {
+ public function assertJsonFileNotEqualsJsonFile($expectedFile, $actualFile, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJsonFileNotEqualsJsonFile', func_get_args()));
}
@@ -10319,9 +10826,13 @@ public function assertJsonFileNotEqualsJsonFile(string $expectedFile, string $ac
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the generated JSON encoded object and the content of the given file are equal.
+ *
+ * @param string $expectedFile
+ * @param string $actualJson
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertJsonStringEqualsJsonFile()
*/
- public function assertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson, string $message = "") {
+ public function assertJsonStringEqualsJsonFile($expectedFile, $actualJson, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJsonStringEqualsJsonFile', func_get_args()));
}
@@ -10330,9 +10841,13 @@ public function assertJsonStringEqualsJsonFile(string $expectedFile, string $act
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that two given JSON encoded objects or arrays are equal.
+ *
+ * @param string $expectedJson
+ * @param string $actualJson
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertJsonStringEqualsJsonString()
*/
- public function assertJsonStringEqualsJsonString(string $expectedJson, string $actualJson, string $message = "") {
+ public function assertJsonStringEqualsJsonString($expectedJson, $actualJson, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJsonStringEqualsJsonString', func_get_args()));
}
@@ -10341,9 +10856,13 @@ public function assertJsonStringEqualsJsonString(string $expectedJson, string $a
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the generated JSON encoded object and the content of the given file are not equal.
+ *
+ * @param string $expectedFile
+ * @param string $actualJson
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertJsonStringNotEqualsJsonFile()
*/
- public function assertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson, string $message = "") {
+ public function assertJsonStringNotEqualsJsonFile($expectedFile, $actualJson, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJsonStringNotEqualsJsonFile', func_get_args()));
}
@@ -10352,9 +10871,13 @@ public function assertJsonStringNotEqualsJsonFile(string $expectedFile, string $
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that two given JSON encoded objects or arrays are not equal.
+ *
+ * @param string $expectedJson
+ * @param string $actualJson
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertJsonStringNotEqualsJsonString()
*/
- public function assertJsonStringNotEqualsJsonString(string $expectedJson, string $actualJson, string $message = "") {
+ public function assertJsonStringNotEqualsJsonString($expectedJson, $actualJson, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJsonStringNotEqualsJsonString', func_get_args()));
}
@@ -10364,11 +10887,12 @@ public function assertJsonStringNotEqualsJsonString(string $expectedJson, string
*
* Asserts that a value is smaller than another value.
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertLessThan()
*/
- public function assertLessThan($expected, $actual, string $message = "") {
+ public function assertLessThan($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertLessThan', func_get_args()));
}
@@ -10378,11 +10902,12 @@ public function assertLessThan($expected, $actual, string $message = "") {
*
* Asserts that a value is smaller than or equal to another value.
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertLessThanOrEqual()
*/
- public function assertLessThanOrEqual($expected, $actual, string $message = "") {
+ public function assertLessThanOrEqual($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertLessThanOrEqual', func_get_args()));
}
@@ -10391,9 +10916,13 @@ public function assertLessThanOrEqual($expected, $actual, string $message = "")
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string matches a given regular expression.
+ *
+ * @param string $pattern
+ * @param string $string
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertMatchesRegularExpression()
*/
- public function assertMatchesRegularExpression(string $pattern, string $string, string $message = "") {
+ public function assertMatchesRegularExpression($pattern, $string, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertMatchesRegularExpression', func_get_args()));
}
@@ -10403,10 +10932,11 @@ public function assertMatchesRegularExpression(string $pattern, string $string,
*
* Asserts that a variable is nan.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNan()
*/
- public function assertNan($actual, string $message = "") {
+ public function assertNan($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNan', func_get_args()));
}
@@ -10416,10 +10946,12 @@ public function assertNan($actual, string $message = "") {
*
* Asserts that a haystack does not contain a needle.
*
- * @param mixed $needle
+ * @param $needle
+ * @param $haystack
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotContains()
*/
- public function assertNotContains($needle, iterable $haystack, string $message = "") {
+ public function assertNotContains($needle, $haystack, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotContains', func_get_args()));
}
@@ -10430,7 +10962,7 @@ public function assertNotContains($needle, iterable $haystack, string $message =
*
* @see \Codeception\Module\AbstractAsserts::assertNotContainsEquals()
*/
- public function assertNotContainsEquals($needle, iterable $haystack, string $message = "") {
+ public function assertNotContainsEquals($needle, $haystack, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotContainsEquals', func_get_args()));
}
@@ -10439,9 +10971,14 @@ public function assertNotContainsEquals($needle, iterable $haystack, string $mes
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a haystack does not contain only values of a given type.
+ *
+ * @param string $type
+ * @param $haystack
+ * @param bool|null $isNativeType
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotContainsOnly()
*/
- public function assertNotContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = NULL, string $message = "") {
+ public function assertNotContainsOnly($type, $haystack, $isNativeType = NULL, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotContainsOnly', func_get_args()));
}
@@ -10451,10 +10988,12 @@ public function assertNotContainsOnly(string $type, iterable $haystack, ?bool $i
*
* Asserts the number of elements of an array, Countable or Traversable.
*
- * @param \Countable|iterable $haystack
+ * @param int $expectedCount
+ * @param Countable|iterable $haystack
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotCount()
*/
- public function assertNotCount(int $expectedCount, $haystack, string $message = "") {
+ public function assertNotCount($expectedCount, $haystack, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotCount', func_get_args()));
}
@@ -10464,10 +11003,11 @@ public function assertNotCount(int $expectedCount, $haystack, string $message =
*
* Asserts that a variable is not empty.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotEmpty()
*/
- public function assertNotEmpty($actual, string $message = "") {
+ public function assertNotEmpty($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotEmpty', func_get_args()));
}
@@ -10477,11 +11017,12 @@ public function assertNotEmpty($actual, string $message = "") {
*
* Asserts that two variables are not equal.
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotEquals()
*/
- public function assertNotEquals($expected, $actual, string $message = "") {
+ public function assertNotEquals($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotEquals', func_get_args()));
}
@@ -10491,11 +11032,12 @@ public function assertNotEquals($expected, $actual, string $message = "") {
*
* Asserts that two variables are not equal (canonicalizing).
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotEqualsCanonicalizing()
*/
- public function assertNotEqualsCanonicalizing($expected, $actual, string $message = "") {
+ public function assertNotEqualsCanonicalizing($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotEqualsCanonicalizing', func_get_args()));
}
@@ -10505,11 +11047,12 @@ public function assertNotEqualsCanonicalizing($expected, $actual, string $messag
*
* Asserts that two variables are not equal (ignoring case).
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotEqualsIgnoringCase()
*/
- public function assertNotEqualsIgnoringCase($expected, $actual, string $message = "") {
+ public function assertNotEqualsIgnoringCase($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotEqualsIgnoringCase', func_get_args()));
}
@@ -10519,11 +11062,13 @@ public function assertNotEqualsIgnoringCase($expected, $actual, string $message
*
* Asserts that two variables are not equal (with delta).
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param float $delta
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotEqualsWithDelta()
*/
- public function assertNotEqualsWithDelta($expected, $actual, float $delta, string $message = "") {
+ public function assertNotEqualsWithDelta($expected, $actual, $delta, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotEqualsWithDelta', func_get_args()));
}
@@ -10533,10 +11078,11 @@ public function assertNotEqualsWithDelta($expected, $actual, float $delta, strin
*
* Asserts that a condition is not false.
*
- * @param mixed $condition
+ * @param $condition
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotFalse()
*/
- public function assertNotFalse($condition, string $message = "") {
+ public function assertNotFalse($condition, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotFalse', func_get_args()));
}
@@ -10546,10 +11092,12 @@ public function assertNotFalse($condition, string $message = "") {
*
* Asserts that a variable is not of a given type.
*
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotInstanceOf()
*/
- public function assertNotInstanceOf(string $expected, $actual, string $message = "") {
+ public function assertNotInstanceOf($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotInstanceOf', func_get_args()));
}
@@ -10559,10 +11107,11 @@ public function assertNotInstanceOf(string $expected, $actual, string $message =
*
* Asserts that a variable is not null.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotNull()
*/
- public function assertNotNull($actual, string $message = "") {
+ public function assertNotNull($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotNull', func_get_args()));
}
@@ -10572,11 +11121,12 @@ public function assertNotNull($actual, string $message = "") {
*
* Asserts that two variables do not have the same type and value.
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotSame()
*/
- public function assertNotSame($expected, $actual, string $message = "") {
+ public function assertNotSame($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotSame', func_get_args()));
}
@@ -10586,11 +11136,12 @@ public function assertNotSame($expected, $actual, string $message = "") {
*
* Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same.
*
- * @param \Countable|iterable $expected
- * @param \Countable|iterable $actual
+ * @param Countable|iterable $expected
+ * @param Countable|iterable $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotSameSize()
*/
- public function assertNotSameSize($expected, $actual, string $message = "") {
+ public function assertNotSameSize($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotSameSize', func_get_args()));
}
@@ -10600,10 +11151,11 @@ public function assertNotSameSize($expected, $actual, string $message = "") {
*
* Asserts that a condition is not true.
*
- * @param mixed $condition
+ * @param $condition
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNotTrue()
*/
- public function assertNotTrue($condition, string $message = "") {
+ public function assertNotTrue($condition, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotTrue', func_get_args()));
}
@@ -10613,10 +11165,11 @@ public function assertNotTrue($condition, string $message = "") {
*
* Asserts that a variable is null.
*
- * @param mixed $actual
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertNull()
*/
- public function assertNull($actual, string $message = "") {
+ public function assertNull($actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNull', func_get_args()));
}
@@ -10625,10 +11178,13 @@ public function assertNull($actual, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that an object has a specified attribute.
- * @see \Codeception\Module\AbstractAsserts::assertObjectHasAttribute()
+ *
+ * @param string $attributeName
* @param object $object
+ * @param string $message
+ * @see \Codeception\Module\AbstractAsserts::assertObjectHasAttribute()
*/
- public function assertObjectHasAttribute(string $attributeName, $object, string $message = "") {
+ public function assertObjectHasAttribute($attributeName, $object, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertObjectHasAttribute', func_get_args()));
}
@@ -10637,10 +11193,13 @@ public function assertObjectHasAttribute(string $attributeName, $object, string
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that an object does not have a specified attribute.
- * @see \Codeception\Module\AbstractAsserts::assertObjectNotHasAttribute()
+ *
+ * @param string $attributeName
* @param object $object
+ * @param string $message
+ * @see \Codeception\Module\AbstractAsserts::assertObjectNotHasAttribute()
*/
- public function assertObjectNotHasAttribute(string $attributeName, $object, string $message = "") {
+ public function assertObjectNotHasAttribute($attributeName, $object, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertObjectNotHasAttribute', func_get_args()));
}
@@ -10650,11 +11209,12 @@ public function assertObjectNotHasAttribute(string $attributeName, $object, stri
*
* Asserts that two variables have the same type and value.
*
- * @param mixed $expected
- * @param mixed $actual
+ * @param $expected
+ * @param $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertSame()
*/
- public function assertSame($expected, $actual, string $message = "") {
+ public function assertSame($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertSame', func_get_args()));
}
@@ -10664,11 +11224,12 @@ public function assertSame($expected, $actual, string $message = "") {
*
* Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same.
*
- * @param \Countable|iterable $expected
- * @param \Countable|iterable $actual
+ * @param Countable|iterable $expected
+ * @param Countable|iterable $actual
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertSameSize()
*/
- public function assertSameSize($expected, $actual, string $message = "") {
+ public function assertSameSize($expected, $actual, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertSameSize', func_get_args()));
}
@@ -10676,10 +11237,12 @@ public function assertSameSize($expected, $actual, string $message = "") {
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- *
+ * @param string $needle
+ * @param string $haystack
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringContainsString()
*/
- public function assertStringContainsString(string $needle, string $haystack, string $message = "") {
+ public function assertStringContainsString($needle, $haystack, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringContainsString', func_get_args()));
}
@@ -10690,7 +11253,7 @@ public function assertStringContainsString(string $needle, string $haystack, str
*
* @see \Codeception\Module\AbstractAsserts::assertStringContainsStringIgnoringCase()
*/
- public function assertStringContainsStringIgnoringCase(string $needle, string $haystack, string $message = "") {
+ public function assertStringContainsStringIgnoringCase($needle, $haystack, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringContainsStringIgnoringCase', func_get_args()));
}
@@ -10699,9 +11262,13 @@ public function assertStringContainsStringIgnoringCase(string $needle, string $h
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string ends not with a given suffix.
+ *
+ * @param string $suffix
+ * @param string $string
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringEndsNotWith()
*/
- public function assertStringEndsNotWith(string $suffix, string $string, string $message = "") {
+ public function assertStringEndsNotWith($suffix, $string, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringEndsNotWith', func_get_args()));
}
@@ -10710,9 +11277,13 @@ public function assertStringEndsNotWith(string $suffix, string $string, string $
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string ends with a given suffix.
+ *
+ * @param string $suffix
+ * @param string $string
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringEndsWith()
*/
- public function assertStringEndsWith(string $suffix, string $string, string $message = "") {
+ public function assertStringEndsWith($suffix, $string, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringEndsWith', func_get_args()));
}
@@ -10721,9 +11292,13 @@ public function assertStringEndsWith(string $suffix, string $string, string $mes
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the contents of a string is equal to the contents of a file.
+ *
+ * @param string $expectedFile
+ * @param string $actualString
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringEqualsFile()
*/
- public function assertStringEqualsFile(string $expectedFile, string $actualString, string $message = "") {
+ public function assertStringEqualsFile($expectedFile, $actualString, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringEqualsFile', func_get_args()));
}
@@ -10732,9 +11307,13 @@ public function assertStringEqualsFile(string $expectedFile, string $actualStrin
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the contents of a string is equal to the contents of a file (canonicalizing).
+ *
+ * @param string $expectedFile
+ * @param string $actualString
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringEqualsFileCanonicalizing()
*/
- public function assertStringEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message = "") {
+ public function assertStringEqualsFileCanonicalizing($expectedFile, $actualString, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringEqualsFileCanonicalizing', func_get_args()));
}
@@ -10743,9 +11322,13 @@ public function assertStringEqualsFileCanonicalizing(string $expectedFile, strin
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the contents of a string is equal to the contents of a file (ignoring case).
+ *
+ * @param string $expectedFile
+ * @param string $actualString
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringEqualsFileIgnoringCase()
*/
- public function assertStringEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message = "") {
+ public function assertStringEqualsFileIgnoringCase($expectedFile, $actualString, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringEqualsFileIgnoringCase', func_get_args()));
}
@@ -10754,9 +11337,13 @@ public function assertStringEqualsFileIgnoringCase(string $expectedFile, string
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string matches a given format string.
+ *
+ * @param string $format
+ * @param string $string
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringMatchesFormat()
*/
- public function assertStringMatchesFormat(string $format, string $string, string $message = "") {
+ public function assertStringMatchesFormat($format, $string, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringMatchesFormat', func_get_args()));
}
@@ -10765,9 +11352,13 @@ public function assertStringMatchesFormat(string $format, string $string, string
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string matches a given format file.
+ *
+ * @param string $formatFile
+ * @param string $string
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringMatchesFormatFile()
*/
- public function assertStringMatchesFormatFile(string $formatFile, string $string, string $message = "") {
+ public function assertStringMatchesFormatFile($formatFile, $string, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringMatchesFormatFile', func_get_args()));
}
@@ -10775,10 +11366,12 @@ public function assertStringMatchesFormatFile(string $formatFile, string $string
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- *
+ * @param string $needle
+ * @param string $haystack
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringNotContainsString()
*/
- public function assertStringNotContainsString(string $needle, string $haystack, string $message = "") {
+ public function assertStringNotContainsString($needle, $haystack, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotContainsString', func_get_args()));
}
@@ -10786,10 +11379,12 @@ public function assertStringNotContainsString(string $needle, string $haystack,
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- *
+ * @param string $needle
+ * @param string $haystack
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringNotContainsStringIgnoringCase()
*/
- public function assertStringNotContainsStringIgnoringCase(string $needle, string $haystack, string $message = "") {
+ public function assertStringNotContainsStringIgnoringCase($needle, $haystack, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotContainsStringIgnoringCase', func_get_args()));
}
@@ -10798,9 +11393,13 @@ public function assertStringNotContainsStringIgnoringCase(string $needle, string
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the contents of a string is not equal to the contents of a file.
+ *
+ * @param string $expectedFile
+ * @param string $actualString
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringNotEqualsFile()
*/
- public function assertStringNotEqualsFile(string $expectedFile, string $actualString, string $message = "") {
+ public function assertStringNotEqualsFile($expectedFile, $actualString, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotEqualsFile', func_get_args()));
}
@@ -10809,9 +11408,12 @@ public function assertStringNotEqualsFile(string $expectedFile, string $actualSt
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).
+ * @param string $expectedFile
+ * @param string $actualString
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringNotEqualsFileCanonicalizing()
*/
- public function assertStringNotEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message = "") {
+ public function assertStringNotEqualsFileCanonicalizing($expectedFile, $actualString, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotEqualsFileCanonicalizing', func_get_args()));
}
@@ -10820,9 +11422,13 @@ public function assertStringNotEqualsFileCanonicalizing(string $expectedFile, st
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that the contents of a string is not equal to the contents of a file (ignoring case).
+ *
+ * @param string $expectedFile
+ * @param string $actualString
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringNotEqualsFileIgnoringCase()
*/
- public function assertStringNotEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message = "") {
+ public function assertStringNotEqualsFileIgnoringCase($expectedFile, $actualString, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotEqualsFileIgnoringCase', func_get_args()));
}
@@ -10831,9 +11437,13 @@ public function assertStringNotEqualsFileIgnoringCase(string $expectedFile, stri
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string does not match a given format string.
+ *
+ * @param string $format
+ * @param string $string
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringNotMatchesFormat()
*/
- public function assertStringNotMatchesFormat(string $format, string $string, string $message = "") {
+ public function assertStringNotMatchesFormat($format, $string, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotMatchesFormat', func_get_args()));
}
@@ -10842,9 +11452,13 @@ public function assertStringNotMatchesFormat(string $format, string $string, str
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string does not match a given format string.
+ *
+ * @param string $formatFile
+ * @param string $string
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringNotMatchesFormatFile()
*/
- public function assertStringNotMatchesFormatFile(string $formatFile, string $string, string $message = "") {
+ public function assertStringNotMatchesFormatFile($formatFile, $string, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotMatchesFormatFile', func_get_args()));
}
@@ -10853,9 +11467,13 @@ public function assertStringNotMatchesFormatFile(string $formatFile, string $str
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string starts not with a given prefix.
+ *
+ * @param string $prefix
+ * @param string $string
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringStartsNotWith()
*/
- public function assertStringStartsNotWith(string $prefix, string $string, string $message = "") {
+ public function assertStringStartsNotWith($prefix, $string, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringStartsNotWith', func_get_args()));
}
@@ -10864,9 +11482,13 @@ public function assertStringStartsNotWith(string $prefix, string $string, string
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that a string starts with a given prefix.
+ *
+ * @param string $prefix
+ * @param string $string
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertStringStartsWith()
*/
- public function assertStringStartsWith(string $prefix, string $string, string $message = "") {
+ public function assertStringStartsWith($prefix, $string, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringStartsWith', func_get_args()));
}
@@ -10876,10 +11498,12 @@ public function assertStringStartsWith(string $prefix, string $string, string $m
*
* Evaluates a PHPUnit\Framework\Constraint matcher object.
*
- * @param mixed $value
+ * @param $value
+ * @param Constraint $constraint
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertThat()
*/
- public function assertThat($value, \PHPUnit\Framework\Constraint\Constraint $constraint, string $message = "") {
+ public function assertThat($value, $constraint, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertThat', func_get_args()));
}
@@ -10889,10 +11513,11 @@ public function assertThat($value, \PHPUnit\Framework\Constraint\Constraint $con
*
* Asserts that a condition is true.
*
- * @param mixed $condition
+ * @param $condition
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertTrue()
*/
- public function assertTrue($condition, string $message = "") {
+ public function assertTrue($condition, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertTrue', func_get_args()));
}
@@ -10901,9 +11526,13 @@ public function assertTrue($condition, string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that two XML files are equal.
+ *
+ * @param string $expectedFile
+ * @param string $actualFile
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertXmlFileEqualsXmlFile()
*/
- public function assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile, string $message = "") {
+ public function assertXmlFileEqualsXmlFile($expectedFile, $actualFile, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertXmlFileEqualsXmlFile', func_get_args()));
}
@@ -10912,9 +11541,13 @@ public function assertXmlFileEqualsXmlFile(string $expectedFile, string $actualF
* [!] Method is generated. Documentation taken from corresponding module.
*
* Asserts that two XML files are not equal.
+ *
+ * @param string $expectedFile
+ * @param string $actualFile
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertXmlFileNotEqualsXmlFile()
*/
- public function assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile, string $message = "") {
+ public function assertXmlFileNotEqualsXmlFile($expectedFile, $actualFile, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertXmlFileNotEqualsXmlFile', func_get_args()));
}
@@ -10924,10 +11557,12 @@ public function assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actu
*
* Asserts that two XML documents are equal.
*
- * @param \DOMDocument|string $actualXml
+ * @param string $expectedFile
+ * @param DOMDocument|string $actualXml
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertXmlStringEqualsXmlFile()
*/
- public function assertXmlStringEqualsXmlFile(string $expectedFile, $actualXml, string $message = "") {
+ public function assertXmlStringEqualsXmlFile($expectedFile, $actualXml, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertXmlStringEqualsXmlFile', func_get_args()));
}
@@ -10937,11 +11572,12 @@ public function assertXmlStringEqualsXmlFile(string $expectedFile, $actualXml, s
*
* Asserts that two XML documents are equal.
*
- * @param \DOMDocument|string $expectedXml
- * @param \DOMDocument|string $actualXml
+ * @param DOMDocument|string $expectedXml
+ * @param DOMDocument|string $actualXml
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertXmlStringEqualsXmlString()
*/
- public function assertXmlStringEqualsXmlString($expectedXml, $actualXml, string $message = "") {
+ public function assertXmlStringEqualsXmlString($expectedXml, $actualXml, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertXmlStringEqualsXmlString', func_get_args()));
}
@@ -10951,10 +11587,12 @@ public function assertXmlStringEqualsXmlString($expectedXml, $actualXml, string
*
* Asserts that two XML documents are not equal.
*
- * @param \DOMDocument|string $actualXml
+ * @param string $expectedFile
+ * @param DOMDocument|string $actualXml
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertXmlStringNotEqualsXmlFile()
*/
- public function assertXmlStringNotEqualsXmlFile(string $expectedFile, $actualXml, string $message = "") {
+ public function assertXmlStringNotEqualsXmlFile($expectedFile, $actualXml, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertXmlStringNotEqualsXmlFile', func_get_args()));
}
@@ -10964,11 +11602,12 @@ public function assertXmlStringNotEqualsXmlFile(string $expectedFile, $actualXml
*
* Asserts that two XML documents are not equal.
*
- * @param \DOMDocument|string $expectedXml
- * @param \DOMDocument|string $actualXml
+ * @param DOMDocument|string $expectedXml
+ * @param DOMDocument|string $actualXml
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::assertXmlStringNotEqualsXmlString()
*/
- public function assertXmlStringNotEqualsXmlString($expectedXml, $actualXml, string $message = "") {
+ public function assertXmlStringNotEqualsXmlString($expectedXml, $actualXml, $message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('assertXmlStringNotEqualsXmlString', func_get_args()));
}
@@ -10977,9 +11616,11 @@ public function assertXmlStringNotEqualsXmlString($expectedXml, $actualXml, stri
* [!] Method is generated. Documentation taken from corresponding module.
*
* Fails a test with the given message.
+ *
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::fail()
*/
- public function fail(string $message = "") {
+ public function fail($message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('fail', func_get_args()));
}
@@ -10988,9 +11629,11 @@ public function fail(string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Mark the test as incomplete.
+ *
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::markTestIncomplete()
*/
- public function markTestIncomplete(string $message = "") {
+ public function markTestIncomplete($message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('markTestIncomplete', func_get_args()));
}
@@ -10999,9 +11642,11 @@ public function markTestIncomplete(string $message = "") {
* [!] Method is generated. Documentation taken from corresponding module.
*
* Mark the test as skipped.
+ *
+ * @param string $message
* @see \Codeception\Module\AbstractAsserts::markTestSkipped()
*/
- public function markTestSkipped(string $message = "") {
+ public function markTestSkipped($message = "") {
return $this->getScenario()->runStep(new \Codeception\Step\Action('markTestSkipped', func_get_args()));
}
}