Как сделать шаблонизатор на php

Как сделать шаблонизатор на php?

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

Да понятно MVC, но. у меня нет контроллера. Запрос приходит на роутер, который определяет какой вызывать класс обработчик (это жирная модель по сути), класс всё готовит и должен выплюнуть результат в шаблон по идее. Передавать шаблонизатору он через массив вероятно всё будет, но как это лучше делать, как определить для этого набора данных можно использовать сущствующий шаблон или надо создавть новый? Как таблицы шаблонизаирова если в одной 3 столбца, в другой 5? Или 4 и 4, но у первой первый столбец должен быть 70% а у второй последний?

• Вопрос задан более трёх лет назад
• 3447 просмотров

Комментировать
Решения вопроса 2
Empower people to give

Сначала — зачем нужен шаблонизатор. Тут подмена понятий. Скорее вопрос такой: как отделить вывод от заголовков. Если не отделять, то может быть такая ошибка

   Hello, 

Проблема решается, если вывод HTML делать после вывода заголовков. Например, использовать буфер

    Hello,  

Однако так придётся писать в каждом месте, где формируется HTML. Можно ли сократить?

Простейшее представление через буфер

 session_start(); if (empty($_SESSION['username'])) header('Location: /login.php'); $viewsPath = __DIR__.'/views/'; // где лежат представления render($viewsPath . 'page.php'); // нарисовать страницу HTML

   Hello, 

А дополнительно ещё решают проблему отделения логики от формирования интерфейса. Работа с внешними данными в одном месте, а отображение их — в другом. Для этого в представление передают всё, что нужно показать. И точка. Лишних данных там не надо. В некоторых фреймворках стоит Exception если представление начнёт работать с базой данных, читает данные из входного запроса или пытается отправить заголовки.

 session_start(); if (empty($_SESSION['username'])) header('Location: /login.php'); $viewsPath = __DIR__.'/views/'; // где лежат представления render($viewsPath . 'page.php', array( // отображаемые данные передаются массивом 'username' => $_SESSION['username'], ));

# page.php  Hello, 

Не правда ли, с представлениями код становится значительно изящнее. А если логика для реализации представлений хранится в отдельном файле-библиотеке, то код становится короче и понятнее.

В фреймворках вместо функции render может использоваться объектная реализация

 class View < public $viewsPath = __DIR__.'/views/'; public function __construct($viewsPath = null) < // настройка представлений // например, можно перепределить место хранения представлений if (!is_null($viewsPath)) $this->viewsPath = $viewsPath; > public function render($viewPath, $vars) < if (!is_file($this->viewsPath . $viewPath)) throw new ViewException('View "'. $viewPath . '" in folder "'. $this->viewsPath . '" not exists'); extract($vars); ob_start(); include($this->viewsPath . $viewPath); return ob_get_clean(); > > $view = new View(); $view->render('page.php', array( 'username' => $_SESSION['username'] ));

Как таблицы шаблонизаирова если в одной 3 столбца, в другой 5?

Никто в представлениях не запрещает использовать языковые конструкции. Это могут быть конструкции языка PHP или какой-нибудь другой язык, специально написанный для шаблонизатора. Например, в Smarty, Blade, Pug свои языки. Передай в представление количество колонок и сделай цикл 🙂

у первой первый столбец должен быть 70% а у второй последний?

В представлениях можно подключать стили CSS, через которые меняется отображение (колонка 70%).
У каждого представления может быть свои стили.
Если нужно, чтобы были некоторые общие стили и дополнительные, нужные только для этой страницы, используют что-то типа буферизирования вывода блока стилей.

 // добавить блок стилей public function addCss($name, $css) // $name - это чтобы не дублировались блоки стилей, на всякий случай < self::$css[$name] = $css; >public function renderCss() < foreach(self::$cssLinks as $url) echo ''; echo ''; > >

# index.php $assets = new Assets(); // общие стили $assets->addCssLink('https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css'); // . $view = new View(); $view->render('page.php', array( 'username' => $_SESSION['username'] ));

