Craft

Type

Class

Namespace

craft\test

Inherits

craft\test\Craft » Codeception\Module\Yii2

Since

3.2.0

Craft module for codeception

View source

Public Properties

Property	Description
currentTest	\Codeception\TestInterface
instance	self – The current instance

currentTest

Type

\Codeception\TestInterface

Default value

null

View source

instance

Type

self

Default value

null

The current instance

View source

Protected Properties

Property	Description
addedConfig	array – Application config file must be set.
requiredEvents	array – For expecting events code
triggeredEvents	array – For expecting events code

addedConfig

Type

array

Default value

[ 'migrations' => [], 'plugins' => [], 'dbSetup' => null, 'projectConfig' => null, 'fullMock' => false, 'edition' => \craft\enums\CmsEdition::Pro->value, ]

Application config file must be set.

View source

requiredEvents

Type

array

Default value

[]

For expecting events code

View source

triggeredEvents

Type

array

Default value

[]

For expecting events code

View source

Public Methods

Method	Description
__construct()	Craft constructor.
_afterSuite()
_before()
_beforeSuite()
_initialize()
assertElementsExist()
assertEqualDates()
assertNotPushedToQueue()
assertPushedToQueue()
assertTestFails()
createDbConfig()	Creates a DB config according to the loaded .env variables.
createEventItems()
deleteElement()
expectEvent()	Ensure that an event is triggered by the $callback() function.
getCodeceptionName()
getFieldLayoutByFieldHandle()
installPlugin()
mockCraftMethods()
mockDbMethods()
mockMethods()
normalizePathSeparators()
resetProjectConfig()	Reset's the project config.
runQueue()	An easy way of handling the testing of queue jobs.
saveElement()
setupDb()

__construct()

Craft constructor.

We need to merge the config settings here as this is the earliest point in the instance's existence. Doing it in _initialize() won't work as the config variables have already been added.

View source

Arguments

• $moduleContainer (\Codeception\Lib\ModuleContainer)
• $config (null)

_afterSuite()

View source

_before()

View source

Arguments

• $test (\Codeception\TestInterface)

Throws

• yii\base\InvalidConfigException
• ReflectionException
• Throwable
• yii\base\ErrorException

_beforeSuite()

View source

Arguments

• $settings

_initialize()

View source

assertElementsExist()

View source

Arguments

• $elementType (class-string<\craft\base\ElementInterface>)
• $searchProperties (array)
• $amount (integer)
• $searchAll (boolean) – Whether status(null) and trashed(null) should be applied

Returns

array

assertEqualDates()

View source

Arguments

• $test (\Codeception\TestInterface)
• $dateOne (string)
• $dateTwo (string)
• $secondsDelta (float)

Throws

• Exception

assertNotPushedToQueue()

View source

Arguments

• $description (string)

assertPushedToQueue()

View source

Arguments

• $description (string)

assertTestFails()

View source

Arguments

• $callable (callable)
• $message (string)

createDbConfig()

Creates a DB config according to the loaded .env variables.

View source

Returns

craft\config\DbConfig

createEventItems()

View source

Arguments

• $config (array)

Returns

array

deleteElement()

View source

Arguments

• $element (craft\base\ElementInterface)
• $hardDelete (boolean)
• $failHard (boolean)

Returns

boolean

Throws

• Throwable

expectEvent()

Ensure that an event is triggered by the $callback() function.

View source

Arguments

• $class (string)
• $eventName (string)
• $callback (callable)
• $eventInstance (string)
• $eventValues (array)

getCodeceptionName()

View source

Returns

string

getFieldLayoutByFieldHandle()

View source

Arguments

• $fieldHandle (string)

Returns

craft\models\FieldLayout, null

installPlugin()

View source

Arguments

• $plugin (array)

Throws

• yii\base\InvalidConfigException
• Throwable
• craft\errors\InvalidPluginException

mockCraftMethods()

View source

Arguments

• $component (string)
• $params (array)
• $constructorParams (array)

Throws

• yii\base\InvalidConfigException

mockDbMethods()

Since

3.6.11

View source

Arguments

• $params (array)

mockMethods()

View source

Arguments

• $module (yii\base\Module)
• $component (string)
• $params (array)
• $constructorParams (array)

Throws

• yii\base\InvalidConfigException

normalizePathSeparators()

View source

Arguments

• $path (mixed)

Returns

string, false

resetProjectConfig()

Since

3.3.10

Reset's the project config.

View source

Arguments

• $force (boolean) – Whether to force the reset. If set to true the reset key of the projectConfig configuration will be ignored and the project config will be reset regardless.

Returns

boolean

runQueue()

An easy way of handling the testing of queue jobs.

View source

Arguments

• $queueItem (string)
• $params (array)

Throws

• yii\base\InvalidArgumentException

saveElement()

View source

Arguments

• $element (craft\base\ElementInterface)
• $failHard (boolean)

Returns

boolean

Throws

• craft\errors\ElementNotFoundException
• Throwable
• yii\base\Exception

setupDb()

View source

Throws

• Throwable

Protected Methods

Method	Description
addModule()
mockModulesAndPlugins()
recreateClient()
validateEventValue()

addModule()

View source

Arguments

• $test (\Codeception\PHPUnit\TestCase)
• $moduleClass (class-string<\yii\base\Module>)

Throws

• ReflectionException

mockModulesAndPlugins()

View source

Arguments

• $test (\Codeception\PHPUnit\TestCase)

Throws

• ReflectionException

recreateClient()

View source

validateEventValue()

View source

Arguments

• $event (yii\base\Event)
• $eventRequirements (craft\test\EventItem)