a-blog cms PHP API Reference

Step1 extends AbstractStep
in package

インストール phase 1(動作要件チェック)。旧 setup/install.php の Install_Step_1。 必須/推奨 PHP 拡張、必須ファイルの存在・パーミッション、.htaccess の有効化(W7)を検査する。

Table of Contents

Constants

OPTIONAL_EXTENSIONS  = ['imagick', 'exif', 'opcache', 'apcu', 'redis', 'gettext', 'openssl']
オプションPHP拡張の定義(警告レベル) composer.json の suggest セクションに対応
OPTIONAL_FUNCTIONS  = ['imagerotate' => 'imagerotate']
オプション機能のチェック(警告レベル) 拡張はあるが特定の関数が存在しない場合など
REQUIRED_EXTENSIONS  = ['curl', 'dom', 'fileinfo', 'filter', 'gd', 'hash', 'json', 'mbstring', 'pcre', 'pdo', 'pdo_mysql', 'session', 'xmlreader', 'xmlwriter', 'zip']
必須PHP拡張の定義 composer.json の require セクションに対応

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>
画面固有の表示データ(規約テキスト・テーマ選択肢など、操作結果に依存しないもの)。
checkInput()  : ToolErrors
送信フィールドのうち空のものを {フィールド名}_input エラーにする。 db_create(作成しない選択)と db_pass(空パス許容)は必須にしない。
fileExists()  : ToolErrors
writeConfig()  : ToolErrors
config.server.php の define(KEY, ...) を書き換える。失敗時は config_write エラーを返す。
buildEnvironmentReport()  : array<int, array{title: string, items: list}>
結果画面で「何が正しく設定されているか」を肯定的に提示する環境レポートを組み立てる。 旧インストーラーの動作環境チェック表示(パーミッション / GD / .htaccess / .env)に相当する。

Constants

OPTIONAL_EXTENSIONS

オプションPHP拡張の定義(警告レベル) composer.json の suggest セクションに対応

private mixed OPTIONAL_EXTENSIONS = ['imagick', 'exif', 'opcache', 'apcu', 'redis', 'gettext', 'openssl']

OPTIONAL_FUNCTIONS

オプション機能のチェック(警告レベル) 拡張はあるが特定の関数が存在しない場合など

private mixed OPTIONAL_FUNCTIONS = ['imagerotate' => 'imagerotate']

REQUIRED_EXTENSIONS

必須PHP拡張の定義 composer.json の require セクションに対応

private mixed REQUIRED_EXTENSIONS = ['curl', 'dom', 'fileinfo', 'filter', 'gd', 'hash', 'json', 'mbstring', 'pcre', 'pdo', 'pdo_mysql', 'session', 'xmlreader', 'xmlwriter', 'zip']

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

template()

描画に使う setup 専用 Twig テンプレート(`@setup/install/...twig`)。

public template() : string
Return values
string

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

buildEnvironmentReport()

結果画面で「何が正しく設定されているか」を肯定的に提示する環境レポートを組み立てる。 旧インストーラーの動作環境チェック表示(パーミッション / GD / .htaccess / .env)に相当する。

private buildEnvironmentReport() : array<int, array{title: string, items: list}>

結果画面は必須チェックを通過したときだけ表示されるため、必須項目(GD・パーミッション・Apache 時の .htaccess)は基本 OK になる。非必須(.env、非 Apache 時の .htaccess)は実状態で提示する。 PHP バージョンと拡張の注意(OPcache 等)は既存の phpVersion / noticeMessages で表示済みのため、 ここでは扱わない(重複回避)。

Return values
array<int, array{title: string, items: list}>

        
On this page

Search results