Что такое modx сниппет
Основы движка MODX — чанки, сниппеты и плейсхолдеры
Рассмотрим базовые элементы движка MODX — чанки, сниппеты и плейсхолдеры. Они являются неотъемлемой частью сайтов на этой CMS, поэтому следует четко понимать их отличие и назначение. Посмотрим следующую схему:
Чанки
Чанк это мини-шаблон для отдельного блока сайта. Например, требуется для разных страниц использовать разные шаблоны, а шапка сайта должна быть одинаковой. В таком случае её лучше вынести в отдельный чанк и подключить его в нужных шаблонах. При необходимости поправить код шапки, не придется редактировать все имеющиеся шаблоны. Достаточно будет поправить один чанк.
Чанки могут быть вложены друг в друга, содержать сниппеты и плейсхолдеры:
Сниппеты в modx revo
Сниппет — это программный код (PHP,SQL,XPDO), в результате выполнения которого возвращается результат (аналог функций в PHP). Чаще всего результатом является html код, но это не обязательно. Например, он может произвести действия с базой данных и при этом ничего не вывести на экран. Вызываться сниппет может в шаблоне, чанке и даже в содержимом ресурса:
В примере используется стандартный вариант вызова сниппета с кешированием. В этом режиме при первом обращении к сниппету результат его работы кешируется, а при последующих обращениях — выдается сохраненный результат. Такой способ вызова ускоряет время генерации страницы и может применяться к элементам сайта, которые не требуют моментального обновления. Например, главное меню сайта, которое изменяется редко. Для запрета кеширования перед названием ставится восклицательный знак:
В MODX чаще всего используют готовые сниппеты, входящие в состав установленных компонентов (пакетов), но для лучшего понимания принципов их работы создадим свой.
Передача параметров сниппету
Создадим сниппет «CountChar», который будет в качестве параметров получать строку и цвет, а на выходе выдавать количество букв в строке и выделять это число указанным цветом.
В коде сниппета получаем параметры. При этом, можно задать значение, которое будет присваиваться переменной, если параметр не указывался (», ‘black’). Далее производим вычисления и возвращаем результат.
Передача плейсхолдеров в чанк
Мы реализовали задуманное, но при этом нарушили негласное правило — смешали программный код и теги оформления. Если кому-то потребуется обернуть результат не в тег «span», а в «div», то могут возникнуть проблемы. Конечно, хорошо когда в коде всего десять строк, а если их будет тысяча? Для избежания таких проблем отделим «мух от котлет».
Создадим чанк «tplCountChar», внутрь которого поместим плейсхолдеры:
Осталось доработать сам сниппет. Разбирать его подробно не будем, так как он содержит в себе комментарии:
Результат работы: 11 символов!
Запуск сниппета из сниппета
Про тонкости разработки сниппетов в MODX Revolution можно написать целую книгу, поэтому я ограничусь ещё только одной «фишкой» — возможностью запускать из своего сниппета сторонние. При создании сайтов такой функционал будет требоваться крайне редко, поэтому считайте эту информацию лишь небольшим бонусом.
Синтаксис вызова отличается от используемого в чанках или шаблонах, но результат будет тот же самый.
Плейсхолдеры в MODX
Есть ещё системные плейсхолдеры. Они берутся из системных настроек MODX и доступны для вызова в любом месте сайта:
Таких переменных насчитывается несколько десятков, но большинство из них не требуется при разработке сайта.
Сниппеты MODx
Сниппеты MODx, что это такое? Давайте поговорим об этом в данной статье, разберемся, что это такое, как это работает и некоторые другие полезные фичи, которые можно реализовать.
Общее представление
Сниппеты – это элемент, с помощью которого MODx позволяет вставлять динамический PHP-код в любое место на ваших страницах. Они являются основным средством разработки для большинства веб-мастеров.
Что такое сниппет?
Согласно одному из определений, «сниппет» – это «короткий многократно используемый фрагмент исходного кода». Некоторым людям трудно отличить сниппет от чанка. Но в процессе работы различия будут видны (можете посмотреть, что такое чанк).
Как они работают?
Большинство сниппетов кэшируются, это означает, что они хранятся как временная динамическая функция в кэше. Если они помечены как некэшируемые, то они не анализируются до тех пор, пока синтаксический анализатор не выполнит все другое кэшированное содержимое.
Вот простой пример того, как может выглядеть сниппет:
Если вы назвали сниппет “helloWorld», вы можете вызвать этот сниппет с помощью [[helloWorld]] в ресурсах, шаблонах или чанках. Можно, также, вызвать сниппет из другого сниппета.
Передача значений в сниппет
Значения передаются в сниппет с помощью измененной нотации типа веб-формы CGI, которая следует за именем сниппета. Если Ваш сниппет был назван «mySnippet», вы можете вызвать его, используя следующий код:
[[!mySnippet? &input=`Hello World`]]
И код для Вашего сниппета, допустим, выглядит так:
Обратите внимание: имена переменных в вызывающем коде должны точно совпадать с именами переменных в сниппете. Во-вторых, не забывайте ‘&’ перед именами переменных. Обратите внимание: обратные, а не одиночные кавычки!
Чтение переменных в сниппетах
Например, если Вы вызываете сниппет с помощью такого кода:
Взаимодействие с базой данных в сниппетах
Доступ на уровне базы данных в MODx опирается на Object Relational Model (ORM), вызывает xPDO для подключения к базе данных, так что вам не придется писать необработанных запросов к базе данных, что пришлось бы сделать в других CMS. Обычно, вы будете использовать данные из базы, используя несколько объектов MODx и методов, таких как getobject и getCollection. Это зависит от базовой платформы xPDO.
Понятие и особенности MODx сниппетов.
Как хорош бы не был ваш МЛМ сайт, достигнуть его посещаемости и продвинуть его в топ поисковиков без сниппетов вам не удастся. Использование сниппетов сегодня — обыкновенное явление, но лишь при его грамотном выполнении будут прослеживаться результаты.
Итак, что из себя представляет сниппет?
Сниппет — это выделенные куски кода PHP, за счёт которых на ваш MODx сайт добавляется функциональность. Более точное определение сниппетов звучит так: это отклик MODx сайта на внутренний код. Благодаря им на поисковой странице отображаются такие элементы динамического контента, как меню, блоги, какие-либо списки и любая информация, которая проходит обработку непосредственно на вашем сайте.
При помощи сниппетов пользователь может узнать и ознакомиться с навигацией по сайту, галереей, формой контактов и любым другим контентом.
Репозиторий MODx имеет свойство постоянно пополнять свои шаблоны, созданными профессионалами и опытными разработчиками. Однако, вы также можете создать свой собственный сниппет с желаемым функционалом. Все зависит лишь от вашего знания PHP и MODx.
Как поставить сниппет на MODx Revolution?
В Revolution все гораздо проще и легче. Вам не придется писать код, а просто достаточно зайти в раздел менеджера сайта, затем в «System» => «Package Management», после чего нажать на кнопку «Download Extras». После этого необходимо выбрать нужный сниппет и загрузить его на сервер.
Простейший вызов сниппета MODx.
Данный шаг выполняется в том случае, когда необходимые сниппеты уже загружены на сайт. Вызов сниппета целесообразно совершать в том месте или на той странице, где вам не хватает функциональности. Основной синтаксис, используемый для вызова сниппета: [[SpinnetName]]. В том случае, если вам необходим некешируемый сниппет, необходимо и достаточно поставить перед базовой синтаксической командой восклицательный знак: [[!SpinnetName]].
Однако, простого базового вызова сниппета будет не достаточно для получения желаемой функциональности. Чтобы получить необходимый результат, сниппеты предполагают использование обязательных и необязательных свойств. Так, во многих случаях сниппеты даю возможность самостоятельно выбрать стиль и шаблон для своего вывода.
Большая часть сниппетов, которые есть в репозитории MODx, отлично задокументированы, поэтому целесообразно заглядывать в раздел MODx документации. На форумах MODx каждый отдельно созданный сниппет имеет собственный раздел, в котором можно обсудить все вопросы с разработчиками и опытными сотрудниками. Поэтому, данные форумы способны решить почти любую проблему, ведь вы определенно не первый, у кого она возникла.
Ранее я писал о том, как выглядит сайт в поисковиках и как влияет на это сниппеты.
Процесс создания MODx сниппета.
Условно говоря, незачем каждый раз переписывать код в HTML. Достаточно научиться работать с шаблонами, процесс создания которых можно описать так:
В итоге, MODx Revolution не создает каких-либо ограничений при работе, однако, дает полноценную возможность увидеть и воплотить ваше представление о внешнем виде сайта и о его функциональности.
Написание сниппетов
Общее представление¶
Что такое сниппет?¶
Как они работают?¶
Большинство сниппетов кэшируются, то есть они хранятся как временная динамическая функция в кэше. Если они помечены как некэшированные, они не анализируются, пока синтаксический анализатор не выполнит все остальное кэшированное содержимое.
Простой пример¶
Вот базовый пример того, как может выглядеть код сниппета:
Если вы назвали этот сниппет «helloWorld», вы можете вызвать его, используя [[helloWorld]] в ваших документах, шаблонах или чанках (см. Синтаксис тегов). Вы также можете вызвать сниппет из другого сниппета, используя метод API runSnippet.
Передача значений в сниппет¶
Значения передаются в ваш сниппет с использованием модифицированной нотации типа веб-формы CGI, которая следует за именем сниппета. Если ваш сниппет был назван «mySnippet», вы можете вызвать его, используя что-то вроде этого:
И код вашего сниппета может выглядеть примерно так:
Обратите внимание, что имена переменных в вызывающем бите должны точно соответствовать именам переменных в сниппете (регистр имеет значение, т.е. ‘input’, а не ‘INPUT’ или ‘Input’. Во-вторых, не забывайте «&» перед потенциальными именами переменных. И, наконец, что не менее важно, обратите внимание, что это обратные кавычки, а не одинарные кавычки!
Чтение значений в ваших сниппетах¶
В общем, вы можете прочитать ваши значения, сославшись на переданные аргументы: &someParameter в вызове преобразуется в $someParameter в коде PHP.
Вы также можете прочитать все параметры, используя встроенный массив $scriptProperties. Это полезно, если ваш сниппет принимает переменные параметры, т.е. он обрабатывает тот же вариант использования, что и PHP-функция func_get_args().
Например, если вы вызываете свой сниппет следующим образом:
Тогда массив $scriptProperties будет содержать следующее:
Взаимодействие с базой данных в сниппетах¶
Доступ к слою базы данных в MODX основан на объектно-реляционной модели (ORM), называемой xPDO для подключения к базе данных, поэтому, чаще всего, вам не придется писать необработанные запросы к базе данных, как вы могли бы делать в других CMS. Обычно вы получаете доступ к данным из базы данных, используя несколько объектов и методов MODX, таких как getObject и getCollection. Это зависит от базовой структуры xPDO.
Почему ОРМ?¶
Вы можете спросить, зачем использовать ОРМ вместо простого SQL? Ну, хотя бы несколько причин ниже:
Есть и другие причины, но это для краткости. Давайте посмотрим на несколько примеров:
Пример кода БД¶
Давайте возьмем чанк с названием LineItem и изменим в нем плейсхолдеры (выполненные с помощью синтаксиса [[+placeholderName]]) на некоторые пользовательские значения:
Дальнейшие подробности о работе с базой данных¶
Чтобы узнать больше о xPDO, прочитайте следующее:
Рекомендуемые методы и советы¶
Пишите свои сниппеты за пределами менеджера MODX¶
Начиная с 2.2.0, вы можете просто добавить «статический» сниппет: просто сослаться на статический файл.
Вы можете использовать сниппет ‘include’ на странице, например:
И запускайте свои cниппеты извне, пока вы их разрабатываете!
Помните, что любой сниппет в файле на вашем веб-сайте может выполнить любой, у кого есть веб-браузер, поэтому не оставляйте его на живом сайте, если вы не разместили код сниппета вне корневого веб-каталога таким образом, чтобы файл не мог быть доступным через Интернет. В MODX Revolution вы можете поместить файлы сниппетов в основной каталог и переместить весь каталог за пределы корневого веб-каталога. Вы также можете поместить тест в сниппет, который заставляет его завершиться, если сниппет не работает внутри MODX. Однако безопаснее всего просто переместить файл или вставить код в сниппет в менеджере и удалить файл.
Не пытайтесь смешивать коды PHP и HTML в сниппете¶
Сниппеты выполняют PHP-код. Они всегда должны начинаться с Нельзя смешивать PHP и HTML в сниппете!
** Например, следующий код работать не будет:
Вы обнаружите, что MODX будет добавлять теги PHP в начало и конец сниппета, создавая неверный синтаксис, например:
Не работайте с работающими сниппетами¶
Если вы пишете новые версии сниппетов, продублируйте старую версию! Таким образом, вы можете вернуться к старой версии кода, если что-то работает неправильно! MODX по своей сути не управляет версиями, поэтому вы должны сделать резервную копию кода самостоятельно.
Используйте свойства по умолчанию¶
Попробуйте добавить свойства по умолчанию для вашего сниппета на вкладку «Свойства», чтобы другой разработчик мог добавить пользовательские наборы свойств для их переопределения.
Написание сниппетов
Общее представление¶
Что такое сниппет?¶
Как они работают?¶
Большинство сниппетов кэшируются, то есть они хранятся как временная динамическая функция в кэше. Если они помечены как некэшированные, они не анализируются, пока синтаксический анализатор не выполнит все остальное кэшированное содержимое.
Простой пример¶
Вот базовый пример того, как может выглядеть код сниппета:
Если вы назвали этот сниппет «helloWorld», вы можете вызвать его, используя [[helloWorld]] в ваших документах, шаблонах или чанках (см. Синтаксис тегов). Вы также можете вызвать сниппет из другого сниппета, используя метод API runSnippet.
Передача значений в сниппет¶
Значения передаются в ваш сниппет с использованием модифицированной нотации типа веб-формы CGI, которая следует за именем сниппета. Если ваш сниппет был назван «mySnippet», вы можете вызвать его, используя что-то вроде этого:
И код вашего сниппета может выглядеть примерно так:
Обратите внимание, что имена переменных в вызывающем бите должны точно соответствовать именам переменных в сниппете (регистр имеет значение, т.е. ‘input’, а не ‘INPUT’ или ‘Input’. Во-вторых, не забывайте «&» перед потенциальными именами переменных. И, наконец, что не менее важно, обратите внимание, что это обратные кавычки, а не одинарные кавычки!
Чтение значений в ваших сниппетах¶
В общем, вы можете прочитать ваши значения, сославшись на переданные аргументы: &someParameter в вызове преобразуется в $someParameter в коде PHP.
Вы также можете прочитать все параметры, используя встроенный массив $scriptProperties. Это полезно, если ваш сниппет принимает переменные параметры, т.е. он обрабатывает тот же вариант использования, что и PHP-функция func_get_args().
Например, если вы вызываете свой сниппет следующим образом:
Тогда массив $scriptProperties будет содержать следующее:
Взаимодействие с базой данных в сниппетах¶
Доступ к слою базы данных в MODX основан на объектно-реляционной модели (ORM), называемой xPDO для подключения к базе данных, поэтому, чаще всего, вам не придется писать необработанные запросы к базе данных, как вы могли бы делать в других CMS. Обычно вы получаете доступ к данным из базы данных, используя несколько объектов и методов MODX, таких как getObject и getCollection. Это зависит от базовой структуры xPDO.
Почему ОРМ?¶
Вы можете спросить, зачем использовать ОРМ вместо простого SQL? Ну, хотя бы несколько причин ниже:
Есть и другие причины, но это для краткости. Давайте посмотрим на несколько примеров:
Пример кода БД¶
Давайте возьмем чанк с названием LineItem и изменим в нем плейсхолдеры (выполненные с помощью синтаксиса [[+placeholderName]]) на некоторые пользовательские значения:
Дальнейшие подробности о работе с базой данных¶
Чтобы узнать больше о xPDO, прочитайте следующее:
Рекомендуемые методы и советы¶
Пишите свои сниппеты за пределами менеджера MODX¶
Начиная с 2.2.0, вы можете просто добавить «статический» сниппет: просто сослаться на статический файл.
Вы можете использовать сниппет ‘include’ на странице, например:
И запускайте свои cниппеты извне, пока вы их разрабатываете!
Помните, что любой сниппет в файле на вашем веб-сайте может выполнить любой, у кого есть веб-браузер, поэтому не оставляйте его на живом сайте, если вы не разместили код сниппета вне корневого веб-каталога таким образом, чтобы файл не мог быть доступным через Интернет. В MODX Revolution вы можете поместить файлы сниппетов в основной каталог и переместить весь каталог за пределы корневого веб-каталога. Вы также можете поместить тест в сниппет, который заставляет его завершиться, если сниппет не работает внутри MODX. Однако безопаснее всего просто переместить файл или вставить код в сниппет в менеджере и удалить файл.
Не пытайтесь смешивать коды PHP и HTML в сниппете¶
Сниппеты выполняют PHP-код. Они всегда должны начинаться с Нельзя смешивать PHP и HTML в сниппете!
** Например, следующий код работать не будет:
Вы обнаружите, что MODX будет добавлять теги PHP в начало и конец сниппета, создавая неверный синтаксис, например:
Не работайте с работающими сниппетами¶
Если вы пишете новые версии сниппетов, продублируйте старую версию! Таким образом, вы можете вернуться к старой версии кода, если что-то работает неправильно! MODX по своей сути не управляет версиями, поэтому вы должны сделать резервную копию кода самостоятельно.
Используйте свойства по умолчанию¶
Попробуйте добавить свойства по умолчанию для вашего сниппета на вкладку «Свойства», чтобы другой разработчик мог добавить пользовательские наборы свойств для их переопределения.