class ApplicationTester

Eases the testing of console applications.

When testing an application, don't forget to disable the auto exit flag:

$application = new Application();
$application->setAutoExit(false);

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(Application $application)

No description

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

Executes the application.

Details

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

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

InputInterface getInput()

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

Return Value

InputInterface The current input instance

OutputInterface getOutput()

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

Return Value

OutputInterface The current output instance

int getStatusCode()

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

Return Value

int The status code

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

__construct(Application $application)

Parameters

Application $application

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

Executes the application.

Available 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 arguments and options
array $options An array of options

Return Value

int The command exit code