Форматированный вывод записей в MaxSite CMS

Головная боль любого верстальщика - смесь HTML и PHP-кода. Особенно запутанным будет код, в котором используется множество вложенных тэгов, css-классы и стили.

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

Например - заголовок записи. Если это главная страница, то это должна быть ссылка. Если одиночная, то просто H1. Если это какой-то виджет, то просто текст.

Именно по этой причине в MaxSite CMS с самых первых версий используются универсальные функции mso_page_...() в которых можно указать HTML-оформление. Этот подход на порядок проще, чем заставлять верстальщика оперировать PHP-переменными: код был бы в несколько раз сложней и запутанней (одни if-условия чего стоят...).

Вместе с тем, нельзя не заметить, что в шаблонах часть функций mso_page_... повторяется без изменений в части аргументов. Если это заголовок, то скорее всего это будет тэг H1 в виде ссылки.

Таким образом достаточно давно у меня возникала идея организовать вывод записей в виде некой форматированной строки. Скрипт будет сам её разбирать и подставлять соответствующую mso_page_...-функцию с требуемыми аргументами.

Со временем идея немного трансформировалась в универсальный PHP-класс Page_out, готовый для работы с произвольным HTML-кодом.

Скорее всего верстальщики вздрогнут, поняв, что вывод HTML будет реализован с помощью PHP, но здесь есть один гиганский плюс в том, что результирующий код будет проще и более наглядней, чем «адская» смесь PHP и HTML.

Основная задача php-класса - это вывод записей. Я использую его для формирования главной страницы сайта. Но, технически же нет никакой разницы где он используется.

Покажу на примере простого вывода записей.

В первую очередь необходимо подключить файл и инициализировать его. Файл находится в detault-шаблоне в каталоге stock/page-out. Нужно скопировать его в свой шаблон.

require_once(getinfo('template_dir') . 'stock/page-out/page-out.php');
$p = new Page_out; // сразу подготавливаем объект для вывода записей

Дальше все операции выполняются с $p. Рассмотрим следующий пример вывода трех последних записей:

if ($pages = mso_get_pages(array( 
			'limit' => 3, 
			'pagination' => false,
			), $temp))
{
	foreach ($pages as $page)
	{
		$p->load($page); // загружаем данные записи
 
		$p->line('[title]'); // заголовок
		$p->line('[date] [cat]', '<p class="info">', '< /p>');
		$p->content();  // текст
	}
}

Функция mso_get_pages() получает записи. Первый аргумент - массив параметров, согласно которым происходит выборка записей. Это стандартный код, не будем на нем останавливаться. Второй аргумент - $temp - нужен для пагинации. В этом примере она не используется.

Далее формируется стандартный foreach-цикл вывода записей, но уже основанный на Page_out.

Метод load() загружает текущую запись в объект $p. Метод line() выводит форматированную строчку. Первым параметром указывается строка подстановки, вторым - текст до, третим - после. Уникальность line() в том, что каждый элемент подстановки может обрамляться своим HTML-кодом (или произвольным текстом).

В нашем примере код [title] выводит заголовок записи. Код с «[date] [cat]» выводит дату записи и рубрики в p.info.

Метод content() выводит текст записи.

Пример достаточно простой, но отлично демонстрирует более простой код, чем «стандартный», которым мы обычно и пользуемся в шаблонах (в type-файлах). В качестве возможных подстановок в line() можно использовать:

• title - заголовок записи
• date - дата
• cat - рубрики
• tag - метки
• feed - rss-подписка на комментарии записи
• comments - ссылка на комментарии
• autor - автор
• edit - ссылка на редактирование записи
• read - аля «читать далее»

Каждый их этих кодов имеет свой формат вывода. Например title по-умолчанию выводится как H1. Если же нужно изменить на другое оформление, то просто задаём требуемый формат:

$p->format('title', '<h2>', '</h2>', true); // до, после, формировать ссылку

Задать формат лучше перед циклом foreach.

Каждый код содержит разное количество аргументов и свои дефолтные значения. Приведу format из дефолтных значений:

$p->format('title', '<h1>', '</h1>', true); // до, после, формировать ссылку
$p->format('date', 'Y-m-d H:i:s', '', ''); // формат даты, до, после
$p->format('cat', ', ', '', ''); // разделитель, до, после
$p->format('tag', ', ', '', ''); // разделитель, до, после
$p->format('feed', 'Подписаться', '', ''); // титул, до, после
$p->format('autor', '', ''); // до, после
$p->format('edit', 'Редактировать', '', ''); // титул, до, после
$p->format('read', 'Читать дальше', '', ''); // титул, до, после
$p->format('comments', 'Обсудить', 'Посмотреть комментарии', '', ''); 
// без комментариев, есть комментарии, до, после

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

