PaginatedArray is a type of WireArray that supports pagination of items within it.

Here you will see methods specific to the pagination aspects of this class only. For full details on available methods outside of pagination, please see the WireArray class. The most common type of PaginatedArray is a PageArray.


Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the PaginatedArray class also inherits all the methods and properties of: WireArray and Wire.

Retrieval / Manipulation / Other

Show “PaginatedArray”             Show Arguments        

Retrieval

NameReturnSummary 
PaginatedArray::getLimit()
intGet the limit that was used in pagination.
PaginatedArray::getStart()
intGet the starting offset number that was used for pagination.
PaginatedArray::getTotal()
intGet the total number of items in the WireArray, including all paginations.

Manipulation

NameReturnSummary 
PaginatedArray::setLimit(int $numLimit)
$thisSet the limit that was used in pagination.
PaginatedArray::setStart(int $numStart)
$thisSet the starting offset number to use for pagination.
PaginatedArray::setTotal(int $total)
$thisSet the total number of items, if more than are in the WireArray.

Other

NameReturnSummary 
PaginatedArray::getPaginationString()
stringGet a "1 to 10 of 50" type of string useful for pagination headlines.
PaginatedArray::getProperty(string $property)
mixedGet a property of the PageArray

Additional methods and properties

In addition to the methods and properties above, PaginatedArray also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.61