Центр документации
|
Самоучитель по интеграции дизайна и настройке Amiro.CMS на примере демонстрационной версии пакета Визитка »
Модуль представляет собой совокупность кода, шаблонов, файлов локализаций (языковых переменных), изображений иконок модулей/спецблоков и таблиц в базе данных. Начиная с версии 5.14.6 Amiro.CMS вводятся понятия "Гипермодуль", "Конфигурация гипермодуля" и "Экземпляр модуля". Для сокращения трудозатрат на разработку модуля используется генератор решений. Гипермодуль - кодовая и шаблонная основа модуля. Содержит код MVC компонент модуля, настройки и шаблоны. Модуль, так же именутся как Конфигурация гипермодуля - наследник гипермодуля (либо другого модуля), содержит дополнения к функционалу, шаблонам и настройкам, именуемые конфигурацией гипермодуля, необходимые для создания экземпляров модуля конкретного типа. Экземпляр модуля - экземпляр определенной конфигурации гипермодуля, устанавливаемый в систему. Каждый экземпляр модуля имеет уникальное имя-идентификатор, рекомендуется именовать все устанавливаемые экземпляры модулей с префиксом "inst_", например "inst_sample". Например, "Новости" -
это экземпляр модуля "Новости" с идентификатором news, "Дневник" - это
экземпляр модуля "Блог" с идентификаторм blog. Код модуля В качестве родительских классов новой конфигурации гипермодуля рекомендуется использовать гипермодуль "Базовый гипермодуль" (AmiClean), содержащий весь минимально необходимый функциональный набор классов модуля. Имена классов гипермодуля AmiClean имеют вид Hyper_AmiClean_*, имена классов наследников именуются как AmiClean_{$modNameCamelCase}_*. Например:
Код модуля разбит на несколько файлов, расположенных в каталоге "_local/modules/code":
Шаблоны экземпляра модуля Шаблоны экземпляра модуля доступны по путям "_local/_admin/templates/modules" (панель управления) и "templates/modules" (сайт). Шаблоны экземпляра модуля для панели управления - это набор шаблонов компонент экземпляра модуля, которые имеют имена вида {$modId}_{$componentType}.tpl Шаблоны экземпляра модуля для отображения на сайте - это шаблон с именем {$modId}.tpl с которым работают все основные компоненты экземпляра модуля. При необходимости, отдельные компоненты экземпляра модуля могут работать и с собственными шаблонами, в таком случае именование шаблонов компонент аналогично именованию шаблонов компонент экземпляра модуля для панели управления.
Файлы языковых переменных экземпляра модуля
Изображения Иконка модуля, изображение спеблокам и иконки действий списка модуля находятся по пути "_local/_admin/images/{$modId}". Таблицы в базе данных Для того чтобы минимизировать изменения в коде модели, рекомендуется именовать таблицу в виде "cms_{$modId}", а поля таблицы именовать в соответствии со стандартным набором полей, принятым системными модулями Amiro.CMS Структура таблицы экземпляра модуля inst_sample:
|