| layout | title |
|---|---|
doc |
Module - Codeception - Documentation |
- Uses
Codeception\Util\Shared\Asserts
Basic class for Modules and Helpers. You must extend from it while implementing own helpers.
Public methods of this class start with _ prefix in order to ignore them in actor classes.
Module contains HOOKS which allow to handle test execution routine.
public static $includeInheritedActions
By setting it to false module wan't inherit methods of parent class.
public static $onlyActions
Allows to explicitly set what methods have this class.
public static $excludeActions
Allows to explicitly exclude actions from module.
public static $aliases
Allows to rename actions
public __construct($moduleContainer, array $config = null)
param \Codeception\Lib\ModuleContainer$moduleContainerparam ?array$config
Module constructor.
Requires module container (to provide access between modules of suite) and config.
public _after($test)
param \Codeception\TestInterface$test
HOOK executed after test
public _afterStep($step)
param \Codeception\Step$step
HOOK executed after step
public _afterSuite()
HOOK executed after suite
public _before($test)
param \Codeception\TestInterface$test
HOOK executed before test
public _beforeStep($step)
param \Codeception\Step$step
HOOK executed before step
public _beforeSuite(array $settings = array ( ))
param array$settings
HOOK executed before suite
public _failed($test, $fail)
param \Codeception\TestInterface$testparam \Exception$fail
HOOK executed when test fails but before _after
public _getConfig($key = null)
param string|null$keyreturn mixedthe config item's value or null if it doesn't exist
Get config values or specific config item.
public _getName()
return string
Returns a module name for a Module, a class name for Helper
public _hasRequiredFields()
return bool
Checks if a module has required fields
public _initialize()
HOOK triggered after module is created and configuration is loaded
public _reconfigure(array $config)
param array$configthrows ModuleConfigException|ModuleExceptionreturn void
Allows to redefine config for a specific test.
Config is restored at the end of a test.
{% highlight php %}
getMetadata()->getGroups()) { $this->getModule('Db')->_reconfigure(['cleanup' => true]); } } {% endhighlight %} [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L103) #### _resetConfig() *public* _resetConfig() * `return void` Reverts config changed by `_reconfigure` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L121) #### _setConfig() *public* _setConfig(array $config) * `param array` $config * `throws ModuleConfigException|ModuleException` * `return void` Allows to define initial module config. Can be used in `_beforeSuite` hook of Helpers or Extensions {% highlight php %} getModule('otherModule')->_setConfig($this->myOtherConfig); } {% endhighlight %} [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L80) #### assert() *protected* assert(array $arguments, $not = false) * `param array` $arguments * `param bool` $not * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L19) #### assertArrayHasKey() *protected* assertArrayHasKey($key, $array, $message = '') * `param string|int` $key * `param \ArrayAccess|array` $array * `param string` $message * `return void` Asserts that an array has a specified key. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L21) #### assertArrayNotHasKey() *protected* assertArrayNotHasKey($key, $array, $message = '') * `param string|int` $key * `param \ArrayAccess|array` $array * `param string` $message * `return void` Asserts that an array does not have a specified key. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L30) #### assertClassHasAttribute() *protected* assertClassHasAttribute($attributeName, $className, $message = '') * `param string` $attributeName * `param class-string` $className * `param string` $message * `return void` Asserts that a class has a specified attribute. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L39) #### assertClassHasStaticAttribute() *protected* assertClassHasStaticAttribute($attributeName, $className, $message = '') * `param string` $attributeName * `param class-string` $className * `param string` $message * `return void` Asserts that a class has a specified static attribute. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L49) #### assertClassNotHasAttribute() *protected* assertClassNotHasAttribute($attributeName, $className, $message = '') * `param string` $attributeName * `param class-string` $className * `param string` $message * `return void` Asserts that a class does not have a specified attribute. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L60) #### assertClassNotHasStaticAttribute() *protected* assertClassNotHasStaticAttribute($attributeName, $className, $message = '') * `param string` $attributeName * `param class-string` $className * `param string` $message * `return void` Asserts that a class does not have a specified static attribute. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L70) #### assertContains() *protected* assertContains($needle, $haystack, $message = '') * `param mixed` $needle * `param iterable` $haystack * `param string` $message * `return void` Asserts that a haystack contains a needle. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L81) #### assertContainsEquals() *protected* assertContainsEquals($needle, $haystack, $message = '') * `param mixed` $needle * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L89) #### assertContainsNotOnlyArray() *protected* assertContainsNotOnlyArray($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L105) #### assertContainsNotOnlyBool() *protected* assertContainsNotOnlyBool($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L113) #### assertContainsNotOnlyCallable() *protected* assertContainsNotOnlyCallable($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L121) #### assertContainsNotOnlyClosedResource() *protected* assertContainsNotOnlyClosedResource($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L194) #### assertContainsNotOnlyFloat() *protected* assertContainsNotOnlyFloat($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L129) #### assertContainsNotOnlyInstancesOf() *protected* assertContainsNotOnlyInstancesOf($className, $haystack, $message = '') * `param class-string` $className * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L138) #### assertContainsNotOnlyInt() *protected* assertContainsNotOnlyInt($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L146) #### assertContainsNotOnlyIterable() *protected* assertContainsNotOnlyIterable($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L154) #### assertContainsNotOnlyNull() *protected* assertContainsNotOnlyNull($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L162) #### assertContainsNotOnlyNumeric() *protected* assertContainsNotOnlyNumeric($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L170) #### assertContainsNotOnlyObject() *protected* assertContainsNotOnlyObject($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L178) #### assertContainsNotOnlyResource() *protected* assertContainsNotOnlyResource($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L186) #### assertContainsNotOnlyScalar() *protected* assertContainsNotOnlyScalar($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L202) #### assertContainsNotOnlyString() *protected* assertContainsNotOnlyString($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L210) #### assertContainsOnly() *protected* assertContainsOnly($type, $haystack, $isNativeType = null, $message = '') * `param string` $type * `param iterable` $haystack * `param ?bool` $isNativeType * `param string` $message * `return void` Asserts that a haystack contains only values of a given type. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L220) #### assertContainsOnlyArray() *protected* assertContainsOnlyArray($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L278) #### assertContainsOnlyBool() *protected* assertContainsOnlyBool($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L286) #### assertContainsOnlyCallable() *protected* assertContainsOnlyCallable($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L294) #### assertContainsOnlyClosedResource() *protected* assertContainsOnlyClosedResource($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L358) #### assertContainsOnlyFloat() *protected* assertContainsOnlyFloat($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L302) #### assertContainsOnlyInstancesOf() *protected* assertContainsOnlyInstancesOf($className, $haystack, $message = '') * `param class-string` $className * `param iterable` $haystack * `param string` $message * `return void` Asserts that a haystack contains only instances of a given class name. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L270) #### assertContainsOnlyInt() *protected* assertContainsOnlyInt($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L310) #### assertContainsOnlyIterable() *protected* assertContainsOnlyIterable($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L318) #### assertContainsOnlyNull() *protected* assertContainsOnlyNull($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L326) #### assertContainsOnlyNumeric() *protected* assertContainsOnlyNumeric($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L334) #### assertContainsOnlyObject() *protected* assertContainsOnlyObject($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L342) #### assertContainsOnlyResource() *protected* assertContainsOnlyResource($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L350) #### assertContainsOnlyScalar() *protected* assertContainsOnlyScalar($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L366) #### assertContainsOnlyString() *protected* assertContainsOnlyString($haystack, $message = '') * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L374) #### assertCount() *protected* assertCount($expectedCount, $haystack, $message = '') * `param int` $expectedCount * `param \Countable|iterable` $haystack * `param string` $message * `return void` Asserts the number of elements of an array, Countable or Traversable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L384) #### assertDirectoryDoesNotExist() *protected* assertDirectoryDoesNotExist($directory, $message = '') * `param string` $directory * `param string` $message * `return void` Asserts that a directory does not exist. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L392) #### assertDirectoryExists() *protected* assertDirectoryExists($directory, $message = '') * `param string` $directory * `param string` $message * `return void` Asserts that a directory exists. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L400) #### assertDirectoryIsNotReadable() *protected* assertDirectoryIsNotReadable($directory, $message = '') * `param string` $directory * `param string` $message * `return void` Asserts that a directory exists and is not readable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L408) #### assertDirectoryIsNotWritable() *protected* assertDirectoryIsNotWritable($directory, $message = '') * `param string` $directory * `param string` $message * `return void` Asserts that a directory exists and is not writable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L416) #### assertDirectoryIsReadable() *protected* assertDirectoryIsReadable($directory, $message = '') * `param string` $directory * `param string` $message * `return void` Asserts that a directory exists and is readable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L424) #### assertDirectoryIsWritable() *protected* assertDirectoryIsWritable($directory, $message = '') * `param string` $directory * `param string` $message * `return void` Asserts that a directory exists and is writable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L432) #### assertDoesNotMatchRegularExpression() *protected* assertDoesNotMatchRegularExpression($pattern, $string, $message = '') * `param string` $pattern * `param string` $string * `param string` $message * `return void` Asserts that a string does not match a given regular expression. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L440) #### assertEmpty() *protected* assertEmpty($actual, $message = '') * `phpstan-assert` empty $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is empty. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L452) #### assertEquals() *protected* assertEquals($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that two variables are equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L463) #### assertEqualsCanonicalizing() *protected* assertEqualsCanonicalizing($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that two variables are equal (canonicalizing). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L474) #### assertEqualsIgnoringCase() *protected* assertEqualsIgnoringCase($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that two variables are equal (ignoring case). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L485) #### assertEqualsWithDelta() *protected* assertEqualsWithDelta($expected, $actual, $delta, $message = '') * `param mixed` $expected * `param mixed` $actual * `param float` $delta * `param string` $message * `return void` Asserts that two variables are equal (with delta). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L496) #### assertFalse() *protected* assertFalse($condition, $message = '') * `phpstan-assert` false $condition * `param mixed` $condition * `param string` $message * `return void` Asserts that a condition is false. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L508) #### assertFileDoesNotExist() *protected* assertFileDoesNotExist($filename, $message = '') * `param string` $filename * `param string` $message * `return void` Asserts that a file does not exist. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L516) #### assertFileEquals() *protected* assertFileEquals($expected, $actual, $message = '') * `param string` $expected * `param string` $actual * `param string` $message * `return void` Asserts that the contents of one file is equal to the contents of another file. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L524) #### assertFileEqualsCanonicalizing() *protected* assertFileEqualsCanonicalizing($expected, $actual, $message = '') * `param string` $expected * `param string` $actual * `param string` $message * `return void` Asserts that the contents of one file is equal to the contents of another file (canonicalizing). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L532) #### assertFileEqualsIgnoringCase() *protected* assertFileEqualsIgnoringCase($expected, $actual, $message = '') * `param string` $expected * `param string` $actual * `param string` $message * `return void` Asserts that the contents of one file is equal to the contents of another file (ignoring case). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L540) #### assertFileExists() *protected* assertFileExists($filename, $message = '') * `param string` $filename * `param string` $message * `return void` Asserts that a file exists. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L548) #### assertFileIsNotReadable() *protected* assertFileIsNotReadable($file, $message = '') * `param string` $file * `param string` $message * `return void` Asserts that a file exists and is not readable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L556) #### assertFileIsNotWritable() *protected* assertFileIsNotWritable($file, $message = '') * `param string` $file * `param string` $message * `return void` Asserts that a file exists and is not writable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L564) #### assertFileIsReadable() *protected* assertFileIsReadable($file, $message = '') * `param string` $file * `param string` $message * `return void` Asserts that a file exists and is readable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L572) #### assertFileIsWritable() *protected* assertFileIsWritable($file, $message = '') * `param string` $file * `param string` $message * `return void` Asserts that a file exists and is writable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L580) #### assertFileNotEquals() *protected* assertFileNotEquals($expected, $actual, $message = '') * `param string` $expected * `param string` $actual * `param string` $message * `return void` Asserts that the contents of one file is not equal to the contents of another file. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L588) #### assertFileNotEqualsCanonicalizing() *protected* assertFileNotEqualsCanonicalizing($expected, $actual, $message = '') * `param string` $expected * `param string` $actual * `param string` $message * `return void` Asserts that the contents of one file is not equal to the contents of another file (canonicalizing). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L596) #### assertFileNotEqualsIgnoringCase() *protected* assertFileNotEqualsIgnoringCase($expected, $actual, $message = '') * `param string` $expected * `param string` $actual * `param string` $message * `return void` Asserts that the contents of one file is not equal to the contents of another file (ignoring case). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L604) #### assertFileNotExists() *protected* assertFileNotExists($filename, $message = '') * `param string` $filename * `param string` $message * `return void` Asserts that a file does not exist. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L55) #### assertFinite() *protected* assertFinite($actual, $message = '') * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is finite. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L614) #### assertGreaterOrEquals() *protected* assertGreaterOrEquals($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that a value is greater than or equal to another value. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L66) #### assertGreaterThan() *protected* assertGreaterThan($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that a value is greater than another value. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L625) #### assertGreaterThanOrEqual() *protected* assertGreaterThanOrEqual($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that a value is greater than or equal to another value. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L636) #### assertInfinite() *protected* assertInfinite($actual, $message = '') * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is infinite. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L646) #### assertInstanceOf() *protected* assertInstanceOf($expected, $actual, $message = '') * `template` ExpectedType of object * `phpstan-assert` =ExpectedType $actual * `param class-string` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of a given type. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L661) #### assertIsArray() *protected* assertIsArray($actual, $message = '') * `phpstan-assert` array $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of type array. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L672) #### assertIsBool() *protected* assertIsBool($actual, $message = '') * `phpstan-assert` bool $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of type bool. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L684) #### assertIsCallable() *protected* assertIsCallable($actual, $message = '') * `phpstan-assert` callable $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of type callable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L696) #### assertIsClosedResource() *protected* assertIsClosedResource($actual, $message = '') * `phpstan-assert` resource $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of type resource and is closed. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L708) #### assertIsEmpty() *protected* assertIsEmpty($actual, $message = '') * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is empty. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L74) #### assertIsFloat() *protected* assertIsFloat($actual, $message = '') * `phpstan-assert` float $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of type float. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L720) #### assertIsInt() *protected* assertIsInt($actual, $message = '') * `phpstan-assert` int $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of type int. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L732) #### assertIsIterable() *protected* assertIsIterable($actual, $message = '') * `phpstan-assert` iterable $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of type iterable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L744) #### assertIsNotArray() *protected* assertIsNotArray($actual, $message = '') * `phpstan-assert` !array $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of type array. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L756) #### assertIsNotBool() *protected* assertIsNotBool($actual, $message = '') * `phpstan-assert` !bool $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of type bool. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L768) #### assertIsNotCallable() *protected* assertIsNotCallable($actual, $message = '') * `phpstan-assert` !callable $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of type callable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L780) #### assertIsNotClosedResource() *protected* assertIsNotClosedResource($actual, $message = '') * `phpstan-assert` !resource $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of type resource. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L792) #### assertIsNotFloat() *protected* assertIsNotFloat($actual, $message = '') * `phpstan-assert` !float $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of type float. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L804) #### assertIsNotInt() *protected* assertIsNotInt($actual, $message = '') * `phpstan-assert` !int $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of type int. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L816) #### assertIsNotIterable() *protected* assertIsNotIterable($actual, $message = '') * `phpstan-assert` !iterable $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of type iterable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L828) #### assertIsNotNumeric() *protected* assertIsNotNumeric($actual, $message = '') * `phpstan-assert` !numeric $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of type numeric. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L840) #### assertIsNotObject() *protected* assertIsNotObject($actual, $message = '') * `phpstan-assert` !object $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of type object. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L852) #### assertIsNotReadable() *protected* assertIsNotReadable($filename, $message = '') * `param string` $filename * `param string` $message * `return void` Asserts that a file/dir exists and is not readable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L860) #### assertIsNotResource() *protected* assertIsNotResource($actual, $message = '') * `phpstan-assert` !resource $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of type resource. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L872) #### assertIsNotScalar() *protected* assertIsNotScalar($actual, $message = '') * `psalm-assert` !scalar $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of type scalar. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L884) #### assertIsNotString() *protected* assertIsNotString($actual, $message = '') * `phpstan-assert` !string $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of type string. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L896) #### assertIsNotWritable() *protected* assertIsNotWritable($filename, $message = '') * `param string` $filename * `param string` $message * `return void` Asserts that a file/dir exists and is not writable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L904) #### assertIsNumeric() *protected* assertIsNumeric($actual, $message = '') * `phpstan-assert` numeric $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of type numeric. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L916) #### assertIsObject() *protected* assertIsObject($actual, $message = '') * `phpstan-assert` object $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of type object. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L928) #### assertIsReadable() *protected* assertIsReadable($filename, $message = '') * `param string` $filename * `param string` $message * `return void` Asserts that a file/dir is readable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L936) #### assertIsResource() *protected* assertIsResource($actual, $message = '') * `phpstan-assert` resource $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of type resource. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L948) #### assertIsScalar() *protected* assertIsScalar($actual, $message = '') * `phpstan-assert` scalar $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of type scalar. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L960) #### assertIsString() *protected* assertIsString($actual, $message = '') * `phpstan-assert` string $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is of type string. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L972) #### assertIsWritable() *protected* assertIsWritable($filename, $message = '') * `param string` $filename * `param string` $message * `return void` Asserts that a file/dir exists and is writable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L980) #### assertJson() *protected* assertJson($actualJson, $message = '') * `param string` $actualJson * `param string` $message * `return void` Asserts that a string is a valid JSON string. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L988) #### assertJsonFileEqualsJsonFile() *protected* assertJsonFileEqualsJsonFile($expectedFile, $actualFile, $message = '') * `param string` $expectedFile * `param string` $actualFile * `param string` $message * `return void` Asserts that two JSON files are equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L996) #### assertJsonFileNotEqualsJsonFile() *protected* assertJsonFileNotEqualsJsonFile($expectedFile, $actualFile, $message = '') * `param string` $expectedFile * `param string` $actualFile * `param string` $message * `return void` Asserts that two JSON files are not equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1004) #### assertJsonStringEqualsJsonFile() *protected* assertJsonStringEqualsJsonFile($expectedFile, $actualJson, $message = '') * `param string` $expectedFile * `param string` $actualJson * `param string` $message * `return void` Asserts that the generated JSON encoded object and the content of the given file are equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1012) #### assertJsonStringEqualsJsonString() *protected* assertJsonStringEqualsJsonString($expectedJson, $actualJson, $message = '') * `param string` $expectedJson * `param string` $actualJson * `param string` $message * `return void` Asserts that two given JSON encoded objects or arrays are equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1020) #### assertJsonStringNotEqualsJsonFile() *protected* assertJsonStringNotEqualsJsonFile($expectedFile, $actualJson, $message = '') * `param string` $expectedFile * `param string` $actualJson * `param string` $message * `return void` Asserts that the generated JSON encoded object and the content of the given file are not equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1028) #### assertJsonStringNotEqualsJsonString() *protected* assertJsonStringNotEqualsJsonString($expectedJson, $actualJson, $message = '') * `param string` $expectedJson * `param string` $actualJson * `param string` $message * `return void` Asserts that two given JSON encoded objects or arrays are not equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1036) #### assertLessOrEquals() *protected* assertLessOrEquals($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that a value is smaller than or equal to another value. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L82) #### assertLessThan() *protected* assertLessThan($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that a value is smaller than another value. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1047) #### assertLessThanOrEqual() *protected* assertLessThanOrEqual($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that a value is smaller than or equal to another value. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1058) #### assertMatchesRegularExpression() *protected* assertMatchesRegularExpression($pattern, $string, $message = '') * `param string` $pattern * `param string` $string * `param string` $message * `return void` Asserts that a string matches a given regular expression. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1066) #### assertNan() *protected* assertNan($actual, $message = '') * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is nan. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1076) #### assertNot() *protected* assertNot(array $arguments) * `param array` $arguments * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L47) #### assertNotContains() *protected* assertNotContains($needle, $haystack, $message = '') * `param mixed` $needle * `param iterable` $haystack * `param string` $message * `return void` Asserts that a haystack does not contain a needle. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1086) #### assertNotContainsEquals() *protected* assertNotContainsEquals($needle, $haystack, $message = '') * `param mixed` $needle * `param iterable` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L97) #### assertNotContainsOnly() *protected* assertNotContainsOnly($type, $haystack, $isNativeType = null, $message = '') * `param string` $type * `param iterable` $haystack * `param ?bool` $isNativeType * `param string` $message * `return void` Asserts that a haystack does not contain only values of a given type. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1096) #### assertNotCount() *protected* assertNotCount($expectedCount, $haystack, $message = '') * `param int` $expectedCount * `param \Countable|iterable` $haystack * `param string` $message * `return void` Asserts the number of elements of an array, Countable or Traversable. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1146) #### assertNotEmpty() *protected* assertNotEmpty($actual, $message = '') * `phpstan-assert` !empty $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not empty. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1158) #### assertNotEquals() *protected* assertNotEquals($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that two variables are not equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1169) #### assertNotEqualsCanonicalizing() *protected* assertNotEqualsCanonicalizing($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that two variables are not equal (canonicalizing). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1180) #### assertNotEqualsIgnoringCase() *protected* assertNotEqualsIgnoringCase($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that two variables are not equal (ignoring case). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1191) #### assertNotEqualsWithDelta() *protected* assertNotEqualsWithDelta($expected, $actual, $delta, $message = '') * `param mixed` $expected * `param mixed` $actual * `param float` $delta * `param string` $message * `return void` Asserts that two variables are not equal (with delta). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1202) #### assertNotFalse() *protected* assertNotFalse($condition, $message = '') * `phpstan-assert` !false $condition * `param mixed` $condition * `param string` $message * `return void` Asserts that a condition is not false. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1214) #### assertNotInstanceOf() *protected* assertNotInstanceOf($expected, $actual, $message = '') * `template` ExpectedType of object * `phpstan-assert` !ExpectedType $actual * `param class-string` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not of a given type. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1229) #### assertNotNull() *protected* assertNotNull($actual, $message = '') * `phpstan-assert` !null $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is not null. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1241) #### assertNotRegExp() *protected* assertNotRegExp($pattern, $string, $message = '') * `param string` $pattern * `param string` $string * `param string` $message * `return void` Asserts that a string does not match a given regular expression. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L90) #### assertNotSame() *protected* assertNotSame($expected, $actual, $message = '') * `param mixed` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that two variables do not have the same type and value. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1252) #### assertNotSameSize() *protected* assertNotSameSize($expected, $actual, $message = '') * `param \Countable|iterable` $expected * `param \Countable|iterable` $actual * `param string` $message * `return void` Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1263) #### assertNotTrue() *protected* assertNotTrue($condition, $message = '') * `phpstan-assert` !true $condition * `param mixed` $condition * `param string` $message * `return void` Asserts that a condition is not true. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1275) #### assertNull() *protected* assertNull($actual, $message = '') * `phpstan-assert` null $actual * `param mixed` $actual * `param string` $message * `return void` Asserts that a variable is null. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1287) #### assertObjectHasAttribute() *protected* assertObjectHasAttribute($attributeName, $object, $message = '') * `param string` $attributeName * `param object` $object * `param string` $message * `return void` Asserts that an object has a specified attribute. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1295) #### assertObjectNotHasAttribute() *protected* assertObjectNotHasAttribute($attributeName, $object, $message = '') * `param string` $attributeName * `param object` $object * `param string` $message * `return void` Asserts that an object does not have a specified attribute. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1309) #### assertRegExp() *protected* assertRegExp($pattern, $string, $message = '') * `param string` $pattern * `param string` $string * `param string` $message * `return void` Asserts that a string matches a given regular expression. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L98) #### assertSame() *protected* assertSame($expected, $actual, $message = '') * `template` ExpectedType * `phpstan-assert` =ExpectedType $actual * `param ExpectedType` $expected * `param mixed` $actual * `param string` $message * `return void` Asserts that two variables have the same type and value. Used on objects, it asserts that two variables reference the same object. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1331) #### assertSameSize() *protected* assertSameSize($expected, $actual, $message = '') * `param \Countable|iterable` $expected * `param \Countable|iterable` $actual * `param string` $message * `return void` Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1341) #### assertStringContainsString() *protected* assertStringContainsString($needle, $haystack, $message = '') * `param string` $needle * `param string` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1346) #### assertStringContainsStringIgnoringCase() *protected* assertStringContainsStringIgnoringCase($needle, $haystack, $message = '') * `param string` $needle * `param string` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1351) #### assertStringEndsNotWith() *protected* assertStringEndsNotWith($suffix, $string, $message = '') * `param non-empty-string` $suffix * `param string` $string * `param string` $message * `return void` Asserts that a string ends not with a given suffix. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1360) #### assertStringEndsWith() *protected* assertStringEndsWith($suffix, $string, $message = '') * `param non-empty-string` $suffix * `param string` $string * `param string` $message * `return void` Asserts that a string ends with a given suffix. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1369) #### assertStringEqualsFile() *protected* assertStringEqualsFile($expectedFile, $actualString, $message = '') * `param string` $expectedFile * `param string` $actualString * `param string` $message * `return void` Asserts that the contents of a string is equal to the contents of a file. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1377) #### assertStringEqualsFileCanonicalizing() *protected* assertStringEqualsFileCanonicalizing($expectedFile, $actualString, $message = '') * `param string` $expectedFile * `param string` $actualString * `param string` $message * `return void` Asserts that the contents of a string is equal to the contents of a file (canonicalizing). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1385) #### assertStringEqualsFileIgnoringCase() *protected* assertStringEqualsFileIgnoringCase($expectedFile, $actualString, $message = '') * `param string` $expectedFile * `param string` $actualString * `param string` $message * `return void` Asserts that the contents of a string is equal to the contents of a file (ignoring case). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1393) #### assertStringMatchesFormat() *protected* assertStringMatchesFormat($format, $string, $message = '') * `param string` $format * `param string` $string * `param string` $message * `return void` Asserts that a string matches a given format string. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1401) #### assertStringMatchesFormatFile() *protected* assertStringMatchesFormatFile($formatFile, $string, $message = '') * `param string` $formatFile * `param string` $string * `param string` $message * `return void` Asserts that a string matches a given format file. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1409) #### assertStringNotContainsString() *protected* assertStringNotContainsString($needle, $haystack, $message = '') * `param string` $needle * `param string` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1414) #### assertStringNotContainsStringIgnoringCase() *protected* assertStringNotContainsStringIgnoringCase($needle, $haystack, $message = '') * `param string` $needle * `param string` $haystack * `param string` $message * `return void` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1419) #### assertStringNotEqualsFile() *protected* assertStringNotEqualsFile($expectedFile, $actualString, $message = '') * `param string` $expectedFile * `param string` $actualString * `param string` $message * `return void` Asserts that the contents of a string is not equal to the contents of a file. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1427) #### assertStringNotEqualsFileCanonicalizing() *protected* assertStringNotEqualsFileCanonicalizing($expectedFile, $actualString, $message = '') * `param string` $expectedFile * `param string` $actualString * `param string` $message * `return void` Asserts that the contents of a string is not equal to the contents of a file (canonicalizing). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1435) #### assertStringNotEqualsFileIgnoringCase() *protected* assertStringNotEqualsFileIgnoringCase($expectedFile, $actualString, $message = '') * `param string` $expectedFile * `param string` $actualString * `param string` $message * `return void` Asserts that the contents of a string is not equal to the contents of a file (ignoring case). [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1443) #### assertStringNotMatchesFormat() *protected* assertStringNotMatchesFormat($format, $string, $message = '') * `param string` $format * `param string` $string * `param string` $message * `return void` Asserts that a string does not match a given format string. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1451) #### assertStringNotMatchesFormatFile() *protected* assertStringNotMatchesFormatFile($formatFile, $string, $message = '') * `param string` $formatFile * `param string` $string * `param string` $message * `return void` Asserts that a string does not match a given format string. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1461) #### assertStringStartsNotWith() *protected* assertStringStartsNotWith($prefix, $string, $message = '') * `param non-empty-string` $prefix * `param string` $string * `param string` $message * `return void` Asserts that a string starts not with a given prefix. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1476) #### assertStringStartsWith() *protected* assertStringStartsWith($prefix, $string, $message = '') * `param non-empty-string` $prefix * `param string` $string * `param string` $message * `return void` Asserts that a string starts with a given prefix. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1485) #### assertThat() *protected* assertThat($value, $constraint, $message = '') * `param mixed` $value * `param \PHPUnit\Framework\Constraint\Constraint` $constraint * `param string` $message * `return void` Evaluates a PHPUnit\Framework\Constraint matcher object. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1495) #### assertThatItsNot() *protected* assertThatItsNot($value, $constraint, $message = '') * `param mixed` $value * `param \PHPUnit\Framework\Constraint\Constraint` $constraint * `param string` $message * `return void` Evaluates a PHPUnit\Framework\Constraint matcher object. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L106) #### assertTrue() *protected* assertTrue($condition, $message = '') * `phpstan-assert` true $condition * `param mixed` $condition * `param string` $message * `return void` Asserts that a condition is true. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1507) #### assertXmlFileEqualsXmlFile() *protected* assertXmlFileEqualsXmlFile($expectedFile, $actualFile, $message = '') * `param string` $expectedFile * `param string` $actualFile * `param string` $message * `return void` Asserts that two XML files are equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1515) #### assertXmlFileNotEqualsXmlFile() *protected* assertXmlFileNotEqualsXmlFile($expectedFile, $actualFile, $message = '') * `param string` $expectedFile * `param string` $actualFile * `param string` $message * `return void` Asserts that two XML files are not equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1523) #### assertXmlStringEqualsXmlFile() *protected* assertXmlStringEqualsXmlFile($expectedFile, $actualXml, $message = '') * `param string` $expectedFile * `param \DOMDocument|string` $actualXml * `param string` $message * `return void` Asserts that two XML documents are equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1531) #### assertXmlStringEqualsXmlString() *protected* assertXmlStringEqualsXmlString($expectedXml, $actualXml, $message = '') * `param \DOMDocument|string` $expectedXml * `param \DOMDocument|string` $actualXml * `param string` $message * `return void` Asserts that two XML documents are equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1545) #### assertXmlStringNotEqualsXmlFile() *protected* assertXmlStringNotEqualsXmlFile($expectedFile, $actualXml, $message = '') * `param string` $expectedFile * `param \DOMDocument|string` $actualXml * `param string` $message * `return void` Asserts that two XML documents are not equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1567) #### assertXmlStringNotEqualsXmlString() *protected* assertXmlStringNotEqualsXmlString($expectedXml, $actualXml, $message = '') * `param \DOMDocument|string` $expectedXml * `param \DOMDocument|string` $actualXml * `param string` $message * `return void` Asserts that two XML documents are not equal. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1584) #### debug() *protected* debug($message) * `param mixed` $message * `return void` Print debug message to the screen. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L235) #### debugSection() *protected* debugSection($title, $msg) * `param string` $title * `param mixed` $msg * `return void` Print debug message with a title [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L243) #### fail() *protected* fail($message = '') * `param string` $message * `return never` Fails a test with the given message. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1604) #### getModule() *protected* getModule($name) * `param string` $name * `throws ModuleException` * `return \Codeception\Module` Get another module by its name: {% highlight php %} getModule('WebDriver')->_findElements('.items'); {% endhighlight %} [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L285) #### getModules() *protected* getModules() * `return array` Get all enabled modules [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L270) #### hasModule() *protected* hasModule($name) * `param string` $name * `return bool` Checks that module is enabled. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L262) #### hasStaticAttribute() *private static* hasStaticAttribute($attributeName, $className) * `see` https://github.com/sebastianbergmann/phpunit/blob/9.6/src/Framework/Constraint/Object/ClassHasStaticAttribute.php * `param string` $attributeName * `param class-string` $className * `return bool` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1629) #### markTestIncomplete() *protected* markTestIncomplete($message = '') * `param string` $message * `return never` Mark the test as incomplete. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1612) #### markTestSkipped() *protected* markTestSkipped($message = '') * `param string` $message * `return never` Mark the test as skipped. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1620) #### onReconfigure() *protected* onReconfigure() HOOK to be executed when config changes with `_reconfigure`. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L113) #### scalarizeArray() *protected* scalarizeArray(array $array) * `param array` $array * `return array` [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L304) #### shortenMessage() *protected* shortenMessage($message, $chars = 150) * `param string` $message * `param int` $chars * `return string` Short text message to an amount of chars [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L254) #### validateConfig() *protected* validateConfig() * `throws ModuleConfigException|ModuleException` * `return void` Validates current config for required fields and required packages. [See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L131)
Reference is taken from the source code. Help us to improve documentation. Edit module reference