Общая схема объектов API и точки входа Amiro.CMS

Диаграмма взаимодействия объектов Amiro.CMS

На данный момент предлагаются 2 основные точки входа для размещения собственного кода:

1. Отдельно стоящий PHP скрипт
2. Плагин (plugin) для Amiro.CMS

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

Отдельно стоящий PHP скрипт — это файл, содержащий пользовательский PHP код, использующий возможности API Amiro.CMS. Данную точку входа можно использовать для получения данных браузером в виде HTML, JSON или прочем формате посредством Amiro.JS.API или другой AJAX-библиотеки; для создания скриптов, выполняемых в фоновом режиме (например, генерация отчетов, обмен данными и т.п.). В текущей версии API скрипту недоступно кеширование, по этой причине не следует нагружать скрипты тяжелым функционалом с частыми вызовами, т.к. это вызовет неоптимальную загрузку сервера. Amiro.CMS ведет учет времени выполнения скрипта и при превышении им заданной величины – в системный лог записывается предупреждение. Различные способы, типы использования и способы создания своего кода описаны в API.Reference/ Environment setting up entry point [English]

Плагин (Plugin) для Amiro.CMS — это набор из одного или нескольких модулей, спецблоков для Amiro.CMS, который может быть представлен в виде дистрибутива для автоматической установки в систему. Плагины могут распространяться в качестве самостоятельных дистрибутивов и с мастером установки через панель управления. Плагины автоматически кешируются системой.

Создание плагина подробно описано в соответствующем руководстве: Разработка и установка плагинов

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

При разработке, следует помнить, что результаты работы как отдельно стоящего скрипта, так и плагина могут кешироваться внутренним кешем Amiro.CMS. Механизмы отладки шаблонов и отключения кеширования рассмотрены в главе «Средства Отладки Amiro.CMS»

        3.1 Режимы работы отдельно стоящего скрипта

Для запуска отдельно стоящего скрипта, необходимо подключить файл ami_env.php, находящийся в корне сайта. Для управления режимом работы можно указать параметры подключения в массиве $AMI_ENV_SETTINGS.

Допустимые значения массива и их расшифровка:

Пример:

$AMI_ENV_SETTINGS = array(
  "response_type" => "JSON",
  "response_buffered" => "false",
);
require 'ami_env.php';
...

Дополнительные примеры способов запуска и инициализации отдельно стоящих скриптов рассмотрены в API.Reference/ Environment setting up entry point [English]