CommandTest

Type: Class
Namespace: craft\test\console
Inherits: craft\test\console\CommandTest
Since: 3.2.0

Class ConsoleTest

# Protected Properties

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

# `actionId`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `command`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `controller`

Type: craft\console\Controller
Default value: null

View source (opens new window)

# `currentIndex`

Type: integer (opens new window)
Default value: null

View source (opens new window)

# `desiredExitCode`

Type: integer (opens new window)
Default value: null

View source (opens new window)

# `eventChain`

Type: array (opens new window), craft\test\console\CommandTestItem
Default value: []

View source (opens new window)

# `eventChainItemsHandled`

Type: integer (opens new window)
Default value: 0

View source (opens new window)

# `expectedExitCode`

Type: integer (opens new window)
Default value: null

View source (opens new window)

# `hasExecuted`

Type: boolean (opens new window)
Default value: false

View source (opens new window)

# `ignoreStdout`

Type: boolean (opens new window)
Default value: false

View source (opens new window)

# `parameters`

Type: array (opens new window)
Default value: null

View source (opens new window)

# `test`

Type: craft\test\console\ConsoleTest
Default value: null

View source (opens new window)

# Public Methods

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

# `__construct()`

CommandTest constructor.

View source (opens new window)

Arguments

$message (string (opens new window))
$returnValue (mixed)
$default (boolean (opens new window))

Returns

craft\test\console\CommandTest

# `exitCode()`

View source (opens new window)

Arguments

$value (integer (opens new window))

Returns

craft\test\console\CommandTest

# `outputCommand()`

View source (opens new window)

Arguments

$desiredOutput (iterable, string (opens new window))
$withScriptName (boolean (opens new window))

Returns

craft\test\console\CommandTest

# `prompt()`

View source (opens new window)

Arguments

$prompt (string (opens new window))
$returnValue (mixed)
$options (array (opens new window))

Returns

craft\test\console\CommandTest

# `run()`

View source (opens new window)

Throws

yii\base\InvalidArgumentException (opens new window)

# `select()`

View source (opens new window)

Arguments

$prompt (string (opens new window))
$returnValue (mixed)
$options (array (opens new window))

Returns

craft\test\console\CommandTest

# `stderr()`

View source (opens new window)

Arguments

$desiredOutput (iterable, string (opens new window))

Returns

craft\test\console\CommandTest

# `stdout()`

View source (opens new window)

Arguments

$desiredOutput (iterable, string (opens new window))

Returns

craft\test\console\CommandTest

# Protected Methods

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