class FixResult

Properties

string|null $details
array<string, mixed> $context

The structured context for the result.

Methods

__construct(Status $status, string $summary, string|null $code = null)

Create a new fix result instance.

static FixResult
pass(string $summary = 'Fixed', string|null $code = null)

Create a passing fix result.

static FixResult
warn(string $summary, string|null $code = null)

Create a warning fix result.

static FixResult
notice(string $summary, string|null $code = null)

Create a notice fix result.

static FixResult
fail(string $summary, string|null $code = null)

Create a failing fix result.

static FixResult
skip(string $summary, string|null $code = null)

Create a skipped fix result.

static FixResult
error(string $summary, string|null $code = null)

Create an error fix result.

withDetails(string $details)

Add evidence to the fix result.

withContext(string $key, mixed $value)

Add context to the fix result.

Details

at line 24
__construct(Status $status, string $summary, string|null $code = null)

Create a new fix result instance.

Parameters

Status $status
string $summary
string|null $code

at line 34
static FixResult pass(string $summary = 'Fixed', string|null $code = null)

Create a passing fix result.

Parameters

string $summary
string|null $code

Return Value

FixResult

at line 42
static FixResult warn(string $summary, string|null $code = null)

Create a warning fix result.

Parameters

string $summary
string|null $code

Return Value

FixResult

at line 50
static FixResult notice(string $summary, string|null $code = null)

Create a notice fix result.

Parameters

string $summary
string|null $code

Return Value

FixResult

at line 58
static FixResult fail(string $summary, string|null $code = null)

Create a failing fix result.

Parameters

string $summary
string|null $code

Return Value

FixResult

at line 66
static FixResult skip(string $summary, string|null $code = null)

Create a skipped fix result.

Parameters

string $summary
string|null $code

Return Value

FixResult

at line 74
static FixResult error(string $summary, string|null $code = null)

Create an error fix result.

Parameters

string $summary
string|null $code

Return Value

FixResult

at line 86
FixResult withDetails(string $details)

Add evidence to the fix result.

Prefer message tokens for short identifying values like versions, paths, constraints, or counts. Use details for unbounded or multi-line evidence such as exception messages, process output, and bullet lists.

Parameters

string $details

Return Value

FixResult

at line 96
FixResult withContext(string $key, mixed $value)

Add context to the fix result.

Parameters

string $key
mixed $value

Return Value

FixResult