Cниппет getPage в MODx Revo

Что такое getPage и для чего он нужен?

getPage это сниппет MODx Revo, который позволяет организовать постраничный просмотр некоторых элементов сайта. К этим элементам могут применяться ограничительные меры, в виде отбора по свойствам или параметрам.

Особенности getPage.

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

Еще одной особенностью, которая может ввести программиста, который не сталкивался ранее со сниппетом getPage заключается в том, что он не должен вызываться некэшируемым в кэшируемом ресурсе.

Параметры сниппета getPage.

• &elementClass=`` - указывает, какой тип мы обертываем, по умолчанию modSnippet;
• &element=`` - указывает, что именно мы обертываем, например getResource;
• &limit=`` - количество выводимых элементов на странице, по умолчанию 10;
• &offset=`` - задает отступ или смещение, относительно начального значения в результирующем массивы выходных данных;
• &page=`` - текущая отображаемая страница;
• &pageCount=`` - количество страниц;
• &pageVarKey=`` текущая отображаемая страница;
• &totalVar=`` - задает наименование плейсхолдера, содержащего общее количество записей в рамках массива;
• &total=`` - общее количество записей, разбиваемых на страницы;
• &firstItem=`` - индекс первого отображаемого элемента списка на странице;
• &lastItem=`` - индекс последнего отображаемого элемента списка на странице;
• &pageOneLimit=`` - дополнительный лимит отображаемых элементов на первой странице, может отличаться от основного;
• &pageLimit=`` - количество отображаемых элементов на странице;
• &pageNavVar=`` - маркер плейсхолдера, устанавливающегося вместе с меню навигации.

Параметры шаблонизации сниппета getPage.

• &pageNavOuterTpl=`` - задает шаблон контейнера постраничной навигации и ее вывод;
• &pageNavTpl=`` - задает шаблон отображения одну страницу элементов навигации;
• &pageActiveTpl=`` - задает шаблон отображения текущей страницы (активной) элементов навигации;
• &pageFirstTpl=`` - задает шаблон отображения первой страницы элементов навигации;
• &pageLastTpl=`` - задает шаблон отображения последней страницы элементов навигации;
• &pagePrevTpl=`` - задает шаблон предыдущей страницы элементов навигации;
• &pageNextTpl=`` - задает шаблон последующей страницы элементов навигации.

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

Выводит список ресурсов, в том числе тех, которые не показываются в меню текущего родительского элемента, включая tv-параметры, используя шаблон в чанке post_tpl с разбиением на постраничную навигацию по 5 на одну страницу.

[ [[getPage? &elementClass=`modSnippet` &element=`getResources` &parents=`` &showHidden=`1` &tpl=`post_tpl` &includeContent=`1` &includeTVs=`1` &processTVs=`1` &hideContainers=`1` &pageLimit=`5` &pageNavVar=`page.nav` &limit=`5`] ]

Как видите, сниппет getPage в нашем случае используется в связке со сниппетом getResource.

Статьи по теме:

Записей не найдено.

Написать комментарий