PaginatedArray::getProperty()

Get a property of the PageArray

These map to functions from the array and are here for convenience. Properties include count, total, start, limit, last, first, keys, values, These can also be accessed by direct reference, i.e. $items->limit.

Please see the WireArray::getProperty() method for full details on non-pagination related properties that can be retrieved through this.

Usage

$mixed = $paginatedArray->getProperty(string $property);

Arguments

Name Type(s) Description

Name	Type(s)	Description
`$property`	`string`	Name of property you want to retrieve, can be any of the following: `count` (int): Count of items currently present. `total` (int): Total quantity of items across all paginations. `start` (int): Current start index for pagination. `limit` (int): Current limit used for pagination. `last` (mixed): Last item in the WireArray. `first` (mixed): First item in the WireArray.

$property

string

Name of property you want to retrieve, can be any of the following:

count (int): Count of items currently present.
total (int): Total quantity of items across all paginations.
start (int): Current start index for pagination.
limit (int): Current limit used for pagination.
last (mixed): Last item in the WireArray.
first (mixed): First item in the WireArray.

Return value

mixed

Value of requested property.

PaginatedArray methods and properties

API reference based on ProcessWire core version 3.0.252