Documentation

InstallStepResult
in package

This class contains information about the step performed in the App\Installer\Installer class such as: if it succeeded or not, what the response is, and possibly what exception was thrown

Table of Contents

$exception  : Exception|null
If the install step has failed, this might contain the exception that has been thrown
$output  : string
Contains the output of the install step
$success  : bool
Indicates if the install step has succeeded or not
__construct()  : mixed
getException()  : Exception|null
Returns the exception, if any; that has been thrown in the install step
getOutput()  : string
Returns the output from the install step
succeeded()  : bool
Returns if the Install step has succeeded or not

Properties

$exception

If the install step has failed, this might contain the exception that has been thrown

private Exception|null $exception

$success

Indicates if the install step has succeeded or not

private bool $success

Methods

__construct()

public __construct(bool $success[, string $output = '' ][, Exception|null $exception = null ]) : mixed
Parameters
$success : bool
$output : string = ''
$exception : Exception|null = null
Return values
mixed

getException()

Returns the exception, if any; that has been thrown in the install step

public getException() : Exception|null
Return values
Exception|null

getOutput()

Returns the output from the install step

public getOutput() : string
Return values
string

succeeded()

Returns if the Install step has succeeded or not

public succeeded() : bool
Return values
bool

Search results