PHP-класс для построения шаблонов. PHP-класс для построения шаблонов Содержимое страницы по умолчанию

Статья поможет пользователям, которые еще довольно мало знакомы с шаблонами Dle и tpl файлов в частности. Статья поможет разобраться в чем их основное предназначение и как с ними работать.
Люди которые хорошо знакомы и не очень с HTML и CSS легко освоят работу с файлами шаблона dle.

Итак начнем в состоящий из шаблонов с расширением *.tpl есть стандартные и обязательные файлы шаблонов, которые должны там присутствовать. При отсутствии одного из файла система будет сообщать о ошибке , в некоторых случаях интернет-портал не будет работать совсем.
Подробно о каждом файле шаблона DataLife Engine

addcomments.tpl - Форма для добавления комментариев только в полной новости.

addnews.tpl - Форма для добавления публикации на веб-ресурс, для заполнения данных о новости: заголовок, категорию новости, короткую и полную новость, поля для облака тегов и различные администраторские функции.

comments.tpl - Отвечает за оформление комментариев, как в полной публикации так и последние комментарии.

feedback.tpl - Основное оформление формы обратной связи с поля заполнения.

fullstory.tpl - Шаблон файл оформление полной новости, дату публикации, автор, количество комментариев, вывод похожих новостей и т.д.

info.tpl - Форма сообщения страницы ошибки на веб-ресурсе, выходит например при неправильной авторизации.

informer.tpl - Файл оформления вывода информера (партнеров или например новости Яндекс и т.д.) на блоге.

login.tpl - Основной файл оформления формы Авторизации, Админ панели

lostpassword.tpl - Форма восстановления (при потери) пароля, выводится только для не авторизованных пользователей.

main.tpl - Основной файл оформления главной страницы вывода информации блога DLE, к которому подключаются остальные шаблоны.

navigation.tpl - Шаблон оформления перехода по страницам, постраничная навигация.

offline.tpl - Страница отключенного сайта при технических работах, если необходимо провести глобальные изменения на веб-проекте. Будет виден всем кроме администрации интернет источника.

pm.tpl - Форма оформления Отправки, Входящих и Отправленных сообщений на интернет-портале дле, отвечает за оформление личных сообщений пользователя.

preview.tpl - Настройки оформления стилей CSS для окна предварительного просмотра при добавлении новости, в которую входит оформление для короткой и полной новости.

print.tpl - Страницы Распечатки для принтера.

profile_popup.tpl - Всплывающее модальное окно при включенном AJAX скрипте, которое выходит при выборе логина пользователя мышкой. Отвечает за оформление POP - Up окна с краткой информацией о пользователе.

registration.tpl - Форма регистрации нового пользователя после принятия правил выдает анкету с полями для заполнения и регистрации.
ПС.Правила интернет-портала находятся в статической странице, и не присутствуют в данном шаблоне.

relatednews.tpl - Форма оформления Вывод похожих новостей.

search.tpl - Выводит страницу простого поиска по веб-ресурсу, куда входит поле для заполнения и кнопки Поиск и Расширенный поиск.

searchresult.tpl - Форма оформления результата поиска, а также при выборе Расширенный поиск выводит поля для заполнения.

shortstory.tpl -Важный шаблон осуществляет оформление короткой новости.

speedbar.tpl - Данный файл выводит полную ссылку на категорию в которой опубликована новость, и отвечает за быстрый переход в нужный раздел (хлебные крошки).

static.tpl - Данный файл шаблона отвечает за оформление и вывод статических страниц созданных в админ панели Dle.

static_print.tpl - Применяется для оформления статической страницы Версия для печати

stats.tpl - Оформление Статистики веб-ресурса, с выводом всей информации.

tagscloud.tpl - Шаблон оформления облака тегов.

topnews.tpl - Применяется для оформления популярных новостей.

userinfo.tpl - Форма оформления профиля информации о пользователи, а также POP - Up окном для последующего редактирования данных, открывается если пользователь зарегистрирован на веб-проекте.

