CommandTester

class CommandTester

Eases the testing of console commands.

Methods

__construct(Command $command)
int execute(array $input, array $options = array())

Executes the command.

string getDisplay(bool $normalize = false)

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

InputInterface getInput()

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

OutputInterface getOutput()

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

int getStatusCode()

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

CommandTester setInputs(array $inputs)

Sets the user inputs.

Details

__construct(Command $command)

Parameters

Command $command

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

Executes the command.

Available execution options:

  • interactive: Sets the input interactive flag
  • decorated: Sets the output decorated flag
  • verbosity: Sets the output verbosity flag

Parameters

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

Return Value

int The command exit code

string getDisplay(bool $normalize = false)

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

Parameters

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

Return Value

string The display

InputInterface getInput()

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

Return Value

InputInterface The current input instance

OutputInterface getOutput()

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

Return Value

OutputInterface The current output instance

int getStatusCode()

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

Return Value

int The status code

CommandTester 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

CommandTester

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Console/Tester/CommandTester.html