レガシーPHPリファクタ 26:PHP用の設定項目を Smartyの `.conf` から PHPの `config.php` 配列へ統合する

2007年に執筆した書籍『Smarty動的Webサイト構築入門』のサンプルコードを現代のPHP環境(PHP 8.5)に向けてモダン化する取り組みを続けています。

今回は、レガシーなSmartyアプリケーションでありがちな、PHP用の設定項目を .conf ファイルから PHPの配列 (config.php) へ移行するリファクタリングを取り上げます。


修正前後のコード比較

修正前 (index.confの読み込み)

修正前は、画面のデフォルト設定(1ページの表示件数やデフォルトのソート順など)を Smartyのコンフィグファイル(.conf)に記述し、PHP側から読み込んでいました。

perPage = 5
sort = "id"
order = "asc"

Code language: JavaScript (javascript)
$smarty = new Smarty();
$smarty->configLoad('index.conf');

if (empty($_REQUEST['sort'])) {
    $_REQUEST['sort'] = $smarty->getConfigVars('sort');
}
if (empty($_REQUEST['order'])) {
    $_REQUEST['order'] = $smarty->getConfigVars('order');
}
if (empty($_REQUEST['setPerPage'])) {
    $_REQUEST['setPerPage'] = $smarty->getConfigVars('perPage');
}

修正前の問題点

  1. Smarty依存の早期化: Smarty用の index.conf を読み込む必要があるため、PHPスクリプトの先頭付近で new Smarty() を実行し、インスタンスを生成しなければならなかった。これにより、本来「描画担当」であるはずのSmartyオブジェクトをスクリプトの後方に集めることができませんでした。
  2. 役割のねじれ: .conf ファイルは本来 Smartyテンプレート側で変数や定数を共有するためのものです。しかしPHPスクリプトのメイン処理におけるデフォルト値の保持に使われていました。

修正後 (config.php への一本化)

.conf ファイルを廃止し、設定値は純粋なPHP配列を返す config.php に集約します。

$CONFIG = require_once __DIR__ . '/config.php';

if (empty($_REQUEST['sort'])) {
    $_REQUEST['sort'] = $CONFIG['sort'];
}
if (empty($_REQUEST['order'])) {
    $_REQUEST['order'] = $CONFIG['order'];
}
if (empty($_REQUEST['setPerPage'])) {
    $_REQUEST['setPerPage'] = $CONFIG['perPage'];
}

このリファクタのメリット

今回のリファクタリングは、PHPアプリケーションとしてのモダンな設計原則に近づける非常に効果的なアプローチです。

この変更によって得られる具体的なメリットは大きく4点あります。

1. $smarty インスタンスの生成・依存を後方に集めることができる

  • 修正前の問題: テンプレートエンジン特有の設定ファイルを読み込むために、スクリプトの早い段階で new Smarty() を呼ぶ必要がありました。
  • 修正後のメリット: $CONFIG = require_once ... で純粋なPHP配列として設定を読み込めるため、リクエスト変数の検証やビジネスロジックの処理を完全に済ませた後、テンプレートを描画する直前まで $smarty のインスタンス化を遅らせる(Lazy Initialization) ことができます。PHPスクリプトの後方に $smarty を集めることができます。

2. パフォーマンスとオーバーヘッドの削減

  • 修正前の問題: Smartyのコンフィグ機能(.conf ファイルのパース、コンパイル、configLoad メカニズム)は、ファイル読み込み・解析のランタイムコストを発生させる。
  • 修正後のメリット: PHPの配列を返す config.php は、PHPのOPcache(オペコードキャッシュ)による高速化の恩恵を直接受けることができ、不要な内部機構をバイパスして処理速度が向上する。

3. 保守性・IDEのコード補完・静的解析の向上

  • 修正前の問題: 独自の .conf 構文は、一般的なPHPのIDE(PhpStormやVS Codeなど)によるコード補完や静的解析(PHPStanなど)の対象外になりがちでした。
  • 修正後のメリット: すべてがPHPコード(配列)で表現されるため、IDEの強力な補完機能やリファクタリング支援をそのまま受けられ、タイポによるバグを未然に防ぎやすい。

4. 責務の分離(セパレーション・オブ・コンサーンス)の徹底

  • 修正前の問題: アプリケーション側の設定とテンプレート側の表示設定の役割が混在していた。
  • 修正後のメリット: 「アプリケーションの設定データはPHP側(config.php)で管理し、テンプレート描画に関する表示設定のみをSmartyに渡す」という、本来あるべきデータの流れと責務の分離が明確になる。

まとめ

地味なリファクタリングですが、この変更によって「PHPスクリプトの後方に $smarty を集めること」が可能になります。コードの見通しがよくなるので、とてもおすすめのリファクタリングです。

config.php はPHPスクリプトの設定基盤、.conf は(必要であれば)Smartyテンプレート用と、それぞれの役割が明確になります。

参考PR

refactor(chapter4_6): Smartyの index.conf を config.php へ移動しました by ninton · Pull Request #393 · ninton/smartybook
概要準備PR config.php を設定配列を return するようにしました refactor(chapter4_6): config.php を設定配列を return するようにしました #392$smarty->configLo...
レガシーPHPリファクタ 26:PHP用の設定項目を Smartyの `.conf` から PHPの `config.php` 配列へ統合する
Smarty動的Webサイト構築入門サンプルソース. Contribute to ninton/smartybook development by creating an account on GitHub.

タイトルとURLをコピーしました