getPage

What is getPage?¶

A general purpose snippet for presenting, navigating, and optionally caching, multi-page views from any Element that accepts a limit and offset properties for limiting a data set, and sets a placeholder which getPage can use to retrieve the total number of items to page over.

Requirements¶

• MODX Revolution 2.0.0-beta5 or later
• PHP5 or later

History¶

getPage was first written by Jason Coward (opengeek) and released on March 19, 2010.

Download¶

It can be downloaded from within the MODX Revolution manager via Package Management, or from the MODX Extras Repository, here: https://modx.com/extras/package/getpage

This Snippet does nothing by itself, but rather depends on another Snippet to return the output for a specified page (or range of data within a complete set). For example, the getResources, getFeed, and Archivist Snippets can both be wrapped by getPage.

Usage¶

The getPage snippet can be called using the tag:

[[!getPage?
    &elementClass=`modSnippet`
    &element=`getResources`
]]

Do Not Cache The getPage snippet must never be called cacheable on a Resource that is cacheable. It is best to always call getPage with the non-cacheable token, !, while still caching the rest of the Resource output. The same rule applies for the placeholder represented by the pageNavVar property (page.nav by default) so that its output is not cached into the cacheable page content.

Required Properties You must specify the element property, plus any additional properties required by the element you are calling via getPage.

Available Properties¶

Required Properties¶

Paging Properties¶

Page Navigation Properties¶

Page Navigation Template Properties¶

You can NOT modify these tpl properties from the snippet tag directly, due to the order in which tags are parsed in Revolution. If you do want to change these defaults you will need to use a property set:

• On the Elements tab, open the Snippets tree and find getPage. Open it.
• You will see a tab called "Element Properties". Open it.
• Create a new property set using the Add property set button and in the window that pops up ticking the "Create new property set" checkbox.
• Give your property set a name and click save.
• Now you can modify the values of the properties which will not be overwritten on upgrade.
• Finally, reference your property set name in your snippet call:

[[!getPage@PropertySetName? &element=`getResources` &parents=`3` ...]]

Caching Properties¶

Other Properties¶

Examples¶

Page a list of all child Resources of the current Resource, using a chunk called 'myRowTpl':

[[!getPage? &element=`getResources` &parents=`[[*id]]` &tpl=`myRowTpl`]]
<div class="pageNav">[[!+page.nav]]</div>

Page all resources beneath the Resource with ID '5', with the exception of resource 10, using a chunk called 'myRowTpl':

[[!getPage? &element=`getResources` &parents=`5` &resources=`-10` &tpl=`myRowTpl`]]
<div class="pageNav">[[!+page.nav]]</div>

If you are making your custom snippet to work with get page there are three things that your snippet needs to do ...

• limit
• offest
• totalVar

Had a couple of issues with getting it all to work ... check out this resources and answer on the forums.

1. Preparing Custom Snippets for getPage
2. getPage: pagination returns empty 2nd page
3. xPDO.getCount & xPDO.limit