CommandTest

Type

Class

Namespace

craft\test\console

Inherits

craft\test\console\CommandTest

Since

3.2.0

Class ConsoleTest

View source

Protected Properties

Property	Description
actionId	string
command	string
controller	craft\console\Controller
currentIndex	integer
desiredExitCode	integer
eventChain	array, craft\test\console\CommandTestItem
eventChainItemsHandled	integer
expectedExitCode	integer
hasExecuted	boolean
ignoreStdout	boolean
parameters	array
test	craft\test\console\ConsoleTest

actionId

Type

string

Default value

null

View source

command

Type

string

Default value

null

View source

controller

Type

craft\console\Controller

Default value

null

View source

currentIndex

Type

integer

Default value

null

View source

desiredExitCode

Type

integer

Default value

null

View source

eventChain

Type

array, craft\test\console\CommandTestItem

Default value

[]

View source

eventChainItemsHandled

Type

integer

Default value

0

View source

expectedExitCode

Type

integer

Default value

null

View source

hasExecuted

Type

boolean

Default value

false

View source

ignoreStdout

Type

boolean

Default value

false

View source

parameters

Type

array

Default value

null

View source

test

Type

craft\test\console\ConsoleTest

Default value

null

View source

Public Methods

Method	Description
__construct()	CommandTest constructor.
confirm()
exitCode()
outputCommand()
prompt()
run()
select()
stderr()
stdout()

__construct()

CommandTest constructor.

View source

Arguments

• $consoleTest (craft\test\console\ConsoleTest)
• $command (string)
• $parameters (array)
• $ignoreStdOut (boolean)

Throws

• yii\base\InvalidConfigException

confirm()

View source

Arguments

• $message (string)
• $returnValue (mixed)
• $default (boolean)

Returns

craft\test\console\CommandTest

exitCode()

View source

Arguments

• $value (integer)

Returns

craft\test\console\CommandTest

outputCommand()

View source

Arguments

• $desiredOutput (iterable, string)
• $withScriptName (boolean)

Returns

craft\test\console\CommandTest

prompt()

View source

Arguments

• $prompt (string)
• $returnValue (mixed)
• $options (array)

Returns

craft\test\console\CommandTest

run()

View source

Throws

• yii\base\InvalidArgumentException

select()

View source

Arguments

• $prompt (string)
• $returnValue (mixed)
• $options (array)

Returns

craft\test\console\CommandTest

stderr()

View source

Arguments

• $desiredOutput (iterable, string)

Returns

craft\test\console\CommandTest

stdout()

View source

Arguments

• $desiredOutput (iterable, string)

Returns

craft\test\console\CommandTest

Protected Methods

Method	Description
addEventChainItem()
confirmHandler()
getNextItem()
outputCommandHandler()
promptHandler()
runHandlerCheck()
selectHandler()
setupController()
stderrHandler()
stdoutHandler()

addEventChainItem()

View source

Arguments

• $config (array)

Returns

craft\test\console\CommandTest

confirmHandler()

View source

Returns

callable

getNextItem()

View source

Returns

craft\test\console\CommandTestItem, null

outputCommandHandler()

View source

Returns

callable

promptHandler()

View source

Returns

callable

runHandlerCheck()

View source

Arguments

• $out (string)
• $type (string)

Returns

craft\test\console\CommandTestItem

selectHandler()

View source

Returns

callable

setupController()

View source

Throws

• yii\base\InvalidConfigException

stderrHandler()

View source

Returns

callable

stdoutHandler()

View source

Returns

callable

Constants

Constant	Description
CONFIRM
OUTPUT_COMMAND
PROMPT
SELECT
STD_ERR
STD_OUT