Создание дополнительного элемента формы к статье Joomla

В этой статье будет рассказано о создании плагина, который объясняет возможности Joomla 2.5 создавать дополнительные поля формы к статьям. Для этого придётся создать отдельный плагин и установить патч изменяющий компонент "Менеджер статей".

Функции создаваемого плагина:

• Добавление дополнительного поля к статье в бакэнде сайта;
• Добавление дополнительного поля к статье в фронтэнде сайта;
• Сохранение данных вновь создаваемого поля в базе данных;
• Вывод полей с использованием собственной разметки на страницах сайта (до вывода текста статьи);

Пример

Для примера у нас будут данные браться "структура", "температура", "вкус":

При этом данные будут доступны как в бакэнде так и во фронтэнде сайта.

Админ раздел

Сайт

Framework

В Joomla менеджер статей как бакэнде так и во фронтэнде сайта является обычным компонентом, при обработке формы происходят следующие действия:

• Загрузка структуры формы в XML
• Загрузка данных из базы
• Вставка данных в поля формы
• Отображение формы в HTML разметке

При сохранении фреймовик Joomla выполняет следующие действия:

• Перехватывае отправляемые даннные
• Загружает описание полей формы
• Осуществляет валидацию полей формы и данных
• При ошибки валидации сохраняет данные во временное состояние
• Либо добавляет данные в базу

Фреймовик Joomla для каждого из указанных этапов предусматривает соотвтсвующие хуки:

onContentPrepareForm()

выполняется, когда происходит загрузка описания форм;

onContentPrepareData()

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

onContentAfterSave()

выполняется, когда происходит сохраннеие данных в базу, этот хук будет использоваться для сохранения дополнительных данных в плагине в талицу #__user_profiles (автор);

onContentAfterDelete()

запускается когда происходит удаление статьи, этот хук будет использоваться для удаление дополнительных данных;

onContentPrepare()

запускается когда происходит отображение статьи (во фронтэнде(автор)), данный хук используется для отображение дополнительных данных;

База данных

Контент дополнительных полей статьи должен сохранятся в базу данных. Для этого можно использовать дополнительные таблица базы данных. В Joomla 2.5 можно расширять профиль пользователя дополнительными полями. Они сохраняются в таблицу " #__user_profiles". Данный плагин будет использовать таблицу #__user_profiles и столбцы "user_id" как "article_id".

Структура нашего плагина:

── plugins/content/rating
   ├── language
   │   └── en-GB
   │       ├── en-GB.plg_content_rating.ini      [language file]
   │       └── en-GB.plg_content_rating.sys.ini  [language file]
   ├── rating
   │   ├── rating.css  [CSS for the rendered rating table]
   │   └── rating.xml  [Form description]
   ├── rating.php   [Plugin hooks]
   └── rating.xml   [Manifest]

Установочный файл

<?xml version="1.0" encoding="utf-8"?> <extension version="2.5" type="plugin" group="content" method="upgrade"> <name>plg_content_rating</name> <author>Joomla! Project</author> <creationDate>June 2012</creationDate> <copyright>(C) 2005 - 2012 Open Source Matters. All rights reserved.</copyright> <license>GNU General Public License version 2 or later; see LICENSE.txt</license> <authorEmail>admin@joomla.org</authorEmail> <authorUrl>www.joomla.org</authorUrl> <version>2.5.0</version> <description>PLG_CONTENT_RATING_XML_DESCRIPTION</description> <files> <folder>language</folder> <folder>rating</folder> <filename plugin="rating">rating.php</filename> <filename>index.html</filename> </files> <config> <fields name="params"> <fieldset name="basic"> <field name="ratingclass_sfx" type="text" label="PLG_CONTENT_RATING_ITEM_FIELD_RATING_CLASS_LABEL" description="PLG_CONTENT_RATING_ITEM_FIELD_RATING_CLASS_DESC" /> </fieldset> </fields> </config> </extension>

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

