Разрботка расширений для CMS Joomla

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

Каждый класс представления описан в файле /components/com_<имя компонента>/views/<имя представления>/view.html.phpи является производным от JView. В этом классе может быть перегружен метод display(), чтобы вызвать метод класса модели для загрузки данных:

class MyComponentViewMyView extends JView { function display($tpl=null) { $model=&$this->getModel(); $list=$model->getList(); $this->assignRef('list', $list); parent::display($tpl); } }

Каждый класс модели описан в файле /components/com_<имя компонента>/models/<имя модели>.phpи является производным от JModel. В этом классе может находиться метод для загрузки данных из базы данных или другого источника:

class ModelMyComponentMyModel extends JModel { var $_somelist = null; function getList() { if (!$this->_somelist) { $query = "SELECT * FROM #__mycomponent"; $this->_somelist = $this->_getList($query, 0, 0); } return $this->_somelist; } }

Итак, метод класса представления display() вызывает метод класса модели для загрузки данных и сохраняет результат в какой-либо переменной, которая затем с помощью метода JView::assignRef() связывается с текущим представлением. Наконец, вызывается метод базового класса JView::display(), который загружает файл заданного шаблона при помощи перехвата выходного потока.

Шаблон находится в папке /components/com_<имя компонента>/views/<имя представления>/tmpl. В его коде осуществляется вывод на экран переменных текущего представления. Например:

<table width="100%"> <?php foreach($this->list as $l) echo '<tr><td>'.$l->data.'</td></tr>'; ?> </table>

Так выглядит простейший вариант взаимодействия моделей, представлений и контроллеров.

Классы Joomla для реализации MVC

JModel

Одно из полей класса JModel - объект-представитель базы данных $_db. Таким образом, для выполнения запросов к базе данных в методах производных от JModel классов нужно обращаться непосредственно к этому полю, не получая новой ссылки на глобальный объект JDatabase:

$this->_db->setQuery($query); $this->_db->query();

Получение списка каких-либо объектов и количества записей

array _getList(string $query, int $limitstart=0, int $limit=0) int _getListCount(string $query)

где

$query - запрос к базе данных; $limitstart - смещение; $limit - количество записей.

Например:

$query = "SELECT * FROM #__mycomponent"; $list = $this->_getList($query, 0, 0); $count = $this->_getListCount($query);

JView

Joomla поддерживает возможность добавления нескольких моделей к одному представлению. В таком случае ссылки на объекты-представители моделей будут храниться в поле _models объекта JView. Для добавления модели используется метод

JModel setModel(object &$model, bool $default = false)

где

$model - имя модели (т.е. имя соответствующего класса); $default - назначить ли ее моделью по умолчанию.

Метод возвращает добавленную модель.

Получение ссылки на объект-представитель одной из добавленных к представлению моделей

JModel getModel(string $name = null)

где $name - имя модели.

Например, добавим в коде контроллера к представлению SomeView модели Model1 и Model2:

$view = &$this->getView('SomeView', 'html'); $view->setModel($this->getModel('Model1'), true); $view->setModel($this->getModel('Model2'));

Получение данных из зарегистрированной модели или поля представления

mixed get(string $property, string $default = null)

где

$property - название метода модели, который требуется вызвать, или поля представления. В первом случае будет вызван метод get<Название метода>() - обратите внимание на заглавную букву; $default - если данные должны быть получены из модели, то $default - имя модели. Если требуется получить значение поля, то $default - значение, которое будет возвращено, если такое поле отсутствует.

Например, если в модели, заданной для текущего представления по умолчанию, есть метод getValue(), то получить в классе представления возвращаемое им значение можно так:

$temp = &$this->get('value');

Связывание переменной с представлением

bool assignRef(string $key, mixed &$val)

где

$key - имя поля объекта-представителя представления. Не может начинаться со знака подчеркивания; $val - значение поля.

Пример:

$view->assignRef('somevar', $someval);

Выполнение и отображение скрипта шаблона

void display(string $tpl = null) string loadTemplate(string $tpl = null)

где $tpl - имя файла шаблона. Конкретное имя файла зависит от значений имени и расширения макета, заданных в классе, по умолчанию это соответственно default и php. Если вы хотите изменить эти значения, используйте методы setLayout() и setLayoutExt(). Будет произведен поиск файла <имя макета>_<$tpl>.<расширение макета> или при $tpl=null <имя макета>.<расширение макета>.

display() выводит на экран результат работы скрипта шаблона, а loadTemplate() только возвращает этот результат. При ошибке display() возвращает объект Exception.

Например:

echo $view->loadTemplate('mytpl');

отобразит результат выполнения скрипта /components/com_<имя компонента>/views/<имя представления>/tmpl/default_mytpl.php.

JController

Выполнение задачи путем вызова одноименного метода производного класса

mixed execute(string $task)

где $task - имя задачи. Если такой задачи не найдется, будет выполнена задача "__default".

Метод возвращает значение, возвращаемое вызванным методом, или false в случае ошибки.

Например, код

$controller->execute('addItem');

приведет к вызову метода addItem() контроллера $controller.

Регистрация задачи

Регистрация задачи- это ее сопоставление какому-либо методу класса, производного от JController.

JController registerTask(string $task, string $method)

где

$task - задача; $method - имя метода.

Пример в коде контроллера:

$this->registerTask('save', 'saveItem');

Стандартная реализация метода display()

О методе display() говорилось выше.

JController display(bool $cachable = false, array $urlparams = false)

где

$cachable - задает, кэшировать ли вывод представления; $urlparams - массив пар "имя-значение" для URL, использующихся при кэшировании.

Получение ссылки на текущее представление

JView getView(string $name = '', string $type = '', string $prefix = '', array $config = array())

где

$name - имя представления. По умолчанию совпадает с именем контроллера; $type - тип представления, который можно определить как $document->getType(); $prefix - префикс класса представления. По умолчанию <имя контроллера>View; $config - массив параметров, которые будут переданы в конструктор представления, - имя представления, кодировка, путь к директории шаблонов и т.д.

Если класс <префикс><имя представления> не найдется в директориях, заданных по умолчанию, то будет произведен его поиск в файле <имя представления>/view.<тип представления>.php. Например, если в коде класса MyComponentController есть строка