# page.php addCssLink('/path/to/my/styles.css'); // ещё один файл стилей $assets->addCss('h1 < color: red; >'); // или даже что-нибудь микроскопическое, только для этой страницы ?>  renderCss() ?> Hello, 

Создание простого шаблонизатора на PHP — часть 1

Недавно я писал несколько составных пакетов для работы с файлами и файловой системой: Affinity4File , Affinity4Config и Affinity4Concat . При работе над ними мне понадобилось протестировать их на файлах. Вначале мои тесты успешно выполнялись на компьютере, который работал под управлением Windows . Но при сохранении утилита TravisCI говорила мне, что пути не совпадали. Потому что разделители папок в адресах Windows и Linux не совпадали.

Затем я наткнулся на виртуальные файловые системы StreamWrappers, в частности vfsStream. Но не все файловые тесты могут быть переписаны с использованием vfsStream . Например, тесты, в которых класс/метод использует SplFileInfo :

$pattern = '/^test[wd-]*.txt$/'; $dir = 'tests/files/01/02'; $this->assertContainsOnlyInstancesOf( 'SplFileInfo', $this->file->find($pattern)->in($dir)->get() );

Как ко мне пришла идея

В vfsStream обработчики потоков используются разными способами. Изучая их, я заметил две интересные:

• Могут обрабатываться как потоки. Это значит, что они хранятся как переменные и могут быть изменены в памяти без необходимости изменения самого файл.
• После этого файл может быть подключен через include или require .

Поэтому мне в голову пришла идея написать простой шаблонизатор PHP , в котором файл шаблона открывается в потоке, изменяется и преобразуется в корректный PHP-код . А затем другой поток используется, чтобы смоделировать файл, который отображается через буфер вывода и функцию include . Таким образом исключаются временные файлы и легко могут быть созданы фильтры, делая синтаксис шаблона простым для изменения.

Синтаксис

Пример реализации механизма шаблонизатора находится здесь -Affinity4/Template. Он поддерживает PHP , поэтому синтаксис шаблонов не является обязательным. На это меня вдохновил Sass .

Вторая ключевая особенность – это то, что синтаксис шаблона не будет отображаться без применения механизма шаблонов или в случае ошибки компиляции потока в PHP . Это означает, что если вы решите использовать другой язык шаблонов или включите файлы напрямую, то при просмотре страницы вы не увидите блоков > или @foreach(thingy in thingys) , оставленных в коде.

Третьей особенностью является то, что синтаксис по умолчанию должен работать во всех IDE , текстовых редакторах и быть понятен всем, знающим HTML .

Чтобы шаблонизатор соответствовал второму и третьему требованию, нужно использовать комментарии HTML.

Недостаток заключается в том, что здесь больше кода. Но он может быть быстро написан, используя горячие клавиши комментариев в редакторе или IDE ( обычно Ctrl + / или Cmd + / ).

1. Поддержку IDE/редакторов по умолчанию.
2. Возможность использования чистого PHP-код . Это позволяет быстро усвоить механизм.
3. Специфический язык шаблона может быть полностью проигнорирован любым, кто хочет работать только над разметкой.

Наш механизм шаблонов не будет включать в себя инструменты макетов или блоков, которые есть в Twig , Blade , Latte и т.д. Это важные средства, и я планирую реализовать их в будущем. Но нам они не нужны.

Структура проекта

Мы поместим всё в два класса: один для обработки правил синтаксиса ( регулярные выражения ), другой — для открытия файлов исходного кода, их компиляции в PHP , выделения переменных и вывода.

Звучит запутанно? Но с помощью vfsStream это становится тривиальной задачей по сравнению с традиционным методом создания лексеров/парсеров, токенизаторов и разработкой некоторой формы AST ( абстрактного синтаксического дерева ).

Мы используем менеджер зависимостей Composer , чтобы подключать vfsStream и загружать наши собственные классы.

composer require mikey179/vfsStream

