pdoTools для MODx

Общие сведения

pdoTools — это набор удобных инструментов (сниппетов) для повседневной работы. Дополнительно включает небольшую библиотеку, которая увеличивает скорость работы сниппета.

Cистема построена на собственной ORM под названием xPDO. Она очень упрощает работу, позволяет писать один универсальный код для разных БД, и еще много чего.

Особенности:

• Быстрая работа с БД (запросы составляются на xPDO, а выбираются без объектов — на PDO).
• Предварительная обработка простых плейсхолдеров в чанках (парсер MODX задействован только при работе со сложными вызовами.
• Код чанков можно указывать прямо при вызове сниппета, загружать обычным образом или из статичных файлов.
• Предусмотрена сортировка, подготовка, обработка и вывод ТВ параметров.
• Ведение подробного журнала работы сниппета с отметками времени, для отладки.
• Возможность загрузки классов и множество функций, которые можно применять в своих разработках.
• Встроенный шаблонизатор Fenom в версии 2.0
• В настоящее время в комплект входит 10 универсальных сниппетов (со временем появляются новые инструменты)

Набор универсальных сниппетов:

• pdoResources — инструмент для выборки ресурсов (очень быстрая замена для getResources, совместимая по параметрам). Он поддерживает почти все его возможности, и бладает особенностями:
  — подключение других таблиц через разные JOIN
  — можно указывать, что именно выбирать из колонок таблиц
  — гибкие условия выборки, вплоть до указания чистого SQL
• pdoMenu — инструмент для постоения различных меню (замена для Wayfinder)
• pdoUsers — выборка и вывод пользователей сайта, с фильтрацией по ролям и группам.
• pdoCrumbs — генерация хлебных крошек (замена BreadCrumb).
• pdoSitemap — генерация карты сайта (очень быстрая замена GoogleSiteMap
• pdoNeighbors — инстумент вывода ссылок на соседние документы.
• pdoField — инструмент получающий любое поле ресурса или его родителя, включая ТВ параметр. Имеет возможность вывода по умолчанияю. Отличная замена getResourcesField и UltimateParent.
• pdoPage — постраничный вывод результатов (замена getPage).
• pdoTitle — выводит оформленный тег title на страницу сайта, который состоит из имени страницы, имён родителей этой страницы и, других параметров. Предназначен для визульного различия документов с постраничной навигацией.
• pdoArchive — предназначен для вывода архива документов сайта с разбивкой на годы, месяцы и дни.

Классы pdoTools

Ядро компонента разделено на 3 класса: общий pdoTools, работа с БД - pdoFetch и работа с оформлением, то есть pdoParser.

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

$pdoTools = $modx->getService('pdoTools');
$pdoFetch = $modx->getService('pdoFetch');
$pdoParser = $modx->getService('pdoParser');

pdoFetch наследует pdoTools, так что не нужно вызывать эти два класса вместе. Если вы хотите работать с БД, вызывайте один Fetch, а если нет - Tools.

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

Установка pdoTools осуществляется стандартным образом из официального репозитория modx.com или c modstore.pro

Общие параметры для сниппетов, основанных на pdoTools/pdoFetch.

Параметры выборки ресурсов

Эти параметры определяют, какие объекты будут получены.

Параметры шаблонов

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

Параметры результатов

Эти параметры дополнительно определяют, какие данные и каким способом будут выводиться.

Способы вызова чанков

Все чанки могут иметь один из следующих префиксов:

@INLINE или @CODE. В качестве шаблона будет использован код после этого префикса.

    [[!pdoResources?
    &parents=`0`
    &tpl=`@INLINE <li>{{+pagetitle}}</li>`
]]

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

Поэтому для INLINE чанков предусмотрена замена [[+]] на {{+}} - такие теги MODX пропускает, а pdoTools при работае конвертирует их как нужно. Конечно, вы всё равно можете использовать теги MODX, если вам нужно, чтобы в чанк попала уже обработанная информация, например:

    [[!pdoResources?
    &parents=`0`
    &tplFirst=`@INLINE Текущая страница: [[*pagetitle]]`
    &tpl=`@INLINE <p>{{+id}} - {{+pagetitle}}<p>`
]]

@FILE. Вместо чанка из базы данных используется содержимое файла. Путь до файла указывается в систеной настройке pdotools_elements_path. Имя файла должно быть с расширением .tpl или .html.

    [[!pdoResources?
    &tpl=`@FILE fileBasedRow.tpl`
]]

@TEMPLATE. Указывается идентификатор или имя шаблона. Если пусто - для каждого ресурса будет использован его собственный шаблон.

    [[!pdoResources?
    &tpl=`@TEMPLATE 10`
]]

@CHUNK. Аналогично простому указанию имени чанка, оставлено для совместимости со сторонними сниппетами.

    [[!pdoResources?
    &tpl=`@CHUNK tpl.Resource.row`
]]
[[!pdoResources?
    &tpl=`tpl.Resource.row`
]]

Возвращаемые значения

pdoTools умеет возвращать данные в разном виде, в зависимости от параметр &return. В основном это используют сами сниппеты для внутренних нужд, но вы можете указывать &return в pdoResources:

    [[!pdoResources?
    &parents=`0`
    &return=`json`
]]

• chunks - оформленные чанки, по умолчанию.
• sql - подготовленный сырой SQL, полезно для отладки. Сам запрос не выполняется, только выводится на экран.
• data - готовый массив данных. Из-за особенностей работы сниппетов MODX этот вариант имеет смысл использовать только при вызове pdoFetch::run() напрямую из своего сниппета, в противном случае вы получите только строку "Array".
• ids - возвращает только идентификаторы документов, через запятую. Удобно для подстановки в качестве параметра другим сниппетам. Параметр &returnIds использует именно этот тип.
• json - возврат массива данных JSON строкой.
• serialize - возврат массива данных сериализованной строкой. Иногда, по непонятным причинам, может вызвать нехватку памяти. Лучше использовать json.

Ссылки по теме

• Описание сниппетов от авторов - https://docs.modx.pro/komponentyi/pdotools