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


Новая документация

Настройка платежных систем
Настройка способа оплаты КупиВкредит
Настройка способа оплаты Acquiro
Настройка способа оплаты AvisoSMS

Обновленная документация 

Разработчикам (API)
Руководство пользователя

Мета-данные модуля

Для того, чтобы модуль мог быть установлен в систему с помощью инструментальных средств CMS, необходимо снабдить модуль специальным Meta-файлом, содержащим набор предустановочных параметров.

Мета-данные хранятся в файле {$hyper}_{$config}_Meta.php, который представляют собой PHP класс, наследник AMI_HyperConfig_Meta.

Например, "_local/modules/code/AmiClean_AmiSample_Meta.php":

class AmiClean_AmiSample_Meta extends AMI_HyperConfig_Meta{
 
    protected $version = '1.0';
 
 
    protected $aTitle = array(
        'en' => 'Sample module',
        'ru' => 'Тестовый модуль'
    );
    protected $aInfo = array(
        'en' => array(
            'description' => 'Sample AmiClean base hypermodule configuration',
            'author'      => '<a href="http://www.amirocms.com" target="_blank">Amiro.CMS</a>'
        ),
        'ru' => array(
            'description' => 'Тестовая конфигурация базового гипермодуля AmiClean',
            'author'      => '<a href="http://www.amiro.ru" target="_blank">Amiro.CMS</a>'
        )
    );
    protected $aCaptions = array(
        'en' => array(
            '' => array(
                'header' => array(
                    'Header',
                    'SAMPLE MODULE',
                    self::CAPTION_OBLIGATORY,
                    self::CAPTION_TYPE_STRING
                ),
                'menu' => array(
                    'Menu caption',
                    'Sample Module',
                    self::CAPTION_OBLIGATORY,
                    self::CAPTION_TYPE_STRING
                ),
                'description' => array(
                    'Admin interface start page module description',
                    'Sample instance of AmiClean base hypermodule / AmiSample configuration',
                    self::CAPTION_OPTIONAL,
                    self::CAPTION_TYPE_TEXT
                ),
                'specblock' => array(
                    'First specblock caption for Site Manager',
                    'First specblock',
                    self::CAPTION_OBLIGATORY,
                    self::CAPTION_TYPE_STRING
                ),
                'specblock:custom' => array(
                    'Second specblock caption for Site Manager',
                    'Second specblock',
                    self::CAPTION_OBLIGATORY,
                    self::CAPTION_TYPE_STRING
                )
            )
        ),
        'ru' => array(
            '' => array(
                'header' => array(
                    'Заголовок',
                    'ПРИМЕР МОДУЛЯ',
                    self::CAPTION_OBLIGATORY,
                    self::CAPTION_TYPE_STRING
                ),
                'menu' => array(
                    'Заголовок для меню',
                    'Пример модуля',
                    self::CAPTION_OBLIGATORY,
                    self::CAPTION_TYPE_STRING
                ),
                'description' => array(
                    'Описание модуля для стартовой страницы интерфейса администратора',
                    'Пример экземпляра модуля конфигурации AmiSample базового гипермодуля AmiClean',
                    self::CAPTION_OPTIONAL,
                    self::CAPTION_TYPE_TEXT
                ),
                'specblock' => array(
                    'Название первого спецблока для менеджера сайта',
                    'Первый спецблок',
                    self::CAPTION_OBLIGATORY,
                    self::CAPTION_TYPE_STRING
                ),
                'specblock:custom' => array(
                    'Название второго спецблока для менеджера сайта',
                    'Второй спецблок',
                    self::CAPTION_OBLIGATORY,
                    self::CAPTION_TYPE_STRING
                )
            )
        )
    );
}

Свойства класса:

Свойство
Тип
Описание
$versionstringВерсия кода модуля, в формате "N.NN" обязательное
$aTitlearrayНаименование модуля
$aInfoarrayИнформация о модуле и разработчике
$aCaptionsarrayЗаголовки по умолчанию для различных структурных элементов модуля
$isSingleInstanceboolЕсли true, то возможно установить лишь один экземпляр данного модуля
   

В качестве ключей свойств, отвечающих за заголовки, используется индекс локализации. Например, ru - русская локализация, en - английская локализация.

Флаги self::CAPTION_OBLIGATORY / self::CAPTION_OPTIONAL означают обязательность/необязательность заполнения заголовка, self::CAPTION_TYPE_STRING / self::CAPTION_TYPE_TEXT - тип поля в интерфейсе менеджера модулей (строка или многострочное текстовое поле).

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