Как разработать свой блок(блок-контроллер)?

Эта статья рассчитана на разработчиков, в ней я расскажу о создании простого блока в системе ReadyScript. Блок-контроллер(он же блок, он же компонент в некоторых системах), позволяет добавить блок с какой-либо информацией на сайт.

Легенда нашего тестового задания такова: имеется интернет-магазин, на главной странице которого необходимо поместить блок с недавними комментариями к товарам.

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

Создаваемый файл с классом можно расположить в папке с контроллерами модуля Комментарии, т.к. файлы, не существующие в стандартной поставке модуля, не заменяются при обновлении.

Итак, создадим файл с классом в папке /modules/comments/controller/block:
<?php namespace Comments\Controller\Block; //Задаем пространство имен, соответствующее пути к файлу, относительно папки /modules use \RS\Orm\Type; /** * Класс блочного контроллера "Недавние комментарии". * Будем наследовать от абстрактного класса блочных контроллеров, в котором реализовано все необходимое. */ class LastComments extends \RS\Controller\Block { protected static $controller_title = 'Недавние комментарии к товарам', //Краткое название контроллера $controller_description = 'Отображает список всех недавних комментариев к товарам'; //Описание контроллера protected //У блока будет одна настройка - количество отображаемых комментариев //Задаем значения настроек блока по-умолчанию $default_params = array( 'pageSize' => 10, ); /** * Возвращает объект формы, в котором сообщается какие настройки * могут быть заданы у этого блочного контроллера и в какой форме их отображать. * Если блок не имеет настроек, данный метод можно не реализовывать * * @return \RS\Orm\ControllerParamObject */ public function getParamObject() { return new \RS\Orm\ControllerParamObject( //Объект, описывающий настраиваемые параметры блока new \RS\Orm\PropertyIterator(array( //Объект - менеджер свойств 'pageSize' => new Type\Integer(array( 'description' => t('Количество отображаемых комментариев'), )) )) ); } /** * Action контроллера * * @return \RS\Controller\Result\Standart */ function actionIndex() { $api = new \Comments\Model\Api(); //Создаем экземпляр API комментариев $comments = $api->setCommentTypeFilter(new \Catalog\Model\CommentType\Product) //Устанавливаем фильтр по классу комментариев ->getList(1, $this->getParam('pageSize')); //Возвращаем страницу 1, на которой pageSize элементов $this->view->assign(array( 'comments' => $comments //array of \Comments\Model\Orm\Comment )); return $this->result->setTemplate('blocks/lastcomments/list.tpl'); } }

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

так и с помощью конструкции {moduleinsert name="\Comments\Controller\Block\LastComments" pageSize=15}в любом шаблоне Smarty.

Внутри action'а мы создаем экземпляр API для объектов Комментариев. Комментарии в ReadyScript универсальные, они могут быть привязаны как к товарам, так и к любым другим сущностям. Если быть точнее, то комментарии привязаны к объекту, описывающему их тип. В нашем случае нам нужно выбрать комментарии, которые имеют тип \Catalog\Model\CommentType\Product. В итоге в переменной $comments находится массив ORM объектов. Передаем его в шаблон blocks/lastcomments/list.tpl.

Теперь нам требуется создать шаблон, чтобы вывести полученные данные на страницу. Создадим шаблон list.tpl в папке /modules/comments/view/blocks/lastcomments/ <h2><span>Недавние комментарии</span></h2> <ul class="LastCommentBlock"> {foreach from=$comments item=comment} <li> <small>{$comment.dateof}</small><br> {$comment.message} <br><br> </li> {/foreach} </ul>

После вставки блока на сайт можно увидеть следующую информацию: