Сверните свою собственную систему шаблонов в PHP

Если мы вставим это регулярное выражение в _parse_template () как есть, это не даст желаемого результата. Добавьте смелый код ниже к _parse_template (), чтобы увидеть результат нашего текущего регулярного выражения:

ПРИМЕЧАНИЕ. В оставшейся части этой статьи комментарии по docblock будут опущены для экономии места (если они не новые). Вывод в вашем браузере не изменится, если вы перезагрузите index.php ; это происходит потому, что мы не добавили подстановочный знак с модификатором, чтобы учесть ноль или более символов между открытием и закрытием комментария ( . * ). Кроме того, нам нужно учесть тот факт, что комментарии на уровне блоков обычно многострочные, нам нужно добавить модификатор s , чтобы учесть это. Наше модифицированное регулярное выражение должно выглядеть так:

  $ comment_pattern = '# / \ *. * \ * / # s'; 

Настройте это в _parse_template () , затем перезагрузите index.php в вашем браузере. Упс! Выход:

Мы забыли сделать подстановочный знак ленивым, поэтому вместо остановки в конце первого комментария он продолжился до конца второго комментария блока. Однако это легко исправить: просто добавьте знак вопроса после подстановочного знака, чтобы сделать его ленивым. Это должно выглядеть так:

  $ comment_pattern = '# / \ *. *? \ * / # s'; 

Настройте _parse_template () , затем перезагрузите index.php . Намного лучше!

