Небольшому сайту хватит функции шаблонов на PHP в десять строк

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

Функция

<?php
function render($template, array $vars = array())
{
    extract($vars, EXTR_SKIP);
    ob_start();
    include $template;
    return ob_get_clean();
}

Вот и всё. Она выполняет три работы.

extract() превращает ключи массива в локальные переменные, так что шаблон может писать $title вместо $vars['title']. Флаг EXTR_SKIP означает, что ключ по имени template не сможет затереть собственный параметр функции.

ob_start() включает буферизацию вывода, так что всё, что выводит шаблон, перехватывается, а не отправляется в браузер.

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

Шаблон

Шаблоны — это обычные файлы PHP, состоящие в основном из HTML:

<h1><?php echo htmlspecialchars($title); ?></h1>
<ul>
<?php foreach ($items as $item): ?>
    <li><?php echo htmlspecialchars($item); ?></li>
<?php endforeach; ?>
</ul>

Альтернативный синтаксис управляющих конструкций (foreach ... endforeach, if ... endif) существует именно для такого применения. Он читается как шаблон, а не как код, а закрывающие ключевые слова сохраняют видимой вложенность, когда теги перемежаются с разметкой.

Применение

<?php
$page = render('templates/list.php', array(
    'title' => 'Things I own',
    'items' => array('a bicycle', 'a piano', 'too many books'),
));

echo render('templates/layout.php', array(
    'title' => 'Things I own',
    'body'  => $page,
));

Шаблоны вкладываются друг в друга так: внутренний отрисовывается в строку и передаётся внешнему как переменная. Шаблон макета печатает $body там, где должно быть содержимое. Это даёт ту единственную возможность, которой люди на самом деле ждут от движка шаблонов, — общую рамку страницы, — без всякого движка.

Экранирование

Единственное, что даёт движок шаблонов и не даёт эта функция, — автоматическое экранирование, и как раз о нём забывать нельзя. Каждое значение, пришедшее извне программы, перед выводом проходит через htmlspecialchars(). Печатать это утомительно, поэтому определите короткий псевдоним:

<?php
function e($s)
{
    return htmlspecialchars($s, ENT_QUOTES, 'UTF-8');
}

и пишите <?php echo e($title); ?>. Шаблон выше становится короче, а правило — легко проверяемым: любой echo без обёртки e() — ошибка, если только переменная заведомо не содержит HTML, который вы сами и сгенерировали, как $body в макете.

Почему этого достаточно

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

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

Я использовал эту функцию — или неотличимую от неё — на каждом небольшом сайте на PHP, который делал. Заменять её мне не понадобилось ни разу.