vote.tpl - Используется оформления вывода результатов голосований, как Все опросы на DLE или Всего проголосовало.

На данный момент перечислены основные tpl файлы шаблона Dle, с выходом новых версий возможны изменения и добавления новых шаблонов TPL для движка DataLife Engine .

Помимо основных шаблонов TPL в DLE, любой пользователь может добавить свои, для удобного оформления, улучшения и установки сторонних модулей на веб-проект!
Для этого создается сам шаблон например:

leftblocks.tpl (левый блок веб-проекта) в который добавляются элементы оформления.

Внимание! Для нормальной работы файл должен находится в папке с основными шаблонами там же где и main.tpl!
Для подключения такого блока используется тег {include} Например:
Который вставляется в нужном месте main.tpl

{include file="leftblocks.tpl"}

Помимо такой вставки есть ещё вариант подключения коротких новостей с помощью шаблонов например:

shortstory-1.tpl Короткая новость в который добавляются элементы оформления. Пример вставки:

{title}

В main.tpl вставляем тег с настройками:

{custom category="2,3" template="shortstory-1" aviable="global" from="0" limit="5" cache="yes"}

В результате если вставить такую вставку например: в правый блок, появится ссылка и title последних новостей категории 2 и 3 как на нашем сайте www.сайт раздел Новости "Модули ДЛЕ " и т.д., где

custom category="2,3" (категории из которых берется новость можно добавить ещё через запятую)
template="shortstory-1" (название шаблона)
aviable="global" (глобально для всех, можно установить main вместо global будет только на главной выводится информация)
from="0"
limit="5" (количество публикаций)
cache="yes" (Включить/Выключить кеширование)

Также в шаблонах присутствую стандартные папки:
bbcodes (Папка с файлами картинок для редактирования таких как Смайлов, HTML цвета и BBcodes)
dleimages (Папка с файлами картинок для оформления рейтинга, закладок, водяного знака и т.д.)
images ((Папка с файлами изображений для оформления шаблона. может иметь разное название)
js (Папка с файлами скриптов JS и т.д.)
style (Папка с файлами каскадов стилей для оформления шаблонов)

Внимание! Скрипты обязательно должны находиться в папке JS ,в котором должен быть файл.htaccess для защиты от разного рода угроз, если такого файла не будет скрипт не запустится (сработает система защиты Dle).
Внимание! Во всех папках шаблона также должен быть файл.htaccess
Пример файла.htaccess с данными внутри:
Order Deny,AllowAllow from all

Внимание! В шаблоне там же где main.tpl должен быть файл.htaccess С таким кодом:
Order allow,denyDeny from all

Файл.htaccess можно скачать из шаблона дистрибутива движка DataLife Engine


Отделение логики получения данных от логики их отображения - очень важная составляющая веб-девелопмента.
Любой программист, который поднялся чуть выше уровня "Hello world", начинает ощущать потребность в таком разделении. Но далеко не все приходят к правильным выводам и решениям.
Поэтому я приведу здесь самые важные правила:
1. Код получения и код отображения данных надо разделять.
2. Любой вывод должен начинаться только после того, как для него готовы все данные.
3. Как следствие, любой скрипт должен заниматься только обработкой данных. После этого он может либо отправить какой-то НТТР заголовок, или вызвать шаблон, передав ему подготовленные данные, или и то и другое вместе.
4. Каким именно шаблонизатором пользоваться - дело десятое. Самый простой и доступный - сам РНР, поэтому примеры будет приводиться на нём.

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

Самое простое и очевидное заблуждение состоит в том, что новички называют шаблоном вынесенный в отдельный файл "дизайн" - общий html для всех страниц сайта. И на этом успокаиваются. Динамическую информацию, ничтоже сумняшеся, выводя старым добрым echo:-)
На самом же деле, шаблонизатор в основном занимается выводом изменяющегося содержимого страниц сайта. А вывод "дизайна" - задача второстепенная.

