Сниппет

    multiTV: Сниппет

    Параметры и примеры использования сниппета multiTV.

    Сниппет multiTV отображает содержимое переменной multiTV. Разместите примерно такой вызов сниппета. Параметр &tvName обязателен. Остальные параметры в случае если используются значения по умолчанию, могут быть удалены.

    [!multiTV?
    &tvName=`yourMultiTVname`
    &docid=`[*id*]`
    &tplConfig=``
    &outerTpl=`@CODE:<ul>((wrapper))</ul>`
    &rowTpl=`@CODE:<li>((event)), ((location)), ((price))</li>`
    &display=`5`
    &offset=`0`
    &rows=`all`
    &randomize=`0`
    &reverse=`0`
    &orderBy=``
    &toPlaceholder=``
    &toJson=`0`
    &published=`1`
    &emptyOutput=`1`
    &noResults=``
    &outputSeparator=``
    &firstClass=`first`
    &lastClass=`last`
    &evenClass=``
    &oddClass=``
    &paginate=`0`
    &offsetKey=`page`
    &prepare=``
    &prepareWrap=``
    !]

    Параметры

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

    Формат: TV-параметр
    Значение по умолчанию: пусто
    Примечание: Обязательный параметр. Имена столбцов multiTV будут получены из конфигурационного файла
    Пример:
    &tvName=`yourMultiTVname`
    Формат: id документа
    Значение по умолчанию: Id текущего документа
    Примечание: Необходим при вызове в шаблоне Ditto.
    Пример:
    &docid=``
    Формат:
    Значение по умолчанию: нет
    Примечание: Будет с префиксом templates
    Пример:
    &tplConfig=``
    Формат: имя чанка | @FILE | @CODE
    Значение по умолчанию: @CODE:
    Примечание: Имя чанка, имя файла (должно начинаться с @FILE) или код (должно начинаться с @CODE - плэйсхолдеры должны быть в двойных скобках (( и )). (Примечание 3)
    Пример:
    &outerTpl=``
    Формат: имя чанка | @FILE | @CODE
    Значение по умолчанию: @CODE:
    Примечание: Имя чанка, имя файла (должно начинаться с @FILE) или код (должно начинаться с @CODE - плэйсхолдеры должны быть в двойных скобках (( и )). (Примечание 3)
    Пример:
    &rowTpl=``
    Формат: число | all
    Значение по умолчанию: 5
    Примечание: all - показать все
    Пример:
    &display=`all`
    Формат: число
    Значение по умолчанию: 0
    Примечание:
    Пример:
    &offset=`5`
    Формат: число | all
    Значение по умолчанию: all
    Примечание:
    Пример:
    &rows=`1,2`
    Формат: 0 | 1
    Значение по умолчанию: 0
    Примечание: Отключает параметры reverse и orderBy
    Пример:
    &randomize=`1`
    Формат: 0 | 1
    Значение по умолчанию: 0
    Примечание: Отключает orderBy параметр
    Пример:
    &reverse=`1`
    Формат: name:type direction
    Значение по умолчанию: name:text asc
    Примечание: Тип может быть text или date
    Пример:
    &orderBy=``
    Формат: имя плейсхолдера
    Значение по умолчанию: нет
    Примечание: Будет создан плейсхолдер с именем, указанным в значении параметра [+element+]. Отдельные элементы выводятся плейсхолдерами, где к имени добавляется номер строки [+element.1+]. Нормальный вывод сниппета подавляется.
    Пример:
    &toPlaceholder=`myPlaceholder`
    Формат: 0 | 1
    Значение по умолчанию: 0
    Примечание:
    Пример:
    &toJson=`1`
    Формат: 0 | 1 | 2
    Значение по умолчанию: 1
    Примечание: отображать только multiTV из опубликованных (1), неопубликованных (0) или любых (2) документов
    Пример:
    &published=`2`
    Формат: 0 | 1
    Значение по умолчанию: 1
    Примечание:
    Пример:
    &emptyOutput=`0`
    Формат: имя чанка | @FILE | @CODE
    Значение по умолчанию: нет
    Примечание:
    Пример:
    &noResults=`noResults`
    Формат: строка
    Значение по умолчанию: пусто
    Примечание:
    Пример:
    &outputSeparator=``
    Формат: имя класса
    Значение по умолчанию: first
    Примечание: Содержимое плейсхолдера row.class для первого элемента
    Пример:
    &firstClass=``
    Формат: имя класса
    Значение по умолчанию: last
    Примечание: Содержимое плейсхолдера row.class у последнего элемента
    Пример:
    &lastClass=``
    Формат: имя класса
    Значение по умолчанию: нет
    Примечание: Содержимое плейсхолдера row.class для четных элементов
    Пример:
    &evenClass=`even`
    Формат: имя класса
    Значение по умолчанию: нет
    Примечание: Содержимое плейсхолдера row.class для нечетных элементов
    Пример:
    &oddClass=`odd`
    Формат: 0 | 1
    Значение по умолчанию: 0
    Примечание:
    Пример:
    &paginate=`1`
    Формат:
    Значение по умолчанию: page
    Примечание:
    Пример:
    &offsetKey=``
    Формат: &where=``
    Значение по умолчанию:
    Примечание:
    Пример:
    &where=`{"title":"Lorem ipsum"}`
    Формат: &prepare=``
    Значение по умолчанию:
    Примечание:
    Пример:
    &prepare=`prepareRow,prepareRowAgain`
    Формат: &prepareWrap=``
    Значение по умолчанию:
    Примечание:
    Пример:
    &prepareWrap=`prepareRow,prepareRowAgain`

    Плейсхолдеры rowTpl

    ИмяОписание
    "fieldname" может быть использовано каждое поле, определенное в конфигурации
    iteration содержит номер текущего элемента multiTV
    row.number содержит номер строки текущего элемента multiTV
    row.class 'first' - для первой отображенной строки, 'last' - для последней отображенной строки
    row.total содержит количество всех отображаемых строк
    docid значение параметра docid или id текущего документа

    Плейсхолдеры outerTpl

    ИмяОписание
    wrapper место вывода всех строк
    rows.offset содержит количество строк от начала, которые не отображаются
    rows.total содержит количество всех отображаемых строк
    docid значение параметра docid или id текущего документа
    pagination содержит постраничное разбиение, если параметр включен