InstallStep
in
インストールウィザードの 1 フェーズ(規約 / 要件 / ドメイン / DB / テーブル / ブログ・管理者 / 完了)の契約。
旧 AbstractStep(public 可変 $Error/$Notice+bool を返す validate()+void の business())を置き換える。
check()(進行可否判定)と commit()(副作用の実行)は StepResult を返し、viewData() は画面固有の
表示データを返す。可変状態を持たず、Request 由来の Field を引数で受け取る。Tool 層の ToolErrors
を errors/notices の器として共有する(fix/import/update と同じ語彙)。
Table of Contents
Methods
- check() : StepResult
- 進行可否の判定。errors が空なら commit へ進める。副作用を持たない想定だが、一部フェーズ (DB 接続確認など)は判定に不可分な検査を含む(旧 validate 踏襲)。
- commit() : StepResult
- フェーズの主たる副作用(config 書き込み・DB 作成・ブログ作成・setup 撤去)の実行。 check が通り、かつ副作用リクエスト(do / 完了フェーズ)のときだけ呼ばれる。
- template() : string
- 描画に使う setup 専用 Twig テンプレート(`@setup/install/...twig`)。
- viewData() : array<string, mixed>
- 画面固有の表示データ(規約テキスト・テーマ選択肢など、操作結果に依存しないもの)。
Methods
check()
進行可否の判定。errors が空なら commit へ進める。副作用を持たない想定だが、一部フェーズ (DB 接続確認など)は判定に不可分な検査を含む(旧 validate 踏襲)。
public
check(Field $post) : StepResult
Parameters
- $post : Field
Return values
StepResultcommit()
フェーズの主たる副作用(config 書き込み・DB 作成・ブログ作成・setup 撤去)の実行。 check が通り、かつ副作用リクエスト(do / 完了フェーズ)のときだけ呼ばれる。
public
commit(Field $post) : StepResult
Parameters
- $post : Field
Return values
StepResulttemplate()
描画に使う setup 専用 Twig テンプレート(`@setup/install/...twig`)。
public
template() : string
Return values
stringviewData()
画面固有の表示データ(規約テキスト・テーマ選択肢など、操作結果に依存しないもの)。
public
viewData(Field $post) : array<string, mixed>
Parameters
- $post : Field