PendingCommand
class PendingCommand (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| TestCase | $test | The test being run. |
|
| protected Container | $app | The application instance. |
|
| protected string | $command | The command to run. |
|
| protected array | $parameters | The parameters to pass to the command. |
|
| protected int | $expectedExitCode | The expected exit code. |
|
| protected int | $unexpectedExitCode | The unexpected exit code. |
|
| protected bool | $hasExecuted | Determine if the command has executed. |
Methods
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new pending console command run.
Specify an expected question that will be asked when the command runs.
Specify an expected confirmation question that will be asked when the command runs.
Specify an expected choice question with expected answers that will be asked/shown when the command runs.
Specify an expected search question with an expected search string, followed by an expected choice question with expected answers.
Specify output that should be printed when the command runs.
Specify output that should never be printed when the command runs.
Specify that the given string should be contained in the command output.
Specify that the given string shouldn't be contained in the command output.
Specify a table that should be printed when the command runs.
Assert that the command has the given exit code.
Assert that the command does not have the given exit code.
Assert that the command has the success exit code.
Assert that the command has the success exit code.
Assert that the command does not have the success exit code.
Execute the command.
Execute the command.
Determine if expected questions / choices / outputs are fulfilled.
Mock the application's console output.
Flush the expectations from the test case.
Handle the object's destruction.
Details
$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy.
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) falsy.
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
void
__construct(TestCase $test, Container $app, string $command, array $parameters)
Create a new pending console command run.
$this
expectsQuestion(string $question, string|bool $answer)
Specify an expected question that will be asked when the command runs.
$this
expectsConfirmation(string $question, string $answer = 'no')
Specify an expected confirmation question that will be asked when the command runs.
$this
expectsChoice(string $question, string|array $answer, array $answers, bool $strict = false)
Specify an expected choice question with expected answers that will be asked/shown when the command runs.
$this
expectsSearch(string $question, string|array $answer, string $search, array $answers)
Specify an expected search question with an expected search string, followed by an expected choice question with expected answers.
$this
expectsOutput(string|null $output = null)
Specify output that should be printed when the command runs.
$this
doesntExpectOutput(string|null $output = null)
Specify output that should never be printed when the command runs.
$this
expectsOutputToContain(string $string)
Specify that the given string should be contained in the command output.
$this
doesntExpectOutputToContain(string $string)
Specify that the given string shouldn't be contained in the command output.
$this
expectsTable(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])
Specify a table that should be printed when the command runs.
$this
assertExitCode(int $exitCode)
Assert that the command has the given exit code.
$this
assertNotExitCode(int $exitCode)
Assert that the command does not have the given exit code.
$this
assertSuccessful()
Assert that the command has the success exit code.
$this
assertOk()
Assert that the command has the success exit code.
$this
assertFailed()
Assert that the command does not have the success exit code.
int
execute()
Execute the command.
int
run()
Execute the command.
protected void
verifyExpectations()
Determine if expected questions / choices / outputs are fulfilled.
protected MockInterface
mockConsoleOutput()
Mock the application's console output.
protected void
flushExpectations()
Flush the expectations from the test case.
void
__destruct()
Handle the object's destruction.