class FakeProcessResult implements ProcessResult (View source)

Properties

protected string $command

The command string.

protected int $exitCode

The process exit code.

protected string $output

The process output.

protected string $errorOutput

The process error output.

Methods

void
__construct(string $command = '', int $exitCode = 0, array|string $output = '', array|string $errorOutput = '')

Create a new process result instance.

string
normalizeOutput(array|string $output)

Normalize the given output into a string with newlines.

string
command()

Get the original command executed by the process.

withCommand(string $command)

Create a new fake process result with the given command.

bool
successful()

Determine if the process was successful.

bool
failed()

Determine if the process failed.

int|null
exitCode()

Get the exit code of the process.

string
output()

Get the standard output of the process.

bool
seeInOutput(string $output)

Determine if the output contains the given string.

string
errorOutput()

Get the error output of the process.

bool
seeInErrorOutput(string $output)

Determine if the error output contains the given string.

$this
throw(callable|null $callback = null)

Throw an exception if the process failed.

$this
throwIf(bool $condition, callable|null $callback = null)

Throw an exception if the process failed and the given condition is true.

Details

void __construct(string $command = '', int $exitCode = 0, array|string $output = '', array|string $errorOutput = '')

Create a new process result instance.

Parameters

string $command
int $exitCode
array|string $output
array|string $errorOutput

Return Value

void

protected string normalizeOutput(array|string $output)

Normalize the given output into a string with newlines.

Parameters

array|string $output

Return Value

string

string command()

Get the original command executed by the process.

Return Value

string

FakeProcessResult withCommand(string $command)

Create a new fake process result with the given command.

Parameters

string $command

Return Value

FakeProcessResult

bool successful()

Determine if the process was successful.

Return Value

bool

bool failed()

Determine if the process failed.

Return Value

bool

int|null exitCode()

Get the exit code of the process.

Return Value

int|null

string output()

Get the standard output of the process.

Return Value

string

bool seeInOutput(string $output)

Determine if the output contains the given string.

Parameters

string $output

Return Value

bool

string errorOutput()

Get the error output of the process.

Return Value

string

bool seeInErrorOutput(string $output)

Determine if the error output contains the given string.

Parameters

string $output

Return Value

bool

$this throw(callable|null $callback = null)

Throw an exception if the process failed.

Parameters

callable|null $callback

Return Value

$this

Exceptions

ProcessFailedException

$this throwIf(bool $condition, callable|null $callback = null)

Throw an exception if the process failed and the given condition is true.

Parameters

bool $condition
callable|null $callback

Return Value

$this

Exceptions

Throwable