; Joomla! Project ; Copyright (C) 2005 - 2012 Open Source Matters. All rights reserved. ; License GNU General Public License version 2 or later; see LICENSE.txt, see LICENSE.php PLG_CONTENT_RATING="Content - Rating" PLG_CONTENT_RATING_XML_DESCRIPTION="[plg_content_rating] Example plugin on how to add custom fields (texture/temperature/taste) to articles (com_content). Adds ratings to an article, and display them as a table before the article content." PLG_CONTENT_RATING_SLIDER_LABEL="Rating Options" PLG_CONTENT_RATING_FIELD_TEXTURE_LABEL="Texture" PLG_CONTENT_RATING_FIELD_TEXTURE_DESC="What does the sample feel like" PLG_CONTENT_RATING_FIELD_TEMPERATURE_LABEL="Temperature" PLG_CONTENT_RATING_FIELD_TEMPERATURE_DESC="What is the temperature of the sample" PLG_CONTENT_RATING_FIELD_TASTE_LABEL="Taste" PLG_CONTENT_RATING_FIELD_TASTE_DESC="How does the sample taste" PLG_CONTENT_RATING_ITEM_FIELD_RATING_CLASS_LABEL="Rating Class" PLG_CONTENT_RATING_ITEM_FIELD_RATING_CLASS_DESC="Optional CSS class to add to the rating. This allows CSS styling specific to the page."

CSS

