AJAX-части плагинов в Cotonti Siena

техническое руководство (фактическое описание, основано по-большей части из старой документации разработчиков Cotonti.)

1. Общий принцип работы AJAX-частей

В архитектуре Cotonti Siena AJAX-обработчики реализуются через части плагина (plugin parts), которые используют hook ajax.

Фактические свойства таких частей:

• выполняются как самостоятельный обработчик запроса

• вызываются через plug.php

• используются для AJAX-запросов

• не выполняют стандартный вывод страницы (шаблон сайта)

Документация Cotonti указывает:

• AJAX-часть плагина должна использовать hook ajax

• она вызывается через параметр r в plug.php

• стандартный вывод страницы не используется

2. URL вызова AJAX-части

AJAX-обработчик вызывается через:

где:

— код плагина.

При таком вызове Cotonti:

1. определяет код плагина

2. ищет plugin parts

3. выполняет часть с hook ajax

Документация подтверждает, что при вызове могут подключаться файлы:

или другой файл плагина, объявленный как AJAX-часть.

3. Расположение файлов

AJAX-части находятся в каталоге плагина:

или:

Имя файла не фиксировано.

Единственное требование — наличие hook ajax.

4. Заголовок AJAX-части

Каждая часть плагина содержит служебный блок расширения.

Пример:

Факты:

• Hooks=ajax регистрирует файл как AJAX-часть

• defined('COT_CODE') используется для защиты от прямого запуска файла

5. Поведение header.php и footer.php

В режиме AJAX Cotonti изменяет процесс вывода страницы.

Фактическое поведение:

• header.php и footer.php не выводятся

• но могут подключаться системой для внутренней инициализации

Это сделано для сохранения совместимости с кодом системы.

Таким образом:

6. Определение AJAX-режима

Cotonti автоматически определяет AJAX-запрос.

В системе устанавливается константа:

Если запрос выполнен через AJAX:

Если обычный HTTP-запрос:

Это значение доступно во всех частях системы.

Пример использования:

7. Обработка параметров запроса

В Cotonti принято использовать функцию:

Она выполняет:

• чтение параметров

• фильтрацию

• приведение типов

Пример:

Параметры:

8. Формат ответа AJAX-части

Cotonti не ограничивает формат ответа.

Разработчик может вернуть:

• JSON

• HTML

• текст

• XML

Документация указывает, что система не содержит специальных API для JSON/XML, так как PHP уже предоставляет необходимые функции.

Пример JSON-ответа

Пример HTML-ответа

9. Пример реальной AJAX-части плагина

Пример обработчика:

Фактические операции:

1. чтение параметра code

2. SQL-запрос

3. формирование массива

4. возврат JSON

Такой пример используется в официальном руководстве разработки плагинов.

10. Вызов AJAX-части через JavaScript

AJAX-часть может вызываться через jQuery или обычный JavaScript.

Пример:

Это пример из документации Cotonti.

11. Параметр безопасности x

При отправке данных необходимо передавать параметр защиты:

Он содержит значение функции:

Этот параметр используется:

Пример POST:

Документация описывает этот параметр как anti-XSS защиту.

12. AJAX-helpers в Cotonti

Cotonti содержит клиентские вспомогательные инструменты.

Главная функция:

Она:

• собирает данные формы

• выполняет AJAX-запрос

• поддерживает GET и POST

Пример:

Функция описана в разделе AJAX helpers.

13. Автоматическая AJAX-навигация

Cotonti поддерживает автоматическую AJAX-навигацию интерфейса.

Условия:

• включён jQuery

• включён AJAX в настройках системы

После этого:

на ссылке или форме активирует AJAX-загрузку.

Пример:

Результат загружается в контейнер:

Это стандартный контейнер AJAX-вывода.

14. AJAX-режим в модулях

В Cotonti Siena AJAX поддерживается не только в плагинах.

Начиная с версии:

AJAX-режим может использоваться:

• в плагинах

• в модулях

Система автоматически устанавливает COT_AJAX для асинхронных запросов.

15. Фактические выводы

Актуальные свойства AJAX-частей в Cotonti Siena:

1. AJAX-обработчик реализуется как plugin part с hook ajax.

2. Вызывается через plug.php?r=plugin_code.

3. Файл может иметь любое имя, если объявлен с Hooks=ajax.

4. Стандартный вывод страницы не выполняется.

5. Система определяет AJAX-режим через константу COT_AJAX.

6. Ответ может быть любого формата (JSON, HTML, текст).

7. Для получения данных используется cot_import().

8. Для защиты форм используется параметр x (sourcekey).

9. На клиентской стороне доступна вспомогательная функция ajaxSend().

10. AJAX-режим может использоваться в плагинах и модулях системы.

Все перечисленные пункты собраны из по-большей части старой документации разработчиков Cotonti.