Slim 4 で Latte を使う

Daniel Opitz による本記事は、Slim Framework で Latte を使う方法を解説します。

まず Slim Framework をインストール し、続いて Composer で Latte をインストールします。

composer require latte/latte

設定

プロジェクトのルートディレクトリに templates ディレクトリを新しく作ります。あとでテンプレートはすべてそこに置きます。

config/defaults.php ファイルに template 設定キーを追加します。

$settings['template'] = __DIR__ . '/../templates';

Latte はテンプレートをネイティブの PHP コードにコンパイルし、ディスク上のキャッシュに保存します。そのため、ネイティブの PHP で書いたのと同じくらい高速です。

config/defaults.php ファイルに template_temp 設定キーを追加します。{project}/tmp/templates ディレクトリが存在し、読み書きの権限があることを確認してください。

$settings['template_temp'] = __DIR__ . '/../tmp/templates';

Latte はテンプレートを変更するたびに自動でキャッシュを作り直します。本番環境では、わずかな性能を稼ぐためにこれを無効にできます。

// 本番環境では false に変更します
$settings['template_auto_refresh'] = true;

次に、Latte\Engine クラスの DI コンテナ定義を追加します。

<?php

use Latte\Engine;
use Latte\Loaders\FileLoader;
use Psr\Container\ContainerInterface;
// ...

return [

	// ...

	Engine::class => function (ContainerInterface $container) {
		$latte = new Engine();
		$settings = $container->get('settings');
		$latte->setLoader(new FileLoader($settings['template']));
		$latte->setTempDirectory($settings['template_temp']);
		$latte->setAutoRefresh($settings['template_auto_refresh']);

		return $latte;
	},
];

これだけでも技術的には Latte のテンプレートをレンダリングできますが、PSR-7 のレスポンスオブジェクトと組み合わせて動くようにする必要があります。

そのために、この仕事を代わりにやってくれる専用の TemplateRenderer クラスを作ります。

src/Renderer/TemplateRenderer.php にファイルを作り、次のコードをコピーして貼り付けてください。

<?php

namespace App\Renderer;

use Latte\Engine;
use Psr\Http\Message\ResponseInterface;

final class TemplateRenderer
{
	public function __construct(
		private Engine $engine,
	) {
	}

	public function template(
		ResponseInterface $response,
		string $template,
		array $data = [],
	): ResponseInterface
	{
		$string = $this->engine->renderToString($template, $data);
		$response->getBody()->write($string);

		return $response;
	}
}

使い方

Latte の Engine オブジェクトを直接使う代わりに、TemplateRenderer オブジェクトを使ってテンプレートを PSR-7 互換のオブジェクトにレンダリングします。

home.latte という名前のテンプレートをレンダリングする典型的な Action ハンドラクラスは、次のようになります。

<?php

namespace App\Action\Home;

use App\Renderer\TemplateRenderer;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

final class HomeAction
{
	public function __construct(
		private TemplateRenderer $renderer,
	) {
	}

	public function __invoke(
		ServerRequestInterface $request,
		ResponseInterface $response,
	): ResponseInterface
	{
		$viewData = [
			'items' => ['one', 'two', 'three'],
		];

		return $this->renderer->template($response, 'home.latte', $viewData);
	}
}

動かすために、templates/home.latte に次の内容のテンプレートファイルを作ります。

<ul n:if=$items>
	{foreach $items as $item}
		<li id="item-{$iterator->counter}">{$item|capitalize}</li>
	{/foreach}
</ul>

すべて正しく設定されていれば、次の出力が見られるはずです。

One
Two
Three
バージョン: 3.x