ArchivistGrouper

Последнее обновление not available | История страницы | Улучшить эту страницу | Сообщить о проблеме

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$204 per month—let's make that $500!

Learn more

Дополнение Articles 1.6.1 поставлялось с Archivist 1.2.3, поэтому сниппет ArchivistGrouper теперь входит в Archivist. Автор ещё не опубликовал документацию, но доступные параметры сниппета найдены в коде.

Описания в таблице ниже предположительные. Их стоит проверить или уточнить тем, кто знает сниппет лучше, или автору.

Использование¶

Разместите сниппет там, где нужен список архивов. Укажите родителей, из которых брать архивы.

[[!ArchivistGrouper? &parents=`12`]]

Доступные параметры¶

Имя	Описание	По умолчанию
mode	Режим группировки: month или year	month
itemTpl	Chunk для каждого элемента внутри группы
parents	Список ID родителей через запятую.
target	Ресурс, на котором вызывается getArchives и отображаются результаты фильтра архива.
depth	Глубина поиска ресурсов от каждого родителя.	10
where
hideContainers		true
sortBy	Поле для сортировки и группировки результатов.	publishedon
sortDir	Направление сортировки. По умолчанию DESC.	DESC
dateFormat	Формат даты по синтаксису MySQL DATE_FORMAT() для каждой строки. Если пусто, ArchivistGrouper вычислит его автоматически.
limitGroups	Ограничивает число возвращаемых групп.	12
limitItems	Ограничивает число возвращаемых элементов. 0 означает без лимита?	0
resourceSeparator		\n
groupSeparator		\n
filterPrefix	Префикс GET-параметров в ссылках Archivist. Должен совпадать с filterPrefix в вызове getArchives.	arc_
useFurls	Если true, ссылки генерируются в формате Friendly URL.	true
persistGetParams		false
extraParams
cls	CSS-класс для каждой строки.	arc-resource-row
altCls	CSS-класс для каждой чередующейся строки.	arc-resource-row-alt
setLocale	Если true, Archivist вызывает setlocale с вашим cultureKey, если cultureKey не «en».	true
groupTpl	Chunk для каждого результата по месяцу или году.	yearContainer (при mode=`year`)
		monthContainer (при mode=`month`)

Почти все описания совпадают с параметрами на странице Archivist.

Chunks¶

Если шаблоны не заданы, используются значения по умолчанию. Чтобы понять, как сделать свой шаблон для групп, можно посмотреть исходный код. Для monthContainer используется такой шаблон:

<li><a href="[[+url]]">[[+month_name]] [[+year]]</a>
<ul>
[[+resources]]
</ul>

Обратите внимание на плейсхолдер [[+resources]]. Он передаёт результаты в itemTpl.