f:be.widget.paginate

This ViewHelper allows you to split a large amount of data into chunks across multiple pages, to define the number of records on each page, and to define where and how the navigation between the pages should appear.

Properties

objects

Variable type
QueryResultInterface
Description
Not the result objects themselves, but the object from the Repository which contains the data needed to reproduce the SQL command. The SQL statement object and the SQL command aren't allowed here, as Extbase won't be able to work out how to implement the LIMIT attribute which controls the division of the data into paginated results.

Default value

Required
Yes

as

Variable type
String
Description
The name of the variable in which the reduced object is made available.
Required
Yes

configuration

Variable type
Array
Description
Configuration of the page navigation
Default value
See "Configuration of the page navigation"
Required
No

Configuration of the page navigation

itemsPerPage

Variable type
QueryResultInterface
Description
The number of objects which may be associated with each page in the series.
Default value
10
Required
No

insertAbove

Variable type
Boolean
Description
Display the page navigation above the results.
Default value
FALSE
Required
No

insertBelow

Variable type
Boolean
Description
Display the page navigation below the results.
Default value
TRUE
Required
No

recordsLabel

Variable type
String
Description
An optional text to replace the standard descriptor “Records 1 - xy”.
Default value
Empty string
Required
No