Далее создадим в корне проекта папку под названием src. Внутри нее разместим два файла классов ( Engine.php и Syntax.php ). Структура папок должна выглядеть следующим образом:

template |-- composer.json |-- src |-- Engine.php |-- Syntax.php |-- views |-- home.php

Затем я записываю всё в файл index.php , чтобы увидеть правильность реализации. Для механизма шаблонов это достаточно просто. Поэтому можно сделать следующее:

render('views/home.php', [ 'show_title' => true, 'title' => 'Home' ]);?>

Чтобы получить рабочую версию шаблонизатора, нужно следующее:

1. Метод прорисовки шаблона ( render ).
2. Метод render должен получать путь к представлению в качестве первого аргумента.
3. Необязательный массив параметров может передаваться в представление.
4. Параметры должны быть выделены в переменные, если второй аргумент – не пустой массив.
5. Загрузка представления в vfsStream для дальнейшей обработки.
6. Включение обработанного ( скомпилированного ) « файла » в буфер вывода для отображения.
7. Файл представления: views/home.php.

Сначала создадим наше представление с простым PHP кодом, чтобы убедиться, что переменные передаются в представление:

Теперь можно сфокусироваться на простейшей реализации класса шаблонизатора на PHP ( Engine.php ).

Так мы получим рабочую версию метода render, хотя и без желаемой функциональности.

Перед тем, как двигаться дальше, нужно добавить папку src в автозагрузчик PSR-4 , расположенный в файле composer.json:

 < "autoload": < "psr-4": < "Template": "src/" >>, "require": < "mikey179/vfsStream": "^1.6" >>

Теперь требуется повторно сгенерировать файлы автозагрузки и файл composer.lock :

composer dumpautoload

Реализуем логику получения представления для отображения с параметрами, которые мы передали.

 else < // 3. Если файл представления не найден, вывести исключение. throw new Exception(sprintf('Файл %s не найден.', $view)); >> > ?>

Запустите локальный сервер для PHP . Перейдите в корень проекта и откройте командную строку. В командной строке наберите:

php -S localhost:80

Вы увидите сообщение о том, что сервер запущен. Откройте браузер, перейдите по адресу http://localhost/ и вы должны увидеть:

Теперь мы знаем, что метод render будет работать, так как ожидается. В следующей части мы подключим vfsStream .

Сергей Бензенко автор-переводчик статьи « Creating a Simple Template Engine with PHP Part 1 »

Шаблонизатор — Веб-разработка на PHP

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

Рассмотрим следующий пример:

 $app->get('/courses/', function ($request, $response, array $args) use ($courses)  $slug = $args['name']; $course = $courses[$slug]; return $response->write(" $course->name> ") ->write(" $course->body> "); >); 

У такого подхода есть следующие недостатки:

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

Для решения подобных задач придумали шаблонизаторы — специализированные библиотеки, которые позволяют описывать шаблон отдельно от остальной части кода. Мы будем использовать slim/php-view, который установили ранее.

Измените настройку Slim в начале файла public/index.php так, как показано в примере:

 // Контейнеры в этом курсе не рассматриваются (это тема связанная с самим ООП), но если интересно, то посмотрите DI Container use Slim\Factory\AppFactory; use DI\Container; $container = new Container(); $container->set('renderer', function ()  // Параметром передается базовая директория, в которой будут храниться шаблоны return new \Slim\Views\PhpRenderer(__DIR__ . '/../templates'); >); $app = AppFactory::createFromContainer($container); $app->addErrorMiddleware(true, true, true); 

В этих строчках происходит подключение шаблонизатора к Слиму с помощью DI Container . Наши шаблоны будут храниться в директории templates в корне проекта.

