| 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.
type bool
public static $onlyActions
Allows to explicitly set what methods have this class.
type array
public static $excludeActions
Allows to explicitly exclude actions from module.
type array
public static $aliases
Allows to rename actions
type array
public __construct($moduleContainer, $config = null)
Module constructor.
Requires module container (to provide access between modules of suite) and config.
param ModuleContainer$moduleContainerparam array|null$config
public _after($test)
HOOK executed after test
param TestInterface$test
public _afterStep($step)
HOOK executed after step
param Step$step
public _afterSuite()
HOOK executed after suite
public _before($test)
HOOK executed before test
param TestInterface$test
public _beforeStep($step)
HOOK executed before step
param Step$step
public _beforeSuite($settings = null)
HOOK executed before suite
param array$settings
public _failed($test, $fail)
HOOK executed when test fails but before _after
param TestInterface$testparam \Exception$fail
public _getConfig($key = null)
Get config values or specific config item.
param mixed$keyreturnmixed the config item's value or null if it doesn't exist
public _getName()
Returns a module name for a Module, a class name for Helper
returnstring
public _hasRequiredFields()
Checks if a module has required fields
returnbool
public _initialize()
HOOK triggered after module is created and configuration is loaded
public _reconfigure($config)
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 %} * `param` $config * `throws` Exception\ModuleConfigException * `throws` ModuleException [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Module.php#L120) #### _resetConfig() *public* _resetConfig() Reverts config changed by `_reconfigure` [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Module.php#L138) #### _setConfig() *public* _setConfig($config) Allows to define initial module config. Can be used in `_beforeSuite` hook of Helpers or Extensions {% highlight php %} getModule('otherModule')->_setConfig($this->myOtherConfig); } {% endhighlight %} * `param` $config * `throws` Exception\ModuleConfigException * `throws` ModuleException [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Module.php#L96) #### assert() *protected* assert($arguments, $not = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L6) #### assertArrayHasKey() *protected* assertArrayHasKey($key, $actual, $description = null) * `param` $key * `param` $actual * `param` $description [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L369) #### assertArrayNotHasKey() *protected* assertArrayNotHasKey($key, $actual, $description = null) * `param` $key * `param` $actual * `param` $description [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L379) #### assertArraySubset() *protected* assertArraySubset($subset, $array, $strict = null, $message = null) Checks that array contains subset. * `param array` $subset * `param array` $array * `param bool` $strict * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L392) #### assertContains() *protected* assertContains($needle, $haystack, $message = null) Checks that haystack contains needle * `param` $needle * `param` $haystack * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L133) #### assertCount() *protected* assertCount($expectedCount, $actual, $description = null) * `param` $expectedCount * `param` $actual * `param` $description [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L402) #### assertEmpty() *protected* assertEmpty($actual, $message = null) Checks that variable is empty. * `param` $actual * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L205) #### assertEquals() *protected* assertEquals($expected, $actual, $message = null, $delta = null) Checks that two variables are equal. * `param` $expected * `param` $actual * `param string` $message * `param float` $delta [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L35) #### assertFalse() *protected* assertFalse($condition, $message = null) Checks that condition is negative. * `param` $condition * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L271) #### assertFileExists() *protected* assertFileExists($filename, $message = null) Checks if file exists * `param string` $filename * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L318) #### assertFileNotExists() *protected* assertFileNotExists($filename, $message = null) Checks if file doesn't exist * `param string` $filename * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L330) #### assertGreaterOrEquals() *protected* assertGreaterOrEquals($expected, $actual, $description = null) * `param` $expected * `param` $actual * `param` $description [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L340) #### assertGreaterThan() *protected* assertGreaterThan($expected, $actual, $message = null) Checks that actual is greater than expected * `param` $expected * `param` $actual * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L84) #### assertGreaterThanOrEqual() *protected* assertGreaterThanOrEqual($expected, $actual, $message = null) Checks that actual is greater or equal than expected * `param` $expected * `param` $actual * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L96) #### assertInstanceOf() *protected* assertInstanceOf($class, $actual, $description = null) * `param` $class * `param` $actual * `param` $description [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L412) #### assertInternalType() *protected* assertInternalType($type, $actual, $description = null) * `param` $type * `param` $actual * `param` $description [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L432) #### assertIsArray() *protected* assertIsArray($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L467) #### assertIsBool() *protected* assertIsBool($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L472) #### assertIsCallable() *protected* assertIsCallable($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L512) #### assertIsEmpty() *protected* assertIsEmpty($actual, $description = null) * `param` $actual * `param` $description [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L359) #### assertIsFloat() *protected* assertIsFloat($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L477) #### assertIsInt() *protected* assertIsInt($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L482) #### assertIsNotArray() *protected* assertIsNotArray($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L517) #### assertIsNotBool() *protected* assertIsNotBool($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L522) #### assertIsNotCallable() *protected* assertIsNotCallable($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L562) #### assertIsNotFloat() *protected* assertIsNotFloat($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L527) #### assertIsNotInt() *protected* assertIsNotInt($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L532) #### assertIsNotNumeric() *protected* assertIsNotNumeric($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L537) #### assertIsNotObject() *protected* assertIsNotObject($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L542) #### assertIsNotResource() *protected* assertIsNotResource($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L547) #### assertIsNotScalar() *protected* assertIsNotScalar($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L557) #### assertIsNotString() *protected* assertIsNotString($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L552) #### assertIsNumeric() *protected* assertIsNumeric($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L487) #### assertIsObject() *protected* assertIsObject($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L492) #### assertIsResource() *protected* assertIsResource($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L497) #### assertIsScalar() *protected* assertIsScalar($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L507) #### assertIsString() *protected* assertIsString($actual, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L502) #### assertLessOrEquals() *protected* assertLessOrEquals($expected, $actual, $description = null) * `param` $expected * `param` $actual * `param` $description [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L350) #### assertLessThan() *protected* assertLessThan($expected, $actual, $message = null) Checks that actual is less than expected * `param` $expected * `param` $actual * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L108) #### assertLessThanOrEqual() *protected* assertLessThanOrEqual($expected, $actual, $message = null) Checks that actual is less or equal than expected * `param` $expected * `param` $actual * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L120) #### assertNot() *protected* assertNot($arguments) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L22) #### assertNotContains() *protected* assertNotContains($needle, $haystack, $message = null) Checks that haystack doesn't contain needle. * `param` $needle * `param` $haystack * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L145) #### assertNotEmpty() *protected* assertNotEmpty($actual, $message = null) Checks that variable is not empty. * `param` $actual * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L216) #### assertNotEquals() *protected* assertNotEquals($expected, $actual, $message = null, $delta = null) Checks that two variables are not equal * `param` $expected * `param` $actual * `param string` $message * `param float` $delta [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L48) #### assertNotFalse() *protected* assertNotFalse($condition, $message = null) Checks that the condition is NOT false (everything but false) * `param` $condition * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L282) #### assertNotInstanceOf() *protected* assertNotInstanceOf($class, $actual, $description = null) * `param` $class * `param` $actual * `param` $description [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L422) #### assertNotNull() *protected* assertNotNull($actual, $message = null) Checks that variable is not NULL * `param` $actual * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L238) #### assertNotRegExp() *protected* assertNotRegExp($pattern, $string, $message = null) Checks that string not match with pattern * `param string` $pattern * `param string` $string * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L169) #### assertNotSame() *protected* assertNotSame($expected, $actual, $message = null) Checks that two variables are not same * `param` $expected * `param` $actual * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L72) #### assertNotTrue() *protected* assertNotTrue($condition, $message = null) Checks that the condition is NOT true (everything but true) * `param` $condition * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L260) #### assertNull() *protected* assertNull($actual, $message = null) Checks that variable is NULL * `param` $actual * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L227) #### assertRegExp() *protected* assertRegExp($pattern, $string, $message = null) Checks that string match with pattern * `param string` $pattern * `param string` $string * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L157) #### assertSame() *protected* assertSame($expected, $actual, $message = null) Checks that two variables are same * `param` $expected * `param` $actual * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L60) #### assertStringContainsString() *protected* assertStringContainsString($needle, $haystack, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L447) #### assertStringContainsStringIgnoringCase() *protected* assertStringContainsStringIgnoringCase($needle, $haystack, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L457) #### assertStringNotContainsString() *protected* assertStringNotContainsString($needle, $haystack, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L452) #### assertStringNotContainsStringIgnoringCase() *protected* assertStringNotContainsStringIgnoringCase($needle, $haystack, $message = null) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L462) #### assertStringStartsNotWith() *protected* assertStringStartsNotWith($prefix, $string, $message = null) Checks that a string doesn't start with the given prefix. * `param string` $prefix * `param string` $string * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L193) #### assertStringStartsWith() *protected* assertStringStartsWith($prefix, $string, $message = null) Checks that a string starts with the given prefix. * `param string` $prefix * `param string` $string * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L181) #### assertThat() *protected* assertThat($haystack, $constraint, $message = null) * `param` $haystack * `param` $constraint * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L293) #### assertThatItsNot() *protected* assertThatItsNot($haystack, $constraint, $message = null) Checks that haystack doesn't attend * `param` $haystack * `param` $constraint * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L305) #### assertTrue() *protected* assertTrue($condition, $message = null) Checks that condition is positive. * `param` $condition * `param string` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L249) #### debug() *protected* debug($message) Print debug message to the screen. * `param` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Module.php#L273) #### debugSection() *protected* debugSection($title, $message) Print debug message with a title * `param` $title * `param` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Module.php#L284) #### fail() *protected* fail($message) Fails the test with message. * `param` $message [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Util/Shared/Asserts.php#L442) #### getModule() *protected* getModule($name) Get another module by its name: {% highlight php %} getModule('WebDriver')->_findElements('.items'); {% endhighlight %} * `param` $name * `return` Module * `throws` ModuleException [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Module.php#L337) #### getModules() *protected* getModules() Get all enabled modules * `return` array [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Module.php#L320) #### hasModule() *protected* hasModule($name) Checks that module is enabled. * `param` $name * `return` bool [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Module.php#L310) #### onReconfigure() *protected* onReconfigure() HOOK to be executed when config changes with `_reconfigure`. [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Module.php#L130) #### scalarizeArray() *protected* scalarizeArray($array) [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Module.php#L362) #### shortenMessage() *protected* shortenMessage($message, $chars = null) Short text message to an amount of chars * `param` $message * `param` $chars * `return` string [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Module.php#L299) #### validateConfig() *protected* validateConfig() Validates current config for required fields and required packages. * `throws` Exception\ModuleConfigException * `throws` ModuleException [See source](https://github.com/Codeception/Codeception/blob/3.0/src/Codeception/Module.php#L149)
Reference is taken from the source code. Help us to improve documentation. Edit module reference