Что такое QuickCrumbs
QuickCrumbs – сниппет, позволяющий быстро и эффективно работать с компонентами для MODx Revolution. Он поддерживает tpl чанки для работы с крамбами (crumbs), обладает настраиваемым разделителем и т.д.
История разработки
Разрабатывается с 11 октября 2010 Джейсоном Ковардом (Jason Coward).
Системные требования
- MODX Revolution
Разработка & отчеты об ошибках
ModDef разрабатывается на Github.
Сниппет QuickCrumbs вызывается с помощью тега:
|
4141 |
Вызов без задания свойства &tpl будет просто возвращать массив, содержащий Ресурсы (Resource) и соответствующие им поля.
Доступные свойства
В сниппете доступны следующие свойства.
Свойства шаблона
Имя |
Описание |
Значениепоумолчанию |
tpl |
Имя чанка (Chunk), выступающего шаблоном для крамба ресурса (Resource crumb). ВНИМАНИЕ: Если значение не задано, свойства выдаются в виде префикса для каждого крамба. |
|
siteStartTpl |
Необязательный Чанк (Chunk), служащий шаблоном для site_start. |
Если не задано, берется из *tpl*. |
selfTpl |
Необязательный Чанк (Chunk), служащий шаблоном для текущего крамба ресурса (Resource crumb). |
Если не задано, берется из *tpl*. |
outerTpl |
Необязательный Чанк (Chunk), шаблон-упаковщик для завершения вывода данных крамба. |
По умолчанию – пусто, выдается «как есть». |
Свойства Crumb Selection
Имя | Описание | Значение по умолчанию |
fields | Список полей, отобранных из ресурсов в качестве плейсхолдеров. ВНИМАНИЕ:id, class_key, и context_keyвыбираются всегда. | По умолчанию 'pagetitle,menutitle,description' |
showSiteStart | Указывает, следует ли создавать крамб (crumb) представляющий ресурс site_start. | По умолчанию 1 (или true). |
showSelf | Указывает, следует ли создавать крамб (crumb) представляющий текущий ресурс. | По умолчанию 1 (или true). |
Дополнительные свойства
Имя | Описание | Значение по умолчанию |
separator | Строковая переменная, используемая в качестве разделителя между крамбами (crumbs). | По умолчанию `»` |
toPlaceholder | Если заполнено, выходные данные сохраняются в плейсхолдер с заданным именем, а не непосредственно в сниппет. | По умолчанию не заполнено. |
debug | Если true, отладочная информация будет отправлена в лог MODx. | По умолчанию 0 (или false). |
Свойства Parent-Titles
Имя | Описание | Значение по умолчанию |
parentTitlesPlaceholder | Если заполнено, pagetitles всех родительских крамбов объединяются и формируются в сниппет с заданным именем для использования в контенте Ресурса. | По умолчанию не заполнено. |
parentTitlesReversed | Указывает, следует ли выводить родительские pagetitles в реверсивном порядке. | По умолчанию 0 (или false). |
titleSeparator | Разделитель между pagetitles, используемых в parentTitlesPlaceholder. |
Сниппет QuickCrumbs вызывается с помощью тега:
|
<code></code> 4141 |
Вызов без задания свойства &tpl будет просто возвращать массив, содержащий Ресурсы (Resource) и соответствующие им поля.
Доступные свойства
В сниппете доступны следующие свойства.
Свойства шаблона
Имя | Описание | Значениепоумолчанию |
tpl | Имя чанка (Chunk), выступающего шаблоном для крамба ресурса (Resource crumb). ВНИМАНИЕ: Если значение не задано, свойства выдаются в виде префикса для каждого крамба. | |
siteStartTpl | Необязательный Чанк (Chunk), служащий шаблоном для site_start. | Если не задано, берется из *tpl*. |
selfTpl | Необязательный Чанк (Chunk), служащий шаблоном для текущего крамба ресурса (Resource crumb). | Если не задано, берется из *tpl*. |
outerTpl | Необязательный Чанк (Chunk), шаблон-упаковщик для завершения вывода данных крамба. | По умолчанию – пусто, выдается «как есть». |
Свойства Crumb Selection
Имя | Описание | Значение по умолчанию |
fields | Список полей, отобранных из ресурсов в качестве плейсхолдеров. ВНИМАНИЕ:id, class_key, и context_keyвыбираются всегда. | По умолчанию 'pagetitle,menutitle,description' |
showSiteStart | Указывает, следует ли создавать крамб (crumb) представляющий ресурс site_start. | По умолчанию 1 (или true). |
showSelf | Указывает, следует ли создавать крамб (crumb) представляющий текущий ресурс. | По умолчанию 1 (или true). |
Дополнительные свойства
Имя | Описание | Значение по умолчанию |
separator | Строковая переменная, используемая в качестве разделителя между крамбами (crumbs). | По умолчанию `»` |
toPlaceholder | Если заполнено, выходные данные сохраняются в плейсхолдер с заданным именем, а не непосредственно в сниппет. | По умолчанию не заполнено. |
debug | Если true, отладочная информация будет отправлена в лог MODx. | По умолчанию 0 (или false). |
Свойства Parent-Titles
Имя | Описание | Значение по умолчанию |
parentTitlesPlaceholder | Если заполнено, pagetitles всех родительских крамбов объединяются и формируются в сниппет с заданным именем для использования в контенте Ресурса. | По умолчанию не заполнено. |
parentTitlesReversed | Указывает, следует ли выводить родительские pagetitles в реверсивном порядке. | По умолчанию 0 (или false). |
titleSeparator | Разделитель между pagetitles, используемых в parentTitlesPlaceholder. |