Фантазий же главных две:
1. Шаблоны нужны "дизайнеру", чтобы он мог их править, не разбираясь в PHP.
2. Следовательно, шаблоны служат для отделения PHP от HTML.

Давайте попробуем задуматься над первым утверждением. Кто такой дизайнер? Это человек, который работает в фотошопе. HTML он чаще всего не знает вообще. А над шаблоном работает либо специальный верстальщик или - чаще всего... сам программист! Смешно, правда?
Теперь следствие, про отделение PHP от HTML. Отлично. Перед нами стоит святая цель отделить. Поэтому мы придумываем Смарти и пишем:
{foreach key=cid item=con from=$contacts}
{$con.name} - {$con.nick}

{/foreach}
Ещё смешнее.
"Дизайнер", ради которого все затевалось, падает в обморок от счастья.

Теория
Получается, что наши причины, по которым мы решили пользоваться шаблонами, гроша выеденного не стоят. И что же теперь - не нужны, выходит, шабоны вообще? Нужны. Но сначала надо ответить себе на вопрос - "зачем?" Для чего нужны шаблоны. И проверить ответ практикой. Я много раз задавал людям этот вопрос. Но почти никто не может на него ответить. Зачем ему нужны шаблоны. Получается, люди делают что-то, не зная зачем.
Это - самое смешное.

За время своей деятельности в качестве веб-программиста я сформулировал для себя три причины, по которым нужны шаблоны лично мне. По сути, их две. А сводятся, в конечном счете, к одной:

Один код - несколько представлений .

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

Часто одну и ту же информацию надо показывать в нескольких видах. К примеру - обычная страница и страница для печати. Информация та же самая, код её получения один и тот же, а код вывода - разный. Столкнувшись с такой ситуацией, очень быстро разделишь свой код на две части, одна из которых отвечает за вывод, а вторая - не отвечает. Еще пример: допустим, нам захотелось выводить информацию не напрямую в HTML, а через AJAX-запрос, в формате JSON. Если у нас использовался шаблонизатор, то мы меняем в нашем коде ровно одну строчку - вызов шаблонизатора на вызов json_encode() . А если бы у нас вывод был перемешан с кодом получения данных, то код бы пришлось переписывать весь!

В чем-то похожая ситуация: допустим, наш скрипт стоит на двух сайтах. Плюс копия у нас дома. И вот дома мы нашли крупную багу. Заделали её. Теперь надо обновить код на сайтах. И вот он - момент истины: если шаблоны были использованы правильно, то мы просто заливаем код на оба сайта, и все продолжает работать, как ни в чем не бывало! Такая ситуация, как я считаю - идеальная проверка выбранного подхода к шаблонизации.

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

Следует также помнить, что кроме текста РНР скрипты еще и выводят HTTP заголовки. Которые обязаны выводиться до любого текста, или даже вместо текста вообще (если мы например хотим перенаправить пользователя на другую страницу). Если мы сначала реализуем логику работы приложения, ничего не выводя при этом, то выдать нужный НТТР заголовок не составит для нас никакой проблемы.

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

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

Сам файл links.php. НИЧЕГО не выводит. Только готовит данные и после этого вызывает шаблон.







В нужном месте в него включается шaблон нашей страницы (tpl_links.php):





  • " />

    Это простейший вариант. Всё прокомментировано, поэтому вопросов по этому примеру возникнуть не должно. И по сути любая страница состоит из таких вот блоков. Ваша задача взять нужные блоки (функция getTemplate() ), заменить нужными данными (функция str_replace() и данные полученные, например, из базы), а потом просто соединить все блоки, как обычные строки, и вывести всё на страницу.

    Безусловно, без ООП здесь очень проблемно будет. Вы такое количество условий наплодите (страниц же много), что быстро запутаетесь. Но принцип использования tpl-файлов , надеюсь, Вы осознали. Дальше уже самостоятельно подумайте, как всё это обернуть в ООП , чтобы всё было максимально простым с точки зрения понимания кода и его сопровождения в будущем.