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

Национальный Открытый Университет "ИНТУИТ"

2012

Разрботка расширений для CMS Joomla/ Я.А. Седова - М.: Национальный Открытый Университет "ИНТУИТ", 2012

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

Рассматривается ряд классов фреймворка Joomla, в том числе классы для работы с базой данных, электронной почтой, датами, URI, навигационной цепочкой, для генерации кода элементов HTML-форм, SEF-ссылок. Одна из лекций посвящена реализации архитектуры MVC в компонентах под Joomla. Каждая лекция сопровождается практическим примером пошаговой разработки программного кода, представляющего собой тот или иной фрагмент компонента или модуля. Таким образом, к концу курса учащийся получает два работоспособных расширения для Joomla – компонент и модуль. Код сопровождается комментариями и скриншотами. В конце первой лекции приведены задания для самостоятельной работы по вариантам на весь курс. В качестве лабораторных работ учащийся может адаптировать для своего варианта приведенный в практической части лекций программный код.

(c) ООО "ИНТУИТ.РУ", 2012

(c) Я.А. Седова, 2012

Архитектура Joomla. Базовые сведения

Коротко описана архитектура Joomla. Рассмотрены предопределенные константы, языковые файлы, реализация паттерна "фабрика", работа с HTTP-запросом, объектом JApplication, создание панелей инструментов.

Цель лекции:Изучить базовые сведения об архитектуре Joomla. Получить представление о функционировании такого типа расширений как компоненты.

Введение

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

Иногда достаточно воспользоваться одним из конструкторов контента (CCK) для Joomla, позволяющих создавать свои шаблоны для материалов. Однако и CCK - не панацея, и возможно, что и он окажется бессилен. В таком случае возникает необходимость написать собственное расширение.

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

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

Архитектура Joomla

Фреймворк Joomla состоит из трех уровней (рис. 1.1):

уровень фреймворка;

уровень приложения;

уровень расширений.

Рис. 1.1.  Фреймворк Joomla

Уровень фреймворкаобеспечивает базовую функциональность Joomla с помощью набора библиотек и плагинов и собственно фреймворка Joomla:

фреймворк Joomla(или "ядро") - набор классов, обеспечивающих базовую функциональность Joomla. Названия этих классов начинаются с буквы "J" и говорят сами за себя: JDatabase, JUser, JForm, JEditor и т.д.;

библиотекитребуются для работы фреймворка или сторонних расширений;

плагинырасширяют функциональность фреймворка.

Уровень приложениясостоит из приложений, которые расширяют абстрактный класс JApplication. Приложение- глобальный объект, использующийся для обработки запросов.

В этот уровень входят следующие приложения:

JInstallation запускается при установке Joomla. После завершения установки необходимо удалить директорию installation, которая как раз и содержит данное приложение. В дальнейшем установка расширений выполняется с помощью приложения JAdministrator;

JAdministrator управляет всеми функциями для администрирования Joomla;

JSite отвечает за компоновку и отображение фронтенда;

XML-RPC позволяет администрировать сайт Joomla удаленно.

Уровень расширенийсостоит из расширений фреймворка Joomla и приложений:

компоненты- основной тип расширений Joomla. При каждом обращении к Joomla происходит вызов соответствующего компонента. Например, при отображении какой-либо страницы сайта происходит вызов компонента com_content;

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

плагиныпозволяют зарегистрировать функции и классы для обработки каких-либо событий, вызванных Joomla, например, поиск по сайту;

языковые файлыпозволяют представить контент Joomla на нескольких языках;

шаблоныотвечают за внешний вид сайта.

Фронтенд и бэкенд

Joomla делится на фронтенд- часть сайта, доступная пользователю, и бэкенд- систему администрирования сайта. Соответственно, в Joomla всего две точки входа - index.php для фронтенда и /administrator/index.php для бэкенда. Чтобы вызвать какой-либо установленный на сайте компонент, необходимо передать его имя (с префиксом "com_") скрипту index.php или /administrator/index.php в переменной option в строке URL. Например, переход по ссылке ссылка: http://localhost/joomla/index.php?option=com_bannersприведет к вызову компонента banners.

Большинство компонентов для Joomla делятся на фронтенд и бэкенд, и их код распределяется по двум папкам, каждая из которых называется по схеме com_<имя компонента>. В каждой из этих папок должен находиться файл, являющийся точкой входа, и называющийся так же, как компонент, т.е. <имя компонента>.php. Схематически это можно изобразить так:

administrator |- components ..|- com_mycomponent ....|- mycomponent.php components ..|- com_mycomponent ....|- mycomponent.php

Предопределенные константы

В Joomla определен ряд констант, хранящих значения путей: JPATH_BASE - путь к корневой директории текущего приложения; JPATH_ROOT - путь к корневой директории сайта, JPATH_COMPONENT - путь к директории компонента, JPATH_COMPONENT_SITE - путь к фронтенду компонента, JPATH_COMPONENT_ADMINISTRATOR - путь к бэкенду компонента и т.д. Полный их список можно найти в документации. Все эти константы возвращают значения абсолютных путей в файловой системе. Если вам необходимо получить путь для использования в URL, следует воспользоваться методом JURI::base().

В файле index.php, расположенном в корневой директории Joomla, определена константа _JEXEC. Большинство PHP-файлов, написанных под Joomla, начинаются с выражения

defined('_JEXEC') or die('Restricted access');

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

Еще одна популярная константа Joomla - DS, разделитель директорий, принятый в конкретной операционной системе (например, прямой или обратный слеш).

Языковые файлы

Joomla позволяет создать мультиязыковый сайт, задавая для каждого пользователя язык сайта и панели управления. Данная возможность реализована следующим образом: в кодах расширений при необходимости вывести на экран какой-либо заранее известный текст (например, сообщение об успешном выполнении запроса пользователя) вместо этого текста записывается его эквивалент ( ключ). Для каждого языка, поддерживающегося данным расширением, создаются языковые файлы, которые хранят переводыдля всех ключей, встретившихся в кодах расширения. Например, для ключа "COM_MYCOMPONENT_HELLO_WORLD" перевод на английский язык может задаваться как "Hello, world!", на русский - "Здравствуй, мир!", на французский - "Bonjour le monde!" и т.д.