[modHelpers] Версия 3.2.0

С небольшим опозданием публикую новость о новой версии modHelpers. В ней появился менеджер ответов (Response Manager), файл пользовательских настроек, улучшены функции chunk() и snippet(), а также все классы библиотеки теперь соответствуют стандарту PSR-4 и загружаются через загрузчик композера. Теперь по порядку.

Менеджер ответов

Менеджер ответов (откликов) формирует ответ на запрос пользователя и отправляет его в браузер. По большей части он предназначен для работы в API режиме. Регистрируется он при инициализации MODX и доступен в любом месте приложения. Для работы с ним предназначена функция response(). Менеджер наследует соответствующий класс библиотеки Symfony.

Существует нисколько типов ответов. Перечислю основные:

• Обычный ответ (класс Response). Используется для вывода текстовой информации.
• JSON ответ (класс JsonResponse). Предназначен для вывода массива в JSON формате.
• Файловый ответ (класс BinaryFileResponse). Вид ответа для вывода и скачивания файлов.

Список основных методов перечислен в документации. Наглядно посмотреть как это работает можно в этом видео.

Функции chunk() и snippet()

Теперь в качестве названия файла можно указывать относительный путь. Начинаться он должен с "./". Базовый путь берётся из настроек:

• modhelpers_chunks_path для чанков. По-умолчанию в ней указан путь core/elements/chunks/.
• modhelpers_snippets_path для сниппетов. По-умолчанию в ней указан путь core/elements/snippets/.

//Обычный чанк MODX
$output = chunk('myChunk', $placeholders); 
// Файловый чанк с полным путём
$output = chunk(MODX_CORE_PATH . 'chunks/myChunk.tpl', $params);
// Файловый чанк с относительным путём
$output = chunk('./myChunk.tpl', $params);

Файл настроек

В этой версии добавлен файл config/config.php, который возвращает массив системных настроек. Он позволяет без использования админки менять и добавлять настройки. Это особенно удобно при разработке и тестировании. Вы можете менять настройки в зависимости от условий.

$settings = [];
// Для разработчиков включаем режим отладки
if (app('modx')->user->isMember('Developers')) {
    $settings['debug'] => true;
}
return $settings;

Классы

Классы теперь соответствуют стандарту PSR-4. Для этого пришлось привести в соответствие имена классов и файлов. Теперь не нужно беспокоиться об их загрузке, композер их подгрузит автоматически при первом обращении. Это справедливо и в случае добавления пользовательских классов, расширяющих базовые классы библиотеки.

Надеюсь, я всё понятно объясняю. :)