CommandTest
- Type
- Class
- Namespace
- craft\test\console
- Inherits
- craft\test\console\CommandTest
- Since
- 3.2.0
Class ConsoleTest
View source (opens new window)
# Protected Properties
# 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
$consoleTest
(craft\test\console\ConsoleTest)$command
(string (opens new window))$parameters
(array (opens new window))$ignoreStdOut
(boolean (opens new window))
Throws
# confirm()
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
# 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() |
# addEventChainItem()
View source (opens new window)
Arguments
$config
(array (opens new window))
Returns
craft\test\console\CommandTest
# confirmHandler()
View source (opens new window)
Returns
# getNextItem()
View source (opens new window)
Returns
craft\test\console\CommandTestItem, null (opens new window)
# outputCommandHandler()
View source (opens new window)
Returns
# promptHandler()
View source (opens new window)
Returns
# runHandlerCheck()
View source (opens new window)
Arguments
$out
(string (opens new window))$type
(string (opens new window))
Returns
craft\test\console\CommandTestItem
# selectHandler()
View source (opens new window)
Returns
# setupController()
View source (opens new window)
Throws
# stderrHandler()
View source (opens new window)
Returns
# stdoutHandler()
View source (opens new window)
Returns
# Constants
Constant | Description |
---|---|
CONFIRM | |
OUTPUT_COMMAND | |
PROMPT | |
SELECT | |
STD_ERR | |
STD_OUT |