widget.paginate

This ViewHelper renders a Pagination of objects.

Examples

Required arguments

<f:widget.paginate objects="{blogs}" as="paginatedBlogs">
   use {paginatedBlogs} as you used {blogs} before, most certainly inside
   a <f:for> loop.
</f:widget.paginate>

Full configuration

<f:widget.paginate objects="{blogs}" as="paginatedBlogs" configuration="{itemsPerPage: 5, insertAbove: 1, insertBelow: 0, maximumNumberOfLinks: 10}">
   use {paginatedBlogs} as you used {blogs} before, most certainly inside
   a <f:for> loop.
</f:widget.paginate>

The storeSession attribute can be used in any widget and will prevent cookie creation / session storage for the widget.

Performance characteristics

In the above examples, it looks like {blogs} contains all Blog objects, thus you might wonder if all objects were fetched from the database. However, the blogs are NOT fetched from the database until you actually use them, so the paginate ViewHelper will adjust the query sent to the database and receive only the small subset of objects. So, there is no negative performance overhead in using the Paginate Widget.

Arguments

customWidgetId

DataType
string
Required
false
Description
Extend the widget identifier with a custom widget id

storeSession

DataType
mixed
Default
true
Required
false
Description
Store the widgets session (utilizing a cookie).

objects

DataType
mixed
Required
false
Description
Object

as

DataType
string
Required
false
Description
As

configuration

DataType
mixed
Default
array ( ‘itemsPerPage’ => 10, ‘insertAbove’ => false, ‘insertBelow’ => true, ‘maximumNumberOfLinks’ => 99,)
Required
false
Description
Configuration