StepResult
in package
FinalYes
インストールウィザードの各ステップ(check / commit)の結果を表す不変ペイロード。
旧 AbstractStep は public 可変プロパティ $Error / $Notice を書き換えて結果を伝えていたが、
これを戻り値へ移す。errors はブロッキング(次フェーズへ進めない)、notices は非ブロッキングの通知。
data はテンプレートへ渡す操作結果(作成テーブル一覧など)。redirect は完了フェーズの遷移先。
Table of Contents
Properties
- $data : array<string|int, mixed>
- $errors : ToolErrors
- $notices : ToolErrors
- $redirect : string|null
Methods
- __construct() : mixed
- merge() : self
- check と commit の結果を統合する(errors/notices は union、data は後勝ち、redirect は相手優先)。
- ok() : self
Properties
$data read-only
public
array<string|int, mixed>
$data
= []
$errors read-only
public
ToolErrors
$errors
$notices read-only
public
ToolErrors
$notices
$redirect read-only
public
string|null
$redirect
= null
Methods
__construct()
public
__construct(ToolErrors $errors, ToolErrors $notices[, array<string, mixed> $data = [] ][, string|null $redirect = null ]) : mixed
Parameters
- $errors : ToolErrors
- $notices : ToolErrors
- $data : array<string, mixed> = []
- $redirect : string|null = null
merge()
check と commit の結果を統合する(errors/notices は union、data は後勝ち、redirect は相手優先)。
public
merge(self $other) : self
Parameters
- $other : self
Return values
selfok()
public
static ok() : self