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

В предыдущей статье ("Создание дополнительного элемента формы к статье Joomla 2.x") я рассказывал о создании дополнительных полей в Joomla 2.5, в этой статье этот же вопрос будет расcмотрен в Joomla 3.x!

Функции создаваемого плагина аналогичны функциям плагина в предыдущей статье:

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

Пример

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

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

Админ раздел

Сайт

Framework

Опять же как впредыдущей статье все изменения основаны на Joomla Фреймовике, а именно на его событиях (подробное описание каждого можно найти в предыдущей статье "Создание дополнительного элемента формы к статье Joomla 2.x").

• onContentPrepareForm()
• onContentPrepareData()
• onContentAfterSave()
• onContentAfterDelete()
• onContentPrepare()

База данных

Наш плагин будет использовать таблицу #__user_profiles и столбец "user_id" как "article_id".

Структура нашего плагина остаётся такой же как для Joomla 2.5:

── 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]

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

Установчный файл можно оставить таким же как и для Joomla 2.5, замените версию на 3.x

<?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 2.5

; 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

CSS файл можно оставить таким же как и для Joomla 2.5

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; }

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

Элементы формы остаются такими же как и в Joomla 2.5

<?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' содержит все хуки что и для Joomla 2.5, за исключение хука "onContentPrepareData", который я решил полностью удалить из его отказа работать в Joomla 3.0.x, хотя в 3.1.1 он работает так как описано в документации:

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

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

__construct

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

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

onContentPrepareForm

onContentPrepareForm в Joomla 3.x отличается от того жу хука в Joomla 2.x:

/** * @param JForm $form The form to be altered. * @param array $data The associated data for the form. * * @return boolean * @since 2.5 */ function onContentPrepareForm($form, $data) { if (is_object($data)) { $articleId = isset($data->id) ? $data->id : 0; if (!isset($data->rating) and $articleId > 0) { // Load the profile 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 profile 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]; } } } } if (!($form instanceof JForm)) { $this->_subject->setError('JERROR_NOT_A_FORM'); return false; } // Add the extra fields to the form. // need a seperate directory for the installer not to consider the XML a package when "discovering" JForm::addFormPath(dirname(__FILE__) . '/rating'); $form->loadFile('rating', false); return true; }

onContentPrepareData onContentPrepareData удалена и перенесена полностью в функцию "onContentPrepareForm". onContentAfterSave onContentAfterSave сохраняет данные дополнительных полей в базу данных.

public function onContentAfterSave($context, $article, $isNew) { $jinput = JFactory::getApplication()->input; $input = $jinput->get('jform', 'default_value', 'filter'); $articleId = $article->id; if ($articleId && isset($input['rating']) && (count($input['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 ($input['rating'] as $k => $v) { $query->values($articleId.', '.$db->quote('rating.'.$k).', '.$db->quote($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 - параметры плагина. Эта функция выводит дополнительные пол я в начале статьи на сайте. Функция отличается от её аналога для плагина в Joomla 2.5.

public function onContentPrepare($context, &$article, &$params, $page = 0) { // Load the profile 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($article->id)); $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; } $article->rating = $results; 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', $value[0]); $table->setRowCell('value', $value[1]); $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; }

Вместо патча, используемого в Joomla 2.5, необходимо венсти несколько изменений в файл edit.php, добавить вкладку:

<?php if ($this->canDo->get('core.admin')) : ?> <li><a href="#rating" data-toggle="tab"><?php echo JText::_('PLG_CONTENT_RATING_SLIDER_LABEL');?></a></li> <?php endif ?>

и добавить дополнительне поля из файла "rating/rating.xml" вставив их после вкладки "Права доступа к материалу":

<?php if ($this->canDo->get('core.admin')) : ?> <div class="tab-pane" id="rating"> <?php foreach ($this->form->getFieldset('rating') as $field) : ?> <div class="control-group"> <?php echo $field->label; ?> <div class="controls"> <?php echo $field->input; ?> </div> </div> <?php endforeach; ?> </div> <?php endif; ?> <!-- End Tabs -->

для Joomla 3.1.x послдений код нужно заменить несколько другим вариантом:

<?php if ($this->canDo->get('core.admin')) : ?> <?php echo JHtml::_('bootstrap.addTab', 'myTab', 'rating', JText::_('PLG_CONTENT_RATING_SLIDER_LABEL', true)); ?> <div class="tab-pane" id="rating"> <?php foreach ($this->form->getFieldset('rating') as $field) : ?> <div class="control-group"> <?php echo $field->label; ?> <div class="controls"> <?php echo $field->input; ?> </div> </div> <?php endforeach; ?> </div> <?php echo JHtml::_('bootstrap.endTab'); ?> <?php endif; ?>

Незабывайте что файл, в котрый мы только что внесли изменения перезаписывается при обновлении Joomla! Для того, чтобы это не прроизошло, нужно скопировать файл "edit.php" в администраторский раздел по адресу "\administrator\templates\isis\html\com_content\article\", в моём случае для шаблона "isis", для того чтобы узнать шаблон зайдите в менеджер шаблонов: