Сниппеты — это мощная функция MODX, которая позволяет добавлять свой PHP-код на сайт. Они могут использоваться для создания динамического контента, выполнения вычислений или различных запросов. В этой статье мы покажем вам, как создавать пользовательские сниппеты в MODX.

Навигация по статье

Что такое сниппет

Сниппет — это блок PHP-кода, который может быть вызван из MODX для выполнения определенной функции. Сниппеты могут использоваться для динамической генерации контента, выполнения пользовательских запросов или выполнения вычислений. Сниппеты работают все время пока запущен сайт и могут быть вызваны из шаблонов или ресурсов.

Вот несколько примеров того, как сниппеты используются в MODX:

Проверка формы: Сниппет может быть использован для проверки введенных пользователем данных в форме, гарантируя, что все обязательные поля заполнены и что входные данные представлены в правильном формате.
Изменение размера изображения: Сниппет можно использовать для автоматического изменения размера изображений до определенного размера, гарантируя, что они быстро загружаются и оптимизированы для отображения на разных устройствах.
Меню сайта: С помощью сниппета можно создавать меню, которое выделяет определенные страницы или контент на сайте.
Аутентификация пользователя: Сниппеты используются для управления функциями аутентификации пользователя и входа в систему, гарантируя, что только авторизованные пользователи смогут получить доступ к определенному контенту или функциям на сайте.
Интеграция с базой данных: Сниппеты помогают в интеграции MODX с внешней базой данных, что позволяет осуществлять более сложное управление данными и манипуляции с ними.

Создание кастомных сниппетов

Чтобы создать свой сниппет в MODX, выполните следующие действия:

Войдите в MODX manager и перейдите во вкладку «Элементы».
Нажмите кнопку «Создать сниппет».

Введите имя и описание для сниппета.
Добавьте PHP-код для сниппета в поле «Код сниппета».
Настройте любые дополнительные параметры для сниппета.
Сохраните сниппет.

Вот пример простого пользовательского фрагмента, который отображает текущую дату:

<?php
return date('Y-m-d');
?>

Чтобы вызвать этот фрагмент из ресурса или шаблона, используйте следующий вызов фрагмента:

[[!customSnippet]]

Замените «customSnippet» на название вашего сниппета.

Передача параметров сниппету

В MODX передача параметров сниппету — это способ настроить его поведение и выходные данные на основе различных значений или входных данных. Параметры могут быть переданы фрагменту несколькими способами:

Изначально заданные значения:

Параметры могут быть заданы непосредственно в вызове сниппета:

[[mySnippet?param1=value1&param2=value2]]

В этом примере mySnippet — это имя фрагмента, а param1 и param2 — это имена параметров с их соответствующими значениями.

Поля ресурсов

Параметры также могут быть переданы с использованием значений из определенного поля ресурсов:

[[mySnippet?param1=`[[*resource_field]]`]]

Это код передаст значение поля resource_field в качестве параметра param1 в фрагмент mySnippet.

Системные настройки

Параметры также могут быть переданы с использованием значений из системных настроек:

[[mySnippet?param1=`[[++system_setting_key]]`]]

Этот код передаст значение системного параметра system_setting_key в качестве параметра param1 в фрагмент mySnippet.

Получение доступа к параметрам

Как только параметры переданы фрагменту, к ним можно получить доступ в коде сниппета, используя метод $modx->getOption(). Например, чтобы получить значение параметра param1 в коде фрагмента, вы могли бы использовать этот код:

$param1 = $modx->getOption('param1', $scriptProperties, 'default_value');

В этом коде param1 — это имя параметра, ScriptProperties — это массив всех параметров, переданных фрагменту, а default_value — значение по умолчанию, которое используется, если параметр не указан.

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

Пример передачи параметров в сниппет

Вот более пример того, как использовать параметры в сниппете MODX:

Допустим, у вас есть фрагмент под названием mySnippet, который принимает два параметра: num1 и num2. Цель сниппета состоит в том, чтобы сложить эти два числа вместе и вернуть результат. Вот как может выглядеть фрагмент кода:

<?php
$num1 = $modx->getOption('num1', $scriptProperties, '');
$num2 = $modx->getOption('num2', $scriptProperties, '');

if (!is_numeric($num1) || !is_numeric($num2)) {
    return 'Error: Invalid input';
}

$result = $num1 + $num2;

return $result;
?>

В этом коде мы используем метод getOption для извлечения значений параметров num1 и num2 из массива $ScriptProperties. Если эти значения не являются числовыми, мы возвращаем сообщение об ошибке. В противном случае мы складываем два числа вместе и возвращаем результат.

Чтобы вызвать этот фрагмент и передать значения для num1 и num2, вы должны использовать следующий код:

[[mySnippet?num1=5&num2=10]]

Это вызвало бы фрагмент mySnippet с num1, равным 5, и num2, равным 10. Фрагмент кода сложит эти два числа вместе и вернет результат, который в данном случае будет равен 15.

Заключение

Пользовательские сниппеты — это мощная функция MODX, которая может помочь вам добавить дополнительную функциональность на ваш сайт. Изучив основы, вы можете создать свои собственные пользовательские фрагменты и начать использовать их в шаблонах и ресурсах. Благодаря возможности передавать параметры вы можете сделать свои фрагменты еще более универсальными и полезными.