• 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 $moduleContainer
• param array|null $config

See source

public _after($test)

HOOK executed after test

• param TestInterface $test

See source

public _afterStep($step)

HOOK executed after step

• param Step $step

See source

public _afterSuite()

HOOK executed after suite

See source

public _before($test)

HOOK executed before test

• param TestInterface $test

See source

public _beforeStep($step)

HOOK executed before step

• param Step $step

See source

public _beforeSuite($settings = null)

HOOK executed before suite

• param array $settings

See source

public _failed($test, $fail)

HOOK executed when test fails but before _after

• param TestInterface $test
• param \Exception $fail

See source

public _getConfig($key = null)

Get config values or specific config item.

• param mixed $key
• return mixed the config item's value or null if it doesn't exist

See source

public _getName()

Returns a module name for a Module, a class name for Helper

• return string

See source

public _hasRequiredFields()

Checks if a module has required fields

• return bool

See source

public _initialize()

HOOK triggered after module is created and configuration is loaded

See source

public _reconfigure($config)

Allows to redefine config for a specific test. Config is restored at the end of a test.

{% highlight php %}