Далее добавьте еще один обработчик:

 $app->get('/users/', function ($request, $response, $args)  $params = ['id' => $args['id'], 'nickname' => 'user-' . $args['id']]; // Указанный путь считается относительно базовой директории для шаблонов, заданной на этапе конфигурации // $this доступен внутри анонимной функции благодаря https://php.net/manual/ru/closure.bindto.php // $this в Slim это контейнер зависимостей return $this->get('renderer')->render($response, 'users/show.phtml', $params); >); 

Метод render() выполняет рендеринг указанного шаблона и добавляет результат в ответ. Сама функция принимает на вход три параметра:

1. Объект ответа
2. Путь до нужного шаблона внутри директории templates
3. Набор параметров, которые будут доступны внутри шаблона. Сюда можно передавать все, что угодно

Добавьте файл templates/users/show.phtml со следующим содержимым:

 Hello,  $id ?>  

Расширение phtml используют, когда хотят показать, что внутри файла содержится шаблон на PHP. В остальном файл рассматривается как обычный файл с кодом на PHP.

Теперь откройте браузер и попробуйте загрузить страницу http://localhost:8080/users/nick .

Hello, nick 

Вместо кода на экране появилось значение переменной $id . Это произошло, потому что шаблонизатор берет массив $params , который передается третьим параметром в метод render() и создает внутри шаблона локальную переменную на каждый ключ этого массива. Причем имя переменной и ключа совпадают.

Этот принцип работает всегда. Если нужно вывести данные на странице, то их добавляют в массив $params и обращаются к ним в шаблоне через переменные.

Этой тактики следует придерживаться и для суперглобальных массивов. По понятным причинам их можно использовать напрямую:

  $_GET['name'] ?>  

Но делать так нельзя. Такой код значительно сложнее в отладке и потенциально опасен. Подробнее об этом дальше по курсу.

Собирая все вместе

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

Обработчик

 $app->get('/courses', function ($request, $response) use ($courses)  $params = [ 'courses' => $courses ]; return $this->get('renderer')->render($response, 'courses/index.phtml', $params); >); 

Шаблон

  foreach ($courses as $course): ?>   $course['id'] ?>   $course['name'] ?>    endforeach ?> 

Открыть доступ

Курсы программирования для новичков и опытных разработчиков. Начните обучение бесплатно

• 130 курсов, 2000+ часов теории
• 1000 практических заданий в браузере
• 360 000 студентов

Наши выпускники работают в компаниях:

Что такое шаблонизатор Twig и зачем он нужен?

03-06-2021 08-06-2021

Зачем нужны шаблонизаторы?

Создание качественного продукта, будь то сайт или приложение — результат сплоченной работы целой команды. Это программисты, верстальщики, дизайнеры. Чем сложнее проект, тем важнее отделить его логику от представления. Только при успешном их разделении backend и frontend-разработчики смогут эффективно сотрудничать. Всего этого можно достигнуть благодаря шаблонизаторам. На данный момент существует множество способов генерации конечных html-страниц. В том числе большое количество шаблонизаторов. Вот некоторые из них: Blade, Smarty, Twig, Volt. Мы остановимся подробнее на Twig.

История создания

Twig был написан в 2008 году австрийским разработчиком Армином Ронахером, как обработчик шаблонов с открытым исходном кодом, созданный на языке программирования php. Вскоре он занялся разработкой на Python и больше не возвращался к шаблонизатору. Однако труды были не напрасны. Идею Twig поддержал и развил ведущий разработчик фреймворка Symfony — Фабьен Потенсье. Поколдовав над кодом и написав всю необходимую документацию, он пришел к выводу, что код вполне целостен и библиотеку можно показать публично. В своём личном блоге Фабьен отметил: «Twig не только один из самых функциональных шаблонизаторов, но и самый быстрый».

Особенности Twig

• высокая скорость работы
• наследование шаблонов (возможность определить базовый и дочерние шаблоны)
• понятный и компактный синтаксис
• оптимизированный php код
• безопасный режим «песочницы» (пользователи имеют ограниченный набор тегов, фильтров и методов объектов, определенных разработчиком )
• возможность создания и использования макросов
• полностью документирован (и API тоже)
• простая отладка (при синтаксических ошибках шаблонизатор выведет сообщение об имени файла с ошибкой и номером строки)

Подключение Twig и рендер первого шаблона

Один из самых простых способов установки — скачать компонент с GitHub. Далее следует распаковать архив и каталог lib поместить в папку с рабочим проектом.

Всё необходимое для того, чтобы подключить Twig находится в файле index.php. В каталоге templates размещены файлы шаблонов. В нашем случае base.html и books.html. compilation_cache используется для хранения php-файлов, созданных шаблонизатором для работы.

1. Подключаем Twig.

2. Сообщаем шаблонизатору местонахождение шаблонов. В качестве аргумента передаем путь к папке templates.

3. Создаем объект шаблонизатора, указав необходимые опции cache и auto_reload.

Параметру cache передается путь к папке compilation_cache.

Вторую опцию активируем, прописав true. Это необходимо при обновлении страницы, чтобы Twig заново обработал шаблон. В противном случае шаблонизатор закеширует страницы. В будущем, после завершения работы над сайтом, данную опцию можно отключить.

4. Для наглядной работы с шаблонизатором сформируем небольшой массив со списком книг вида ключ-значение.

5. Используем метод render() для передачи данных в шаблон и вывода html результата.

Аргументы: название файла шаблона и созданный ранее массив.

Общий вид файла:

6. Настройка base.html (базовый шаблон)

Наследование шаблонов позволяет вынести общие элементы сайта, такие как header, footer, sidebar в базовый шаблон. Он определяет костяк html-документа. Каждый блок, в свою очередь, может быть переопределен дочерним шаблоном.

В нашем примере два блока: title и content.

7. Настройка books.html (дочерний шаблон)

a) указываем родительский шаблон

