a-blog cms PHP API Reference

AbstractStep
in package
implements InstallStep

AbstractYes

インストールウィザードの各ステップの基底。旧 setup/install.php の Install_Step。

可変プロパティ（$Post/$Error/$Notice）を廃し、check()（進行可否）/ commit()（副作用）は StepResult を返す。config.server.php への書き込みや入力必須チェックの共通処理は、 ステップに副作用を持たせないため ToolErrors を返すヘルパとして提供する。 template() は各ステップが実装する。

Table of Contents

Interfaces

InstallStep
インストールウィザードの 1 フェーズ（規約 / 要件 / ドメイン / DB / テーブル / ブログ・管理者 / 完了）の契約。

Methods

check()  : StepResult
進行可否の判定。errors が空なら commit へ進める。副作用を持たない想定だが、一部フェーズ （DB 接続確認など）は判定に不可分な検査を含む（旧 validate 踏襲）。
commit()  : StepResult
フェーズの主たる副作用（config 書き込み・DB 作成・ブログ作成・setup 撤去）の実行。 check が通り、かつ副作用リクエスト（do / 完了フェーズ）のときだけ呼ばれる。
viewData()  : array<string, mixed>
画面固有の表示データ（規約テキスト・テーマ選択肢など、操作結果に依存しないもの）。
checkInput()  : ToolErrors
送信フィールドのうち空のものを {フィールド名}_input エラーにする。 db_create（作成しない選択）と db_pass（空パス許容）は必須にしない。
fileExists()  : ToolErrors
writeConfig()  : ToolErrors
config.server.php の define(KEY, ...) を書き換える。失敗時は config_write エラーを返す。

Methods

check()

進行可否の判定。errors が空なら commit へ進める。副作用を持たない想定だが、一部フェーズ （DB 接続確認など）は判定に不可分な検査を含む（旧 validate 踏襲）。

public check(Field $post) : StepResult
Parameters
$post : Field
Return values
StepResult

commit()

フェーズの主たる副作用（config 書き込み・DB 作成・ブログ作成・setup 撤去）の実行。 check が通り、かつ副作用リクエスト（do / 完了フェーズ）のときだけ呼ばれる。

public commit(Field $post) : StepResult
Parameters
$post : Field
Return values
StepResult

viewData()

画面固有の表示データ（規約テキスト・テーマ選択肢など、操作結果に依存しないもの）。

public viewData(Field $post) : array<string, mixed>
Parameters
$post : Field
Return values
array<string, mixed>

checkInput()

送信フィールドのうち空のものを {フィールド名}_input エラーにする。 db_create（作成しない選択）と db_pass（空パス許容）は必須にしない。

protected checkInput(Field $post) : ToolErrors
Parameters
$post : Field
Return values
ToolErrors

writeConfig()

config.server.php の define(KEY, ...) を書き換える。失敗時は config_write エラーを返す。

protected writeConfig(string $key, string $val) : ToolErrors

値の整形・置換は Services\ConfigServer\ConfigServerWriter に委譲する（メンテナンス側の Domain 修正ツールと同一実装）。自前の preg_replace + str_replace 実装は、値に $ + 数字が 含まれると置換文字列がバックリファレンス（$1 等）と解釈されて値が壊れる不具合があったため廃止。

Parameters
$key : string
$val : string
Return values
ToolErrors 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results