| Total Complexity | 152 |
| Total Lines | 2011 |
| Duplicated Lines | 0 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like UnitTesterActions often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use UnitTesterActions, and based on these observations, apply Extract Interface, too.
| 1 | <?php //[STAMP] e24d2a3cdec023ca5099701b6a9590c2 |
||
| 8 | trait UnitTesterActions |
||
| 9 | { |
||
| 10 | /** |
||
| 11 | * @return \Codeception\Scenario |
||
| 12 | */ |
||
| 13 | abstract protected function getScenario(); |
||
| 14 | |||
| 15 | |||
| 16 | /** |
||
| 17 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 18 | * |
||
| 19 | * Handles and checks throwables (Exceptions/Errors) called inside the callback function. |
||
| 20 | * Either throwable class name or throwable instance should be provided. |
||
| 21 | * |
||
| 22 | * ```php |
||
| 23 | * <?php |
||
| 24 | * $I->expectThrowable(MyThrowable::class, function() { |
||
| 25 | * $this->doSomethingBad(); |
||
| 26 | * }); |
||
| 27 | * |
||
| 28 | * $I->expectThrowable(new MyException(), function() { |
||
| 29 | * $this->doSomethingBad(); |
||
| 30 | * }); |
||
| 31 | * ``` |
||
| 32 | * If you want to check message or throwable code, you can pass them with throwable instance: |
||
| 33 | * ```php |
||
| 34 | * <?php |
||
| 35 | * // will check that throwable MyError is thrown with "Don't do bad things" message |
||
| 36 | * $I->expectThrowable(new MyError("Don't do bad things"), function() { |
||
| 37 | * $this->doSomethingBad(); |
||
| 38 | * }); |
||
| 39 | * ``` |
||
| 40 | * |
||
| 41 | * @param \Throwable|string $throwable |
||
| 42 | * @see \Codeception\Module\Asserts::expectThrowable() |
||
| 43 | */ |
||
| 44 | public function expectThrowable($throwable, callable $callback): void { |
||
| 45 | $this->getScenario()->runStep(new \Codeception\Step\Action('expectThrowable', func_get_args())); |
||
| 46 | } |
||
| 47 | |||
| 48 | |||
| 49 | /** |
||
| 50 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 51 | * |
||
| 52 | * Asserts that a file does not exist. |
||
| 53 | * @see \Codeception\Module\AbstractAsserts::assertFileNotExists() |
||
| 54 | */ |
||
| 55 | public function assertFileNotExists(string $filename, string $message = "") { |
||
| 56 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileNotExists', func_get_args())); |
||
| 57 | } |
||
| 58 | |||
| 59 | |||
| 60 | /** |
||
| 61 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 62 | * |
||
| 63 | * Asserts that a value is greater than or equal to another value. |
||
| 64 | * |
||
| 65 | * @param mixed $expected |
||
| 66 | * @param mixed $actual |
||
| 67 | * @see \Codeception\Module\AbstractAsserts::assertGreaterOrEquals() |
||
| 68 | */ |
||
| 69 | public function assertGreaterOrEquals($expected, $actual, string $message = "") { |
||
| 70 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertGreaterOrEquals', func_get_args())); |
||
| 71 | } |
||
| 72 | |||
| 73 | |||
| 74 | /** |
||
| 75 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 76 | * |
||
| 77 | * Asserts that a variable is empty. |
||
| 78 | * |
||
| 79 | * @param mixed $actual |
||
| 80 | * @see \Codeception\Module\AbstractAsserts::assertIsEmpty() |
||
| 81 | */ |
||
| 82 | public function assertIsEmpty($actual, string $message = "") { |
||
| 83 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsEmpty', func_get_args())); |
||
| 84 | } |
||
| 85 | |||
| 86 | |||
| 87 | /** |
||
| 88 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 89 | * |
||
| 90 | * Asserts that a value is smaller than or equal to another value. |
||
| 91 | * |
||
| 92 | * @param mixed $expected |
||
| 93 | * @param mixed $actual |
||
| 94 | * @see \Codeception\Module\AbstractAsserts::assertLessOrEquals() |
||
| 95 | */ |
||
| 96 | public function assertLessOrEquals($expected, $actual, string $message = "") { |
||
| 97 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertLessOrEquals', func_get_args())); |
||
| 98 | } |
||
| 99 | |||
| 100 | |||
| 101 | /** |
||
| 102 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 103 | * |
||
| 104 | * Asserts that a string does not match a given regular expression. |
||
| 105 | * @see \Codeception\Module\AbstractAsserts::assertNotRegExp() |
||
| 106 | */ |
||
| 107 | public function assertNotRegExp(string $pattern, string $string, string $message = "") { |
||
| 108 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotRegExp', func_get_args())); |
||
| 109 | } |
||
| 110 | |||
| 111 | |||
| 112 | /** |
||
| 113 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 114 | * |
||
| 115 | * Asserts that a string matches a given regular expression. |
||
| 116 | * @see \Codeception\Module\AbstractAsserts::assertRegExp() |
||
| 117 | */ |
||
| 118 | public function assertRegExp(string $pattern, string $string, string $message = "") { |
||
| 119 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertRegExp', func_get_args())); |
||
| 120 | } |
||
| 121 | |||
| 122 | |||
| 123 | /** |
||
| 124 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 125 | * |
||
| 126 | * Evaluates a PHPUnit\Framework\Constraint matcher object. |
||
| 127 | * |
||
| 128 | * @param mixed $value |
||
| 129 | * @see \Codeception\Module\AbstractAsserts::assertThatItsNot() |
||
| 130 | */ |
||
| 131 | public function assertThatItsNot($value, \PHPUnit\Framework\Constraint\Constraint $constraint, string $message = "") { |
||
| 132 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertThatItsNot', func_get_args())); |
||
| 133 | } |
||
| 134 | |||
| 135 | |||
| 136 | /** |
||
| 137 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 138 | * |
||
| 139 | * Asserts that an array has a specified key. |
||
| 140 | * |
||
| 141 | * @param int|string $key |
||
| 142 | * @param array|\ArrayAccess $array |
||
| 143 | * @see \Codeception\Module\AbstractAsserts::assertArrayHasKey() |
||
| 144 | */ |
||
| 145 | public function assertArrayHasKey($key, $array, string $message = "") { |
||
| 146 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertArrayHasKey', func_get_args())); |
||
| 147 | } |
||
| 148 | |||
| 149 | |||
| 150 | /** |
||
| 151 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 152 | * |
||
| 153 | * Asserts that an array does not have a specified key. |
||
| 154 | * |
||
| 155 | * @param int|string $key |
||
| 156 | * @param array|\ArrayAccess $array |
||
| 157 | * @see \Codeception\Module\AbstractAsserts::assertArrayNotHasKey() |
||
| 158 | */ |
||
| 159 | public function assertArrayNotHasKey($key, $array, string $message = "") { |
||
| 160 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertArrayNotHasKey', func_get_args())); |
||
| 161 | } |
||
| 162 | |||
| 163 | |||
| 164 | /** |
||
| 165 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 166 | * |
||
| 167 | * Asserts that a class has a specified attribute. |
||
| 168 | * @see \Codeception\Module\AbstractAsserts::assertClassHasAttribute() |
||
| 169 | */ |
||
| 170 | public function assertClassHasAttribute(string $attributeName, string $className, string $message = "") { |
||
| 171 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertClassHasAttribute', func_get_args())); |
||
| 172 | } |
||
| 173 | |||
| 174 | |||
| 175 | /** |
||
| 176 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 177 | * |
||
| 178 | * Asserts that a class has a specified static attribute. |
||
| 179 | * @see \Codeception\Module\AbstractAsserts::assertClassHasStaticAttribute() |
||
| 180 | */ |
||
| 181 | public function assertClassHasStaticAttribute(string $attributeName, string $className, string $message = "") { |
||
| 182 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertClassHasStaticAttribute', func_get_args())); |
||
| 183 | } |
||
| 184 | |||
| 185 | |||
| 186 | /** |
||
| 187 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 188 | * |
||
| 189 | * Asserts that a class does not have a specified attribute. |
||
| 190 | * @see \Codeception\Module\AbstractAsserts::assertClassNotHasAttribute() |
||
| 191 | */ |
||
| 192 | public function assertClassNotHasAttribute(string $attributeName, string $className, string $message = "") { |
||
| 193 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertClassNotHasAttribute', func_get_args())); |
||
| 194 | } |
||
| 195 | |||
| 196 | |||
| 197 | /** |
||
| 198 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 199 | * |
||
| 200 | * Asserts that a class does not have a specified static attribute. |
||
| 201 | * @see \Codeception\Module\AbstractAsserts::assertClassNotHasStaticAttribute() |
||
| 202 | */ |
||
| 203 | public function assertClassNotHasStaticAttribute(string $attributeName, string $className, string $message = "") { |
||
| 204 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertClassNotHasStaticAttribute', func_get_args())); |
||
| 205 | } |
||
| 206 | |||
| 207 | |||
| 208 | /** |
||
| 209 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 210 | * |
||
| 211 | * Asserts that a haystack contains a needle. |
||
| 212 | * |
||
| 213 | * @param mixed $needle |
||
| 214 | * @see \Codeception\Module\AbstractAsserts::assertContains() |
||
| 215 | */ |
||
| 216 | public function assertContains($needle, iterable $haystack, string $message = "") { |
||
| 217 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertContains', func_get_args())); |
||
| 218 | } |
||
| 219 | |||
| 220 | |||
| 221 | /** |
||
| 222 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 223 | * |
||
| 224 | * @param mixed $needle |
||
| 225 | * @see \Codeception\Module\AbstractAsserts::assertContainsEquals() |
||
| 226 | */ |
||
| 227 | public function assertContainsEquals($needle, iterable $haystack, string $message = "") { |
||
| 228 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertContainsEquals', func_get_args())); |
||
| 229 | } |
||
| 230 | |||
| 231 | |||
| 232 | /** |
||
| 233 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 234 | * |
||
| 235 | * Asserts that a haystack contains only values of a given type. |
||
| 236 | * @see \Codeception\Module\AbstractAsserts::assertContainsOnly() |
||
| 237 | */ |
||
| 238 | public function assertContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = NULL, string $message = "") { |
||
| 239 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertContainsOnly', func_get_args())); |
||
| 240 | } |
||
| 241 | |||
| 242 | |||
| 243 | /** |
||
| 244 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 245 | * |
||
| 246 | * Asserts that a haystack contains only instances of a given class name. |
||
| 247 | * @see \Codeception\Module\AbstractAsserts::assertContainsOnlyInstancesOf() |
||
| 248 | */ |
||
| 249 | public function assertContainsOnlyInstancesOf(string $className, iterable $haystack, string $message = "") { |
||
| 250 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertContainsOnlyInstancesOf', func_get_args())); |
||
| 251 | } |
||
| 252 | |||
| 253 | |||
| 254 | /** |
||
| 255 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 256 | * |
||
| 257 | * Asserts the number of elements of an array, Countable or Traversable. |
||
| 258 | * |
||
| 259 | * @param \Countable|iterable $haystack |
||
| 260 | * @see \Codeception\Module\AbstractAsserts::assertCount() |
||
| 261 | */ |
||
| 262 | public function assertCount(int $expectedCount, $haystack, string $message = "") { |
||
| 263 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertCount', func_get_args())); |
||
| 264 | } |
||
| 265 | |||
| 266 | |||
| 267 | /** |
||
| 268 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 269 | * |
||
| 270 | * Asserts that a directory does not exist. |
||
| 271 | * @see \Codeception\Module\AbstractAsserts::assertDirectoryDoesNotExist() |
||
| 272 | */ |
||
| 273 | public function assertDirectoryDoesNotExist(string $directory, string $message = "") { |
||
| 274 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDirectoryDoesNotExist', func_get_args())); |
||
| 275 | } |
||
| 276 | |||
| 277 | |||
| 278 | /** |
||
| 279 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 280 | * |
||
| 281 | * Asserts that a directory exists. |
||
| 282 | * @see \Codeception\Module\AbstractAsserts::assertDirectoryExists() |
||
| 283 | */ |
||
| 284 | public function assertDirectoryExists(string $directory, string $message = "") { |
||
| 285 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDirectoryExists', func_get_args())); |
||
| 286 | } |
||
| 287 | |||
| 288 | |||
| 289 | /** |
||
| 290 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 291 | * |
||
| 292 | * Asserts that a directory exists and is not readable. |
||
| 293 | * @see \Codeception\Module\AbstractAsserts::assertDirectoryIsNotReadable() |
||
| 294 | */ |
||
| 295 | public function assertDirectoryIsNotReadable(string $directory, string $message = "") { |
||
| 296 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDirectoryIsNotReadable', func_get_args())); |
||
| 297 | } |
||
| 298 | |||
| 299 | |||
| 300 | /** |
||
| 301 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 302 | * |
||
| 303 | * Asserts that a directory exists and is not writable. |
||
| 304 | * @see \Codeception\Module\AbstractAsserts::assertDirectoryIsNotWritable() |
||
| 305 | */ |
||
| 306 | public function assertDirectoryIsNotWritable(string $directory, string $message = "") { |
||
| 308 | } |
||
| 309 | |||
| 310 | |||
| 311 | /** |
||
| 312 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 313 | * |
||
| 314 | * Asserts that a directory exists and is readable. |
||
| 315 | * @see \Codeception\Module\AbstractAsserts::assertDirectoryIsReadable() |
||
| 316 | */ |
||
| 317 | public function assertDirectoryIsReadable(string $directory, string $message = "") { |
||
| 318 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDirectoryIsReadable', func_get_args())); |
||
| 319 | } |
||
| 320 | |||
| 321 | |||
| 322 | /** |
||
| 323 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 324 | * |
||
| 325 | * Asserts that a directory exists and is writable. |
||
| 326 | * @see \Codeception\Module\AbstractAsserts::assertDirectoryIsWritable() |
||
| 327 | */ |
||
| 328 | public function assertDirectoryIsWritable(string $directory, string $message = "") { |
||
| 329 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDirectoryIsWritable', func_get_args())); |
||
| 330 | } |
||
| 331 | |||
| 332 | |||
| 333 | /** |
||
| 334 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 335 | * |
||
| 336 | * Asserts that a string does not match a given regular expression. |
||
| 337 | * @see \Codeception\Module\AbstractAsserts::assertDoesNotMatchRegularExpression() |
||
| 338 | */ |
||
| 339 | public function assertDoesNotMatchRegularExpression(string $pattern, string $string, string $message = "") { |
||
| 340 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertDoesNotMatchRegularExpression', func_get_args())); |
||
| 341 | } |
||
| 342 | |||
| 343 | |||
| 344 | /** |
||
| 345 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 346 | * |
||
| 347 | * Asserts that a variable is empty. |
||
| 348 | * |
||
| 349 | * @param mixed $actual |
||
| 350 | * @see \Codeception\Module\AbstractAsserts::assertEmpty() |
||
| 351 | */ |
||
| 352 | public function assertEmpty($actual, string $message = "") { |
||
| 353 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertEmpty', func_get_args())); |
||
| 354 | } |
||
| 355 | |||
| 356 | |||
| 357 | /** |
||
| 358 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 359 | * |
||
| 360 | * Asserts that two variables are equal. |
||
| 361 | * |
||
| 362 | * @param mixed $expected |
||
| 363 | * @param mixed $actual |
||
| 364 | * @see \Codeception\Module\AbstractAsserts::assertEquals() |
||
| 365 | */ |
||
| 366 | public function assertEquals($expected, $actual, string $message = "") { |
||
| 367 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertEquals', func_get_args())); |
||
| 368 | } |
||
| 369 | |||
| 370 | |||
| 371 | /** |
||
| 372 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 373 | * |
||
| 374 | * Asserts that two variables are equal (canonicalizing). |
||
| 375 | * |
||
| 376 | * @param mixed $expected |
||
| 377 | * @param mixed $actual |
||
| 378 | * @see \Codeception\Module\AbstractAsserts::assertEqualsCanonicalizing() |
||
| 379 | */ |
||
| 380 | public function assertEqualsCanonicalizing($expected, $actual, string $message = "") { |
||
| 381 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertEqualsCanonicalizing', func_get_args())); |
||
| 382 | } |
||
| 383 | |||
| 384 | |||
| 385 | /** |
||
| 386 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 387 | * |
||
| 388 | * Asserts that two variables are equal (ignoring case). |
||
| 389 | * |
||
| 390 | * @param mixed $expected |
||
| 391 | * @param mixed $actual |
||
| 392 | * @see \Codeception\Module\AbstractAsserts::assertEqualsIgnoringCase() |
||
| 393 | */ |
||
| 394 | public function assertEqualsIgnoringCase($expected, $actual, string $message = "") { |
||
| 395 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertEqualsIgnoringCase', func_get_args())); |
||
| 396 | } |
||
| 397 | |||
| 398 | |||
| 399 | /** |
||
| 400 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 401 | * |
||
| 402 | * Asserts that two variables are equal (with delta). |
||
| 403 | * |
||
| 404 | * @param mixed $expected |
||
| 405 | * @param mixed $actual |
||
| 406 | * @see \Codeception\Module\AbstractAsserts::assertEqualsWithDelta() |
||
| 407 | */ |
||
| 408 | public function assertEqualsWithDelta($expected, $actual, float $delta, string $message = "") { |
||
| 409 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertEqualsWithDelta', func_get_args())); |
||
| 410 | } |
||
| 411 | |||
| 412 | |||
| 413 | /** |
||
| 414 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 415 | * |
||
| 416 | * Asserts that a condition is false. |
||
| 417 | * |
||
| 418 | * @param mixed $condition |
||
| 419 | * @see \Codeception\Module\AbstractAsserts::assertFalse() |
||
| 420 | */ |
||
| 421 | public function assertFalse($condition, string $message = "") { |
||
| 422 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFalse', func_get_args())); |
||
| 423 | } |
||
| 424 | |||
| 425 | |||
| 426 | /** |
||
| 427 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 428 | * |
||
| 429 | * Asserts that a file does not exist. |
||
| 430 | * @see \Codeception\Module\AbstractAsserts::assertFileDoesNotExist() |
||
| 431 | */ |
||
| 432 | public function assertFileDoesNotExist(string $filename, string $message = "") { |
||
| 433 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileDoesNotExist', func_get_args())); |
||
| 434 | } |
||
| 435 | |||
| 436 | |||
| 437 | /** |
||
| 438 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 439 | * |
||
| 440 | * Asserts that the contents of one file is equal to the contents of another file. |
||
| 441 | * @see \Codeception\Module\AbstractAsserts::assertFileEquals() |
||
| 442 | */ |
||
| 443 | public function assertFileEquals(string $expected, string $actual, string $message = "") { |
||
| 444 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileEquals', func_get_args())); |
||
| 445 | } |
||
| 446 | |||
| 447 | |||
| 448 | /** |
||
| 449 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 450 | * |
||
| 451 | * Asserts that the contents of one file is equal to the contents of another file (canonicalizing). |
||
| 452 | * @see \Codeception\Module\AbstractAsserts::assertFileEqualsCanonicalizing() |
||
| 453 | */ |
||
| 454 | public function assertFileEqualsCanonicalizing(string $expected, string $actual, string $message = "") { |
||
| 456 | } |
||
| 457 | |||
| 458 | |||
| 459 | /** |
||
| 460 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 461 | * |
||
| 462 | * Asserts that the contents of one file is equal to the contents of another file (ignoring case). |
||
| 463 | * @see \Codeception\Module\AbstractAsserts::assertFileEqualsIgnoringCase() |
||
| 464 | */ |
||
| 465 | public function assertFileEqualsIgnoringCase(string $expected, string $actual, string $message = "") { |
||
| 466 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileEqualsIgnoringCase', func_get_args())); |
||
| 467 | } |
||
| 468 | |||
| 469 | |||
| 470 | /** |
||
| 471 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 472 | * |
||
| 473 | * Asserts that a file exists. |
||
| 474 | * @see \Codeception\Module\AbstractAsserts::assertFileExists() |
||
| 475 | */ |
||
| 476 | public function assertFileExists(string $filename, string $message = "") { |
||
| 477 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileExists', func_get_args())); |
||
| 478 | } |
||
| 479 | |||
| 480 | |||
| 481 | /** |
||
| 482 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 483 | * |
||
| 484 | * Asserts that a file exists and is not readable. |
||
| 485 | * @see \Codeception\Module\AbstractAsserts::assertFileIsNotReadable() |
||
| 486 | */ |
||
| 487 | public function assertFileIsNotReadable(string $file, string $message = "") { |
||
| 488 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileIsNotReadable', func_get_args())); |
||
| 489 | } |
||
| 490 | |||
| 491 | |||
| 492 | /** |
||
| 493 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 494 | * |
||
| 495 | * Asserts that a file exists and is not writable. |
||
| 496 | * @see \Codeception\Module\AbstractAsserts::assertFileIsNotWritable() |
||
| 497 | */ |
||
| 498 | public function assertFileIsNotWritable(string $file, string $message = "") { |
||
| 499 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileIsNotWritable', func_get_args())); |
||
| 500 | } |
||
| 501 | |||
| 502 | |||
| 503 | /** |
||
| 504 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 505 | * |
||
| 506 | * Asserts that a file exists and is readable. |
||
| 507 | * @see \Codeception\Module\AbstractAsserts::assertFileIsReadable() |
||
| 508 | */ |
||
| 509 | public function assertFileIsReadable(string $file, string $message = "") { |
||
| 510 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileIsReadable', func_get_args())); |
||
| 511 | } |
||
| 512 | |||
| 513 | |||
| 514 | /** |
||
| 515 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 516 | * |
||
| 517 | * Asserts that a file exists and is writable. |
||
| 518 | * @see \Codeception\Module\AbstractAsserts::assertFileIsWritable() |
||
| 519 | */ |
||
| 520 | public function assertFileIsWritable(string $file, string $message = "") { |
||
| 521 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileIsWritable', func_get_args())); |
||
| 522 | } |
||
| 523 | |||
| 524 | |||
| 525 | /** |
||
| 526 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 527 | * |
||
| 528 | * Asserts that the contents of one file is not equal to the contents of another file. |
||
| 529 | * @see \Codeception\Module\AbstractAsserts::assertFileNotEquals() |
||
| 530 | */ |
||
| 531 | public function assertFileNotEquals(string $expected, string $actual, string $message = "") { |
||
| 532 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileNotEquals', func_get_args())); |
||
| 533 | } |
||
| 534 | |||
| 535 | |||
| 536 | /** |
||
| 537 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 538 | * |
||
| 539 | * Asserts that the contents of one file is not equal to the contents of another file (canonicalizing). |
||
| 540 | * @see \Codeception\Module\AbstractAsserts::assertFileNotEqualsCanonicalizing() |
||
| 541 | */ |
||
| 542 | public function assertFileNotEqualsCanonicalizing(string $expected, string $actual, string $message = "") { |
||
| 543 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileNotEqualsCanonicalizing', func_get_args())); |
||
| 544 | } |
||
| 545 | |||
| 546 | |||
| 547 | /** |
||
| 548 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 549 | * |
||
| 550 | * Asserts that the contents of one file is not equal to the contents of another file (ignoring case). |
||
| 551 | * @see \Codeception\Module\AbstractAsserts::assertFileNotEqualsIgnoringCase() |
||
| 552 | */ |
||
| 553 | public function assertFileNotEqualsIgnoringCase(string $expected, string $actual, string $message = "") { |
||
| 554 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFileNotEqualsIgnoringCase', func_get_args())); |
||
| 555 | } |
||
| 556 | |||
| 557 | |||
| 558 | /** |
||
| 559 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 560 | * |
||
| 561 | * Asserts that a variable is finite. |
||
| 562 | * |
||
| 563 | * @param mixed $actual |
||
| 564 | * @see \Codeception\Module\AbstractAsserts::assertFinite() |
||
| 565 | */ |
||
| 566 | public function assertFinite($actual, string $message = "") { |
||
| 567 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertFinite', func_get_args())); |
||
| 568 | } |
||
| 569 | |||
| 570 | |||
| 571 | /** |
||
| 572 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 573 | * |
||
| 574 | * Asserts that a value is greater than another value. |
||
| 575 | * |
||
| 576 | * @param mixed $expected |
||
| 577 | * @param mixed $actual |
||
| 578 | * @see \Codeception\Module\AbstractAsserts::assertGreaterThan() |
||
| 579 | */ |
||
| 580 | public function assertGreaterThan($expected, $actual, string $message = "") { |
||
| 581 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertGreaterThan', func_get_args())); |
||
| 582 | } |
||
| 583 | |||
| 584 | |||
| 585 | /** |
||
| 586 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 587 | * |
||
| 588 | * Asserts that a value is greater than or equal to another value. |
||
| 589 | * |
||
| 590 | * @param mixed $expected |
||
| 591 | * @param mixed $actual |
||
| 592 | * @see \Codeception\Module\AbstractAsserts::assertGreaterThanOrEqual() |
||
| 593 | */ |
||
| 594 | public function assertGreaterThanOrEqual($expected, $actual, string $message = "") { |
||
| 595 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertGreaterThanOrEqual', func_get_args())); |
||
| 596 | } |
||
| 597 | |||
| 598 | |||
| 599 | /** |
||
| 600 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 601 | * |
||
| 602 | * Asserts that a variable is infinite. |
||
| 603 | * |
||
| 604 | * @param mixed $actual |
||
| 605 | * @see \Codeception\Module\AbstractAsserts::assertInfinite() |
||
| 606 | */ |
||
| 607 | public function assertInfinite($actual, string $message = "") { |
||
| 608 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertInfinite', func_get_args())); |
||
| 609 | } |
||
| 610 | |||
| 611 | |||
| 612 | /** |
||
| 613 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 614 | * |
||
| 615 | * Asserts that a variable is of a given type. |
||
| 616 | * |
||
| 617 | * @param mixed $actual |
||
| 618 | * @see \Codeception\Module\AbstractAsserts::assertInstanceOf() |
||
| 619 | */ |
||
| 620 | public function assertInstanceOf(string $expected, $actual, string $message = "") { |
||
| 621 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertInstanceOf', func_get_args())); |
||
| 622 | } |
||
| 623 | |||
| 624 | |||
| 625 | /** |
||
| 626 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 627 | * |
||
| 628 | * Asserts that a variable is of type array. |
||
| 629 | * |
||
| 630 | * @param mixed $actual |
||
| 631 | * @see \Codeception\Module\AbstractAsserts::assertIsArray() |
||
| 632 | */ |
||
| 633 | public function assertIsArray($actual, string $message = "") { |
||
| 634 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsArray', func_get_args())); |
||
| 635 | } |
||
| 636 | |||
| 637 | |||
| 638 | /** |
||
| 639 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 640 | * |
||
| 641 | * Asserts that a variable is of type bool. |
||
| 642 | * |
||
| 643 | * @param mixed $actual |
||
| 644 | * @see \Codeception\Module\AbstractAsserts::assertIsBool() |
||
| 645 | */ |
||
| 646 | public function assertIsBool($actual, string $message = "") { |
||
| 647 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsBool', func_get_args())); |
||
| 648 | } |
||
| 649 | |||
| 650 | |||
| 651 | /** |
||
| 652 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 653 | * |
||
| 654 | * Asserts that a variable is of type callable. |
||
| 655 | * |
||
| 656 | * @param mixed $actual |
||
| 657 | * @see \Codeception\Module\AbstractAsserts::assertIsCallable() |
||
| 658 | */ |
||
| 659 | public function assertIsCallable($actual, string $message = "") { |
||
| 660 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsCallable', func_get_args())); |
||
| 661 | } |
||
| 662 | |||
| 663 | |||
| 664 | /** |
||
| 665 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 666 | * |
||
| 667 | * Asserts that a variable is of type resource and is closed. |
||
| 668 | * |
||
| 669 | * @param mixed $actual |
||
| 670 | * @see \Codeception\Module\AbstractAsserts::assertIsClosedResource() |
||
| 671 | */ |
||
| 672 | public function assertIsClosedResource($actual, string $message = "") { |
||
| 673 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsClosedResource', func_get_args())); |
||
| 674 | } |
||
| 675 | |||
| 676 | |||
| 677 | /** |
||
| 678 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 679 | * |
||
| 680 | * Asserts that a variable is of type float. |
||
| 681 | * |
||
| 682 | * @param mixed $actual |
||
| 683 | * @see \Codeception\Module\AbstractAsserts::assertIsFloat() |
||
| 684 | */ |
||
| 685 | public function assertIsFloat($actual, string $message = "") { |
||
| 686 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsFloat', func_get_args())); |
||
| 687 | } |
||
| 688 | |||
| 689 | |||
| 690 | /** |
||
| 691 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 692 | * |
||
| 693 | * Asserts that a variable is of type int. |
||
| 694 | * |
||
| 695 | * @param mixed $actual |
||
| 696 | * @see \Codeception\Module\AbstractAsserts::assertIsInt() |
||
| 697 | */ |
||
| 698 | public function assertIsInt($actual, string $message = "") { |
||
| 699 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsInt', func_get_args())); |
||
| 700 | } |
||
| 701 | |||
| 702 | |||
| 703 | /** |
||
| 704 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 705 | * |
||
| 706 | * Asserts that a variable is of type iterable. |
||
| 707 | * |
||
| 708 | * @param mixed $actual |
||
| 709 | * @see \Codeception\Module\AbstractAsserts::assertIsIterable() |
||
| 710 | */ |
||
| 711 | public function assertIsIterable($actual, string $message = "") { |
||
| 712 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsIterable', func_get_args())); |
||
| 713 | } |
||
| 714 | |||
| 715 | |||
| 716 | /** |
||
| 717 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 718 | * |
||
| 719 | * Asserts that a variable is not of type array. |
||
| 720 | * |
||
| 721 | * @param mixed $actual |
||
| 722 | * @see \Codeception\Module\AbstractAsserts::assertIsNotArray() |
||
| 723 | */ |
||
| 724 | public function assertIsNotArray($actual, string $message = "") { |
||
| 725 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotArray', func_get_args())); |
||
| 726 | } |
||
| 727 | |||
| 728 | |||
| 729 | /** |
||
| 730 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 731 | * |
||
| 732 | * Asserts that a variable is not of type bool. |
||
| 733 | * |
||
| 734 | * @param mixed $actual |
||
| 735 | * @see \Codeception\Module\AbstractAsserts::assertIsNotBool() |
||
| 736 | */ |
||
| 737 | public function assertIsNotBool($actual, string $message = "") { |
||
| 738 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotBool', func_get_args())); |
||
| 739 | } |
||
| 740 | |||
| 741 | |||
| 742 | /** |
||
| 743 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 744 | * |
||
| 745 | * Asserts that a variable is not of type callable. |
||
| 746 | * |
||
| 747 | * @param mixed $actual |
||
| 748 | * @see \Codeception\Module\AbstractAsserts::assertIsNotCallable() |
||
| 749 | */ |
||
| 750 | public function assertIsNotCallable($actual, string $message = "") { |
||
| 751 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotCallable', func_get_args())); |
||
| 752 | } |
||
| 753 | |||
| 754 | |||
| 755 | /** |
||
| 756 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 757 | * |
||
| 758 | * Asserts that a variable is not of type resource. |
||
| 759 | * |
||
| 760 | * @param mixed $actual |
||
| 761 | * @see \Codeception\Module\AbstractAsserts::assertIsNotClosedResource() |
||
| 762 | */ |
||
| 763 | public function assertIsNotClosedResource($actual, string $message = "") { |
||
| 764 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotClosedResource', func_get_args())); |
||
| 765 | } |
||
| 766 | |||
| 767 | |||
| 768 | /** |
||
| 769 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 770 | * |
||
| 771 | * Asserts that a variable is not of type float. |
||
| 772 | * |
||
| 773 | * @param mixed $actual |
||
| 774 | * @see \Codeception\Module\AbstractAsserts::assertIsNotFloat() |
||
| 775 | */ |
||
| 776 | public function assertIsNotFloat($actual, string $message = "") { |
||
| 777 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotFloat', func_get_args())); |
||
| 778 | } |
||
| 779 | |||
| 780 | |||
| 781 | /** |
||
| 782 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 783 | * |
||
| 784 | * Asserts that a variable is not of type int. |
||
| 785 | * |
||
| 786 | * @param mixed $actual |
||
| 787 | * @see \Codeception\Module\AbstractAsserts::assertIsNotInt() |
||
| 788 | */ |
||
| 789 | public function assertIsNotInt($actual, string $message = "") { |
||
| 790 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotInt', func_get_args())); |
||
| 791 | } |
||
| 792 | |||
| 793 | |||
| 794 | /** |
||
| 795 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 796 | * |
||
| 797 | * Asserts that a variable is not of type iterable. |
||
| 798 | * |
||
| 799 | * @param mixed $actual |
||
| 800 | * @see \Codeception\Module\AbstractAsserts::assertIsNotIterable() |
||
| 801 | */ |
||
| 802 | public function assertIsNotIterable($actual, string $message = "") { |
||
| 803 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotIterable', func_get_args())); |
||
| 804 | } |
||
| 805 | |||
| 806 | |||
| 807 | /** |
||
| 808 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 809 | * |
||
| 810 | * Asserts that a variable is not of type numeric. |
||
| 811 | * |
||
| 812 | * @param mixed $actual |
||
| 813 | * @see \Codeception\Module\AbstractAsserts::assertIsNotNumeric() |
||
| 814 | */ |
||
| 815 | public function assertIsNotNumeric($actual, string $message = "") { |
||
| 816 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotNumeric', func_get_args())); |
||
| 817 | } |
||
| 818 | |||
| 819 | |||
| 820 | /** |
||
| 821 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 822 | * |
||
| 823 | * Asserts that a variable is not of type object. |
||
| 824 | * |
||
| 825 | * @param mixed $actual |
||
| 826 | * @see \Codeception\Module\AbstractAsserts::assertIsNotObject() |
||
| 827 | */ |
||
| 828 | public function assertIsNotObject($actual, string $message = "") { |
||
| 829 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotObject', func_get_args())); |
||
| 830 | } |
||
| 831 | |||
| 832 | |||
| 833 | /** |
||
| 834 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 835 | * |
||
| 836 | * Asserts that a file/dir exists and is not readable. |
||
| 837 | * @see \Codeception\Module\AbstractAsserts::assertIsNotReadable() |
||
| 838 | */ |
||
| 839 | public function assertIsNotReadable(string $filename, string $message = "") { |
||
| 840 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotReadable', func_get_args())); |
||
| 841 | } |
||
| 842 | |||
| 843 | |||
| 844 | /** |
||
| 845 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 846 | * |
||
| 847 | * Asserts that a variable is not of type resource. |
||
| 848 | * |
||
| 849 | * @param mixed $actual |
||
| 850 | * @see \Codeception\Module\AbstractAsserts::assertIsNotResource() |
||
| 851 | */ |
||
| 852 | public function assertIsNotResource($actual, string $message = "") { |
||
| 853 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotResource', func_get_args())); |
||
| 854 | } |
||
| 855 | |||
| 856 | |||
| 857 | /** |
||
| 858 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 859 | * |
||
| 860 | * Asserts that a variable is not of type scalar. |
||
| 861 | * |
||
| 862 | * @param mixed $actual |
||
| 863 | * @see \Codeception\Module\AbstractAsserts::assertIsNotScalar() |
||
| 864 | */ |
||
| 865 | public function assertIsNotScalar($actual, string $message = "") { |
||
| 866 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotScalar', func_get_args())); |
||
| 867 | } |
||
| 868 | |||
| 869 | |||
| 870 | /** |
||
| 871 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 872 | * |
||
| 873 | * Asserts that a variable is not of type string. |
||
| 874 | * |
||
| 875 | * @param mixed $actual |
||
| 876 | * @see \Codeception\Module\AbstractAsserts::assertIsNotString() |
||
| 877 | */ |
||
| 878 | public function assertIsNotString($actual, string $message = "") { |
||
| 879 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotString', func_get_args())); |
||
| 880 | } |
||
| 881 | |||
| 882 | |||
| 883 | /** |
||
| 884 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 885 | * |
||
| 886 | * Asserts that a file/dir exists and is not writable. |
||
| 887 | * @see \Codeception\Module\AbstractAsserts::assertIsNotWritable() |
||
| 888 | */ |
||
| 889 | public function assertIsNotWritable(string $filename, string $message = "") { |
||
| 890 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNotWritable', func_get_args())); |
||
| 891 | } |
||
| 892 | |||
| 893 | |||
| 894 | /** |
||
| 895 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 896 | * |
||
| 897 | * Asserts that a variable is of type numeric. |
||
| 898 | * |
||
| 899 | * @param mixed $actual |
||
| 900 | * @see \Codeception\Module\AbstractAsserts::assertIsNumeric() |
||
| 901 | */ |
||
| 902 | public function assertIsNumeric($actual, string $message = "") { |
||
| 903 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsNumeric', func_get_args())); |
||
| 904 | } |
||
| 905 | |||
| 906 | |||
| 907 | /** |
||
| 908 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 909 | * |
||
| 910 | * Asserts that a variable is of type object. |
||
| 911 | * |
||
| 912 | * @param mixed $actual |
||
| 913 | * @see \Codeception\Module\AbstractAsserts::assertIsObject() |
||
| 914 | */ |
||
| 915 | public function assertIsObject($actual, string $message = "") { |
||
| 916 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsObject', func_get_args())); |
||
| 917 | } |
||
| 918 | |||
| 919 | |||
| 920 | /** |
||
| 921 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 922 | * |
||
| 923 | * Asserts that a file/dir is readable. |
||
| 924 | * @see \Codeception\Module\AbstractAsserts::assertIsReadable() |
||
| 925 | */ |
||
| 926 | public function assertIsReadable(string $filename, string $message = "") { |
||
| 927 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsReadable', func_get_args())); |
||
| 928 | } |
||
| 929 | |||
| 930 | |||
| 931 | /** |
||
| 932 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 933 | * |
||
| 934 | * Asserts that a variable is of type resource. |
||
| 935 | * |
||
| 936 | * @param mixed $actual |
||
| 937 | * @see \Codeception\Module\AbstractAsserts::assertIsResource() |
||
| 938 | */ |
||
| 939 | public function assertIsResource($actual, string $message = "") { |
||
| 940 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsResource', func_get_args())); |
||
| 941 | } |
||
| 942 | |||
| 943 | |||
| 944 | /** |
||
| 945 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 946 | * |
||
| 947 | * Asserts that a variable is of type scalar. |
||
| 948 | * |
||
| 949 | * @param mixed $actual |
||
| 950 | * @see \Codeception\Module\AbstractAsserts::assertIsScalar() |
||
| 951 | */ |
||
| 952 | public function assertIsScalar($actual, string $message = "") { |
||
| 953 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsScalar', func_get_args())); |
||
| 954 | } |
||
| 955 | |||
| 956 | |||
| 957 | /** |
||
| 958 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 959 | * |
||
| 960 | * Asserts that a variable is of type string. |
||
| 961 | * |
||
| 962 | * @param mixed $actual |
||
| 963 | * @see \Codeception\Module\AbstractAsserts::assertIsString() |
||
| 964 | */ |
||
| 965 | public function assertIsString($actual, string $message = "") { |
||
| 966 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsString', func_get_args())); |
||
| 967 | } |
||
| 968 | |||
| 969 | |||
| 970 | /** |
||
| 971 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 972 | * |
||
| 973 | * Asserts that a file/dir exists and is writable. |
||
| 974 | * @see \Codeception\Module\AbstractAsserts::assertIsWritable() |
||
| 975 | */ |
||
| 976 | public function assertIsWritable(string $filename, string $message = "") { |
||
| 977 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertIsWritable', func_get_args())); |
||
| 978 | } |
||
| 979 | |||
| 980 | |||
| 981 | /** |
||
| 982 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 983 | * |
||
| 984 | * Asserts that a string is a valid JSON string. |
||
| 985 | * @see \Codeception\Module\AbstractAsserts::assertJson() |
||
| 986 | */ |
||
| 987 | public function assertJson(string $actualJson, string $message = "") { |
||
| 988 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJson', func_get_args())); |
||
| 989 | } |
||
| 990 | |||
| 991 | |||
| 992 | /** |
||
| 993 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 994 | * |
||
| 995 | * Asserts that two JSON files are equal. |
||
| 996 | * @see \Codeception\Module\AbstractAsserts::assertJsonFileEqualsJsonFile() |
||
| 997 | */ |
||
| 998 | public function assertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile, string $message = "") { |
||
| 999 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJsonFileEqualsJsonFile', func_get_args())); |
||
| 1000 | } |
||
| 1001 | |||
| 1002 | |||
| 1003 | /** |
||
| 1004 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1005 | * |
||
| 1006 | * Asserts that two JSON files are not equal. |
||
| 1007 | * @see \Codeception\Module\AbstractAsserts::assertJsonFileNotEqualsJsonFile() |
||
| 1008 | */ |
||
| 1009 | public function assertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile, string $message = "") { |
||
| 1010 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJsonFileNotEqualsJsonFile', func_get_args())); |
||
| 1011 | } |
||
| 1012 | |||
| 1013 | |||
| 1014 | /** |
||
| 1015 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1016 | * |
||
| 1017 | * Asserts that the generated JSON encoded object and the content of the given file are equal. |
||
| 1018 | * @see \Codeception\Module\AbstractAsserts::assertJsonStringEqualsJsonFile() |
||
| 1019 | */ |
||
| 1020 | public function assertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson, string $message = "") { |
||
| 1021 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJsonStringEqualsJsonFile', func_get_args())); |
||
| 1022 | } |
||
| 1023 | |||
| 1024 | |||
| 1025 | /** |
||
| 1026 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1027 | * |
||
| 1028 | * Asserts that two given JSON encoded objects or arrays are equal. |
||
| 1029 | * @see \Codeception\Module\AbstractAsserts::assertJsonStringEqualsJsonString() |
||
| 1030 | */ |
||
| 1031 | public function assertJsonStringEqualsJsonString(string $expectedJson, string $actualJson, string $message = "") { |
||
| 1032 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJsonStringEqualsJsonString', func_get_args())); |
||
| 1033 | } |
||
| 1034 | |||
| 1035 | |||
| 1036 | /** |
||
| 1037 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1038 | * |
||
| 1039 | * Asserts that the generated JSON encoded object and the content of the given file are not equal. |
||
| 1040 | * @see \Codeception\Module\AbstractAsserts::assertJsonStringNotEqualsJsonFile() |
||
| 1041 | */ |
||
| 1042 | public function assertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson, string $message = "") { |
||
| 1043 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJsonStringNotEqualsJsonFile', func_get_args())); |
||
| 1044 | } |
||
| 1045 | |||
| 1046 | |||
| 1047 | /** |
||
| 1048 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1049 | * |
||
| 1050 | * Asserts that two given JSON encoded objects or arrays are not equal. |
||
| 1051 | * @see \Codeception\Module\AbstractAsserts::assertJsonStringNotEqualsJsonString() |
||
| 1052 | */ |
||
| 1053 | public function assertJsonStringNotEqualsJsonString(string $expectedJson, string $actualJson, string $message = "") { |
||
| 1054 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertJsonStringNotEqualsJsonString', func_get_args())); |
||
| 1055 | } |
||
| 1056 | |||
| 1057 | |||
| 1058 | /** |
||
| 1059 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1060 | * |
||
| 1061 | * Asserts that a value is smaller than another value. |
||
| 1062 | * |
||
| 1063 | * @param mixed $expected |
||
| 1064 | * @param mixed $actual |
||
| 1065 | * @see \Codeception\Module\AbstractAsserts::assertLessThan() |
||
| 1066 | */ |
||
| 1067 | public function assertLessThan($expected, $actual, string $message = "") { |
||
| 1068 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertLessThan', func_get_args())); |
||
| 1069 | } |
||
| 1070 | |||
| 1071 | |||
| 1072 | /** |
||
| 1073 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1074 | * |
||
| 1075 | * Asserts that a value is smaller than or equal to another value. |
||
| 1076 | * |
||
| 1077 | * @param mixed $expected |
||
| 1078 | * @param mixed $actual |
||
| 1079 | * @see \Codeception\Module\AbstractAsserts::assertLessThanOrEqual() |
||
| 1080 | */ |
||
| 1081 | public function assertLessThanOrEqual($expected, $actual, string $message = "") { |
||
| 1082 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertLessThanOrEqual', func_get_args())); |
||
| 1083 | } |
||
| 1084 | |||
| 1085 | |||
| 1086 | /** |
||
| 1087 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1088 | * |
||
| 1089 | * Asserts that a string matches a given regular expression. |
||
| 1090 | * @see \Codeception\Module\AbstractAsserts::assertMatchesRegularExpression() |
||
| 1091 | */ |
||
| 1092 | public function assertMatchesRegularExpression(string $pattern, string $string, string $message = "") { |
||
| 1093 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertMatchesRegularExpression', func_get_args())); |
||
| 1094 | } |
||
| 1095 | |||
| 1096 | |||
| 1097 | /** |
||
| 1098 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1099 | * |
||
| 1100 | * Asserts that a variable is nan. |
||
| 1101 | * |
||
| 1102 | * @param mixed $actual |
||
| 1103 | * @see \Codeception\Module\AbstractAsserts::assertNan() |
||
| 1104 | */ |
||
| 1105 | public function assertNan($actual, string $message = "") { |
||
| 1106 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNan', func_get_args())); |
||
| 1107 | } |
||
| 1108 | |||
| 1109 | |||
| 1110 | /** |
||
| 1111 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1112 | * |
||
| 1113 | * Asserts that a haystack does not contain a needle. |
||
| 1114 | * |
||
| 1115 | * @param mixed $needle |
||
| 1116 | * @see \Codeception\Module\AbstractAsserts::assertNotContains() |
||
| 1117 | */ |
||
| 1118 | public function assertNotContains($needle, iterable $haystack, string $message = "") { |
||
| 1119 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotContains', func_get_args())); |
||
| 1120 | } |
||
| 1121 | |||
| 1122 | |||
| 1123 | /** |
||
| 1124 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1125 | * |
||
| 1126 | * |
||
| 1127 | * @see \Codeception\Module\AbstractAsserts::assertNotContainsEquals() |
||
| 1128 | */ |
||
| 1129 | public function assertNotContainsEquals($needle, iterable $haystack, string $message = "") { |
||
| 1130 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotContainsEquals', func_get_args())); |
||
| 1131 | } |
||
| 1132 | |||
| 1133 | |||
| 1134 | /** |
||
| 1135 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1136 | * |
||
| 1137 | * Asserts that a haystack does not contain only values of a given type. |
||
| 1138 | * @see \Codeception\Module\AbstractAsserts::assertNotContainsOnly() |
||
| 1139 | */ |
||
| 1140 | public function assertNotContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = NULL, string $message = "") { |
||
| 1141 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotContainsOnly', func_get_args())); |
||
| 1142 | } |
||
| 1143 | |||
| 1144 | |||
| 1145 | /** |
||
| 1146 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1147 | * |
||
| 1148 | * Asserts the number of elements of an array, Countable or Traversable. |
||
| 1149 | * |
||
| 1150 | * @param \Countable|iterable $haystack |
||
| 1151 | * @see \Codeception\Module\AbstractAsserts::assertNotCount() |
||
| 1152 | */ |
||
| 1153 | public function assertNotCount(int $expectedCount, $haystack, string $message = "") { |
||
| 1154 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotCount', func_get_args())); |
||
| 1155 | } |
||
| 1156 | |||
| 1157 | |||
| 1158 | /** |
||
| 1159 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1160 | * |
||
| 1161 | * Asserts that a variable is not empty. |
||
| 1162 | * |
||
| 1163 | * @param mixed $actual |
||
| 1164 | * @see \Codeception\Module\AbstractAsserts::assertNotEmpty() |
||
| 1165 | */ |
||
| 1166 | public function assertNotEmpty($actual, string $message = "") { |
||
| 1167 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotEmpty', func_get_args())); |
||
| 1168 | } |
||
| 1169 | |||
| 1170 | |||
| 1171 | /** |
||
| 1172 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1173 | * |
||
| 1174 | * Asserts that two variables are not equal. |
||
| 1175 | * |
||
| 1176 | * @param mixed $expected |
||
| 1177 | * @param mixed $actual |
||
| 1178 | * @see \Codeception\Module\AbstractAsserts::assertNotEquals() |
||
| 1179 | */ |
||
| 1180 | public function assertNotEquals($expected, $actual, string $message = "") { |
||
| 1181 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotEquals', func_get_args())); |
||
| 1182 | } |
||
| 1183 | |||
| 1184 | |||
| 1185 | /** |
||
| 1186 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1187 | * |
||
| 1188 | * Asserts that two variables are not equal (canonicalizing). |
||
| 1189 | * |
||
| 1190 | * @param mixed $expected |
||
| 1191 | * @param mixed $actual |
||
| 1192 | * @see \Codeception\Module\AbstractAsserts::assertNotEqualsCanonicalizing() |
||
| 1193 | */ |
||
| 1194 | public function assertNotEqualsCanonicalizing($expected, $actual, string $message = "") { |
||
| 1195 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotEqualsCanonicalizing', func_get_args())); |
||
| 1196 | } |
||
| 1197 | |||
| 1198 | |||
| 1199 | /** |
||
| 1200 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1201 | * |
||
| 1202 | * Asserts that two variables are not equal (ignoring case). |
||
| 1203 | * |
||
| 1204 | * @param mixed $expected |
||
| 1205 | * @param mixed $actual |
||
| 1206 | * @see \Codeception\Module\AbstractAsserts::assertNotEqualsIgnoringCase() |
||
| 1207 | */ |
||
| 1208 | public function assertNotEqualsIgnoringCase($expected, $actual, string $message = "") { |
||
| 1209 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotEqualsIgnoringCase', func_get_args())); |
||
| 1210 | } |
||
| 1211 | |||
| 1212 | |||
| 1213 | /** |
||
| 1214 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1215 | * |
||
| 1216 | * Asserts that two variables are not equal (with delta). |
||
| 1217 | * |
||
| 1218 | * @param mixed $expected |
||
| 1219 | * @param mixed $actual |
||
| 1220 | * @see \Codeception\Module\AbstractAsserts::assertNotEqualsWithDelta() |
||
| 1221 | */ |
||
| 1222 | public function assertNotEqualsWithDelta($expected, $actual, float $delta, string $message = "") { |
||
| 1223 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotEqualsWithDelta', func_get_args())); |
||
| 1224 | } |
||
| 1225 | |||
| 1226 | |||
| 1227 | /** |
||
| 1228 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1229 | * |
||
| 1230 | * Asserts that a condition is not false. |
||
| 1231 | * |
||
| 1232 | * @param mixed $condition |
||
| 1233 | * @see \Codeception\Module\AbstractAsserts::assertNotFalse() |
||
| 1234 | */ |
||
| 1235 | public function assertNotFalse($condition, string $message = "") { |
||
| 1236 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotFalse', func_get_args())); |
||
| 1237 | } |
||
| 1238 | |||
| 1239 | |||
| 1240 | /** |
||
| 1241 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1242 | * |
||
| 1243 | * Asserts that a variable is not of a given type. |
||
| 1244 | * |
||
| 1245 | * @param mixed $actual |
||
| 1246 | * @see \Codeception\Module\AbstractAsserts::assertNotInstanceOf() |
||
| 1247 | */ |
||
| 1248 | public function assertNotInstanceOf(string $expected, $actual, string $message = "") { |
||
| 1249 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotInstanceOf', func_get_args())); |
||
| 1250 | } |
||
| 1251 | |||
| 1252 | |||
| 1253 | /** |
||
| 1254 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1255 | * |
||
| 1256 | * Asserts that a variable is not null. |
||
| 1257 | * |
||
| 1258 | * @param mixed $actual |
||
| 1259 | * @see \Codeception\Module\AbstractAsserts::assertNotNull() |
||
| 1260 | */ |
||
| 1261 | public function assertNotNull($actual, string $message = "") { |
||
| 1262 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotNull', func_get_args())); |
||
| 1263 | } |
||
| 1264 | |||
| 1265 | |||
| 1266 | /** |
||
| 1267 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1268 | * |
||
| 1269 | * Asserts that two variables do not have the same type and value. |
||
| 1270 | * |
||
| 1271 | * @param mixed $expected |
||
| 1272 | * @param mixed $actual |
||
| 1273 | * @see \Codeception\Module\AbstractAsserts::assertNotSame() |
||
| 1274 | */ |
||
| 1275 | public function assertNotSame($expected, $actual, string $message = "") { |
||
| 1276 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotSame', func_get_args())); |
||
| 1277 | } |
||
| 1278 | |||
| 1279 | |||
| 1280 | /** |
||
| 1281 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1282 | * |
||
| 1283 | * Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same. |
||
| 1284 | * |
||
| 1285 | * @param \Countable|iterable $expected |
||
| 1286 | * @param \Countable|iterable $actual |
||
| 1287 | * @see \Codeception\Module\AbstractAsserts::assertNotSameSize() |
||
| 1288 | */ |
||
| 1289 | public function assertNotSameSize($expected, $actual, string $message = "") { |
||
| 1290 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotSameSize', func_get_args())); |
||
| 1291 | } |
||
| 1292 | |||
| 1293 | |||
| 1294 | /** |
||
| 1295 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1296 | * |
||
| 1297 | * Asserts that a condition is not true. |
||
| 1298 | * |
||
| 1299 | * @param mixed $condition |
||
| 1300 | * @see \Codeception\Module\AbstractAsserts::assertNotTrue() |
||
| 1301 | */ |
||
| 1302 | public function assertNotTrue($condition, string $message = "") { |
||
| 1303 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNotTrue', func_get_args())); |
||
| 1304 | } |
||
| 1305 | |||
| 1306 | |||
| 1307 | /** |
||
| 1308 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1309 | * |
||
| 1310 | * Asserts that a variable is null. |
||
| 1311 | * |
||
| 1312 | * @param mixed $actual |
||
| 1313 | * @see \Codeception\Module\AbstractAsserts::assertNull() |
||
| 1314 | */ |
||
| 1315 | public function assertNull($actual, string $message = "") { |
||
| 1316 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertNull', func_get_args())); |
||
| 1317 | } |
||
| 1318 | |||
| 1319 | |||
| 1320 | /** |
||
| 1321 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1322 | * |
||
| 1323 | * Asserts that an object has a specified attribute. |
||
| 1324 | * @see \Codeception\Module\AbstractAsserts::assertObjectHasAttribute() |
||
| 1325 | */ |
||
| 1326 | public function assertObjectHasAttribute(string $attributeName, object $object, string $message = "") { |
||
| 1327 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertObjectHasAttribute', func_get_args())); |
||
| 1328 | } |
||
| 1329 | |||
| 1330 | |||
| 1331 | /** |
||
| 1332 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1333 | * |
||
| 1334 | * Asserts that an object does not have a specified attribute. |
||
| 1335 | * @see \Codeception\Module\AbstractAsserts::assertObjectNotHasAttribute() |
||
| 1336 | */ |
||
| 1337 | public function assertObjectNotHasAttribute(string $attributeName, object $object, string $message = "") { |
||
| 1338 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertObjectNotHasAttribute', func_get_args())); |
||
| 1339 | } |
||
| 1340 | |||
| 1341 | |||
| 1342 | /** |
||
| 1343 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1344 | * |
||
| 1345 | * Asserts that two variables have the same type and value. |
||
| 1346 | * |
||
| 1347 | * @param mixed $expected |
||
| 1348 | * @param mixed $actual |
||
| 1349 | * @see \Codeception\Module\AbstractAsserts::assertSame() |
||
| 1350 | */ |
||
| 1351 | public function assertSame($expected, $actual, string $message = "") { |
||
| 1352 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertSame', func_get_args())); |
||
| 1353 | } |
||
| 1354 | |||
| 1355 | |||
| 1356 | /** |
||
| 1357 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1358 | * |
||
| 1359 | * Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same. |
||
| 1360 | * |
||
| 1361 | * @param \Countable|iterable $expected |
||
| 1362 | * @param \Countable|iterable $actual |
||
| 1363 | * @see \Codeception\Module\AbstractAsserts::assertSameSize() |
||
| 1364 | */ |
||
| 1365 | public function assertSameSize($expected, $actual, string $message = "") { |
||
| 1366 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertSameSize', func_get_args())); |
||
| 1367 | } |
||
| 1368 | |||
| 1369 | |||
| 1370 | /** |
||
| 1371 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1372 | * |
||
| 1373 | * |
||
| 1374 | * @see \Codeception\Module\AbstractAsserts::assertStringContainsString() |
||
| 1375 | */ |
||
| 1376 | public function assertStringContainsString(string $needle, string $haystack, string $message = "") { |
||
| 1377 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringContainsString', func_get_args())); |
||
| 1378 | } |
||
| 1379 | |||
| 1380 | |||
| 1381 | /** |
||
| 1382 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1383 | * |
||
| 1384 | * |
||
| 1385 | * @see \Codeception\Module\AbstractAsserts::assertStringContainsStringIgnoringCase() |
||
| 1386 | */ |
||
| 1387 | public function assertStringContainsStringIgnoringCase(string $needle, string $haystack, string $message = "") { |
||
| 1388 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringContainsStringIgnoringCase', func_get_args())); |
||
| 1389 | } |
||
| 1390 | |||
| 1391 | |||
| 1392 | /** |
||
| 1393 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1394 | * |
||
| 1395 | * Asserts that a string ends not with a given suffix. |
||
| 1396 | * @see \Codeception\Module\AbstractAsserts::assertStringEndsNotWith() |
||
| 1397 | */ |
||
| 1398 | public function assertStringEndsNotWith(string $suffix, string $string, string $message = "") { |
||
| 1399 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringEndsNotWith', func_get_args())); |
||
| 1400 | } |
||
| 1401 | |||
| 1402 | |||
| 1403 | /** |
||
| 1404 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1405 | * |
||
| 1406 | * Asserts that a string ends with a given suffix. |
||
| 1407 | * @see \Codeception\Module\AbstractAsserts::assertStringEndsWith() |
||
| 1408 | */ |
||
| 1409 | public function assertStringEndsWith(string $suffix, string $string, string $message = "") { |
||
| 1410 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringEndsWith', func_get_args())); |
||
| 1411 | } |
||
| 1412 | |||
| 1413 | |||
| 1414 | /** |
||
| 1415 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1416 | * |
||
| 1417 | * Asserts that the contents of a string is equal to the contents of a file. |
||
| 1418 | * @see \Codeception\Module\AbstractAsserts::assertStringEqualsFile() |
||
| 1419 | */ |
||
| 1420 | public function assertStringEqualsFile(string $expectedFile, string $actualString, string $message = "") { |
||
| 1421 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringEqualsFile', func_get_args())); |
||
| 1422 | } |
||
| 1423 | |||
| 1424 | |||
| 1425 | /** |
||
| 1426 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1427 | * |
||
| 1428 | * Asserts that the contents of a string is equal to the contents of a file (canonicalizing). |
||
| 1429 | * @see \Codeception\Module\AbstractAsserts::assertStringEqualsFileCanonicalizing() |
||
| 1430 | */ |
||
| 1431 | public function assertStringEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message = "") { |
||
| 1432 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringEqualsFileCanonicalizing', func_get_args())); |
||
| 1433 | } |
||
| 1434 | |||
| 1435 | |||
| 1436 | /** |
||
| 1437 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1438 | * |
||
| 1439 | * Asserts that the contents of a string is equal to the contents of a file (ignoring case). |
||
| 1440 | * @see \Codeception\Module\AbstractAsserts::assertStringEqualsFileIgnoringCase() |
||
| 1441 | */ |
||
| 1442 | public function assertStringEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message = "") { |
||
| 1443 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringEqualsFileIgnoringCase', func_get_args())); |
||
| 1444 | } |
||
| 1445 | |||
| 1446 | |||
| 1447 | /** |
||
| 1448 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1449 | * |
||
| 1450 | * Asserts that a string matches a given format string. |
||
| 1451 | * @see \Codeception\Module\AbstractAsserts::assertStringMatchesFormat() |
||
| 1452 | */ |
||
| 1453 | public function assertStringMatchesFormat(string $format, string $string, string $message = "") { |
||
| 1454 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringMatchesFormat', func_get_args())); |
||
| 1455 | } |
||
| 1456 | |||
| 1457 | |||
| 1458 | /** |
||
| 1459 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1460 | * |
||
| 1461 | * Asserts that a string matches a given format file. |
||
| 1462 | * @see \Codeception\Module\AbstractAsserts::assertStringMatchesFormatFile() |
||
| 1463 | */ |
||
| 1464 | public function assertStringMatchesFormatFile(string $formatFile, string $string, string $message = "") { |
||
| 1465 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringMatchesFormatFile', func_get_args())); |
||
| 1466 | } |
||
| 1467 | |||
| 1468 | |||
| 1469 | /** |
||
| 1470 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1471 | * |
||
| 1472 | * |
||
| 1473 | * @see \Codeception\Module\AbstractAsserts::assertStringNotContainsString() |
||
| 1474 | */ |
||
| 1475 | public function assertStringNotContainsString(string $needle, string $haystack, string $message = "") { |
||
| 1477 | } |
||
| 1478 | |||
| 1479 | |||
| 1480 | /** |
||
| 1481 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1482 | * |
||
| 1483 | * |
||
| 1484 | * @see \Codeception\Module\AbstractAsserts::assertStringNotContainsStringIgnoringCase() |
||
| 1485 | */ |
||
| 1486 | public function assertStringNotContainsStringIgnoringCase(string $needle, string $haystack, string $message = "") { |
||
| 1487 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotContainsStringIgnoringCase', func_get_args())); |
||
| 1488 | } |
||
| 1489 | |||
| 1490 | |||
| 1491 | /** |
||
| 1492 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1493 | * |
||
| 1494 | * Asserts that the contents of a string is not equal to the contents of a file. |
||
| 1495 | * @see \Codeception\Module\AbstractAsserts::assertStringNotEqualsFile() |
||
| 1496 | */ |
||
| 1497 | public function assertStringNotEqualsFile(string $expectedFile, string $actualString, string $message = "") { |
||
| 1498 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotEqualsFile', func_get_args())); |
||
| 1499 | } |
||
| 1500 | |||
| 1501 | |||
| 1502 | /** |
||
| 1503 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1504 | * |
||
| 1505 | * Asserts that the contents of a string is not equal to the contents of a file (canonicalizing). |
||
| 1506 | * @see \Codeception\Module\AbstractAsserts::assertStringNotEqualsFileCanonicalizing() |
||
| 1507 | */ |
||
| 1508 | public function assertStringNotEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message = "") { |
||
| 1509 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotEqualsFileCanonicalizing', func_get_args())); |
||
| 1510 | } |
||
| 1511 | |||
| 1512 | |||
| 1513 | /** |
||
| 1514 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1515 | * |
||
| 1516 | * Asserts that the contents of a string is not equal to the contents of a file (ignoring case). |
||
| 1517 | * @see \Codeception\Module\AbstractAsserts::assertStringNotEqualsFileIgnoringCase() |
||
| 1518 | */ |
||
| 1519 | public function assertStringNotEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message = "") { |
||
| 1520 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotEqualsFileIgnoringCase', func_get_args())); |
||
| 1521 | } |
||
| 1522 | |||
| 1523 | |||
| 1524 | /** |
||
| 1525 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1526 | * |
||
| 1527 | * Asserts that a string does not match a given format string. |
||
| 1528 | * @see \Codeception\Module\AbstractAsserts::assertStringNotMatchesFormat() |
||
| 1529 | */ |
||
| 1530 | public function assertStringNotMatchesFormat(string $format, string $string, string $message = "") { |
||
| 1531 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotMatchesFormat', func_get_args())); |
||
| 1532 | } |
||
| 1533 | |||
| 1534 | |||
| 1535 | /** |
||
| 1536 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1537 | * |
||
| 1538 | * Asserts that a string does not match a given format string. |
||
| 1539 | * @see \Codeception\Module\AbstractAsserts::assertStringNotMatchesFormatFile() |
||
| 1540 | */ |
||
| 1541 | public function assertStringNotMatchesFormatFile(string $formatFile, string $string, string $message = "") { |
||
| 1542 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringNotMatchesFormatFile', func_get_args())); |
||
| 1543 | } |
||
| 1544 | |||
| 1545 | |||
| 1546 | /** |
||
| 1547 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1548 | * |
||
| 1549 | * Asserts that a string starts not with a given prefix. |
||
| 1550 | * @see \Codeception\Module\AbstractAsserts::assertStringStartsNotWith() |
||
| 1551 | */ |
||
| 1552 | public function assertStringStartsNotWith(string $prefix, string $string, string $message = "") { |
||
| 1553 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringStartsNotWith', func_get_args())); |
||
| 1554 | } |
||
| 1555 | |||
| 1556 | |||
| 1557 | /** |
||
| 1558 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1559 | * |
||
| 1560 | * Asserts that a string starts with a given prefix. |
||
| 1561 | * @see \Codeception\Module\AbstractAsserts::assertStringStartsWith() |
||
| 1562 | */ |
||
| 1563 | public function assertStringStartsWith(string $prefix, string $string, string $message = "") { |
||
| 1564 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertStringStartsWith', func_get_args())); |
||
| 1565 | } |
||
| 1566 | |||
| 1567 | |||
| 1568 | /** |
||
| 1569 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1570 | * |
||
| 1571 | * Evaluates a PHPUnit\Framework\Constraint matcher object. |
||
| 1572 | * |
||
| 1573 | * @param mixed $value |
||
| 1574 | * @see \Codeception\Module\AbstractAsserts::assertThat() |
||
| 1575 | */ |
||
| 1576 | public function assertThat($value, \PHPUnit\Framework\Constraint\Constraint $constraint, string $message = "") { |
||
| 1577 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertThat', func_get_args())); |
||
| 1578 | } |
||
| 1579 | |||
| 1580 | |||
| 1581 | /** |
||
| 1582 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1583 | * |
||
| 1584 | * Asserts that a condition is true. |
||
| 1585 | * |
||
| 1586 | * @param mixed $condition |
||
| 1587 | * @see \Codeception\Module\AbstractAsserts::assertTrue() |
||
| 1588 | */ |
||
| 1589 | public function assertTrue($condition, string $message = "") { |
||
| 1590 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertTrue', func_get_args())); |
||
| 1591 | } |
||
| 1592 | |||
| 1593 | |||
| 1594 | /** |
||
| 1595 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1596 | * |
||
| 1597 | * Asserts that two XML files are equal. |
||
| 1598 | * @see \Codeception\Module\AbstractAsserts::assertXmlFileEqualsXmlFile() |
||
| 1599 | */ |
||
| 1600 | public function assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile, string $message = "") { |
||
| 1601 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertXmlFileEqualsXmlFile', func_get_args())); |
||
| 1602 | } |
||
| 1603 | |||
| 1604 | |||
| 1605 | /** |
||
| 1606 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1607 | * |
||
| 1608 | * Asserts that two XML files are not equal. |
||
| 1609 | * @see \Codeception\Module\AbstractAsserts::assertXmlFileNotEqualsXmlFile() |
||
| 1610 | */ |
||
| 1611 | public function assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile, string $message = "") { |
||
| 1612 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertXmlFileNotEqualsXmlFile', func_get_args())); |
||
| 1613 | } |
||
| 1614 | |||
| 1615 | |||
| 1616 | /** |
||
| 1617 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1618 | * |
||
| 1619 | * Asserts that two XML documents are equal. |
||
| 1620 | * |
||
| 1621 | * @param \DOMDocument|string $actualXml |
||
| 1622 | * @see \Codeception\Module\AbstractAsserts::assertXmlStringEqualsXmlFile() |
||
| 1623 | */ |
||
| 1624 | public function assertXmlStringEqualsXmlFile(string $expectedFile, $actualXml, string $message = "") { |
||
| 1625 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertXmlStringEqualsXmlFile', func_get_args())); |
||
| 1626 | } |
||
| 1627 | |||
| 1628 | |||
| 1629 | /** |
||
| 1630 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1631 | * |
||
| 1632 | * Asserts that two XML documents are equal. |
||
| 1633 | * |
||
| 1634 | * @param \DOMDocument|string $expectedXml |
||
| 1635 | * @param \DOMDocument|string $actualXml |
||
| 1636 | * @see \Codeception\Module\AbstractAsserts::assertXmlStringEqualsXmlString() |
||
| 1637 | */ |
||
| 1638 | public function assertXmlStringEqualsXmlString($expectedXml, $actualXml, string $message = "") { |
||
| 1639 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertXmlStringEqualsXmlString', func_get_args())); |
||
| 1640 | } |
||
| 1641 | |||
| 1642 | |||
| 1643 | /** |
||
| 1644 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1645 | * |
||
| 1646 | * Asserts that two XML documents are not equal. |
||
| 1647 | * |
||
| 1648 | * @param \DOMDocument|string $actualXml |
||
| 1649 | * @see \Codeception\Module\AbstractAsserts::assertXmlStringNotEqualsXmlFile() |
||
| 1650 | */ |
||
| 1651 | public function assertXmlStringNotEqualsXmlFile(string $expectedFile, $actualXml, string $message = "") { |
||
| 1652 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertXmlStringNotEqualsXmlFile', func_get_args())); |
||
| 1653 | } |
||
| 1654 | |||
| 1655 | |||
| 1656 | /** |
||
| 1657 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1658 | * |
||
| 1659 | * Asserts that two XML documents are not equal. |
||
| 1660 | * |
||
| 1661 | * @param \DOMDocument|string $expectedXml |
||
| 1662 | * @param \DOMDocument|string $actualXml |
||
| 1663 | * @see \Codeception\Module\AbstractAsserts::assertXmlStringNotEqualsXmlString() |
||
| 1664 | */ |
||
| 1665 | public function assertXmlStringNotEqualsXmlString($expectedXml, $actualXml, string $message = "") { |
||
| 1666 | return $this->getScenario()->runStep(new \Codeception\Step\Action('assertXmlStringNotEqualsXmlString', func_get_args())); |
||
| 1667 | } |
||
| 1668 | |||
| 1669 | |||
| 1670 | /** |
||
| 1671 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1672 | * |
||
| 1673 | * Fails a test with the given message. |
||
| 1674 | * @see \Codeception\Module\AbstractAsserts::fail() |
||
| 1675 | */ |
||
| 1676 | public function fail(string $message = "") { |
||
| 1677 | return $this->getScenario()->runStep(new \Codeception\Step\Action('fail', func_get_args())); |
||
| 1678 | } |
||
| 1679 | |||
| 1680 | |||
| 1681 | /** |
||
| 1682 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1683 | * |
||
| 1684 | * Mark the test as incomplete. |
||
| 1685 | * @see \Codeception\Module\AbstractAsserts::markTestIncomplete() |
||
| 1686 | */ |
||
| 1687 | public function markTestIncomplete(string $message = "") { |
||
| 1688 | return $this->getScenario()->runStep(new \Codeception\Step\Action('markTestIncomplete', func_get_args())); |
||
| 1689 | } |
||
| 1690 | |||
| 1691 | |||
| 1692 | /** |
||
| 1693 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1694 | * |
||
| 1695 | * Mark the test as skipped. |
||
| 1696 | * @see \Codeception\Module\AbstractAsserts::markTestSkipped() |
||
| 1697 | */ |
||
| 1698 | public function markTestSkipped(string $message = "") { |
||
| 1699 | return $this->getScenario()->runStep(new \Codeception\Step\Action('markTestSkipped', func_get_args())); |
||
| 1700 | } |
||
| 1701 | |||
| 1702 | |||
| 1703 | /** |
||
| 1704 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1705 | * |
||
| 1706 | * Creates and loads fixtures from a config. |
||
| 1707 | * The signature is the same as for the `fixtures()` method of `yii\test\FixtureTrait` |
||
| 1708 | * |
||
| 1709 | * ```php |
||
| 1710 | * <?php |
||
| 1711 | * $I->haveFixtures([ |
||
| 1712 | * 'posts' => PostsFixture::class, |
||
| 1713 | * 'user' => [ |
||
| 1714 | * 'class' => UserFixture::class, |
||
| 1715 | * 'dataFile' => '@tests/_data/models/user.php', |
||
| 1716 | * ], |
||
| 1717 | * ]); |
||
| 1718 | * ``` |
||
| 1719 | * |
||
| 1720 | * Note: if you need to load fixtures before a test (probably before the |
||
| 1721 | * cleanup transaction is started; `cleanup` option is `true` by default), |
||
| 1722 | * you can specify the fixtures in the `_fixtures()` method of a test case |
||
| 1723 | * |
||
| 1724 | * ```php |
||
| 1725 | * <?php |
||
| 1726 | * // inside Cest file or Codeception\TestCase\Unit |
||
| 1727 | * public function _fixtures(){ |
||
| 1728 | * return [ |
||
| 1729 | * 'user' => [ |
||
| 1730 | * 'class' => UserFixture::class, |
||
| 1731 | * 'dataFile' => codecept_data_dir() . 'user.php' |
||
| 1732 | * ] |
||
| 1733 | * ]; |
||
| 1734 | * } |
||
| 1735 | * ``` |
||
| 1736 | * instead of calling `haveFixtures` in Cest `_before` |
||
| 1737 | * |
||
| 1738 | * @param $fixtures |
||
| 1739 | * @part fixtures |
||
| 1740 | * @see \Codeception\Module\Yii2::haveFixtures() |
||
| 1741 | */ |
||
| 1742 | public function haveFixtures($fixtures) { |
||
| 1743 | return $this->getScenario()->runStep(new \Codeception\Step\Action('haveFixtures', func_get_args())); |
||
| 1744 | } |
||
| 1745 | |||
| 1746 | |||
| 1747 | /** |
||
| 1748 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1749 | * |
||
| 1750 | * Returns all loaded fixtures. |
||
| 1751 | * Array of fixture instances |
||
| 1752 | * |
||
| 1753 | * @part fixtures |
||
| 1754 | * @return array |
||
| 1755 | * @see \Codeception\Module\Yii2::grabFixtures() |
||
| 1756 | */ |
||
| 1757 | public function grabFixtures() { |
||
| 1758 | return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFixtures', func_get_args())); |
||
| 1759 | } |
||
| 1760 | |||
| 1761 | |||
| 1762 | /** |
||
| 1763 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1764 | * |
||
| 1765 | * Gets a fixture by name. |
||
| 1766 | * Returns a Fixture instance. If a fixture is an instance of |
||
| 1767 | * `\yii\test\BaseActiveFixture` a second parameter can be used to return a |
||
| 1768 | * specific model: |
||
| 1769 | * |
||
| 1770 | * ```php |
||
| 1771 | * <?php |
||
| 1772 | * $I->haveFixtures(['users' => UserFixture::class]); |
||
| 1773 | * |
||
| 1774 | * $users = $I->grabFixture('users'); |
||
| 1775 | * |
||
| 1776 | * // get first user by key, if a fixture is an instance of ActiveFixture |
||
| 1777 | * $user = $I->grabFixture('users', 'user1'); |
||
| 1778 | * ``` |
||
| 1779 | * |
||
| 1780 | * @param $name |
||
| 1781 | * @return mixed |
||
| 1782 | * @throws \Codeception\Exception\ModuleException if the fixture is not found |
||
| 1783 | * @part fixtures |
||
| 1784 | * @see \Codeception\Module\Yii2::grabFixture() |
||
| 1785 | */ |
||
| 1786 | public function grabFixture($name, $index = NULL) { |
||
| 1787 | return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFixture', func_get_args())); |
||
| 1788 | } |
||
| 1789 | |||
| 1790 | |||
| 1791 | /** |
||
| 1792 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1793 | * |
||
| 1794 | * Inserts a record into the database. |
||
| 1795 | * |
||
| 1796 | * ``` php |
||
| 1797 | * <?php |
||
| 1798 | * $user_id = $I->haveRecord('app\models\User', array('name' => 'Davert')); |
||
| 1799 | * ?> |
||
| 1800 | * ``` |
||
| 1801 | * |
||
| 1802 | * @param $model |
||
| 1803 | * @param array $attributes |
||
| 1804 | * @return mixed |
||
| 1805 | * @part orm |
||
| 1806 | * @see \Codeception\Module\Yii2::haveRecord() |
||
| 1807 | */ |
||
| 1808 | public function haveRecord($model, $attributes = []) { |
||
| 1809 | return $this->getScenario()->runStep(new \Codeception\Step\Action('haveRecord', func_get_args())); |
||
| 1810 | } |
||
| 1811 | |||
| 1812 | |||
| 1813 | /** |
||
| 1814 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1815 | * |
||
| 1816 | * Checks that a record exists in the database. |
||
| 1817 | * |
||
| 1818 | * ``` php |
||
| 1819 | * $I->seeRecord('app\models\User', array('name' => 'davert')); |
||
| 1820 | * ``` |
||
| 1821 | * |
||
| 1822 | * @param $model |
||
| 1823 | * @param array $attributes |
||
| 1824 | * @part orm |
||
| 1825 | * @see \Codeception\Module\Yii2::seeRecord() |
||
| 1826 | */ |
||
| 1827 | public function seeRecord(string $model, array $attributes = []): void { |
||
| 1828 | $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeRecord', func_get_args())); |
||
| 1829 | } |
||
| 1830 | /** |
||
| 1831 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1832 | * |
||
| 1833 | * [!] Conditional Assertion: Test won't be stopped on fail |
||
| 1834 | * Checks that a record exists in the database. |
||
| 1835 | * |
||
| 1836 | * ``` php |
||
| 1837 | * $I->seeRecord('app\models\User', array('name' => 'davert')); |
||
| 1838 | * ``` |
||
| 1839 | * |
||
| 1840 | * @param $model |
||
| 1841 | * @param array $attributes |
||
| 1842 | * @part orm |
||
| 1843 | * @see \Codeception\Module\Yii2::seeRecord() |
||
| 1844 | */ |
||
| 1845 | public function canSeeRecord(string $model, array $attributes = []): void { |
||
| 1846 | $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeRecord', func_get_args())); |
||
| 1847 | } |
||
| 1848 | |||
| 1849 | |||
| 1850 | /** |
||
| 1851 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1852 | * |
||
| 1853 | * Checks that a record does not exist in the database. |
||
| 1854 | * |
||
| 1855 | * ``` php |
||
| 1856 | * $I->dontSeeRecord('app\models\User', array('name' => 'davert')); |
||
| 1857 | * ``` |
||
| 1858 | * |
||
| 1859 | * @param $model |
||
| 1860 | * @param array $attributes |
||
| 1861 | * @part orm |
||
| 1862 | * @see \Codeception\Module\Yii2::dontSeeRecord() |
||
| 1863 | */ |
||
| 1864 | public function dontSeeRecord(string $model, array $attributes = []): void { |
||
| 1865 | $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeRecord', func_get_args())); |
||
| 1866 | } |
||
| 1867 | /** |
||
| 1868 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1869 | * |
||
| 1870 | * [!] Conditional Assertion: Test won't be stopped on fail |
||
| 1871 | * Checks that a record does not exist in the database. |
||
| 1872 | * |
||
| 1873 | * ``` php |
||
| 1874 | * $I->dontSeeRecord('app\models\User', array('name' => 'davert')); |
||
| 1875 | * ``` |
||
| 1876 | * |
||
| 1877 | * @param $model |
||
| 1878 | * @param array $attributes |
||
| 1879 | * @part orm |
||
| 1880 | * @see \Codeception\Module\Yii2::dontSeeRecord() |
||
| 1881 | */ |
||
| 1882 | public function cantSeeRecord(string $model, array $attributes = []): void { |
||
| 1883 | $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeRecord', func_get_args())); |
||
| 1884 | } |
||
| 1885 | |||
| 1886 | |||
| 1887 | /** |
||
| 1888 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1889 | * |
||
| 1890 | * Retrieves a record from the database |
||
| 1891 | * |
||
| 1892 | * ``` php |
||
| 1893 | * $category = $I->grabRecord('app\models\User', array('name' => 'davert')); |
||
| 1894 | * ``` |
||
| 1895 | * |
||
| 1896 | * @param $model |
||
| 1897 | * @param array $attributes |
||
| 1898 | * @return mixed |
||
| 1899 | * @part orm |
||
| 1900 | * @see \Codeception\Module\Yii2::grabRecord() |
||
| 1901 | */ |
||
| 1902 | public function grabRecord(string $model, array $attributes = []): mixed { |
||
| 1903 | return $this->getScenario()->runStep(new \Codeception\Step\Action('grabRecord', func_get_args())); |
||
| 1904 | } |
||
| 1905 | |||
| 1906 | |||
| 1907 | /** |
||
| 1908 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1909 | * |
||
| 1910 | * Checks that an email is sent. |
||
| 1911 | * |
||
| 1912 | * ```php |
||
| 1913 | * <?php |
||
| 1914 | * // check that at least 1 email was sent |
||
| 1915 | * $I->seeEmailIsSent(); |
||
| 1916 | * |
||
| 1917 | * // check that only 3 emails were sent |
||
| 1918 | * $I->seeEmailIsSent(3); |
||
| 1919 | * ``` |
||
| 1920 | * |
||
| 1921 | * @param int $num |
||
| 1922 | * @throws \Codeception\Exception\ModuleException |
||
| 1923 | * @part email |
||
| 1924 | * @see \Codeception\Module\Yii2::seeEmailIsSent() |
||
| 1925 | */ |
||
| 1926 | public function seeEmailIsSent(?int $num = NULL): void { |
||
| 1927 | $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeEmailIsSent', func_get_args())); |
||
| 1928 | } |
||
| 1929 | /** |
||
| 1930 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1931 | * |
||
| 1932 | * [!] Conditional Assertion: Test won't be stopped on fail |
||
| 1933 | * Checks that an email is sent. |
||
| 1934 | * |
||
| 1935 | * ```php |
||
| 1936 | * <?php |
||
| 1937 | * // check that at least 1 email was sent |
||
| 1938 | * $I->seeEmailIsSent(); |
||
| 1939 | * |
||
| 1940 | * // check that only 3 emails were sent |
||
| 1941 | * $I->seeEmailIsSent(3); |
||
| 1942 | * ``` |
||
| 1943 | * |
||
| 1944 | * @param int $num |
||
| 1945 | * @throws \Codeception\Exception\ModuleException |
||
| 1946 | * @part email |
||
| 1947 | * @see \Codeception\Module\Yii2::seeEmailIsSent() |
||
| 1948 | */ |
||
| 1949 | public function canSeeEmailIsSent(?int $num = NULL): void { |
||
| 1950 | $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeEmailIsSent', func_get_args())); |
||
| 1951 | } |
||
| 1952 | |||
| 1953 | |||
| 1954 | /** |
||
| 1955 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1956 | * |
||
| 1957 | * Checks that no email was sent |
||
| 1958 | * |
||
| 1959 | * @part email |
||
| 1960 | * @see \Codeception\Module\Yii2::dontSeeEmailIsSent() |
||
| 1961 | */ |
||
| 1962 | public function dontSeeEmailIsSent(): void { |
||
| 1964 | } |
||
| 1965 | /** |
||
| 1966 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1967 | * |
||
| 1968 | * [!] Conditional Assertion: Test won't be stopped on fail |
||
| 1969 | * Checks that no email was sent |
||
| 1970 | * |
||
| 1971 | * @part email |
||
| 1972 | * @see \Codeception\Module\Yii2::dontSeeEmailIsSent() |
||
| 1973 | */ |
||
| 1974 | public function cantSeeEmailIsSent(): void { |
||
| 1975 | $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeEmailIsSent', func_get_args())); |
||
| 1976 | } |
||
| 1977 | |||
| 1978 | |||
| 1979 | /** |
||
| 1980 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 1981 | * |
||
| 1982 | * Returns array of all sent email messages. |
||
| 1983 | * Each message implements the `yii\mail\MessageInterface` interface. |
||
| 1984 | * Useful to perform additional checks using the `Asserts` module: |
||
| 1985 | * |
||
| 1986 | * ```php |
||
| 1987 | * <?php |
||
| 1988 | * $I->seeEmailIsSent(); |
||
| 1989 | * $messages = $I->grabSentEmails(); |
||
| 1990 | * $I->assertEquals('admin@site,com', $messages[0]->getTo()); |
||
| 1991 | * ``` |
||
| 1992 | * |
||
| 1993 | * @part email |
||
| 1994 | * @return array |
||
| 1995 | * @throws \Codeception\Exception\ModuleException |
||
| 1996 | * @see \Codeception\Module\Yii2::grabSentEmails() |
||
| 1997 | */ |
||
| 1998 | public function grabSentEmails(): array { |
||
| 2000 | } |
||
| 2001 | |||
| 2002 | |||
| 2003 | /** |
||
| 2004 | * [!] Method is generated. Documentation taken from corresponding module. |
||
| 2005 | * |
||
| 2006 | * Returns the last sent email: |
||
| 2007 | * |
||
| 2008 | * ```php |
||
| 2009 | * <?php |
||
| 2010 | * $I->seeEmailIsSent(); |
||
| 2011 | * $message = $I->grabLastSentEmail(); |
||
| 2012 | * $I->assertEquals('admin@site,com', $message->getTo()); |
||
| 2013 | * ``` |
||
| 2014 | * @part email |
||
| 2015 | * @see \Codeception\Module\Yii2::grabLastSentEmail() |
||
| 2016 | */ |
||
| 2017 | public function grabLastSentEmail(): object { |
||
| 2018 | return $this->getScenario()->runStep(new \Codeception\Step\Action('grabLastSentEmail', func_get_args())); |
||
| 2019 | } |
||
| 2020 | } |
||
| 2021 |