Добавляем произвольные поля в компоненты ядра с помощью плагина

From Joomla! Documentation

Revision as of 04:18, 4 August 2015 by AlexSmirnov (talk | contribs)
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎català • ‎español • ‎français • ‎italiano • ‎português do Brasil • ‎русский • ‎فارسی • ‎हिन्दी • ‎বাংলা • ‎中文(台灣)‎

Вы когда-нибудь желали, чтобы в компоненте com_content ядра [системы Joomla] присутствовало дополнительное поле для [ввода] номера телефона или Вам когда нибудь было нужно дополнительное поле для материалов компонента com_content?Joomla предоставляет простой и удобный путь для интегрирования таких новых полей в компоненты ядра. Простой плагин содержимого и переопределение макета Вашего шаблона - это все что требуется для достижения [такого интегрирования].

На примере добавления дополнительного адреса эл.почты в контакты компонента com_content, эта статья показывает как добавить какое-либо дополнительное поле в какой-либо компонент ядра. Если Вам нужно добавить произвольные поля в материалы [компонента] com_content, просто измените в ниже следующем коде все упоминания "contact" на "content".

Создание произвольного поля

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

Для того, чтобы добавить какое-либо поле в какой-либо системный компонент, Вам нужно создать плагин содержимого, который подхватывает событие onContentPrepareForm и вставляет свои собственные поля в нужный [класс] JForm. Нижеследующий код предназначен только для Joomla 3.1 и следующих за ней версий.

<?php
// no direct access
defined ( '_JEXEC' ) or die ( 'Restricted access' );
class plgContentExample extends JPlugin {
	/**
	 * Load the language file on instantiation.
	 * Note this is only available in Joomla 3.1 and higher.
	 * If you want to support 3.0 series you must override the constructor
	 *
	 * @var boolean
	 * @since 3.1
	 */
	protected $autoloadLanguage = true;
	function onContentPrepareForm($form, $data) {
		$app = JFactory::getApplication();
		$option = $app->input->get('option');
		switch($option) {
			case 'com_contact':
				if ($app->isAdmin()) {
					JForm::addFormPath(__DIR__ . '/forms');
					$form->loadFile('contact', false);
				}
				return true;
		}
		return true;
	}
}
?>

Enabling Front End Editing of Custom Fields

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

case 'com_contact':
	if ($app->isAdmin()) {
		JForm::addFormPath(__DIR__ . '/forms');
		$form->loadFile('contact', false);
	}
	return true;

Сдублируйте его непосредственно снизу от уже существующего отрывка этого кода и измените 'isAdmin' на 'isSite'.

Once you've got that done, create a template override for the content form edit.php file. If you're creating a set of custom fields for com_content, you would copy /components/com_contact/views/form/tmpl/edit.php to /templates/your-template-name/html/com_contact/form/edit.php

Inside your layout override, add your new fields in the form where you want them to appear (e.g., below the title, below the description), making sure that the field names match the XML file from your plugin (you'll create this next).

<!-- this part can be added anywhere in the file - preferrable towards the beginning, but definitely before the next part -->
<?php if ($this->item->id) : ?>  <!-- checking if this is an existing item or not -->
  <?php $attribs = json_decode($this->item->attribs); ?> <!-- if it is an existing item, get the attribs part of the existing record (attribs is where we save custom fields). You only need this line once. -->
  <?php echo $this->form->setValue('field_name', 'attribs', $attribs->field_name); ?> <!-- set the value of the custom field to what is already saved. Duplicate for the number of fields you need, changing the field_name as needed. -->
<?php endif; ?>
<!-- this part needs added to the file right where you want to display it. So, if you want it to show right after the description field, find the description field and place this right after it. Duplicate for the number of fields you need, changing the field_name as needed.-->
<?php echo $this->form->renderField('field_name', 'attribs'); ?> <!-- now we display the field. If we are editing an existing item, the previously saved data will be populated already -->

With that done, your fields will now appear and be stored via frontend editing.

The additional fields are loaded from the file forms/contact.xml in the plugin directory. It's important that these fields are in a fields element with the name property set to "params". If you don't set this property name, the fields will appear in the admin site but the values will not be saved.

In this case we are adding a field for a label to describe the email field in the public website and a second field for the value of the email address.

<?xml version="1.0" encoding="UTF-8"?>
<form>
	<fields name="params" >
		<fieldset name="params" >
			<field
				name="contact_emaillabel2"
				type="text"
				label="PLG_CONTENT_EXAMPLE_CONTACT_EMAILLABEL2"
				/>
			<field
				name="contact_email2"
				type="text"
				label="PLG_CONTENT_EXAMPLE_CONTACT_EMAIL2"
				filter="email"
			/>
		</fieldset>
	</fields>
</form>

Finally we need a language file so that the parameters are presented nicely in the admin site and are translatable into different languages. This file needs to be called something like en-GB.plg_content_example.ini.

COM_CONTACT_PARAMS_FIELDSET_LABEL="Additional Information"
PLG_CONTENT_EXAMPLE_CONTACT_EMAIL2="Additional email address"
PLG_CONTENT_EXAMPLE_CONTACT_EMAILLABEL2="Additional email label"

That's it for adding the field to com_contact. If you install this plugin, you'll have an additional tab in the contact editing form called "Additional Information" with the new fields included. If you fill in the new label and email address fields for a contact, you'll see that com_contact will store and retrieve the information for you.

The same plugin can be used to add more fields to different components; just add the relevant code into the onContentPrepareForm function and create the appropriate XML form files.

Displaying the Custom Field

To display the custom field you need to create a layout override for the relevant component in your template. For more details on creating templates see Creating a basic Joomla! template. For details on layout overrides, see Understanding Output Overrides.

Copy the file <Joomla>/components/com_contact/views/contact/tmpl/default.php to <template>/html/com_contact/contact/default.php, creating the folders in your template as necessary. We're going to edit this file to include the additional information. The com_contact component will automatically load the additional fields for us and load it into a variable called $this->params. All we need to do is check that the data is set and, if so, display it.

To display the field, find the location in <template>/html/com_contact/contact/default.php that corresponds to where you'd like the additional email address to be displayed and add the following code:

<?php if ($this->params->get('contact_emaillabel2', false)) : ?>
	<div>
		<span class="contact-additionalemail"><?php echo $this->params->get('contact_emaillabel2');?>:&emsp;<a href="mailto:<?php echo $this->params->get('contact_email2'); ?>"><?php echo $this->params->get('contact_email2'); ?></a><br/></span>
	</div>
<?php endif; ?>

If you add this code and install your template, you will now have the custom field displaying in your public Website.