div.rating { display: block; float: left; padding-right: 10px; } div.rating table tr td { margin: 1px !important; padding: 2px !important; } div.rating table tr.row0 { background-color:#efefef; } div.rating table tr.row1 { background-color:#ffffff; }

Дополнительные поля формы

<?xml version="1.0" encoding="utf-8"?> <form> <fields name="rating"> <fieldset name="rating" label="PLG_CONTENT_RATING_SLIDER_LABEL"> <field name="texture" type="text" id="texture" description="PLG_CONTENT_RATING_FIELD_TEXTURE_DESC" label="PLG_CONTENT_RATING_FIELD_TEXTURE_LABEL" message="PLG_CONTENT_RATING_FIELD_TEXTURE_MESSAGE" size="30" /> <field name="temperature" type="text" id="temperature" description="PLG_CONTENT_RATING_FIELD_TEMPERATURE_DESC" label="PLG_CONTENT_RATING_FIELD_TEMPERATURE_LABEL" message="PLG_CONTENT_RATING_FIELD_TEMPERATURE_MESSAGE" size="30" /> <field name="taste" type="text" id="taste" description="PLG_CONTENT_RATING_FIELD_TASTE_DESC" label="PLG_CONTENT_RATING_FIELD_TASTE_LABEL" message="PLG_CONTENT_RATING_FIELD_TASTE_MESSAGE" size="30" /> </fieldset> </fields> </form>

Хуки плагина

Главный файл плагина 'rating.php' содержит следующие хуки выполняемые фреймовиком:

Все хуки будет содержаться следующие объекты:

• $context
• $data – параметр, содержащий данные полей формы
• $article (JTableContent) содержит статью

__construct

Конструктор загружает языковой файл:

public function __construct(& $subject, $config) { parent::__construct($subject, $config); $this->loadLanguage(); }

onContentPrepareForm

onContentPrepareForm добавляет дополнительные поля в формы статей. Загружает фрагмент формы из "rating/rating.xml"

public public function onContentPrepareForm($form, $data) { if (!($form instanceof JForm)) { $this->_subject->setError('JERROR_NOT_A_FORM'); return false; } // Add the extra fields to the form. JForm::addFormPath(dirname(__FILE__) . '/rating'); $form->loadFile('rating', false); return true; }

onContentPrepareData

onContentPrepareData собирает данные после загрузки статьи (из #__content). Так же он объединяет данные дополнительных полей из таблицы #__user_profiles.

public function onContentPrepareData($context, $data) { if (is_object($data)) { $articleId = isset($data->id) ? $data->id : 0; if ($articleId > 0) { // Load the data from the database. $db = JFactory::getDbo(); $query = $db->getQuery(true); $query->select('profile_key, profile_value'); $query->from('#__user_profiles'); $query->where('user_id = ' . $db->Quote($articleId)); $query->where('profile_key LIKE ' . $db->Quote('rating.%')); $query->order('ordering'); $db->setQuery($query); $results = $db->loadRowList(); // Check for a database error. if ($db->getErrorNum()) { $this->_subject->setError($db->getErrorMsg()); return false; } // Merge the data. $data->rating = array(); foreach ($results as $v) { $k = str_replace('rating.', '', $v[0]); $data->rating[$k] = json_decode($v[1], true); if ($data->rating[$k] === null) { $data->rating[$k] = $v[1]; } } } else { // load the form JForm::addFormPath(dirname(__FILE__) . '/rating'); $form = new JForm('com_content.article'); $form->loadFile('rating', false); // Merge the default values $data->rating = array(); foreach ($form->getFieldset('rating') as $field) { $data->rating[] = array($field->fieldname, $field->value); } } } return true; }

onContentAfterSave

onContentAfterSave сохраняет данные дополнительных полей в базу данных.

public function onContentAfterSave($context, &$article, $isNew) { $articleId = $article->id; if ($articleId && isset($article->rating) && (count($article->rating))) { try { $db = JFactory::getDbo(); $query = $db->getQuery(true); $query->delete('#__user_profiles'); $query->where('user_id = ' . $db->Quote($articleId)); $query->where('profile_key LIKE ' . $db->Quote('rating.%')); $db->setQuery($query); if (!$db->query()) { throw new Exception($db->getErrorMsg()); } $query->clear(); $query->insert('#__user_profiles'); $order = 1; foreach ($article->rating as $k => $v) { $query->values($articleId.', '.$db->quote('rating.'.$k).', '.$db->quote(json_encode($v)).', '.$order++); } $db->setQuery($query); if (!$db->query()) { throw new Exception($db->getErrorMsg()); } } catch (JException $e) { $this->_subject->setError($e->getMessage()); return false; } } return true; }

onContentAfterDelete

onContentAfterDelete выполняется при удалении статьи, удаляет данные из дополнительных полей.

public function onContentAfterDelete($context, $article) { $articleId = $article->id; if ($articleId) { try { $db = JFactory::getDbo(); $query = $db->getQuery(true); $query->delete(); $query->from('#__user_profiles'); $query->where('user_id = ' . $db->Quote($articleId)); $query->where('profile_key LIKE ' . $db->Quote('rating.%')); $db->setQuery($query); if (!$db->query()) { throw new Exception($db->getErrorMsg()); } } catch (JException $e) { $this->_subject->setError($e->getMessage()); return false; } } return true; }

onContentPrepare

onContentPrepare при подготовке вывода статьи, переменна $params содержит параметры статьи, $this->params - параметры плагина. Эта функция выводит дополнительные поля в начале статьи на сайте.

public function onContentPrepare($context, &$article, &$params, $page = 0) { if (!isset($article->rating) || !count($article->rating)) return; // add extra css for table $doc = JFactory::getDocument(); $doc->addStyleSheet(JURI::base(true).'/plugins/content/rating/rating/rating.css'); // construct a result table on the fly jimport('joomla.html.grid'); $table = new JGrid(); // Create columns $table->addColumn('attr') ->addColumn('value'); // populate $rownr = 0; foreach ($article->rating as $attr => $value) { $table->addRow(array('class' => 'row'.($rownr % 2))); $table->setRowCell('attr', $attr); $table->setRowCell('value', $value); $rownr++; } // wrap table in a classed <div> $suffix = $this->params->get('ratingclass_sfx', 'rating'); $html = '<div class="'.$suffix.'">'.(string)$table.'</div>'; $article->text = $html.$article->text; }