テンプレートエンジンを使わない方が良いのでしょうか？

Question

言語: PHP 7.1

ここでのエンジンはPHPそのものではなく、外部ライブラリのことです。
下記はleague/platesのサンプルコードです。

<?php
// Create new Plates instance
$templates = new League\Plates\Engine('/path/to/templates');

// Render a template
echo $templates->render('profile', ['name' => 'Jonathan']);

テンプレートファイルを使うと、メソッドではなくパスで指定することになります。
この時、下記のデメリットがあると指摘を受けました。

• IDEの補完が効かない。
  各テンプレートはメソッドではなく、テンプレートファイルで定義されているので補完が効きません。
• IDEでテンプレートファイルにジャンプできない。
  メソッドだと定義元へジャンプできますが、テンプレートだとジャンプが出来ません。
• テンプレートファイル内で使われる変数を事前に定義できないため、型も事前に使えない。
• 上記理由によりコードレビューがしずらい。

補完・ジャンプ

人気のFWなら、IDEにプラグインがあると思います。
ない場合は、ファイルのあいまい検索で開くことになると思いました。
他にも良い方法があれば教えて頂きたいです。

テンプレートファイル内で使われる変数を事前に定義できないため、型も事前に使えない。

コンストラクタやメソッドだと引数で明示的に、必要な値が分かるのですがテンプレートだと分かりません。
使われる変数はテンプレートファイルの先頭のコメントで記載するのでしょうか？

レビューがしずらい

現在は下記のように、viewをメソッドに記述しインサートする形になっています。
私はこの手法より、テンプレートエンジンを使いlayoutを指定して入れ子にする方が分かりやすいです。
そうすれば、アクションメソッドからはテンプレートファイルを1つ指定するだけで良くなります。

<?php

// メソッドに直接Viewを記述するパターン
public function actionMethod()
{
  // Viewクラスに必要なレンダリングメソッドを定義しています。
  // 各レンダリングメソッドに必要なデータを引数で渡します。

  // ビジネスロジック
  $this->view->header($data1);
  $this->view->contentsStart($data2, $data3);
  // ビジネスロジック
  $this->view->home($data4, $data5, $data6);
  $this->view->contentsEnd();
  $this->view->contentsFooter();
  // ビジネスロジック
  return;
}

// テンプレートファイルを使うパターン
public function actionMethod()
{
  // ビジネスロジック
  // ここでの$dataは連想配列です。
  $this->renderView('home', $data);
  return;
}

テンプレートエンジンを使わないほうがメリットが大きい理由はありますでしょうか？
他の方はどうしているか、意見をいただきたいです。
よろしくお願いします。

Answer 1

はっきり言って、このPlatesという「テンプレートエンジン」は、わざわざ入れるほどの理由はないと思います。

PHP自体がHTMLのテンプレートとして扱えることもあって、PHPで動く他のテンプレートエンジンは、以下のような短縮記法を使っていることが多いです。

• TwigやSmartyのような、変数やループの略記法
• HAMLのような、HTMLの略記法

これらの新しい記法は、それぞれ慣れるまでにコストがかかりますが、慣れれば速く書ける、という点でメリットがあります。

---

あと、CodeIgniterやCakePHPなど、PHP製のフレームワークは、「テンプレートエンジン」と銘打つことはないにしてもビューは別ファイルとなっています。これは、設定より規約の思想で、コントローラーのメソッド名とビューのファイル名を一対一対応させることで、対応は自明となります。

Comments

[mitsuru793]

ご回答ありがとうございます。
最初は、既存のレガシーコードをPHPのままテンプレートファイルに移せるものとしてplatesを使いました。
テンプレートエンジンとしては最低限の機能しか無いと思います。
次に使うならpugやbladeがいいかなと考えてます。

今FWだとViewは分かれていますよね。分かれていないのを知らないので、分けないほうがメリットがあるのかを知りたかったです。(テンプレートエンジンを採用しないほうがいい理由)
テンプレートエンジンを使わないまま、ビジネスロジックとviewが相互に入れくんだものは良い気がしません。

> 設定より規約の思想で
railsのvimプラグインだと、このおかげですぐに対応ファイルを開くことができました。
規約の方がxmlなどをたくさん書いたりする必要がなく便利です。

Answer 2

人によっては以下のPHP記法でシンプルなので十分という事もありますが、

<?= $data ?>

テンプレートエンジンを使い、間に処理を挟む事でエスケープ処理等を確実に吸収してくれる役割を果たす利点はあるかと思います。

Comments

[mitsuru793]

ご回答ありがとうございます。
テンプレートの継承ができるのも便利ですよね。

[aro10]

CakePHP2の頃に、最初からテンプレートエンジンがついていないのでViewはPHPのままで書けば良いと言う人も結構いたので、結局は企業文化次第ですね。
メンテナンス性が特に上がるケースで無いならば、プロジェクトやチームに合わせるのが無難かと思います。
テンプレートの継承や親テンプレートに後から子テンプレートでデータを差し込む機能等は構造として便利です。
LaravelのBladeを使っていますが、補完や定義はIDEの検索が賢いので困ると思った事は特にありません。

[mitsuru793]

返信が遅れてしまいました????
Bladeだと補完が効くのですね。継承については、PHPコードのままでもクラスを組み合わせて、テンプレートメソッドのような感じで作れるなと思いました。

> PHPのままで書けば良いと言う人も結構いたので、結局は企業文化次第ですね。
はい、そのとおりだと思います。テンプレートを使わないにしても、ロジックとview部分の混同はなるべく避けたいなと思います。

意見を頂き参考になりました。実際に意見を聞けて良かったです。
ありがとうございます。