Attention

TYPO3 v10 has reached end-of-life as of April 30th 2023 and is no longer being maintained. Use the version switcher on the top left of this page to select documentation for a supported version of TYPO3.

Need more time before upgrading? You can purchase Extended Long Term Support (ELTS) for TYPO3 v10 here: TYPO3 ELTS.

be.widget.paginate

This ViewHelper renders a Pagination of objects for the TYPO3 Backend.

Examples

Minimum call with required arguments only:

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

Full example with all configuration options:

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

The recordsLabel option can be used to replace the text in "Records 1 - 99" with a custom label.

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 Be 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

true

Description

The QueryResult containing all objects.

as

DataType

string

Required

true

Description

As

configuration

DataType

mixed

Default

array ( 'itemsPerPage' => 10, 'insertAbove' => false, 'insertBelow' => true, 'maximumNumberOfLinks' => 99,)

Required

false

Description

Configuration