Центр документации
Карта сайта

Создай визитку сам!


Самоучитель по интеграции дизайна и настройке Amiro.CMS на примере демонстрационной версии пакета Визитка »


Объявление модуля

Для того, чтобы экземпляр модуля стал "известен" системе, его необходимо объявить (задекларировать) в файле "_local/modules/declaration/declares.php".

Объявление модуля выполняется с использованием методов класса AMI_ModDeclarator:

$oDeclarator = AMI_ModDeclarator::getInstance();

Пример объявления модуля:

$oDeclarator->startConfig('modules');
$oDeclarator->register('ami_clean', 'ami_sample', 'inst_sample_module', '', AMI_ModDeclarator::INTERFACE_ADMIN | AMI_ModDeclarator::INTERFACE_FRONT);

Эти строки добавляют экземпляр модуля ami_sample, наследника гипермодуля ami_clean, в раздел modules (Модули Управления) с идентификатором inst_sample_module.

Четвертый параметр - идентификатор родительского экземпляра. В данном случае, этот параметр пустой.

Последний параметр - область "видимости" модуля.
Допустимые значения:
AMI_ModDeclarator::INTERFACE_ADMIN - панель управления;
AMI_ModDeclarator::INTERFACE_FRONT - публичная часть сайта. 

Объявление дочернего модуля:

$oDeclarator->register('ami_clean', 'ami_sample', 'inst_sample_submodule', 'ami_sample_module', AMI_ModDeclarator::INTERFACE_ADMIN);

Эта строка добавляет экземпляр модуля с идентификатором inst_sample_submodule в качестве дочернего для inst_sample_module.

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

$oDeclarator->setAttr('inst_sample_module', 'sample_attribute', 'attribute_value');

Атрибуты модуля доступны практически в любой точке входа и могут быть получены с использованием метода AMI_ModDeclarator::getAttr

AMI_ModDeclarator::getInstance()->getAttr('inst_sample_module', 'sample_attribute');

Главные модули раздела обязаны иметь атрибуты id_pkg и id_install, подробнее эти атрибуты будут описаны в разделе "Заготовки кода деклараций и настроек модуля".

Важно

Записи объявления модуля добавляются в этот файл автоматически при установке модуля из дистрибутива.
Ручное изменение этого файла допускается лишь в крайнем случае.
Подробнее о подготовке шаблона объявления модуля в дистрибутиве будет рассказано в разделе "Заготовки кода деклараций и настроек модуля".

Установка и настройка Руководство пользователя Интеграция дизайна Разработчикам (API)
 2000 – 2019 © Amiro.CMS Все права защищены.