В настоящее время прием заказов временно приостановлен. Приносим извинения за возможные неудобства.
Разработка и создание сайтов в Ростове-на-Дону

Разработка сайтов

Главное направление деятельности студии ArtWebMaster, это разработка и создание сайтов в Ростове-на-Дону.

Далее...
Создание компонентов Joomla и модулей

Компоненты и модули

Мы также занимаемся созданием компонентов, модулей и плагинов для CMS Joomla.

Далее...
Перенос сайтов на CMS Joomla

Перенос сайтов на Joomla

Ваш сайт статичный? Мы можем перенести его на CMS Joomla и Вы получите быстрый динамичный сайт.

Далее...
Поддержка и сопровождение сайтов

Сопровождение сайтов

Не хватает времени заниматься сайтом? Мы берем на себя работу по поддержке и сопровождению сайтов.

Далее...

Параметры XML файла модуля Joomla

Как уже говорилось в статье «Изготовление модуля для CMS Joomla», все параметры, которые разработчик хочет использовать для настройки своего модуля, прописываются в XML файле. В данной статье речь как раз и пойдет о том, как именно прописываются эти параметры в XML файле и какие свойства они имеют.

В XML файле модуля все необходимые параметры помещаются между тегами <params></params>, в виде списка.
Каждый параметр может быть прописан в XML файле различными способами. Все зависит от того, что это за параметр, как мы хотим использовать его в дальнейшем, в каком виде он должен быть представлен пользователю в административной части и т.д. Пример описания простейшего параметра:

<param name="items" type="text" default="" label="Количество объектов" description="Количество показываемых объектов" />

В ряде случаев, параметр может быть прописан так, что его выходные данные смогут принять только какое-то одно фиксированное значение. Это делается с помощью «радио-кнопок» или выпадающих списков. Конструкция описания параметра при этом сильно видоизменяется, а сами фиксированные значения прописываются в тегах «option». Например:

<param name="item_title" type="list" default="0" label="Заголовок объекта" description="Показывать или нет заголовок объекта">
<option value="0">Нет</option>
<option value="1">Да</option>
</param>

В данном примере, пользователь сможет задать параметру «item_title» только одно из двух, заранее определенных разработчиком модуля значений - 0 или 1. Свойству «default» в такой конструкции необходимо присвоить одно из опциональных значений «value». В приведенном примере default="0", значит при первом пуске административной части модуля, указатель «option» будет установлен в положение «Нет».


Каждый параметр модуля должен иметь обязательное свойство «name», которое служит идентификатором этого параметра. Значение этого свойства должно быть уникальным. Так же параметр должен быть дополнительно описан с помощью ряда свойств, таких как «type» - тип, «default» - значение параметра по умолчанию, «label» - наименование параметра и «description» - описание параметра.

Помимо основных свойств, параметр может содержать еще ряд дополнительных. Некоторые из них нужны лишь для изменения внешнего вида поля, в которое пользователь будет вводить данные, некоторые служат дополнением к типу параметра. Все свойства параметра актуальны лишь в административной части модуля. Для программного скрипта модуля они никокого значения не несут.

Пример использования дополнительных параметров в XML файле модуля:

<param name="sometext" type="textarea" cols="80" rows="5" default="" label="Текст" description="Обычный текст или текст в формате HTML, который будет выводиться в блоке модуля." />

Здесь свойства «cols» и «rows» определяют только ширину и высоту многострочного поля для ввода текста - «textarea» в административной части модуля.

Теперь давайте рассмотрим, какие свойства можно задавать параметрам в XML файле.

Свойство «name» - имя параметра.

Как уже говорилось, свойство «name» это идентификатор параметра, с помощью которого мы можем получить его значение в процессе выполнения скрипта модуля.
Имена для параметров модуля устанавливает разработчик в процессе его создания. Однако существуют еще зарезервированный CMS Joomla список имен параметров, которые служат для строго определенных целей. Это имена системных параметров.

moduleclass_sfx - это суффикс, который будет автоматически присоединен Joomla (Джумлой) ко всем CSS классам данного модуля, при его выводе на страницу сайта.

Пример использования параметра moduleclass_sfx в XML файле модуля:

<param name="moduleclass_sfx" type="text" default="" label="CSS-cуффикс класса модуля" description="Суффикс, который будет использован в описании класса (table.moduletable) таблицы стилей (CSS) модуля. Это позволяет использовать индивидуальный стиль модуля." />

сache - позволяет принудительно включить/отключить кэширование модуля.

Пример использования параметра cache в XML файле модуля:

<param name="cache" type="radio" default="0" label="Разрешить кэширование" description="Выберите, кэшировать ли содержимое этого модуля">
<option value="0">Нет</option>
<option value="1">Да</option>
</param>

Свойство «type» - тип поля.

Чтобы повысить юзабилити административной части модуля, разработчики CMS Joomla ввели в параметр свойство «type». Это свойство используется только в административной части модуля и служит для указания, в какой тип поля будет выведен параметр при его редактировании. Некоторые типы полей «type» очень похожи по структуре с полями html разметки, однако есть и такие, которые были созданы специально для CMS Joomla и имеют уникальные параметры. Рассмотрим, какие типы полей можно указать в XML файле модуля.

text - выводит однострочное текстовое поле ввода. Для этого поля можно добавить дополнительный параметр «size», который будет определять длинну (размер) выводимого поля.

Пример использования поля text в XML файле модуля:

