Читаем Разрботка расширений для CMS Joomla полностью

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

$k = 0; for ($i = 0, $n = count($rows); $i < $n; $i ++) { $row = &$rows[$i]; ?> "> id)?> name?>

Пример результата приведен на рис. 3.3.

(есть увеличенное изображение)

Рис. 3.3. Чекбокс и пиктограмма "опубликовано/не опубликовано"

Обратите внимание, что методы класса JHTMLGrid лишь отображают какой-либо элемент, но не добавляют код для его обработки. В приведенном выше примере кнопки "опубликовано"/"не опубликовано"отображаются, но не работают. Чтобы это исправить, необходимо зарегистрировать задачи publish и unpublish (если вы не изменили их названия, задав какой-либо префикс) и написать функцию для их обработки, которая будет вызывать метод JTable::publish.

JHTMLImage

Содержит два метода для поиска изображения в фронтенде и бэкенде соответственно. Каждый из них ищет либо изображение из директории images текущего шаблона сайта/панели управления, либо, если файла с заданным именем там нет, изображение из заданной директории.

string site(string $file, string $folder = '/images/system/', int $altFile = null, string $altFolder = '/images/system/', string $alt = null, array $attribs = null, bool $asTag = true) string administrator(string $file, string $folder = '/images/', int $altFile = null, string $altFolder = '/images/', string $alt = null, array $attribs = null, bool $asTag = true)

где

$file - имя файла; $folder - путь к файлу. Будет использован, если в директории images текущего шаблона не нашлось файла с заданным именем; $altFile - если не задано, то используются значения $file и $folder, при $altFile = -1 метод возвращает пустую строку, при других значениях используются $altFile и $altFolder; $altFolder - другой путь к файлу; $alt - будущее значение атрибута alt; $attribs - ассоциативный массив атрибутов; $asTag - вернуть весь тег с его содержимым или только путь.

Пример:

echo JHTML::_('image.site', 'notice-info.png', '/media/system/images/');

JHTMLList

Методы класса JHTMLList используются для создания списков некоторых значений.

Список для выбора одного из существующих в Joomla уровней доступа

string accesslevel(object &$row)

где $row - объект, имеющий поле access.

Пример:

$query = 'SELECT id,access FROM #__content WHERE id = 1'; $db =& JFactory::getDBO; $db->setQuery($query); $article = $db->loadObject; echo JHTML::_('list.accesslevel', $article);

Результат показан на рис. 3.4.

Рис. 3.4. Список для выбора уровня доступа

Список для выбора изображения

array images(string $name, string $active = NULL, string $javascript = NULL, string $directory = NULL, string $extensions = "bmp|gif|jpg|png")

где

$name - имя поля; $active - выбранный по умолчанию элемент; $javascript - дополнительный код Javascript, который будет выведен внутри тега

Например, вывод на экран JHTML::_('list.images','imglist') приведет к отображению такого списка (рис. 3.5).

Рис. 3.5. Список для выбора изображения

Список незаблокированных пользователей

string users(string $name, string $active, int $nouser = 0, string $javascript = NULL, string $order = 'name', string $reg = 1)

где

$name - название элемента ; $order - имя поля для сортировки списка; $reg - исключить пользователей из группы " Зарегистрированные".

Например, вывод на экран JHTML::_('list.users','usrlist','42', 1, NULL, 'id', $reg = 1) приведет к отображению такого списка (рис. 3.6).

Рис. 3.6. Список для выбора пользователя

Список категорий

string category(string $name, string $extension, string $selected = NULL, string $javascript = NULL, string $order = null, int $size = 1, bool $sel_cat = 1)

где

$name - название элемента ; $size - высота списка (значение атрибута size тега

Пример:

echo JHTML::_('list.category', 'catlist', 'com_content', 2, 'onclick="someFunc"', 'id', 1, 1);

Данный код выведет на экран список, представленный на рис. 3.7.

Рис. 3.7. Список для выбора категории

JHTMLMenu

Класс используется для отображения элементов меню и не представляет интереса для использования в расширениях.

JHTMLSelect

Класс JHTMLSelect используется для генерации кода списков.

Выпадающий список

string genericlist(array $data, string $name, mixed $attribs = null, string $optKey = 'value', string $optText = 'text', mixed $selected = null, mixed $idtag = false, bool $translate = false)

где

$data - массив данных для отображения. Каждый элемент может быть сгенерирован с помощью метода JHTMLSelect.option или другим образом; $name - имя элемента HTML; $attribs - дополнительные атрибуты тега ; $translate - пропускать ли текст через функцию JText::_.

Пример:

$query = 'SELECT id,title FROM #__content'; $db =& JFactory::getDBO; $db->setQuery($query); $content = $db->loadObjectList; echo JHTML::_('select.genericlist', $content, 'genlist', 'size='.count($content), 'id', 'title', 2);

Так как мы передали в функцию genericlist $selected=2, то в сгенерированном списке по умолчанию выделен элемент с id, равным 2 (рис. 3.8).

Рис. 3.8. Список для выбора материала

Объект, представляющий элемент

object option(string $value, string $text = '', mixed $optKey = 'value', string $optText = 'text', bool $disable = false)

где

$value - значение элемента

Рассмотрим пример:

$query = 'SELECT id,title FROM #__content'; $db =& JFactory::getDBO; $db->setQuery($query); $content = $db->loadObjectList; foreach ($content as $c) $data[] = JHTML::_('select.option', $c->id, $c->title, 'my_value', 'my_text'); echo JHTML::_('select.genericlist', $data, 'genlist', 'size='.count($data), 'my_value', 'my_text', 2);

В данном примере для каждого материала сайта с помощью метода JHTMLSelect.option создается объект, представляющий элемент

JObject Object ([_errors:protected]=>Array [my_value]=>1 [my_text]=>Материал #1 [disable]=>)

Таким образом, значения $optKey и $optText, переданные в функцию option, стали названиями полей получившегося объекта, а значения $c->id и $c->title - значениями этих полей. Теперь в функцию JHTMLSelect.genericlist необходимо передать те же названия полей, что и в option. Если не передать их, то функция genericlist будет по умолчанию искать в объектах массива $data поля $value и $text, которых там нет.

Результат работы данного примера будет выглядеть так же, как и результат предыдущего.

Список целых чисел

string integerlist(int $start, int $end, int $inc, string $name, mixed $attribs = null, mixed $selected = null, string $format = '')

где

$start - первое число последовательности; $end - последнее число последовательности; $inc - шаг; $name - имя тега; $attribs - массив атрибутов тега; $selected - значение выбранного по умолчанию элемента; $format - формат вывода числа для функции printf.

Пример:

echo JHTML::_('select.integerlist', 1, 10, 1, 'intlist', 'size=10', 3, '%02d');

Этот код выведет список, представленный на рис. 3.9.

Рис. 3.9. Список для выбора числа

Группа переключателей

string radiolist(array $data, string $name, mixed $attribs = null, mixed $optKey = 'value', string $optText = 'text', string $selected = null, bool $idtag = false, bool $translate = false)

где

$data - массив объектов; $name - имя, общее для всех переключателей; $attribs - дополнительные атрибуты тега (могут быть заданы сразу в виде строки); $optKey - из какого поля объекта, представляющего собой элемент массива $data, брать значения элементов ; $optText - из какого поля объекта, представляющего собой элемент массива $data, брать текст элементов ; $selected - значение выбранного по умолчанию элемента; $idtag - префикс id сгенерированных тегов. Для каждого тега id станет равным $idtag, где - значение поля под названием $optKey в соответствующем объекте из массива $data. Если $idtag не задан, то вместо него будет использовано значение $name. В Joomla 1.7 в этой функции имеется ошибка: если объекты массива $data содержат поле с названием id, то к каждому элементу добавляется второй id со значением, взятым из этого поля; $translate - пропускать ли текст через функцию JText::_.

Пример:

$query = 'SELECT id,title FROM #__content'; $db =& JFactory::getDBO; $db->setQuery($query); $content = $db->loadObjectList; echo JHTML::_('select.radiolist', $content, 'radlist', 'class="inputbox"', 'id', 'title', 2, 'radlist', false);

Результат показан на рис. 3.10.

Рис. 3.10. Группа переключателей

Практика

Обработка категорий

В единственном вопросе, который хранится в нашей базе, в поле id_cat стоит значение 1. Оно должно означать id категории. Добавим таблицу и код для работы с категориями.

Создание таблицы для категорий

Выполните следующий SQL-запрос, чтобы создать таблицу для хранения категорий:

CREATE TABLE `jos_myquestions_categories` ( `id` INT NOT NULL AUTO_INCREMENT PRIMARY KEY, `name` VARCHAR(255) NOT NULL, `desc` TEXT NOT NULL DEFAULT '' )

Добавьте записи в эту таблицу:

INSERT INTO `jos_myquestions_categories` VALUES (NULL,'Без категории',''), (NULL,'Риторические вопросы','Вопросы, не требующие ответа')

Зайдите в phpMyAdminи убедитесь, что таблица jos_myquestions_categoriesсодержит две записи (рис. 3.11).

Рис. 3.11. Таблица базы данных, хранящая данные о категориях

Таким образом, сейчас все вопросы, для которых в поле id_catстоит значение 1, относятся к категории " Без категории".

Создание класса таблицы

Создайте файл /administrator/components/com_myquestions/tables/category.php:

Вывод списка категорий

Добавьте в файл admin.myquestions.phpфункцию showCategories:

function showCategories($option) { $db =& JFactory::getDbo; $query = "SELECT * FROM #__myquestions_categories"; $db->setQuery($query); $rows = $db->loadObjectList; if ($db->getErrorNum) { echo $db->stderr; return false; } HTML_questions::showCategories($option, $rows); }

Эта функция аналогична функции showQuestions, рассмотренной ранее.

В файл admin.myquestions.html.phpв класс HTML_questions добавьте еще одну функцию:

function showCategories($option, &$rows) { ?>


	'.$row->name.''?>	desc?>

Данная функция также аналогична одноименной функции для отображения списка вопросов.

Добавьте в переключатель switch в файле admin.myquestions.phpобработку новой задачи:

case 'showcat': showCategories($option); break;

Добавьте в файл /administrator/language/ru-RU/ru-RU.com_myquestions.iniкод:

COM_MYQUESTIONS_CATEGORY_NAME="Название категории" COM_MYQUESTIONS_CATEGORY_DESC="Описание категории"

Перейдя по ссылке ссылка: http://localhost/joomla/administrator/index.php?option=com_myquestions&task=showcat, вы уже можете увидеть список категорий.

Однако пока над списком будет отображаться старая панель инструментов, которую мы создали для списка вопросов. Поэтому необходимо также создать новые панели инструментов для работы с категориями. Откройте файл toolbar.myquestions.phpи добавьте в переключатель switch следующий код:

case 'showcat': TOOLBAR_myquestions_categories::_DEFAULT; break;

Как видите, мы добавили обработку задачи showcat - отображение списка категорий. Соответственно, вызывается функция _DEFAULT класса TOOLBAR_myquestions_categories. Напишем код этого класса. Добавьте в файл toolbar.myquestions.html.phpкод:

class TOOLBAR_myquestions_categories { function _DEFAULT { JToolBarHelper::title(JText::_('COM_MYQUESTIONS_TOOLBAR_TITLE_CATEGORIES'), 'generic.png'); JToolBarHelper::addNew('addcat'); JToolBarHelper::editList('editcat'); JToolBarHelper::deleteList (JText::_('COM_MYQUESTIONS_TOOLBAR_REMOVE_CATEGORIES_CONFIRMATION'), 'removecat'); } }

Таким образом, панель инструментов для списка категорий будет содержать три кнопки: " Создать", " Изменить" и " Удалить".

Добавьте в файл /administrator/language/ru-RU/ru-RU.com_myquestions.iniкод:

COM_MYQUESTIONS_TOOLBAR_TITLE_CATEGORIES="Управление категориями вопросов" COM_MYQUESTIONS_TOOLBAR_REMOVE_CATEGORIES_CONFIRMATION="Вы действительно хотите удалить эти категории?"

Теперь по ссылке ссылка: http://localhost/joomla/administrator/index.php?option=com_myquestions&task=showcatвидим список категорий (рис. 3.12).

(есть увеличенное изображение)

Рис. 3.12. Список категорий в бэкенде

Создание, редактирование и удаление категорий

При нажатии на кнопки " Создать" или " Изменить", расположенные над списком категорий, должна отображаться другая панель инструментов. Для этого добавьте в класс TOOLBAR_myquestions_categories функцию _NEW:

class TOOLBAR_myquestions_categories { function _NEW { JToolBarHelper::title(JText::_('COM_MYQUESTIONS_TOOLBAR_TITLE_CATEGORIES'), 'generic.png'); JToolBarHelper::save('savecat'); JToolBarHelper::apply('applycat'); JToolBarHelper::cancel('showcat'); } function _DEFAULT { JToolBarHelper::title(JText::_('COM_MYQUESTIONS_TOOLBAR_TITLE_CATEGORIES'), 'generic.png'); JToolBarHelper::addNew('addcat'); JToolBarHelper::editList('editcat'); JToolBarHelper::deleteList(JText::_('COM_MYQUESTIONS_TOOLBAR_REMOVE_CONFIRMATION'), 'removecat'); } }

Запишем в файле toolbar.myquestions.php, что при обработке задач addcat и editcat должна отображаться панель инструментов _NEW. Измените код этого файла так:

Теперь добавим обработку всех перечисленных в файле toolbar.myquestions.html.phpзадач. Откройте файл admin.myquestions.phpи добавьте в переключатель switch код:

case 'addcat': case 'editcat': editCategory($option); break; case 'savecat': case 'applycat': saveCategory($option, $task); break; case 'removecat': removeCategories($option); break;

Добавьте перечисленные функции в файл admin.myquestions.php:

Добавьте в файл admin.myquestions.html.phpв класс HTML_questions метод editCategory для отображения формы редактирования категории:

function editCategory ($row, $option) { $editor =& JFactory::getEditor; ?>

Наконец, добавьте в файл /administrator/language/ru-RU/ru-RU.com_myquestions.iniкод:

COM_MYQUESTIONS_CATEGORY_SAVED="Категория сохранена" COM_MYQUESTIONS_CATEGORY_DELETED="Категории успешно удалены"

Убедитесь, что все кнопки обеих панелей инструментов работают корректно.

Присвоение вопросу какой-либо категории

Добавим в форму ответа на вопрос выпадающий список для выбора категории.

Откройте файл admin.myquestions.phpи измените код функции replyToQuestion следующим образом:

function replyToQuestion($option) { $row =& JTable::getInstance('Question','Table'); $cid = JRequest::getVar('cid', array(0), '', 'array'); $id = $cid[0]; $row->load($id); $db = &JFactory::getDBO; $query = 'SELECT name AS text, id AS value FROM #__myquestions_categories'; $db->setQuery($query); $categories = $db->loadObjectList; $list_cat = JHTML::_('select.genericlist', $categories, 'id_cat', ' class="inputbox" ', 'value', 'text', $row->id_cat); HTML_questions::replyToQuestion($row, $option, $list_cat); }

В файле admin.myquestions.html.phpизмените прототип функции HTML_questions::replyToQuestion так:

function replyToQuestion ($row, $option, $list_cat)

Наконец, в коде этой функции измените фрагмент, в котором раньше выводилось текстовое поле с id категории, так:

Перейдите к странице ответа на вопрос и убедитесь, что отображается выпадающий список для выбора категории (рис. 3.13).

Рис. 3.13. Выбор категории вопроса в бэкенде

Ключевые термины

JHTML - класс для вывода элементов XHTML. JHTMLBehavior - поддерживающий класс, который позволяет вывести календарь, дерево элементов, файловый загрузчик и некоторые другие элементы управления. JHTMLEmail - поддерживающий класс, содержащий метод для скрытия адреса электронной почты в целях его защиты от спам-ботов. JHTMLForm - поддерживающий класс, содержащий метод, который возвращает код скрытого поля формы для уменьшения риска CSRF-атак. JHTMLGrid - поддерживающий класс, позволяющий вывести в таблице в панели управления такие элементы, как чекбокс, пиктограмма для переключения состояния "опубликовано"/"не опубликовано", отобразить заголовок столбца как ссылки для сортировки по этому столбцу и др. JHTMLImage - поддерживающий класс, содержащий методы для поиска изображения в фронтенде и бэкенде. JHTMLList - поддерживающий класс для создания списков некоторых конкретных значений. JHTMLSelect - поддерживающий класс для генерации кода списков. Основной метод класса JHTML - метод JHTML::_, который вызывает метод, определяющийся его первым параметром, и передает ему свои остальные параметры. Поддерживающие классы - классы для вывода элементов XHTML и поведений Javascript.

Краткие итоги

Joomla содержит методы для генерации и отображения элементов XHTML и поведений JavaScript. Эти методы вызываются с помощью метода JHTML::_. По первому параметру данный метод определяет, какой метод необходимо вызвать, а остальные параметры передаются в этот метод. Таким образом могут быть вызваны как методы самого класса JHTML, так и методы поддерживающих классов.

Методы класса JHTML позволяют вывести следующие элементы: календарь, форматированную дату, элементы , <img/>, <a>, <script>, <link> и всплывающую подсказку.Поддерживающие классы используются следующим образом:JHTMLBehavior позволяет вывести календарь, дерево элементов, файловый загрузчик и некоторые другие элементы управления.JHTMLEmail содержит метод для скрытия адреса электронной почты в целях его защиты от спам-ботов.JHTMLForm содержит метод, который возвращает код скрытого поля формы для уменьшения риска CSRF-атак.JHTMLGrid позволяет вывести в таблице в панели управления такие элементы, как чекбокс, пиктограмма для переключения состояния "опубликовано"/"не опубликовано", отобразить заголовок столбца как ссылки для сортировки по этому столбцу и др.JHTMLImage содержит два метода для поиска изображения в фронтенде и бэкенде соответственно.JHTMLList используется для создания списков некоторых конкретных значений.JHTMLSelect используется для генерации кода списков.Вопросы<empty-line/>Каким образом работает метод JHTML::_?Какие элементы могут быть отображены с помощью класса JHTML?Для чего используется класс JHTMLBehavior?Для чего используется класс JHTMLEmail?Для чего используется класс JHTMLForm?Код каких элементов генерируют методы класса JHTMLGrid?В чем преимущество использования класса JHTMLImage?Для чего используются классы JHTMLList и JHTMLSelect?УпражненияАдаптируйте код из раздела " Практика" для своего варианта (см. список вариантов в дополнительных материалах).</section><section>Иерархия пунктов меню. Отправка писем. Классы ядра JEditor, JURI, JError, JDateРассмотрен принцип хранения иерархии пунктов меню, использующийся в Joomla. Рассмотрены классы для отправки электронной почты, отображения кода визуального редактора, работы с URI, ошибками и датами.Цель лекции:Ознакомиться со способом программного добавления пунктов меню в Joomla, а также с некоторыми методами классов JMail, JEditor, JURI, JError, JDate.Организация иерархии пунктов меню в JoomlaДля хранения иерархии пунктов меню в Joomla используются вложенные множества (ссылка: http://en.wikipedia.org/wiki/Nested_set_model). Например, на рис. 4.1 представлена эта иерархия для случая, если бы в ней было всего восемь пунктов: корневой пункт меню Menu_Item_Root, com_bannersс подпунктами com_banners, com_banners_categories, com_banners_clientsи com_messagesс подпунктами com_messages_add, com_messages_read:<image xlink:href="#_29.jpg"/>(есть увеличенное изображение)<empty-line/>Рис. 4.1. Пример использования вложенных множеств для организации иерархии пунктов менюКаждому элементу иерархии соответствуют два числа - левый и правый ключи.Для каждого пункта в таблице #__menuхранится idродителя parent_id, уровень levelи левый и правый ключи lftи rgt. На рис. 4.2 оранжевым цветом показаны id, синим - уровни, красным - левые и правые ключи.<image xlink:href="#_30.jpg"/>(есть увеличенное изображение)<empty-line/>Рис. 4.2. Данные, хранящиеся для каждого пункта меню как элемента иерархииОтправка писем (класс JMail)Класс JMail предназначен для создания и отправки электронных писем. JMail поддерживает три механизма отправки почты: функцию PHP mail, Sendmail и SMTP.Доступ к глобальному объекту JMail можно получить через метод getMailer класса JFactory:$mailer =& JFactory::getMailer;Отправитель письмаДля задания отправителя письма используется методJMail setSender(mixed $from)где $from - либо строка, содержащая e-mail отправителя, либо массив, который содержит e-mail и имя отправителя.Примеры:// Первый вариант $mailer =& JFactory::getMailer; $mailer->setSender('vasya@mysite.ru'); // Второй вариант $sender = array('vasya@mysite.ru', 'Вася') $mailer->setSender($sender);Правильнее будет не задавать эти значения вручную, а получать их из настроек отправки почты, заданных в панели управления ( "Сайт" - "Общие настройки" - "Сервер"):$config =& JFactory::getConfig; $sender = array( $config->getValue('config.mailfrom'), $config->getValue('config.fromname')); $mailer->setSender($sender);Адреса для ответаАдреса для ответа задаются методомJMail addReplyTo(array $replyto)где $replyto - пара e-mail-имя или массив таких пар.Например:// Первый вариант $reply = array('vasya@mysite.ru', 'Вася'); $mailer->addReplyTo($reply); // Второй вариант $reply0 = array('vasya@mysite.ru', 'Вася'); $reply1 = array('vanya@mysite.ru', 'Ваня'); $replies = array($reply0, $reply1); $mailer->addReplyTo($replies);ПолучательДля задания получателя, получателя копии (Carbon Copy) и получателя скрытой копии (Blind Carbon Copy), используются методыJMail addRecipient(mixed $recipient, mixed name = '') JMail addCC(mixed $cc, mixed name = '') JMail addBCC(mixed $bcc, mixed name = '')где$recipient, $cc, $bcc - e-mail или массив, состоящий из e-mail; $name - имя получателя или массив, состоящий из имен.<empty-line/>Для примера зададим в качестве адреса получателя адрес текущего пользователя:$user =& JFactory::getUser; $mailer->addRecipient($user->email);Задание нескольких получателей:$recipient = array('vasya@mysite.ru', 'vanya@mysite.ru'); $mailer->addRecipient($recipient);Тема, текст, вложенияТема, текст и вложения письма задаются методамиJMail setSubject(string $subject) JMail setBody(string $content) JMail addAttachment(mixed $attachment, mixed $name = '', mixed $encoding = 'base64', mixed $type = 'application/octet-stream')где$subject - строка, содержащая тему письма; $content - строка, содержащая текст письма; $attachment - строка, содержащая путь к файлу, или массив таких строк; $name - строка, содержащая имя файла, или массив таких строк; $encoding - кодировка сообщения: 8bit, 7bit, binary, base64, quoted-printable; $type - MIME-тип файла.<empty-line/>Например:$mailer->setSubject('Тема письма'); $mailer->setBody("Текст письма"); $mailer->addAttachment(JPATH_COMPONENT.DS.'files'.DS.'document.pdf');По умолчанию содержимое письма имеет формат plain text. Если вам нужно отправить письмо в формате HTML, используйте метод IsHTML, задающий MIME-тип содержимого письма как text/html:$mailer->IsHTML(true); $mailer->setBody("Текст письма, содержащий HTML-теги");В этом случае желательно указать кодировку письма - base64, чтобы в нем не появились нежелательные символы:$mailer->Encoding = 'base64';ОтправкаНаконец, для отправки письма используется метод Send, возвращающий true при успешной отправке или объект JError в случае ошибки:if ($mailer->Send !== true) die('Ошибка отправки письма');Проверка корректности e-mailПомимо класса JMail, существует статический класс JMailHelper. Большинство его методов предназначены для очистки данных перед добавлением к электронному письму и используются классом JMail. Интерес для разработчика представляет метод isEmailAddress, который проверяет, является ли заданная строка корректным адресом электронной почты:if (!JMailHelper::isEmailAddress($str)) die('Недопустимый формат e-mail');Перед использованием класса JMailHelper необходимо подключить библиотеку JMail:jimport('joomla.utilities.mail');WYSIWYG-редактор (класс JEditor)Класс JEditor используется для работы с WYSIWYG-редактором.Получить ссылку на глобальный объект JEditor можно так:$editor =& JFactory::getEditor;Отображение редактораДля отображения выбранного администратором сайта редактора используется метод display. Если не выбран ни один редактор, то будет отображено поле <textarea>.string display(string $name, string $html, string $width, string $height, int $col, int $row, bool $buttons = true, string $id = null, string $asset = null, object $author = null, array $params = array)где$name - имя элемента управления формы; $html - содержимое поля; $width - ширина текстового поля в процентах или пикселях; $height - высота текстового поля; $col - количество столбцов в поле <textarea> (применяется, если администратор выбрал не использовать HTML-редактор); $row - количество строк в <textarea>; $buttons - отображать ли кнопки редактора (" Материал", " Изображение", " Разрыв страницы", " Подробнее…"); $id - idэлемента управления формы; $asset и $author - используются для подтверждения прав доступа пользователя к некоторым функциям плагина редактора. Более подробная информация об этих параметрах в справочной документации отсутствует; $params - ассоциативный массив параметров редактора.<empty-line/>Пример:echo $editor->display('question', $row->question,'100%', '250', '40', '10');Если по умолчанию задан редактор TinyMCE, то этот код выведет на экран следующее (рис. 4.3).<image xlink:href="#_31.jpg"/>(есть увеличенное изображение)<empty-line/>Рис. 4.3. Отображение WYSIWYG-редактораURI (класс JURI)Чтобы создать новый объект класса JURI или получить ссылку на глобальный объект, используется методJURI &getInstance(string $uri='SERVER')где $uri - URI страницы. При $uri='SERVER' метод вернет ссылку на глобальный объект, который представляет URI текущей страницы. В противном случае будет создан новый объект.Например, так можно получить URI текущей страницы:$u =& JURI::getInstance; echo $u->toString;Методы класса JURIМетоды класса JURI хорошо документированы (ссылка: http://docs.joomla.org/JURI), поэтому здесь мы только перечислим некоторые из них.Получение базового URI сайта:string base(bool $pathonly)где $pathonly - возвращать только путь или также вернуть хост и порт.Построение запроса (т.е. компонента URI):string buildQuery(array $params)где $params - ассоциативный массив пар " имя-значение".Получение текущего URI без запроса и фрагмента:string currentПолучение отдельных компонентов URI:фрагмента - string getFragment; хоста - string getHost; пароля - string getPass; пути - string getPath; порта - string getPort; запроса - string getQuery(bool $toArray), где $toArray задает, возвращать ли элементы запроса в виде ассоциативного массива или в виде строки; схемы - string getScheme; имени пользователя - string getUser.<empty-line/>Получение заданной переменной из запроса:string getVar(string $name, string $default)где$name - имя переменной; $default - значение по умолчанию.<empty-line/>Заполнение полей класса значениями, полученными из заданного URI ($uri):boolean parse(string $uri)Получение корневого URI сайта:string root(bool $pathonly, string $path)где $path - задает новый путь.Ошибки (класс JError)Методы raiseError, raiseNotice и raiseWarning класса JError вызываются при возникновении каких-либо ошибок. Все они возвращают объект JException, содержащий сведения об ошибке, например, в каких файлах она возникла. raiseError добавляет заданное сообщение в очередь сообщений и останавливает выполнение расширения, а остальные два метода только добавляют сообщение в очередь, но работа расширения продолжается.JException raiseError(string $code, string $msg, mixed $info = null) JException raiseWarning(string $code, string $msg, mixed $info = null) JException raiseNotice(string $code, string $msg, mixed $info = null)где$code - внутренний код ошибки, задается по усмотрению программиста; $msg - сообщение об ошибке для пользователя; $info - дополнительная информация об ошибке для программиста.<empty-line/>Пример:if ($this->published == 0) JError::raiseError (404, "Нет такой страницы");Перечисленные методы создавались в то время, когда Joomla работала с PHP4, где отсутствовал механизм обработки исключений. Если на хостинге стоит PHP5, предпочтительнее использовать класс Exception.Даты (класс JDate)JDate - класс для работы с датами. Для создания объекта JDate используется метод getDate класса JFactory:JDate JFactory::getDate(mixed $time = 'now', mixed $tzOffset = null)где$time - дата и время в формате, годном для функции PHP strtotime; $tzOffset - временная зона. Может задаваться числом от -12 до 14 (смещение относительно всемирного координированного времени - UTC) или строкой из числа временных зон, поддерживаемых PHP (их список можно найти на странице ссылка: http://www.php.net/manual/ru/timezones.php).<empty-line/>В отличие от многих других методов JFactory, getDate не возвращает глобальный объект, а создает новый. Поэтому перед вызовом этого метода не нужно ставить амперсанд:$now = JFactory::getDate; // текущие дата и время $some_date = JFactory::getDate('2012-01-01 00:00:00','Europe/Moscow');Получение даты в каком-либо форматеstring format(string $format, bool $local = false, bool $translate = true)где$format - формат; $local - возвращать дату в локальной временной зоне или в GMT; $translate - переводить ли текст.<empty-line/>Чтобы не задавать формат даты вручную, можно использовать один из определенных в Joomla форматов: DATE_FORMAT_LC, DATE_FORMAT_LC1 и т.д. Их список находится в языковом файле language/<ln-LN>/<ln-LN>.ini, где <ln-LN>- код языка. Как и для всякого языкового ключа, значение такого формата можно получить с помощью функции JText::_. Например, выведем дату в формате DATE_FORMAT_LC3:echo $some_date->format(JText::_('DATE_FORMAT_LC3'));Получение даты в формате, пригодном для вставки в запрос SQLstring toMySQL(bool $local=false)Например, для получения материалов, созданных ранее даты $some_date, можно выполнить запрос:$query = "SELECT * FROM #__content WHERE created < '{$some_date->toMySQL}'";ПрактикаОтправка уведомлений по электронной почтеСейчас в форме для ответа на вопрос две кнопки на панели инструментов (рис. 4.4) - нерабочие.<image xlink:href="#_32.jpg"/>Рис. 4.4. Кнопки для отправки уведомлений по электронной почтеНапишем код для их обработки.Откройте файл admin.myquestions.phpи добавьте в переключатель switch обработку двух задач:case 'sendToExpert': case 'sendAnswer': send($option,$task); break;Добавьте также в этот же файл функцию send:function send($option,$task) { $row_new = save; $q = $row_new->question; $a = $row_new->answer; $mailer =& JFactory::getMailer; $mailer->setSender('test@mysite.ru'); if ($task == 'sendToExpert') { $mailer->addRecipient('expert@mysite.ru'); $mailer->setSubject(JText::_('COM_MYQUESTIONS_NEW_QUESTION')); $mailer->setBody(JText::sprintf('COM_MYQUESTIONS_EMAIL_EXPERT_BODY',$q)); } else { $mailer->addRecipient($row_new->email); $mailer->setSubject(JText::_('COM_MYQUESTIONS_NEW_ANSWER')); $mailer->setBody(JText::sprintf('COM_MYQUESTIONS_EMAIL_USER_BODY',$q,$a)); } $mailer->IsHTML(true); if ($mailer->Send !== true) $message = 'COM_MYQUESTIONS_EMAIL_ERROR'; else { $message = 'COM_MYQUESTIONS_EMAIL_SUCCESS'; $db =& JFactory::getDbo; if ($task == 'sendToExpert') $query = "UPDATE #__myquestions SET senttoexpert=1 WHERE id={$row_new->id}"; else $query = "UPDATE #__myquestions SET senttoauthor=1 WHERE id={$row_new->id}"; $db->setQuery($query); $db->query; if ($db->getErrorNum) { echo $db->stderr; return false; } } global $app; $app->redirect('index.php?option='.$option.'&task=reply&cid[]='.$row_new->id, JText::_($message)); } Листинг .<empty-line/>В данной функции прежде всего происходит сохранение текущей записи и обновленная запись сохраняется в переменной row_new. Затем в зависимости от того, отправляется это уведомление эксперту или автору вопроса, задаются отправитель, получатель, тема и текст письма. Если уведомление отправляется пользователю, задавшему вопрос, то адрес электронной почты получателя берется из записи row_new.При задании тела письма используется метод JText::sprintf, пропускающий заданную ему строку через PHP-функцию sprintf. В выражении JText::sprintf('COM_MYQUESTIONS_EMAIL_USER_BODY',$q,$a) 'COM_MYQUESTIONS_EMAIL_USER_BODY' - это строка формата, которую мы сейчас зададим в языковом файле, а $q и $a - это аргументы (соответственно текст вопроса и текст ответа).Тип содержимого письма задается как text/html, так как оно содержит html-теги.Если письмо успешно отправлено, то в соответствующей вопросу записи в базе данных значение senttoexpert или senttoauthor устанавливается равным 1.В конце функции происходит перенаправление на текущую страницу с выводом сообщения либо об успешной отправке письма, либо об ошибке.Добавьте в файл /administrator/language/ru-RU/ru-RU.com_myquestions.iniследующий код:COM_MYQUESTIONS_EMAIL_SUCCESS="e-mail отправлен" COM_MYQUESTIONS_EMAIL_ERROR="Не удалось отправить e-mail" COM_MYQUESTIONS_NEW_QUESTION="Новый вопрос" COM_MYQUESTIONS_EMAIL_EXPERT_BODY="Добрый день!На сайте появился новый вопрос: %s" COM_MYQUESTIONS_NEW_ANSWER="Ответ на ваш вопрос" COM_MYQUESTIONS_EMAIL_USER_BODY="Добрый день!На сайте появился ответ на ваш вопрос: %sОтвет был таким:%s"Как видите, строки COM_MYQUESTIONS_EMAIL_EXPERT_BODY и COM_MYQUESTIONS_EMAIL_USER_BODY содержат параметры. Так как их тип - строковый (тексты вопроса, ответа), то используется описатель типа %s.Теперь перейдите в бэкенде на страницу ответа на вопрос и нажмите кнопку " Отправить эксперту". Вы должны увидеть сообщение о том, что письмо отправлено (рис. 4.5).<image xlink:href="#_33.jpg"/>(есть увеличенное изображение)<empty-line/>Рис. 4.5. Сообщение об отправке уведомления по электронной почтеЕсли вы используете локальный сервер, то ваше письмо, скорее всего, на самом деле не отправилось. В Денвере срабатывает почтовая заглушка sendmail: все письма просто помещаются в папку <путь к Денверу>/tmp/!sendmailв виде файлов с расширением .eml. Если в вашем случае так и есть, то откройте эту папку и найдите в ней только что "отправленное" письмо (можно ориентироваться по названию файла - это дата и время "отправки"). Откройте файл в почтовой программе и убедитесь, что его содержимое соответствует заданным нами значениям (рис. 4.6).<image xlink:href="#_34.jpg"/>Рис. 4.6. Результат отправки уведомления на локальном сервере - файл .eml, открытый в почтовой программеПерейдите к списку вопросов и убедитесь, что значение в столбце " Отправлен ли вопрос эксперту" поменялось с " Нет" на " Да" (рис. 4.7).<image xlink:href="#_35.jpg"/>(есть увеличенное изображение)<empty-line/>Рис. 4.7. Новое значение в столбце "Отправлен ли вопрос эксперту"Аналогично проверьте, как работает кнопка " Отправить ответ".Добавление пункта менюДобавим пункт меню для управления категориями.Создавая первый пункт меню для нашего компонента, мы не указали значения левого и правого ключей. Определим их сейчас. Уровень данного пункта равен 1 (его предком является корень дерева с уровнем 0, а потомки могут иметь уровень 2 и более). Родительский узел - это самая первая строка в таблице #__menu, посмотрите значение его правого ключа в поле rgt.Пусть $right_key - правый ключ родительского узла, $level - уровень родительского узла. Тогда для задания правильных значений левого и правого ключей выполним следующие запросы (не забудьте заменить $right_key и $level на значения из вашей таблицы):Обновление ключей узлов, стоящих за родительским узлом:UPDATE jos_menu SET lft=lft+2, rgt=rgt+2 WHERE lft>$right_keyОбновление родительской ветки:UPDATE jos_menu SET rgt=rgt+2 WHERE rgt>=$right_key AND lft<$right_keyОбновление нового узла:UPDATE jos_menu SET lft=$right_key, rgt=$right_key+1, level=$level+1 WHERE title='com_myquestions_menu'Пусть теперь $right_key и $level - соответственно правый ключ и уровень этого только что обновленного нами узла, а $parent_id - его id. Создадим два подпункта этого пункта меню (не забудьте заменить 10006 на id вашего компонента из таблицы #__extensions).Подпункт для управления списком вопросов:UPDATE jos_menu SET lft=lft+2, rgt=rgt+2 WHERE lft>$right_key; UPDATE jos_menu SET rgt=rgt+2 WHERE rgt>=$right_key AND lft<$right_key; INSERT INTO `jos_menu` (`menutype`, `title`, `alias`, `path`, `link`, `type`, `parent_id`, `level`, `component_id`, `access`, `img`, `params`, `lft`, `rgt`, `client_id`) VALUES ('menu', 'com_myquestions_menu_questions', 'Questions', 'My Questions/Questions', 'index.php?option=com_myquestions', 'component', $parent_id, $level+1, 10006, 1, 'class:component', '', $right_key, $right_key+1, 1);Обратите внимание, что значения alias и path соответствуют иерархии узлов.Посмотрите в таблице #__menu новое значение $right_key главного пункта меню для нашего компонента - оно должно было увеличиться на 2. Теперь создадим подпункт для управления списком категорий:UPDATE jos_menu SET lft=lft+2, rgt=rgt+2 WHERE lft>$right_key; UPDATE jos_menu SET rgt=rgt+2 WHERE rgt>=$right_key AND lft<$right_key; INSERT INTO `jos_menu` (`menutype`, `title`, `alias`, `path`, `link`, `type`, `parent_id`, `level`, `component_id`, `access`, `img`, `params`, `lft`, `rgt`, `client_id`) VALUES ('menu', 'com_myquestions_menu_categories', 'Categories', 'My Questions/Categories', 'index.php?option=com_myquestions&task=showcat', 'component', $parent_id, $level+1, 10006, 1, 'class:component', '', $right_key, $right_key+1, 1);Наконец, добавьте в файл /administrator/language/ru-RU/ru-RU.com_myquestions.sys.iniкод:COM_MYQUESTIONS_MENU_QUESTIONS="Управление вопросами" COM_MYQUESTIONS_MENU_CATEGORIES="Управление категориями"Обновите любую страницу в бэкенде и убедитесь, что появились два новых подпункта меню " Моя система "вопрос - ответ"" (рис. 4.8).<image xlink:href="#_36.jpg"/>(есть увеличенное изображение)<empty-line/>Рис. 4.8. Подпункты меню в бэкендеРазработка фронтендаДля удобства дальнейшего тестирования добавим еще несколько вопросов в различные категории:INSERT INTO `jos_myquestions` (`id`, `name`, `date`, `question`, `city`, `email`, `IP`, `id_cat`) VALUES (NULL, 'Аноним', '2012-01-02 09:01:00', 'Быть или не быть?', 'Москва', 'somebody@mail.ru', '12.345.67.890', '1'); INSERT INTO `jos_myquestions` (`id`, `name`, `date`, `question`, `city`, `email`, `IP`, `id_cat`) VALUES (NULL, 'Аноним', '2012-01-01 09:02:00', 'А судьи кто?', 'Москва', 'somebody@mail.ru', '12.345.67.890', '2'); INSERT INTO `jos_myquestions` (`id`, `name`, `date`, `question`, `city`, `email`, `IP`, `id_cat`) VALUES (NULL, 'Аноним', '2012-01-01 09:03:00', ' А был ли мальчик?', 'Москва', 'somebody@mail.ru', '12.345.67.890', '2');Для наглядности выключите SEF в настройках сайта: в бэкенде зайдите в меню " Сайт" - " Общие настройки" и установите переключатель " Включить SEF (ЧПУ)" в значение " Нет".<empty-line/>Вывод списка категорийЗамените содержимое файла /components/com_myquestions/myquestions.php(обратите внимание, что мы больше не работаем с папкой /administrator) на следующий код:<?php defined('_JEXEC') or die('Restricted access'); jimport('joomla.application.helper'); require_once(JApplicationHelper::getPath('html')); JTable::addIncludePath(JPATH_ADMINISTRATOR.DS.'components'. DS.$option.DS.'tables'); switch($task) { default: showCategories($option); break; } function showCategories($option) { $db =& JFactory::getDbo; $query = "SELECT c.id, c.name, c.desc ". "FROM #__myquestions_categories c"; $db->setQuery($query); $rows = $db->loadObjectlist; if ($db->getErrorNum) { echo $db->stderr; return false; } HTML_questions::showCategories($rows, $option); } ?>Мы подключаем файл myquestions.html.phpс помощью require_once(JApplicationHelper::getPath('html')) и папку tableбэкенда с помощью JTable::addIncludePath. Обратите внимание, что мы обращаемся к классам таблиц бэкенда, хотя пишем фронтенд компонента.Переключатель switch обрабатывает пока только значение задачи по умолчанию, вызывая функцию для получения списка категорий.Теперь добавим класс HTML_questions для фронтенда. Создайте файл /components/com_myquestions/myquestions.html.php:<?php class HTML_questions { function showCategories($rows, $option) { ?> <a href='index.php?option=<?=$option?>&task=showlist'><?= JText::_('COM_MYQUESTIONS_ALL_QUESTIONS')?></a> <table> <?php foreach($rows as $row) { $link = 'index.php?option='.$option.'&id_cat='.$row->id.'&task=showlist'; echo '<tr><td><a href="' . $link . '">'.$row->name .'</a></td><td>'.$row->desc.'</td></tr>'; } ?> </table> <?php } } ?>Класс HTML_questions будет содержать все функции вывода во фронтенде. Функция showCategories принимает в качестве параметров массив записей таблицы базы данных и название текущего компонента. В цикле осуществляется обход этого массива и каждая запись выводится на экран.Создайте файл /language/ru-RU/ru-RU.com_myquestions.iniи скопируйте в него строку:COM_MYQUESTIONS_ALL_QUESTIONS="Все вопросы"Теперь на странице компонента myquestions во фронтенде по умолчанию отображается список категорий (рис. 4.9).<image xlink:href="#_37.jpg"/>(есть увеличенное изображение)<empty-line/>Рис. 4.9. Вывод списка категорий во фронтенде<empty-line/>Просмотр списка вопросовИзмените код конструкции switch в файле myquestions.php, добавив обработку задачи showlist:case 'showlist': showQuestions($option); break;Добавьте в этот же файл функцию showQuestions:function showQuestions($option) { $db =& JFactory::getDbo; $query = "SELECT q.id,q.name,q.date,q.question,q.city,q.email,q.answer,q.id_cat,c.name AS cname ". "FROM #__myquestions q, #__myquestions_categories c ". "WHERE q.id_cat=c.id AND q.answer <> '' AND (q.published = 1 OR (q.expiration_date <> '0000-00-00 00:00:00' AND q.expiration_date > NOW))"; $id_cat = JRequest::getVar('id_cat', '0'); if ($id_cat != 0) $query .= " AND q.id_cat = $id_cat"; $db->setQuery($query); $rows = $db->loadObjectlist; if ($db->getErrorNum) { echo $db->stderr; return false; } if ($id_cat != 0) { $query = "SELECT name FROM #__myquestions_categories WHERE id=$id_cat"; $db->setQuery($query); if ($db->getErrorNum) { echo $db->stderr; return false; } $name_cat = $db->loadResult; } else $name_cat = ''; HTML_questions::showQuestions($rows, $option, $name_cat); }Длинный SQL-запрос требует пояснения. Как вы помните, при описании функциональности нашего компонента упоминалось, что отображаться на сайте будут вопросы, удовлетворяющие следующим условиям:есть ответ;либо вопрос не помечен как скрытый, либо дата снятия вопроса с публикации указана и больше текущей даты.Данный запрос выбирает вопросы, которые соответствуют этим условиям.Проверяется значение переменной $id_cat (id категории), и если категория задана, то из базы выбираются только вопросы, отнесенные к этой категории. Затем извлекается название категории для отображения над списком вопросов. Если же категория не задана, то выбираются вопросы из всех категорий.Добавьте в класс HTML_questions в файле myquestions.html.phpследующую функцию:function showQuestions($rows, $option, $name_cat) { if ($name_cat !== '') echo "<h1>$name_cat</h1>"; foreach($rows as $row) { $link = 'index.php?option='.$option.'&id='.$row->id.'&task=showquestion'; $link_cat = 'index.php?option='.$option.'&id_cat='.$row->id_cat.'&task=showlist'; ?> <table width="100%"> <tr> <td><?=$row->name?></td> <td><?=$row->email?></td> <td><?=JHTML::_('date', $row->date, JText::_('DATE_FORMAT_LC3'))?></td> <td><?=$row->city?></td> </tr> <tr> <td colspan="4"><a href="<?=$link_cat?>"><?=$row->cname?></a></td> </tr> <tr> <td colspan="4"><?=$row->question?></td> </tr> <tr> <td colspan="4"><?=$row->answer?></td> </tr> <tr> <td colspan="4"><a style="text-decoration: none;" title="<?=JText::_('COM_MYQUESTIONS_READMORE')?>" alt="<?=JText::_ ('COM_MYQUESTIONS_READMORE')?>" href="<?=$link?>">---></a></td> </tr> </table> <? } }Данная функция выводит название категории, если оно задано, и затем проходит в цикле по всем записям, переданным ей. Для каждой записи выводится таблица с теми ее полями, которые были извлечены ранее.Добавьте в файл language/ru-RU/ru-RU.com_myquestions.iniстроку:COM_MYQUESTIONS_READMORE="Подробнее"Для проверки работоспособности нового кода нажмите на ссылку " Все вопросы" во фронтенде нашего компонента. Результат должен быть приблизительно таким, как на рис. 4.10.<image xlink:href="#_38.jpg"/>(есть увеличенное изображение)<empty-line/>Рис. 4.10. Список вопросов во фронтенде<empty-line/>Вывод одного вопросаИногда может понадобиться вывести какой-либо один вопрос. Например, если пользователь захочет поделиться ссылкой на свой вопрос с кем-то другим.Измените код конструкции switch в файле myquestions.php, добавив обработку задачи showquestion:case 'showquestion': showQuestion($option); break;Добавьте в этот же файл функцию showQuestion:function showQuestion($option) { $id = JRequest::getVar('id', 0) ; $row = &JTable::getInstance ('question', 'Table'); $row->load($id); if ($row->answer == '' || ($row->published == 0 && ($row->expiration_date == '0000-00-00 00:00:00' || strtotime($row->expiration_date) <= time))) JError::raiseError(404, JText::_(' COM_MYQUESTIONS_ERROR404')); $row_cat =& JTable::getInstance('Category','Table'); $row_cat->load($row->id_cat); HTML_questions::showQuestion($row, $option, $row_cat); }В данном коде мы получаем id из запроса к серверу с помощью функции getVar. Если значение id отсутствует или неприемлемо, будет использовано значение по умолчанию, переданное во втором параметре (ноль). Затем мы получаем экземпляр класса таблицы из бэкенда и загружаем запись таблицы базы данных, соответствующую идентификатору id.Далее происходит проверка того, можно ли отображать в открытом доступе данный вопрос. Исходя из условий отображения вопроса на сайте, нетрудно заметить, что не должны отображаться на сайте вопросы, удовлетворяющие хотя бы одному из условий:нет ответа;вопрос помечен как скрытый и дата снятия вопроса с публикации не указана или меньше или равна текущей дате.Если вопрос не должен отображаться, то используется функция raiseError класса JError для вывода сообщения " 404 - Вопрос не найден". Такое же сообщение появится при попытке обращения к несуществующей записи.Добавьте в файл language/ru-RU/ru-RU.com_myquestions.iniстроку:COM_MYQUESTIONS_ERROR404="Вопрос не найден"Проверьте, что при обращении к вопросу, который не должен отображаться, выводится сообщение (рис. 4.11).<image xlink:href="#_39.jpg"/>(есть увеличенное изображение)<empty-line/>Рис. 4.11. Ошибка 404 "Вопрос не найден"Теперь создадим функцию в классе вывода. Добавьте функцию showQuestion в класс HTML_questions в файле myquestions.html.php:function showQuestion($row, $option, $row_cat) { $link_cat = 'index.php?option='.$option.'&id_cat='.$row->id_cat.'&task=showlist'; ?> <a href='index.php?option=<?=$option?>&task=showlist'><?=JText::_ ('COM_MYQUESTIONS_ALL_QUESTIONS')?></a> <table width="100%"> <tr> <td><?=$row->name?></td> <td><?=$row->email?></td> <td><?=JHTML::_('date', $row->date,JText::_ ('DATE_FORMAT_LC3'))?></td> <td><?=$row->city?></td> </tr> <tr> <td colspan="4"><a href="<?= $link_cat?>"><?=$row_cat->name?></a></td> </tr> <tr> <td colspan="4"><?=$row->question?></td> </tr> <tr> <td colspan="4"><?=$row->answer?></td> </tr> </table> <? }Данная функция аналогична функции showQuestions за исключением того, что выводит не массив вопросов, а один вопрос.Теперь в списке вопросов стрелка под каждым из них ("--->") ведет на страницу с выводом этого вопроса (рис. 4.12).<image xlink:href="#_40.jpg"/>(есть увеличенное изображение)<empty-line/>Рис. 4.12. Просмотр вопросаКлючевые терминыJDate - класс для работы с датами. JEditor - класс для работы с WYSIWYG-редактором. JError - класс для работы с ошибками. JMail - класс для создания и отправки электронных писем. JMailHelper - класс для очистки данных перед добавлением к электронному письму и проверки, является ли заданная строка корректным адресом электронной почты. JURI - класс для работы с URI. Иерархия пунктов меню - дерево, состоящее из пунктов меню и организованное с помощью вложенных множеств.Краткие итогиДля хранения иерархии пунктов меню в Joomla используются вложенные множества. Для каждого пункта в базе данных хранится id родителя, уровень и левый и правый ключи.Создавать и отправлять электронные письма удобнее с помощью методов класса JMail.Для работы с WYSIWYG-редактором используется класс JEditor.Класс JURI позволяет работать с URI текущей или любой другой страницы.Для работы с ошибками и предупреждениями может быть использован класс JError.Для работы с датами в Joomla существует класс JDate.Вопросы<empty-line/>Каким образом в базе данных Joomla хранится иерархия пунктов меню?Какой класс позволяет создавать и отправлять электронные письма?Каким образом можно отобразить код выбранного администратором сайта WYSIWYG-редактора?Какой класс существует для работы с URI?Для чего может быть использован класс JError?Каким образом можно работать с датами в Joomla?УпражненияАдаптируйте код из раздела " Практика" для своего варианта (см. список вариантов в дополнительных материалах).</section><section>SEF-ссылки. Классы ядра JDocument, JUserРассмотрен процесс генерации и декодирования SEF-ссылок для какого-либо компонента. Рассмотрены классы для работы с документом и с данными текущего или любого другого пользователя.Цель лекции:Изучить принципы работы с SEF-ссылками, сгенерированными в компоненте по собственному шаблону. Ознакомиться с некоторыми методами классов JDocument и JUser.Генерация SEF-ссылок (класс JRoute)В Joomla существует возможность создавать SEF-ссылки (Search-Engine Friendly) вида www.mysite.ru/one/two/three, удобные и для посетителей, и для поисковых систем. Для этого используется единственный метод класса JRoute, переводящий внутреннюю ссылку, генерируемую Joomla, в SEF-ссылку:string _(string $url, bool $xhtml=true, int $ssl=null)где$url - абсолютный или относительный URI; $xhtml - заменять ли амперсанды на "&"; $ssl - при $ssl=1 полученный URI будет начинаться с протоколав противном случае - http://.<empty-line/>Данный метод разбирает $url на пары "ключ-значение" и сохраняет результаты разбора в массиве. Из этого массива удаляется элемент option. Его значение добавляется к новому URL в качестве первого сегмента. Затем производится поиск файла /components/com_<option>/router.php. В этом файле должны находиться две функции: функция для генерации SEF-ссылок(<имя компонента>BuildRoute) и функция для декодирования элементов SEF-ссылок(<имя компонента>ParseRoute). Метод JRoute::_ вызовет функцию <имя компонента>BuildRoute и передаст ей массив, полученный при разборе $url. Функция вернет массив $segments. Метод JRoute::_ добавит к новому URL все элементы этого массива, разделив их слэшами. Если в запросе останутся какие-либо необработанные переменные, они будут добавлены в конец URL.Допустим, метод JRoute::_ получит на вход ссылку видаindex.php?option=com_mycomponent&var1=value1&var2=value2&…&varN=valueNТогда он передаст в функцию <имя компонента>BuildRoute ассоциативный массивArray([option]=>com_mycomponent [var1]=>value1 [var2]=>value2... [varN]=>valueN)причем пары "ключ-значение" будут расположены в том порядке, в котором они были в исходной ссылке. Задача функции <имя компонента>BuildRoute - выбрать необходимые пары и сохранить в результирующем массиве только значения, но так, чтобы впоследствии можно было восстановить соответствующие им ключи. Это достигается использованием какого-либо фиксированного порядка. Функция вернет массив видаArray([0]=>value1 [1]=>value2 … [N-1]=>valueN)из которого затем будет создана SEF-ссылкаcomponent/mycomponent/value1/value2/…/valueNВпоследствии при щелчке на какой-либо SEF-ссылке произойдет обратный процесс. Будет вызван метод <имя компонента>ParseRoute, который получит на вход массивArray([0]=>value1 [1]=>value2 ... [N-1]=>valueN)и вернет ассоциативный массив:Array([var1]=>value1 [var2]=>value2 … [varN]=>valueN)который Joomla установит в качестве переменных HTTP-запроса. Таким образом, посетители сайта и поисковые системы увидят SEF-ссылки, а компонент будет работать с обычным набором пар "ключ-значение".Обратите внимание, что SEF-ссылка не содержит никакой информации о том, как называются ключи массива. Чтобы их можно было восстановить, функция генерации ссылок и функция их декодирования должны неявно задавать шаблон SEF-ссылокдля конкретного компонента. В данном примере подразумевается шаблон, который можно сформулировать вербально так: "переменные записываются в следующем порядке: var1, var2, … varN".Шаблон может быть более сложным. Например, его структура может меняться в зависимости от задачи, т.е. от значения входящей в него переменной task.В простейшем случае содержимое файла router.phpвыглядит так:<?php defined('_JEXEC') or die ('Restricted access'); function <имя компонента>BuildRoute(&$query) { $segments = array; if (isset($query['var1'])) { $segments[] = $query['var1']; unset($query['var1' ]) ; } ... if(isset($query['varN' ])) { $segments[] = $query['varN']; unset($query['varN']); } return $segments; } function <имя компонента>ParseRoute($segments) { $vars = array; $vars['var1'] = @$segments[0]; ... $vars['varN'] = @$segments[1]; return $vars; } ?>Обратите внимание, что массив $query должен быть передан в функцию <имя компонента>BuildRoute по ссылке. По мере заполнения массива $segments обработанные элементы удаляются из массива $query с помощью unset. Любые элементы, которые останутся в массиве $query после работы функции <имя компонента>BuildRoute, останутся и в URL. Если мы передадим $query по значению, вызовы функции unset будут действовать только на локальную копию этого массива и все элементы старого URL будут появляться после SEF-сегментов.Документ (класс JDocument)Документ- это буфер, использующийся для хранения содержимого веб-страницы, которая будет показана пользователю после выполнения запроса.Получение ссылки на глобальный объект JDocument:$document =& JFactory::getDocument;Этот объект хранит название, описание, язык, направление текста, дату модификации, кодировку и некоторые другие значения. Класс JDocument содержит несколько методов для получения этих значений: getTitle, getDescription, getLanguage, getDirection, getModifiedDate, getCharset и др. Соответственно, методы для задания этих значений называются setTitle, setDescription и т.д. и принимают в качестве аргумента новое значение.Получение значения мета-тегаstring getMetaData(string $name, bool $http_equiv = false)где$name - название тега; $http_equiv - относится ли этот мета-тег к группе http-equiv (например, Content-Type, Refresh и др.).<empty-line/>Примеры:echo $document->getMetaData('content-type', true); echo $document->getMetaData('keywords', false);Изменение значения мета-тегаvoid setMetaData(string $name, string $content, bool $http_equiv = false, bool $sync = true)где$content - значение атрибута content; $sync - синхронизировать ли тег content-type с MIME-типом документа.<empty-line/>Пример:$document->setMetaData('content-type','text/html',true,true);Добавление скриптов и каскадных таблиц стилейПеречисленные ниже методы добавляют в секцию <head> соответствующие теги.Добавление ссылки на скрипт:void addScript(string $url, string $type = "text/javascript", bool $defer = false, bool $async = false)где$url - URL скрипта; $type - тип скрипта (text/javascript, text/vbscript и т.д.); $defer - добавлять ли к тегу <script> атрибут defer="defer"; $async - добавлять ли к тегу <script> атрибут async="async".<empty-line/>Пример:$document->addScript('/components/com_mycomponent/js/script.js');Добавление непосредственно текста скриптаvoid addScriptDeclaration(string $content, string $type = 'text/javascript')где$content - текст скрипта; $type - тип скрипта.<empty-line/>Пример:$document->addScriptDeclaration('alert("Hello World")');Добавление внешней таблицы стилейvoid addStyleSheet(string $url, string $type = 'text/css', string $media = null, array $attribs = array)где$url - URL файла CSS; $type - MIME-тип файла; $media - значение атрибута media (screen, print, projection и др.); $attribs - массив других атрибутов тега <link>.<empty-line/>Пример:$document->addStyleSheet('/components/com_mycomponent/css/style.css');Добавление внутренней таблицы стилейvoid addStyleDeclaration(string $content, string $type = 'text/css')где$content - код CSS; $type - значение атрибута type будущего тега <style>.<empty-line/>Пример:$document->addStyleDeclaration('.myclass { color: red; }');Пользователь (класс JUser)Пользователь, просматривающий сайт, представлен объектом класса JUser, доступ к которому можно получить через метод getUser класса JFactory:$user =& JFactory::getUser;Чтобы получить доступ к объекту, представляющему какого-либо другого пользователя, необходимо передать в метод getUser id или логин этого пользователя:$user =& JFactory::getUser(42); $user =& JFactory::getUser('admin');Поля класса JUserJUser имеет ряд полей, для которых определен уровень доступа public и к которым поэтому можно обращаться непосредственно. Наиболее важные из них перечислены ниже (таблица 5.1).Таблица 5.1. Некоторые public-поля класса JUser Поле Описаниеblock Равно 1, если пользователь заблокирован email E-mail пользователя guest Равно 1, если пользователь является гостем, т.е. не залогинен id ID пользователя lastvisitDate Дата и время последнего входа пользователя в систему name Имя пользователя params Настройки пользователя registerDate Дата и время регистрации аккаунта пользователя sendEmail Равно 1, если пользователь согласен получать сообщения с сайта по электронной почте username Логин пользователя<empty-line/>Например, выведем приветствие для залогиненного пользователя:if ($user->guest) echo "Пожалуйста, войдите в систему или зарегистрируйтесь"; else echo "Здравствуйте, {$user->name}! Последний раз вы были на сайте ".JHTML::_('date',$user->lastvisitDate);Получение и изменение настроек пользователяmixed getParam(string $key, mixed $default = null) mixed setParam(string $key, mixed $value)где$key - ключ параметра; $default - значение параметра по умолчанию; $value - устанавливаемое значение параметра. setParam - возвращает предыдущее значение параметра.<empty-line/>Пример:echo $user->getParam('language','ru-RU'); $user->setParam('language','en-GB');ПрактикаФорма для написания вопросаИзмените код конструкции switch в файле myquestions.php, добавив обработку задачи showform:case 'showform': showForm($option); break;Добавьте в этот же файл функцию showForm:function showForm($option) { $user =&JFactory::getUser; if($user->name) $name = $user->name; else $name = ''; HTML_questions::showForm($option, $name); }Перед вызовом функции вывода HTML-кода мы получаем имя залогиненного в настоящий момент пользователя, если таковой имеется. Код $user = &JFactory::getUser присваивает переменной $user ссылку на объект-представитель залогиненного пользователя. Если удалось получить имя пользователя, то мы сохраняем это значение в переменной $name, а в противном случае этой переменной присваивается пустая строка. Таким образом поле " Автор" в форме для написания вопроса будет уже заполнено, так что залогиненным пользователям не придется его заполнять.Перейдите в файл myquestions.html.phpи добавьте в класс HTML_questions метод showForm:function showForm($option, $name) { ?> <form action="index.php" method="post"> <table> <tr> <td width="100"> <?php echo JText::_('COM_MYQUESTIONS_AUTHOR');?>: </td> <td> <input class="text_area" type="text" name="name" id="name" size="50" maxlength="255" value="<?php echo $name;?>"/> </td> </tr> <tr> <td width="100"> <?php echo JText::_('COM_MYQUESTIONS_CITY');?>: </td> <td> <input class="text_area" type="text" name="city" id="city" size="50" maxlength="50"/> </td> </tr> <tr> <td width="100"> <?php echo JText::_('COM_MYQUESTIONS_EMAIL');?>: </td> <td> <input class="text_area" type="text" name="email" id="email" size="50" maxlength="50"/> </td> </tr> <tr> <td width="100"> <?php echo JText::_('COM_MYQUESTIONS_QUESTION');?>: </td> <td> <textarea name='question' id='question' class='inputbox' rows='15' cols='38'></textarea> </td> </tr> <tr> <td width="100"> <?php echo JText::_('COM_MYQUESTIONS_PUBLISHED');?>: </td> <td> <input type="hidden" name="published" value="0"/> <input type="checkbox" name="published" id="published" value="1"/> </td> </tr> </table> <input type="hidden" name="task" value="addquestion"/> <input type="hidden" name="option" value="<?php echo $option;?>"/> <input type="submit" class="button" id="button" value="<?php echo JText::_('COM_MYQUESTIONS_SENDBUTTON');?>"/> </form> <?php } Листинг .<empty-line/>Как видите, в данной форме сразу два элемента с именем published. Дело в том, что, когда флажок установлен в выбранное состояние, то сценарию-обработчику формы в числе других параметров приходит пара "имя_флажка=значение". Однако когда флажок не установлен, эта пара не посылается. Поэтому используется следующий прием: перед флажком в форме помещается одноименное скрытое поле со значением, равным нулю. Тогда если флажок не установлен, то сценарий получит пару published=0. Если же он установлен, то сценарий тоже получит эту пару, но сразу же последует пара published=1, которая перекроет значение скрытого поля.Так как мы поместили на форму скрытый элемент task со значением addquestion, то она будет обработана при обработке задачи addquestion. Поэтому добавьте в конструкцию switch в файле myquestions.phpследующий код:case 'addquestion': addQuestion($option); break;Добавьте в этот же файл функцию addQuestion:function addQuestion($option) { $row =& JTable::getInstance('question', 'Table'); if (!$row->bind(JRequest::get('post'))) { echo "<script> alert('".$row->getError."'); window.history.go(-1); </script>\n"; exit; } $row->question = nl2br(htmlspecialchars(JRequest::getVar('question', '', 'post', 'string',JREQUEST_ALLOWRAW), ENT_QUOTES)); $row->IP = getenv('REMOTE_ADDR'); $row->date = &JFactory::getDate->toFormat; $row->id_cat = 1; if (!$row->store) { echo "<script> alert('".$row->getError."'); window.history.go(-1); </script>\n"; exit; } $mailer =& JFactory::getMailer; $mailer->setSender('test@mysite.ru'); $mailer->addRecipient('admin@mysite.ru'); $mailer->setSubject(JText::_('COM_MYQUESTIONS_ADMIN_LETTER_SUBJECT')); $mailer->setBody(JText::sprintf('COM_MYQUESTIONS_ADMIN_LETTER_NEW_QUESTION',$row->question)); $mailer->IsHTML(true); if ($mailer->Send !== true) { echo "<script> alert('".JText::_('COM_MYQUESTIONS_ADMIN_LETTER_ERROR')."'); window.history.go(-1); </script>\n"; exit; } global $app; $app-> redirect(JRoute::_('index.php?option='.$option.'&task=view&view=all'), JText::sprintf('COM_MYQUESTIONS_QUESTION_SENT',$row->name)); }</a>

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

IP-адрес пользователя определяется с помощью функции getenv, которая возвращает значение переменной окружения, в данном случае - REMOTE_ADDR.

По умолчанию вопросу присваивается категория с id, равным 1, то есть "Без категории".

Добавьте в файл language/ru-RU/ru-RU.com_myquestions.iniкод:

COM_MYQUESTIONS_ADD_QUESTION="Задать вопрос" COM_MYQUESTIONS_AUTHOR="Автор" COM_MYQUESTIONS_DATE="Дата вопроса" COM_MYQUESTIONS_QUESTION="Текст вопроса" COM_MYQUESTIONS_CITY="Город" COM_MYQUESTIONS_EMAIL="e-mail" COM_MYQUESTIONS_CATEGORY="Категория" COM_MYQUESTIONS_PUBLISHED="Отображать ли вопрос на сайте" COM_MYQUESTIONS_SENDBUTTON="Отправить вопрос" COM_MYQUESTIONS_QUESTION_SENT="Спасибо, %s! Ваш вопрос отправлен. Он будет опубликован на сайте после получения ответа" COM_MYQUESTIONS_ADMIN_LETTER_SUBJECT="Новый вопрос на сайте" COM_MYQUESTIONS_ADMIN_LETTER_NEW_QUESTION="Добрый день!На сайте появился новый вопрос:%s" COM_MYQUESTIONS_ADMIN_LETTER_ERROR="Ошибка отправки письма"

Осталось добавить ссылку для написания вопроса. Измените начало функции showCategories так:

function showCategories($rows, $option) { ?>

Теперь на главной странице компонента во фронтенде появилась ссылка " Задать вопрос" (рис. 5.1).

(есть увеличенное изображение)

Рис. 5.1. Ссылка "Задать вопрос"

При переходе по этой ссылке появляется форма для написания вопроса (рис. 5.2). Обратите внимание, что в поле " Автор" подставилось имя текущего пользователя, если он залогинен.

(есть увеличенное изображение)

Рис. 5.2. Форма для написания вопроса

После написания вопроса и нажатия кнопки " Отправить вопрос" происходит перенаправление на главную страницу компонента с сообщением об успешной отправке вопроса (рис. 5.3).

(есть увеличенное изображение)

Рис. 5.3. Сообщение об отправке вопроса

Зайдите в папку <путь к Денверу>/tmp/!sendmailи найдите в ней файл *.eml, содержащий письмо-уведомление администратора о новом вопросе.

SEF

Включите SEF в бэкенде. Для этого перейдите в меню " Сайт" - " Общие настройки" и убедитесь, что переключатель " Включить SEF (ЧПУ)" установлен в " Да". Если вы используете в качестве веб-сервера Apache со включенным mod_rewrite, то вы можете также установить переключатель " Перенаправление URL" в " Да"; тогда из ваших ссылок исчезнет строка " index.php". Вид раздела " Настройки SEO" при включенном mod_rewriteпоказан на рис. 5.4.

Рис. 5.4. Раздел панели управления "Настройки SEO"

Если ваша конфигурация не позволяет использовать mod_rewrite, SEF-ссылки все равно могут быть построены, но они будут включать строку " index.php", например: ссылка: http://www.mysite.ru/index.php/one/two/three.

Нажмите кнопку " Сохранить и закрыть" для сохранения конфигурации. Если вы используете mod_rewrite, убедитесь, что вы переименовали находящийся в корневой папке Joomla файл htaccess.txtв .htaccess(если переименовать файл в проводнике Windows не удается, воспользуйтесь интерфейсом командной строки или каким-либо файловым менеджером, например, Total Commander).

Если вы получили сообщение о том, что ваша конфигурация не может быть перезаписана, задайте те же два значения вручную. Для этого откройте файл configuration.phpв корневой папке Joomla, найдите строки:

public $sef = '0'; public $sef_rewrite = '0';

и измените оба значения на " 1" вместо "0".

Генерация SEF-ссылок

Напишем функцию для генерации SEF-ссылок. Создайте файл /components/com_myquestions/router.php:

Мы создаем пустой массив $segments. Затем проверяем, есть ли в массиве запроса элемент "task", и в этом случае добавляем значение задачи в массив $segments в качестве первого элемента и затем удаляем task из запроса. Далее мы повторяем тот же процесс для id. Наконец, возвращаем массив $segments, чтобы JRoute::_ могла закончить построение URL.

Исправим функции вывода нашего компонента так, чтобы они выводили SEF-ссылки вместо обычных. Откройте файл /components/com_myquestions/myquestions.html.phpи измените код функции showCategories класса HTML_questions следующим образом:

function showCategories($rows, $option) { ?> '> '>

id.'&task=showlist'); echo ''; } ?>

'.$row->name. '

'.$row->desc.'

Измените выделенный код в функции HTML_questions::showQuestions:

foreach($rows as $row) { $link = JRoute::_('index.php?option='.$option.'&id='.$row->id.'&task=showquestion'); $link_cat = JRoute::_('index.php?option='.$option.'&id_cat='.$row->id_cat.'&task=showlist'); ?>

Измените также выделенный код в функции HTML_questions::showQuestion:

function showQuestion($row, $option, $row_cat) { $link_cat = JRoute::_('index.php?option='.$option.'&id_cat='.$row->id_cat.'&task=showlist');

Теперь компонент будет генерировать SEF-ссылки по шаблону, установленному в функции MyQuestionsBuildRoute.

Декодирование SEF-ссылок

Если вы сейчас попытаетесь щелкнуть на одной из SEF-ссылок, то получите сообщение:

"Fatal error: Call to undefined function myquestionsParseRoute in Y:\home\localhost\www\joomla\includes\router.php on line …".

Напишем функцию для декодирования SEF-ссылок.

Откройте файл /components/com_myquestions/router.phpи добавьте следующую функцию:

function MyQuestionsParseRoute ($segments) { $vars = array; $vars['task'] = @$segments[0]; $vars['id'] = @$segments[1]; return $vars; }

Как видите, в функции MyQuestionsParseRoute мы считали переменные task и id из массива $segments в том же порядке, в котором мы их записывали в одноименный массив в функции MyQuestionsBuildRoute.

Знаки "@" при получении элементов массива $segments используются для подавления вывода сообщений об обращении к несуществующим элементам массива, т.к. не все наши SEF-ссылки будут содержать id.

Теперь щелкните по какой-либо ссылке во фронтенде и обратите внимание на строку статуса в браузере. Вы должны увидеть URL вида: ссылка: http://localhost/joomla/component/myquestions/showlistили ссылка: http://localhost/joomla/component/myquestions/showquestion/1

Ключевые термины

JDocument - класс для работы с документом. JRoute - класс для создания SEF-ссылок. JUser - класс для работы с данными о пользователе.Документ Документ - буфер, использующийся для хранения содержимого веб-страницы, которая будет показана пользователю после выполнения запроса. Функция генерации SEF-ссылок - функция, которая принимает массив элементов HTTP-запроса и возвращает массив сегментов SEF-ссылки. Функция декодирования SEF-ссылок - функция, которая из массива сегментов SEF-ссылки создает массив переменных HTTP-запроса. Шаблон SEF-ссылок - последовательность сегментов.

Краткие итоги

SEF-ссылки в Joomla создаются с помощью метода JRoute::_, который переводит внутреннюю ссылку, генерируемую Joomla, в SEF-ссылку. Чтобы компонент работал с SEF-ссылками, сгенерированными по собственному шаблону, необходимо создать в корневой папке его фронтенда файл router.php, в котором должны находиться функция для генерации SEF-ссылок и функция для их декодирования. Эти функции осуществляют взаимно обратные операции: первая из них из массива элементов HTTP-запроса создает массив сегментов SEF-ссылки, а вторая из массива сегментов SEF-ссылки создает массив переменных HTTP-запроса.

Так как SEF-ссылки не позволяют задать названия переменных запроса, то единственный способ определить, к какой переменной относится то или иное значение сегмента, - это использовать шаблон, который задает последовательность сегментов. Шаблон неявно задается в коде каждой из функций в файле router.php.

Для работы с документом и с данными пользователя в Joomla существуют соответственно классы JDocument и JUser.

Вопросы

Какой метод переводит внутреннюю ссылку, генерируемую Joomla, в SEF-ссылку?

Каким образом компоненты работают с SEF-ссылками?

Для чего служат функции генерации и декодирования SEF-ссылок?

Что такое шаблон SEF-ссылок и как он задается?

Какие классы используются для работы с документом и с данными пользователя?

Упражнения

Адаптируйте код из раздела " Практика" для своего варианта (см. список вариантов в дополнительных материалах).

Перейти на страницу: