modx_SimpleCatalog

Сниппет modx_SimpleCatalog предназначен для вывода простых каталогов(не имеющих вложенных) из собственных источников данных (таблиц.)

Установка сниппета

Modx сниппет SimpleCatalog для своей корректной работы требует установку плагина, задачей которого является подмена заголовка и описания страницы на данные из источника( к примеру мы выводим новости и нам необходимо чтобы заголовок новости и был заголовком страницы).

Примеры вызова

[!SimpleCatalog? &table=`sd_news` &tableId=`id` &tplRow=`news_tplRow` &addSlash=`thumb` &itemLink=`/module/infoline/news%d.html` &count=`10` &pager=`1` &pPath=`/module/infoline/` &pFileName=`news_page%d.html` &pNextImg=`След.` &pPrevImg=`Пред.` &dateField=`date` &dateFormat=`d.m.Y` &truncText=`text` &desc=`1`!]

Параметры вызова

Параметр Описание Default
??сточник данных
table ??мя таблицы используемой как источник данных null
tableId ??мя ключевого поля таблицы null
renderer ??мя класса исользуемого для формирования вывода 'Default'
tableSelect Выражение подставляемое в дерективу "SELECT <tableSelect>" '*'
tableWhere

Выражение подставляемое в дерективу "WHERE <tableWhere>"

Примечание: Для вставки знака "=" используеться специальная последовательность символов [eq]

null
tableOrderBy Выражение подставляемое в дерективу "ORDER BY <tableOrderBy>" null
seoTitle ??мя поля таблицы значение которого будет подставлятся в тег <title></title> при расширенном выводе информации. false
seoDesc ??мя поля таблицы значение которого будет формировать мета тег description при расширенном выводе информации. Если длина значения поля более 500 символов, то произойдёт автоматическое сокращение текста до 500 символов. false
Управляющие параметры
count Количество выводимых записей. Если установлен параметр pager, то значение параметра count указывает количество записей выводимых на одной странице 0
desc Флаг указывающий на вывод расширенного описания если переданна переммая в GET c именем указанным в параметре getParamId false
itemLink Путь к странице с расширенным описанием. ??меет служебную комбинацию %d которая заменяеться на значение ключевого поля записи. Если указать ещё один %d то он будет заменён на номер текущей страницы(например /news%d_page%d.html) '/defWay%d.html'
getParamId имя GET параметра который используеться для передачи ключа записи. По значению этого параметра и ищется запись для вывод расширенного описания. 'scId'
getParamPage имя GET параметра который используеться для передачи номера страницы. 'scPage'
Разбитие на страницы
pager Флаг включения выключения разбития на страницы

Значения : 1,0

false
pPath Это значение опции 'path' обьекта Pager null
pFileName Это значение опции 'fileName' обьекта Pager null
pNextImg Это значение опции 'nextImg' обьекта Pager. Это подпись указывающая на следующую страницу. '>>'
pPrevImg Это значение опции 'prevImg' обьекта Pager. Это подпись указывающая на предыдущую страницу. '<<'
Операции со значениями
addSlash Список имён полей разделённых запятой к значению которых добавляеться '/'. Это параметр используеться для полей в которых храняться пути к файлам. Например если поле хранит значение 'assets/images/45/photo.jpg', то после модификации будет '.assets/images/45/photo.jpg' null
truncText

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

Примечание: Через запятую можно указать необходимое число символов по умолчанию этот параметр равен 200

null
dateField ??мя поля в котором храниться дата. 'date'
dateFormat

Формат в котором необходимо вывести дату. Смотрите описание формата функции date.

Примечание:При задание данного параметра в значение параметра dateField должно быть указанного корректное имя поля в котором находиться значение даты. ?? тип поля должен быть либо Date либо Datetime

null
Шаблоны
tplContainer Шаблон контейнера списка записей см. ниже
tplRow Шаблон одной записи в списке записей см. ниже
tplItem Шаблон расширенного вывода информации. см. ниже

Служебные placeholders

Список записей

  • [+sc.link+] - ссылка на расширенное описание
  • [+sc.linkWithPage+] - ссылка на расширенное описание параметр страницы добавляеться в конце как GET параметр

Расширенное описание

  • [+sc.page+] - номер страницы с которой пришли (если был передан чере GET)
  • [+sc.pageFull+] - параметр с номером страницы для подставноки в строку GET параметров (если был передан чере GET)

Шаблоны

tplContainer

<div class="catalogContainer">
    [+sc.pager+]
     <div class="catalog">[+sc.content+]
     <div class="clear">&nbsp;</div> 
     </div> 
     [+sc.pager+]
</div>

tplRow

<div class="item">
    <a href="[+sc.link+]">[+sc.name+]</a>&nbsp;&nbsp;([+sc.date+])
</div>

tplItem

<div id="item">
<h3>[+name+]</h3>
<div>[+text+]</div>
<br />
<a href="/[~[*id*]~]?[+sc.pageFull+]">К списку новостей</a>
</div>