Параметри

    Ditto: Параметри

    Параметри сніпета 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=``