$p->format('title', '<h4>', '</h4>');
$p->format('date', 'd/m/Y');
 
foreach ($pages as $page)
{ 
	$p->load($page);
	$p->line('[title]'); 
	$p->line('[date] | [autor] | [comments]', '< p>', '< /p>');
	... и т.д.

Эти примеры - основа вывода через Page_out. Вместе с тем, класс содержит методы, которых нет в «стандартных» функциях. Например вывод контента возможен с обрезкой по максимальному количеству слов:

$p->content_words(10);

Или по максимальному количеству символов:

$p->content_chars(100);

Можно вывести произвольное мета-поле, например:

$p->meta('title', 'Титул: ');

Если же нам нужно только получить значение мета-поля, то делаем так:

$meta_title = $p->meta_val('title');

Также доступны любые данные записи. Формально $page - это массив из полей, совпадающих с таблицей базы данных. Например, чтобы получить id записи:

$id = $p->val('page_id');

Точно также можно получить любое другое поле.

Для вывода заголовка можно использовать не только line(), но и специальный метод title(). Удобство в том, что он позволяет сформировать заголовок, без учета заданного в format. Используется, например для формирования UL-списка записей:

$p->title('<li>', '</li>');

Если необходимо получить адрес записи, то используется метод page_url():

$url = $p->page_url();

Для вывода произвольного HTML используется метод html().

$p->html('<hr>');

Более сложный метод block() позволяет организовать вывод данных только если есть какое-то содержимое. Например, если задано мета-поле, то выводим какой-то блок. Если нет, то ничего. Раньше нужно было бы вводить if-условие и проверять содержимое мета-поля. Теперь block() делает это сам. Вот пример с рубриками:

$bl = $p->line_r('[cat]', 'Рубрики: ');
$p->block('< p>', '< /p>', $bl);

Кстати метод line_r() полностью аналогичен line() с той разницей, что всегда возвращает данные через return, а не по echo. (Впрочем, это также настраивается.)

Метод div() призван выводить DIV с указанным текстом и css-классом.

$p->div('Текст', 'red');

Сформирует

<div class="red">Текст</div>

Впрочем div() позволяет формировать и произвольный HTML-тэг. Он указывается третьим параметром:

$p->div('Текст', 'red', 'span');

Получится

<span class="red">Текст</span>

В цикле вывода записей можно использовать счетчик. Он бывает полезен, когда требуется «отловить» какую-то конкретную запись, например первую или последнюю. Счетчик перед foreach-циклом следует сбросить, указав общее количество записей.

$p->reset_counter(count($pages)); // сброс счетчика/кол-во записей
 
foreach($pages as $page)
{
	$p->load($page);
	
	$num = $p->num; // номер текущей записи
	...
	
	if ($p->last) $p->html('<hr>'); // последняя запись
}

Ещё одной замечательной возможностью Page_out является формирование box - эдакий аналог таблиц, только основанных на DIV'ах. По сути это и есть таблица только с display:table. Скрипт сам формирует требуемые тэги и их css-классы.

Рассмотрим простой пример с однострочной таблицей.

$p->box_start(); // старт
	$p->cell('111'); // вывод ячейки
	$p->cell('222'); // вывод ячейки
	$p->cell('333'); // вывод ячейки
$p->box_end(); // конец

LESS/CSS стили будут такими:

div.box {
	display: table;
	width: 100%;
	
	div.row {
		display: table-row;
		
		div.cell {
			display: table-cell;
		}
	}
}

Если необходимо указать дополнительный css-класс, то он указывается первым параметром box_start(). Метод cell() выводит указанный в первом аргументе текст. Вторым аргументом можно указать произвольный css-класс.

Если требуется более сложное формирование строк, то можно их объявить явно.

$p->box_start('css-класс', false); // старт

	$p->row_start(); // старт строки
		$p->cell('111', 'css-класс'); // вывод ячейки
		$p->cell('222'); // вывод ячейки
		$p->cell('333'); // вывод ячейки
	$p->row_end(); // конец строки	
	
	$p->row_start(); // старт строки
		$p->cell('444', 'css-класс'); // вывод ячейки
		$p->cell('555'); // вывод ячейки
		$p->cell('666'); // вывод ячейки
	$p->row_end(); // конец строки			
		
$p->box_end(); // конец

Очень похоже на то как формируется TABLE. Если же в ячейке какой-то сложный вывод, то её можно вывести явно. Вместо cell() используем cell_start() и cell_end():

...
	$p->cell_start('css-класс'); 
			
		$p->line('[date]');
		$p->content_words(20, '...');
 
	$p->cell_end();
...

Как мы видим, Page_out значительно упрощает написание кода. Поскольку это новый подход, то он еще будет «оттачиваться» и улучшаться, но его уже можно использовать в своих шаблонах.