<param name="count" type="text" default="10" label="Число объектов" description="Количество отображаемых объектов" />

textarea - выводит многострочное текстовое поле ввода. Для этого поля можно добавить два дополнительных параметра - «cols» и «rows», которые определяют соответственно ширину и высоту этого поля.

Пример использования поля textarea в XML файле модуля:

<param name="sometext" type="textarea" cols="80" rows="5" default="" label="Текст" description="Обычный текст или текст в формате HTML, который будет выводиться в блоке модуля." />

radio - выводит поле с радио-кнопками. Для этого поля необходимо добавить минимум два опциональных свойства «option».

Пример использования поля radio в XML файле модуля:

<param name="hide_menu_name" type="radio" default="0" label="Показывать имя меню" description="Показывать или скрывать имя меню">
<option value="0">Да</option>
<option value="1">Нет</option>
</param>

list - выводит выпадающий список. Для этого поля также необходимо добавить минимум два свойства «option».

Пример использования поля list в XML файле модуля:

<param name="doc_image" type="list" default="1" label="Картинка документа">
<option value="0">Без картинки</option>
<option value="1">В виде иконки</option>
<option value="2">С картинкой</option>
</param>

imagelist - выводит имена графических файлов (картинок) из указанной директории сайта в виде выпадающего списка. Директория указывается в дополнительном свойстве «directory». Данный тип поля может содержать еще два свойства:

  1. hide_default - при значение 0 (по умолчанию) в список файлов добавляется поле «Изображение по умолчанию», которое обязывает пользователя выбрать картинку из списка.
  2. hide_none - при значение 0 (по умолчанию) в список файлов добавляется поле «Не использовать изображение».

При значении этих параметров 1, указанные поля не выводятся.
Если дополнительное свойство не прописать, его значение принимается 0 (по умолчанию).

Пример использования поля imagelist в XML файле модуля:

<param name="my_image1" type="imagelist" directory="/images/stories/mypic" hide_default="1" default="" label="Изображение 1" description="Изображение первого уровня" />

filelist - выводит имена всех файлов из указанной директории сайта в виде выпадающего списка. Директория указывается в дополнительном свойстве «directory». Данный тип поля может содержать еще три свойства:

  1. hide_default - при значение 0 (по умолчанию) в список файлов добавляется поле «Изображение по умолчанию», которое обязывает пользователя выбрать картинку из списка.
  2. hide_none - при значение 0 (по умолчанию) в список файлов добавляется поле «Не использовать изображение».
  3. filter - задает фильтр для вывода списка файлов с определенным расширением. При необходимости задать фильтр для нескольких типов файлов, они разделяются символом «|» (вертикальная черта). Например: filter= ".html|.ico".

Пример использования поля filelist в XML файле модуля:

<param name="myfilelist" type="filelist" directory="/images/texts" filter=".htm|.txt" default="0" label="Файл 1" description="Файл с текстом" />

mos_section - выводит имена всех разделов сайта в виде выпадающего списка.

Пример использования mos_section в XML файле модуля:

<param name="myarticle" type="mos_section" default="0" label="Разделы сайта" description="Выберите раздел" />

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

Пример использования поля mos_category в XML файле модуля:

<param name="mycatid" type="mos_category" scope="com_docman" default="0" label="Категория" description="Категория содержимого" />

mos_menu - выводит наименования всех меню сайта в виде выпадающего списка.

Пример использования поля mos_menu в XML файле модуля:

<param name="mymenunames" type="mos_menu" default="0" label="Меню сайта" description="Выбирете меню" />

Свойство «default» - значение параметра по умолчанию.

Каждому параметру модуля необходимо задать его значение по умолчанию. Эти значения используются при первом запуске административной части модуля и подставляются в соответствующие поля. Таким образом разработчик помогает пользователю правильно сконфигурировать модуль.

Когда пользователь нажимает кнопку «Сохранить» или «Применить» в административной панели, значения всех параметров сохраняются в базе данных и при повторном запуске административной части модуля значения всех параметров берутся уже из базы данных.

Свойство «label» - наименование параметра.

Чтобы пользователь имел возможность ориентироваться в том, какие параметры модуля ему необходимо настроить, каждый параметр имеет свое наименование. Наименования выводятся справа от поля ввода данных.

Свойство «description» - описание параметра.

Наименование параметра не всегда может раскрыть его суть или предназначение. Текст краткого описания прописанный в свойстве «description» позволит пользователю более четко понять, для чего именно необходим тот или иной параметр. Текстовое содержание свойства «description» выводится в виде небольшого плавающего окна (tooltip) в административной панели модуля, при наведении указателя мыши на наименование параметра. При этом пунктирная линия под наименованием параметра показывает, что для него есть краткое описание - «description».

В XML файле используется еще один параметр, который служит только для оформления внешнего вида административной части модуля. Этот параметр имеет имя @spacer. Он позволяет вывести горизонтальную разделительную черту на страницу настроек модуля в админпанели. Используется совместно со свойством type="spacer".

Пример использования параметра @spacer в XML файле модуля:

<param name="@spacer" type="spacer" default="" label="" description="" />

===============================
© 2008 Соловьев И. В. (ArtWebMaster)
Дата создания и публикации статьи на сайте Joomla4All.ru : 04.05.2008 г.

Форма быстрой связи

С помощью этой формы Вы можете быстро сделать заказ сайта или задать нам вопрос.









Ответьте пожалуйста

Как Вы нашли наш сайт?