09-templating.md

<< Инъектор зависимостей | Динамические страницы >>

Шаблонизация

PHP не нуждается в сторонних механизмах шаблонизации, ибо сам может позаботиться об этом. Но сторонний механизм мог бы упростить нам жизнь. С помощью него мы можем провести четкую линию между логикой приложения и файлами шаблонов, которые отвечают только за вывод переменных в окно бразузера.

Советую прочесть набольшую статью о шаблонизации здесь. Также есть и противоположное мнение. Лично у меня нету единого устоявшегося мнения касательно этой темы, поэтому я не буду советовать следовать какому-то одному подходу. Выбирайте то, что считаете лучшим для вас.

В данном руководстве мы будем использовать PHP реализацию Mustache. Давайте установим пакет: composer require mustache/mustache.

Еще могу выделить Twig, как хорошую альтернативу Mustache.

Давайте посмотрим на исходный код движка шаблонизатора. Как вы видите, данный класс не имплементирует какой-либо интерфейс.

Мы конечно можем при внедрении шаблонизатора привязаться к конкретному классу, но минус данного подхода в том, что в таком случае мы будем тесно связаны с реализацией, а не с абстракцией. Другими словами, весь ваш код, который использует шаблонизатор, будет зависеть от пакета Mustache. И, если вы захотите изменить реализацию, просто так это сделать не выйдет. Возможно вы захотите переключится на Twig, или возможно захотите использовать свой собственный шаблонизатор. В следствии тесной связи с реализацией нужно будет править много кода.

Конечно хотелось бы не зависеть от реализации и в нашем случае это поправимо. Но вместо редактирования кода стороннего пакета предлагаю использовать адаптер. Звучит это намного сложнее, чем есть на самом деле.

Для начала определим нужный нам интерфейс. Не забываем о принципе разделения интерфейсов, который гласит, что слишком «толстые» интерфейсы необходимо разделять на более маленькие.

Определим, что должен делать наш шаблонизатор? Сейчас нам нужен только метод рендеринга. Давайте создадим папку Template в директории src/, где будем хранить все файлы связанные с шаблонизацией. В папке Template создадим файл Renderer.php, который должен выглядеть следующим образом:

<?php declare(strict_types = 1);

namespace Example\Template;

interface Renderer
{
    public function render($template, $data = []) : string;
}

Интерфейс готов, теперь давайте создадим класс для Mustache. В этой же папке создаем файл MustacheRenderer.php:

<?php declare(strict_types = 1);

namespace Example\Template;

use Mustache_Engine;

class MustacheRenderer implements Renderer
{
    private $engine;

    public function __construct(Mustache_Engine $engine)
    {
        $this->engine = $engine;
    }

    public function render($template, $data = []) : string
    {
        return $this->engine->render($template, $data);
    }
}

Как вы видите, адаптер получился очень простой. Теперь нужно добавить алиас в Dependencies.php, так как инъектор пока ничего на знает о созданном ранее интерфейсе. Добавим строку:

$injector->alias('Example\Template\Renderer', 'Example\Template\MustacheRenderer');

Теперь можем добавить еще один аргумент к контроллеру Homepage:

<?php declare(strict_types = 1);

namespace Example\Controllers;

use Http\Request;
use Http\Response;
use Example\Template\Renderer;

class Homepage
{
    private $request;
    private $response;
    private $renderer;

    public function __construct(
        Request $request, 
        Response $response,
        Renderer $renderer
    ) {
        $this->request = $request;
        $this->response = $response;
        $this->renderer = $renderer;
    }

...

Давайте перепишем метод show. Обратите внимание что сейчас шаблонизатор принимает массив. Это сделано для простоты примера. Mustache предоставляет возможность передавать объект контекста представления. Но к более сложным вещам мы перейдем немного позже:

    public function show()
    {
        $data = [
            'name' => $this->request->getParameter('name', 'stranger'),
        ];
        $html = $this->renderer->render('Hello {{name}}', $data);
        $this->response->setContent($html);
    }

По умолчанию Mustache принимает на вход обычную строку. Но нам хотелось бы использовать файлы шаблонов вместо строк. Все что нам нужно, это передать конструктору Mustache_Engine нужные параметры. Давайте перейдем в Dependencies.php и определим правила создания объекта Mustache_Engine:

$injector->define('Mustache_Engine', [
    ':options' => [
        'loader' => new Mustache_Loader_FilesystemLoader(dirname(__DIR__) . '/templates', [
            'extension' => '.html',
        ]),
    ],
]);

Мы передаем массив с параметрами, потому что хотели бы использовать расширение .html вместо дефолтного .mustache. Зачем? Затем, что другие шаблонизаторы используют подобный синтаксис и если мы все же захотим изменить шаблонизатор, нам не придется переименовывать все файлы шаблонов.

В корневой директории проекта создадим папку templates. Создадим файл Homepage.html и вставим в него код:

<h1>Hello World</h1>
Hello {{ name }}

Теперь мы можем вернутся к контроллеру Homepage и изменить строку где вызывается метод рендеринга на $html = $this->renderer->render('Homepage', $data);. Откроем главную страницу сайта в браузере и убедимся что все работает корректно.

<< Инъектор зависимостей