Как уже говорилось в статье «Изготовление модуля для CMS Joomla», все параметры, которые разработчик хочет использовать для настройки своего модуля, прописываются в XML файле. В данной статье речь как раз и пойдет о том, как именно прописываются эти параметры в XML файле и какие свойства они имеют.
В XML файле модуля все необходимые параметры помещаются между тегами
Каждый параметр может быть прописан в XML файле различными способами. Все зависит от того, что это за параметр, как мы хотим использовать его в дальнейшем, в каком виде он должен быть представлен пользователю в административной части и т.д. Пример описания простейшего параметра:
В ряде случаев, параметр может быть прописан так, что его выходные данные смогут принять только какое-то одно фиксированное значение. Это делается с помощью «радио-кнопок» или выпадающих списков. Конструкция описания параметра при этом сильно видоизменяется, а сами фиксированные значения прописываются в тегах «option». Например:
В данном примере, пользователь сможет задать параметру «item_title» только одно из двух, заранее определенных разработчиком модуля значений — 0 или 1. Свойству «default» в такой конструкции необходимо присвоить одно из опциональных значений «value». В приведенном примере default=»0″, значит при первом пуске административной части модуля, указатель «option» будет установлен в положение «Нет».
Каждый параметр модуля должен иметь обязательное свойство «name», которое служит идентификатором этого параметра. Значение этого свойства должно быть уникальным. Так же параметр должен быть дополнительно описан с помощью ряда свойств, таких как «type» — тип, «default» — значение параметра по умолчанию, «label» — наименование параметра и «description» — описание параметра.
Помимо основных свойств, параметр может содержать еще ряд дополнительных. Некоторые из них нужны лишь для изменения внешнего вида поля, в которое пользователь будет вводить данные, некоторые служат дополнением к типу параметра. Все свойства параметра актуальны лишь в административной части модуля. Для программного скрипта модуля они никокого значения не несут.
Пример использования дополнительных параметров в XML файле модуля:
Здесь свойства «cols» и «rows» определяют только ширину и высоту многострочного поля для ввода текста — «textarea» в административной части модуля.
Теперь давайте рассмотрим, какие свойства можно задавать параметрам в XML файле.
Свойство «name» — имя параметра.
Как уже говорилось, свойство «name» это идентификатор параметра, с помощью которого мы можем получить его значение в процессе выполнения скрипта модуля.
Имена для параметров модуля устанавливает разработчик в процессе его создания. Однако существуют еще зарезервированный CMS Joomla список имен параметров, которые служат для строго определенных целей. Это имена системных параметров.
moduleclass_sfx — это суффикс, который будет автоматически присоединен Joomla (Джумлой) ко всем CSS классам данного модуля, при его выводе на страницу сайта.
Пример использования параметра moduleclass_sfx в XML файле модуля:
сache — позволяет принудительно включить/отключить кэширование модуля.
Пример использования параметра cache в XML файле модуля:
|
Теги:
|
Честно скажу вот этих параметров зарезервированных joomla очень не хватает так как это очень интересно, где эти параметры хранятся, записываются они в бд или нет, их использование. Есть небольшие описания, но в целом темы раскрытой нет. В родных компонентах можно подсмотреть как и что там работает и использовать это у себя, но вопросы остаются.