Затем нам нужно нацелить встроенные комментарии (те, которые начинаются с двух косых черт ( // ). Поскольку они не многострочные, на самом деле это будет собственное регулярное выражение вместо расширения регулярного выражения комментариев на уровне блоков. Для этого регулярного выражения нам нужно найти любой текст после двух прямых косых черт ( // ). Единственное исключение из этого правила — две прямые косые черты в удаленном URL ( http: // ) — чтобы исключить это, мы будем использовать отрицательный вид сзади . Готовое регулярное выражение должно выглядеть так:

  # (<?!) //.*# 

Добавьте это к _parse_template () , изменив переменную $ comment_pattern на массив с нашим регулярным выражением уровня блока в качестве первого элемента и регулярным регулярным выражением комментария в качестве второго:

Теперь комментарии правильно удаляются при перезагрузке index.php в вашем браузере:

Разделите верхний и нижний колонтитулы и цикл для обработки

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

Изолировать основной входной цикл

Сначала мы возьмем цикл, перехватывая весь контент между тегами шаблона {loop} и {/ loop} . Это регулярное выражение будет соответствовать всему шаблону и использовать группу захвата для определения цикла:

  #. * {Цикл} (. *?) {/ Цикл}. * # Это 

Измените _parse_template (), как показано жирным шрифтом, чтобы проверить правильность извлечения цикла ввода:

ПРИМЕЧАНИЕ. Не забудьте изменить функцию, чтобы она возвращала $ entry_template, чтобы вы могли видеть правильный вывод. Используя preg_replace () для «замены» всего шаблона только на захваченный шаблон цикла, мы успешно изолировали основной цикл. Перезагрузите index.php в вашем браузере, и вы должны увидеть следующее:

Изолировать заголовок

Далее, давайте получим заголовок из шаблона. Регулярное выражение для этого будет похоже на то, которое перехватило основной цикл, но на этот раз мы собираемся захватить содержимое до тега шаблона {loop} . Чтобы соответствовать заголовку, нам нужно начать с начала шаблона и записывать все до тега {loop} . Поскольку мы используем preg_replace () для извлечения заголовка, нам также необходимо сопоставить все после тега {loop}, чтобы убедиться, что он удаляется при замене. Это регулярное выражение, когда оно завершено, должно выглядеть так:

  /^(.*)?{loop.*$/is 

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

Как и ожидалось, перезагрузка index.php в вашем браузере приведет к отображению данных заголовка:

Изолировать нижний колонтитул

Нижний колонтитул очень похож на верхний колонтитул в том, как он извлекается, за исключением того, что на этот раз мы собираем данные после тега {/ loop} и проверяем, чтобы они не соответствовали всему шаблону с помощью этого регулярного выражения:

 # ^. *? {/ Цикл} (. *) $ # Это 

Вставьте это в _parse_template () и установите метод для возврата содержимого нижнего колонтитула, как мы сделали с заголовком, используя жирный код:

Перезагрузите файл индекса, чтобы увидеть вывод нижнего колонтитула:

Определить теги шаблонов с помощью регулярных выражений

Следующим шагом в нашем процессе является создание регулярного выражения, которое будет соответствовать любому тегу шаблона, чтобы мы могли заменить их входными данными. В отличие от других, которые мы написали, этот не должен соответствовать всему шаблону. Этот шаблон должен соответствовать только тегу шаблона, который будет заменен . Для этого мы можем использовать сокращение, чтобы сопоставить любой символ слова ( \ w эквивалентен [A-Za-z0-9_] ) и сопоставить один или несколько символов между фигурными скобками. Полное регулярное выражение выглядит так:

 / {(\ W +)} / 

Мы проверим, что это работает всего лишь немного, но сейчас давайте просто определим шаблон на потом, добавив жирный код в _parse_template () :

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

Шаг 7 Подготовьтесь к замене тега шаблона: карри

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

Подождите. Что ты только что сказал?

Карри — это довольно странная концепция, которая заставляет вас задуматься, поэтому давайте на секунду рассмотрим, как именно она работает. Цель функции каррирования — сделать возможным предоставление одного аргумента за раз функции, которая требует нескольких аргументов, не вызывая ошибок. Так, например, давайте посмотрим на простую математическую функцию:

Если бы мы хотели вызвать эту функцию как обычно, мы бы просто сделали следующее:

Но давайте скажем, что — по какой-то причине — нам нужно было вызывать функцию add () постепенно; мы не можем просто добавить один аргумент сейчас, а другой позже (вызывая add (1) ). Это выдает предупреждение:

Поэтому нам нужен промежуточный шаг, который проверит, было ли передано правильное количество аргументов. Если это так, функция выполняется как обычно. Однако, если аргументов слишком мало, будет возвращена новая функция с именем функции и сохраненным первым аргументом. Таким образом, когда передан второй аргумент, исходная функция может быть вызвана правильно. Используя нашу функцию add () в качестве примера и предполагая, что мы можем карри эту функцию, используя воображаемую функцию curry () , мы можем продемонстрировать этот процесс:

Напишите метод карри

Теперь, когда мы знаем, как работает карри, давайте начнем писать функцию. Сама функция каррирования всегда будет возвращать функцию, которую мы будем делать с помощью create_function () . Созданная функция проверит, существует ли надлежащее количество аргументов, и выполнит функцию curried, как обычно, если это так, используя call_user_func_array () . Если аргументов недостаточно, будет возвращена другая функция с помощью create_function () . Поскольку объединение всего этого требует создания функций внутри созданных функций, существует много способов избежать этого. Это делает наш метод карри выглядит более запутанным, чем на самом деле. Добавьте его в класс Template с помощью следующего жирного кода:

Как карри применяется к шаблонной системе?

Сейчас может быть неясно, как все это относится к системе шаблонов. Когда мы перейдем к следующему шагу, мы рассмотрим это подробно, но вкратце нам нужно иметь возможность вызывать функцию с двумя аргументами, чтобы заменить теги шаблона: один аргумент — это запись, из которой должны быть получены данные. вытащил, а другой тег шаблона должен быть заменен. Поскольку мы используем регулярные выражения для замены тегов, нам нужно использовать preg_replace_callback () для выполнения замен. Однако, поскольку обратный вызов, переданный этой функции, может принимать только один аргумент — сопоставленный текст — нам нужно передать каррированную функцию, в которой уже есть запись, хранящаяся внутри нее. Есть смысл? Давайте сделаем это!

Шаг 8 Замените теги шаблона соответствующими данными ввода

Все части на месте. Теперь нам просто нужно соединить точки и сделать это.

Напишите метод замены тегов

Замена тегов сама по себе довольно проста: возьмите соответствующий текст из тега шаблона и посмотрите, существует ли свойство в объекте ввода с таким именем. Если это так, вернуть данные, хранящиеся в указанном свойстве; если нет, просто верните тег шаблона, чтобы дизайнер мог видеть, что что-то пошло не так (или, в крайних случаях, нечетная строка, заключенная в фигурные скобки, не разрывается). Эта функция будет называться replace_tags () , и она будет статической, чтобы ее можно было передать функции каррирования в качестве допустимого обратного вызова . Добавьте его в класс Template, используя жирный код ниже:

ПРИМЕЧАНИЕ . Вызов unserialize () в начале этого метода происходит из-за проблемы с передачей объекта через функцию каррирования. Мы сериализуем объект на следующем шаге.

Измените метод анализа шаблона, чтобы заменить теги шаблона

Чтобы завершить нашу систему шаблонов, нам сначала нужно подготовить нашу функцию обратного вызова карри для использования со всеми вызовами замены. Это делается путем каррирования Template :: replace_tags () и сохранения его в переменной с именем $ callback . Добавьте это к _parse_template () с помощью полужирного кода ниже:

Далее нам нужно настроить цикл для прохождения каждого объекта записи в массиве $ records . Для каждой записи нам нужно вызвать preg_replace_callback () с тегом шаблона regex в качестве первого аргумента, обратным вызовом с сериализованным объектом записи в качестве второго аргумента и циклом в качестве третьего аргумента. Разметка, возвращаемая при каждом вызове, должна добавляться к переменной с именем $ markup , в которой хранится вся разметка записи, которая должна быть выведена в браузер. Добавьте это к _parse_template () с жирным кодом:

Прежде чем мы сможем это проверить, нам нужно создать запись, чтобы у движка было что-то, что можно было бы пройти. В index.php добавьте фиктивную запись со свойством
$ test, чтобы соответствовать тегу шаблона в нашем файле шаблона тестирования:

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

Это означает, что мы эффективно создали шаблонизатор! Однако мы еще не закончили: нам все еще нужно добавить возможность замены тегов шаблона в верхнем и нижнем колонтитулах нашего файла шаблона.

Заменить теги шаблона в верхнем и нижнем колонтитулах шаблона

Процесс замены тегов шаблонов верхнего и нижнего колонтитула идентичен процессу для тегов в цикле, но для этого необходимы другие данные. Возможно, вы помните, что мы включили аргумент $ extra, когда писали методы generate_markup () и _parse_template () ; эта переменная должна использоваться как объект, который будет хранить данные для замены тегов шаблона верхнего и нижнего колонтитула. Для наших целей $ extra может содержать два свойства, $ header и $ footerоба из которых будут хранить объект, свойства которого будут использоваться для замены тегов шаблона в соответствующем разделе шаблона. Очевидно, что если нет тегов верхнего или нижнего колонтитула, то никакие данные не будут сохраняться в $ extra для обработки. По этой причине мы начнем с проверки, является ли $ extra объектом. Если это так, мы пройдемся по его свойствам и запустим preg_replace_callback () с тегом regex шаблона, обратным вызовом после передачи сериализованного объекта верхнего или нижнего колонтитула и раздела верхнего или нижнего колонтитула шаблона. Добавьте жирный код ниже, чтобы завершить нашу систему шаблонов:

Если вы перезагрузите index.php в своем браузере, вы увидите следующий вывод:

Последнее, что нужно сделать, это проверить замену тега шаблона верхнего и нижнего колонтитула. Откройте template-test.inc и добавьте два новых тега шаблона, один в верхнем колонтитуле и один в нижнем колонтитуле:

Затем вернитесь в index.php и добавьте новый объект с именем $ extra, в котором два объекта
хранятся в свойствах $ header и $ footer, свойства которых соответствуют тегам нового шаблона:

ПРИМЕЧАНИЕ: не забудьте передать $ extra для generate_markup () ! Сохраните эти изменения, перезагрузите файл в браузере, и вы увидите следующее:

Шаг 9 Используйте реальные записи

В качестве последнего упражнения давайте воспользуемся некоторыми реальными записями из Envato Marketplace и разработаем шаблон для их отображения.

Создать шаблон

Для шаблона давайте создадим новое в папке шаблонов с именем entry-list.inc . Внутри добавьте следующий код:

Загрузите реальные записи и используйте новый шаблон

Все, что нам нужно сделать для загрузки реальных записей из API Envato, — это вызвать функцию, которую мы написали ранее в этом руководстве. В
index.php , измените код, чтобы использовать новый файл шаблона и загружать последние записи из audiojungle :

ПРИМЕЧАНИЕ. Я добавил декларацию типа документа и основные теги HTML, чтобы избежать проблем с кодировкой символов.

Резюме

К этому моменту вы успешно объединили объектно-ориентированный PHP, регулярные выражения и функции карри в простую в использовании систему шаблонов. Методы, описанные в этом руководстве, могут быть добавлены в ваш арсенал разработки для использования в будущих проектах, и, надеюсь, вы сейчас чувствуете себя лучшим разработчиком. Вы заметили ярлык, который я пропустил? Можете ли вы придумать способ улучшить систему шаблонов? Как вы относитесь к использованию этой системы в проекте, чтобы отделить разметку от бизнес-логики ? Дайте мне знать ваши мысли в комментариях!