б) вписываем название дочерней страницы в наш блок title. Оно появится между тегам title в base.html

в) заполняем содержание, оно будет помещено в блок content базового шаблона

Цикл for проходится по данным, которые были переданы в шаблон посредством метода render(). Для извлечения значений необходимо обратиться к элементам по их ключам. В нашем случае это: > и > .

Выстраивается следующая цепочка:

Срабатывает метод $twig->render(‘books.html’, array(‘books’ => $books))

Twig подгружает шаблон books.html и формирует html-содержание

Распознает, что books.html это дочерний шаблон base.html и помещает туда сформированное содержание

Шаблонизатор возвращает полноценную страницу html

Оформление кода

Правило 1. Только один пробел после начала разделителя (>,%> и #>) :

Правило 2. Не ставить пробелов:

• после открытия круглой скобки и перед закрытием круглой скобки в выражениях
• перед и после разделителей строк
• перед и после следующих операторов: |, ., . []
• перед и после круглой скобки, используемой для фильтра и вызовов функций
• перед и после открытия и закрытия массивов и хэшей

Правило 3. В названиях переменных использовать маленькие буквы и символы подчеркивания.

Правило 4. Делать отступы внутри тегов.

Циклы и условия в Twig

В Twig есть такие базовые конструкции как циклы и условия. В примере с выводом книг был задействован цикл for:

Одной из особенностей шаблонизатора является использование оператора двоеточие (..). Это альтернатива range в php для создания массива, содержащего диапазон элементов.

Пример перебора цифр:

То же самое можно проделать с буквами.

Кроме того, полезной является возможность добавить условие в определение цикла.

Пример — фильтрация продуктов по цене:

Условия, поддерживаемые Twig: if, elseif, if not и else:

Фильтры в Twig

Фильтры – более продвинутые средства Twig. Эти инструменты позволяют форматировать данные перед выводом, определять в каком формате и как будет передана информация в шаблон. Вот несколько из них:

Date и date_modify — форматируют и модифицируют дату

Format — преобразует placeholder’ы, строки, которые начинаются со знака %, заменяя на подставляемые значения.

Striptags — удаляет html теги, все пробелы, находящиеся рядом, заменяет одним.

Escape — экранирует строку для безопасного отображения.

Заключение

Twig – это мощное средство для создания шаблонов сайта, которое хорошо документировано и полностью протестировано. Он особенно полезен для командного ведения проекта, позволяя комфортно работать программистам и frontend-разработчикам.