Ditto: Параметры

Формат: Имя конфигурационного файла
Значение по умолчанию: default
Примечание: Файл конфигурации может включать значения различных параметров Ditto, избавляя от неудобств, связанных с ограничениями, накладываемыми MODX на значения параметров сниппетов (нельзя использовать &, `, <enter> т.п.). Файлы конфигурации сохраняются в папке &ditto_base/configs/. Их имена имею формат &config.config.php

Пример:

&config=``

Формат: Любой валидный формат времени, который соответствует правилам функции PHP - strftime
Значение по умолчанию: [LANG]
Примечание: Определяет формат времени, которое выводится с помощью плейсхолдера

Пример:

&dateFormat=`%d.%m.%Y`

Формат: Время в формате UNIX timestamp из поля MODX или TV-параметра
Значение по умолчанию: createdon
Примечание: Любое значение времени в формате UNIX timestamp из поля MODX или TV-параметра, как например createdon, pub_date, or editedon.

Пример:

&dateSource=`pub_date`

Формат: 0 | 1
Значение по умолчанию: 0
Примечание: Режим отладки позволяет разобраться в сложных и непонятных ситуациях. Особенно актуальная возможндость для крупных сайтов, где множество вызовов Ditto могут конфликтовать между собой. При включенном режиме отладки помимо результатов работы выводится множество полезной для разработчика информации (все параметры, список документов результата, их ID и т.п.).

Пример:

&debug=`1`

Формат: число
Значение по умолчанию: 1
Примечание: Число уровней в глубину для поиска документов. Документы будут найдены внутри документов-контейнеров, указанных в &startID и &parents и вложенных документов-контейнеров до уровня указанного в &depth. Т.е. если этот параметр равен 1, то будут брать только непосредственно дочерние документы, указанных в &startID и &parents. Если &depth = 2, в поиск пройдет еще и в дочерних.

Пример:

&depth=`5`

Формат: число | all
Значение по умолчанию: 3
Примечание: all - все документы

Пример:

&display=`10`

Формат: путь
Значение по умолчанию: [(base_path)]assets/snippets/ditto/
Примечание: Папка со слэшем на конце, указывающая размещение фалов Ditto на сервере. Как правило этот параметр изменять не приходится.

Пример:

&ditto_base=``

Формат: ID документов, через запятую
Значение по умолчанию: нет
Примечание: Этот параметр должен сожержать список ID'ов тех документов, которые будут отображены в результатах. Т. е. можно жестко задать список документов, которые будут отображаться.

Пример:

&documents=`1, 35, 122`

Формат: Расширения через запятую
Значение по умолчанию: нет
Примечание: Указывает Ditto, какие расширения следует загрузить. Пример расширения с комментариями (на английском) можно найти по пути: &ditto_base/extenders/example.extender.inc.php. Все расширения находятся в папке &ditto_base/extenders/ и имена файлов имеют формат: name.extender.inc.php.

Пример:

&extenders=`summary`

Формат: поле,критерий,тип сравнения
Значение по умолчанию: NULL
Примечание: Используется формат `поле,критерий,тип сравнения` с запятой между значениями.
Список фильтров:
По умолчанию: NULL
Типы сравнения:
1 - != (не соответствует критерию)
2 - == (соответствует критерию)
3 - < (меньше критерия)
4 - > (больше критерия)
5 - <= (меньше или равен критерию)
6 - >= (больше или равен критерию)
7 - (не содержит текст критерия)
8 - (содержит текст критерия)
9 - case insenstive version of #7
10 - case insenstive version of #8
11 - checks leading character of the field
Может содержать несколько запросов, разделенных глобальным разделителем |.

Пример:

&filter=`id,10,2|id,20,2`

Формат: html | json | xml | atom | rss
Значение по умолчанию: html
Примечание: Ditto умеет работать с различными форматами данных. Например, он может выводить RSS ленту новостей или данные в XML формате.

Пример:

&format=`rss`

Формат: Любой сивол, который не будет использоваться в правиле фильтра
Значение по умолчанию: |
Примечание: Задает значение разделителя для параметра &filter.

Пример:

&globalFilterDelimiter=``

Формат: Любое название параметра MODX или TV-параметра, перечисленные через запятую.
Значение по умолчанию: NULL
Примечание:

Пример:

&hiddenFields=``

Формат: 0 | 1
Значение по умолчанию: 0
Примечание:

Пример:

&hideFolders=`1`

Формат: 0 | 1
Значение по умолчанию: 1
Примечание:

Пример:

&hidePrivate=`0`

Формат: Числа или буквы английского алфавита. Строка чувствительна к регистру.
Значение по умолчанию: нет
Примечание: Уникальный идентификатор нужен главным образом тогда, когда необходимо использовать более одного вызова Ditto на странице, причем актуален этот параметр тогда, когда для более чем одного вызова Ditto используются глобальные плэйсхолдеры.
К примеру, Вы выводите на одной странице спосок новостей и список последних публикаций, причем оба списка имеют пэйджер. Если Вы вставите дважды [+pages+], то оба пэйджера будут управлять двумя списками сразу. Это во-первых. А во-вторых оба пэйджера буду отражать страницы первого списка. Т.е. когда MODX обработает первый вызов, он заменит оба плэйсхолдера [+pages+] на это значение. А список страниц второго списка ни куда не попадет.
Так вот в таком случае, следует использовать для каждого вызова Ditto свой id. А глобальные плэйсхолдеры примут вид [+id_placeholder+]. Символ подчеркивания между идентификатором и названием плэйсхолдера добавится автоматически.

Пример:

&id=`nav`

Формат: 0 | 1
Значение по умолчанию: 0
Примечание: Используется как [+keywords+] или источник tagData.

Пример:

&keywords=`1`

Формат: Название языкового файла
Значение по умолчанию: english
Примечание: В языковых файлах Ditto хранятся шаблоны, используемые по-умолчанию, описания ошибок и уведомления.
Ditto сначала загружает свой стандартный языковой файл, а уже после этого тот файл, что указан в данном параметре. Таким образом, если в файле указанном пользователем нет какой-либо строки, она будет использована из стандартного файла. Примечание. Языковые файлы находятся в папке &ditto_base/lang/. Имена имею формат: &language.inc.php

Пример:

&language=`russian-UTF8`

Формат: Любой сивбол, который не будет использоваться в параметре фильтра
Значение по умолчанию: ,
Примечание:

Пример:

&localFilterDelimiter=``

Формат: Любой текст или название чанка
Значение по умолчанию: LANG
Примечание:

Пример:

&noResults=`Документы не найдены`

Формат: Разделенный запятыми список
Значение по умолчанию: createdon DESC
Примечание: Взамен &sortBy и &sortDir.

Пример:

&orderBy=`pagetitle ASC`

Формат: Список ID через запятую
Значение по умолчанию: Текущий документ
Примечание: Указывает Ditto список идентификаторов (id) документов-контейнеров, откуда будут браться документы для вывода Ditto. Документы беруться до глубины &depth.

Пример:

&parents=`1, 5, 8`

Формат: 0 | 1
Значение по умолчанию: 1
Примечание: В Ditto имеетвы встроенный парсер PHx. Эта опция включает / выключает его.

Пример:

&phx=`0`

Формат: число
Значение по умолчанию: 0
Примечание: 0 - нет ограничения

Пример:

&queryLimit=``

Формат: 0 | 1
Значение по умолчанию: 0
Примечание: Остерегайтесь кэшированных вызовов!

Пример:

&randomize=`1`

Формат: Любое название чанка, которое используется при выводе
Значение по умолчанию: NULL
Примечание: Обычно используется для удаления комментариев

Пример:

&removeChunk=``

Формат: 0 | 1 | 2 | 3
Значение по умолчанию: 0
Примечание: 0 - off; returns output
1 - remaining; returns output
2 - all;
3 - all; returns ph only

Пример:

&save=`3`

Формат: 0 | 1
Значение по умолчанию: 0
Примечание: Используется если глубина (&depth) больше 1

Пример:

&seeThruUnpub=`1`

Формат: 0 | 1
Значение по умолчанию: 0
Примечание:
0 - показывать все документы
1 - показывать только документы у которых поставлен флаг «Показывать в меню»

Пример:

&showInMenuOnly=`1`

Формат: 0 | 1
Значение по умолчанию: 1
Примечание:
0 - показывать только неопубликованные документы
1 - показывать только опубликованные документы

Пример:

&showPublishedOnly=`0`

Формат: число
Значение по умолчанию: 0
Примечание:

Пример:

&start=`5`

Формат: число | all
Значение по умолчанию: all
Примечание:

Пример:

&total=`10`

Формат: Любое валидное выражение MySQL WHERE
Значение по умолчанию: NULL
Примечание: Используется только для параметров документов. Не поддерживает TV-параметры.

Пример:

&where=``