class CommandTester

Eases the testing of console commands.

Traits

Methods

string
getDisplay(bool $normalize = false)

Gets the display returned by the last execution of the command or application.

string
getErrorOutput(bool $normalize = false)

Gets the output written to STDERR by the application.

getInput()

Gets the input instance used by the last execution of the command or application.

getOutput()

Gets the output instance used by the last execution of the command or application.

int
getStatusCode()

Gets the status code returned by the last execution of the command or application.

setInputs(array $inputs)

Sets the user inputs.

__construct(Command $command)

No description

int
execute(array $input, array $options = [])

Executes the command.

Details

in TesterTrait at line 36
string getDisplay(bool $normalize = false)

Gets the display returned by the last execution of the command or application.

Parameters

bool $normalize Whether to normalize end of lines to \n or not

Return Value

string The display

in TesterTrait at line 56
string getErrorOutput(bool $normalize = false)

Gets the output written to STDERR by the application.

Parameters

bool $normalize Whether to normalize end of lines to \n or not

Return Value

string

in TesterTrait at line 78
InputInterface getInput()

Gets the input instance used by the last execution of the command or application.

Return Value

InputInterface The current input instance

in TesterTrait at line 88
OutputInterface getOutput()

Gets the output instance used by the last execution of the command or application.

Return Value

OutputInterface The current output instance

in TesterTrait at line 98
int getStatusCode()

Gets the status code returned by the last execution of the command or application.

Return Value

int The status code

in TesterTrait at line 111
TesterTrait setInputs(array $inputs)

Sets the user inputs.

Parameters

array $inputs An array of strings representing each input passed to the command input stream

Return Value

TesterTrait

at line 31
__construct(Command $command)

Parameters

Command $command

at line 51
int execute(array $input, array $options = [])

Executes the command.

Available execution options:

  • interactive: Sets the input interactive flag
  • decorated: Sets the output decorated flag
  • verbosity: Sets the output verbosity flag
  • capture_stderr_separately: Make output of stdOut and stdErr separately available

Parameters

array $input An array of command arguments and options
array $options An array of execution options

Return Value

int The command exit code