PaginatedArray::getProperty() method

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.

Example

// Get count
$count = $items->getProperty('count');

// Same as above using direct access property
$count = $items->count; 

Usage

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

Arguments

NameType(s)Description
propertystring

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.130

Twitter updates

  • New post: ProcessWire 3.0.131 adds support for partial/resumable downloads and http stream delivery, and contains several updates to our comments system, among other updates— More
    3 May 2019
  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019

Latest news

  • ProcessWire Weekly #262
    The 262nd issue of ProcessWire Weekly will cover the latest module updates, both Pro modules and non-commercial ones. We've also got some highlights from the support forum, and a beautiful new site of the week. Read on!
    Weekly.pw / 18 May 2019
  • Lots of module updates
    In this post we take a quick look at the new version of ProFields Repeater Matrix, yet another new version of FormBuilder, and a new version of the GoogleClientAPI module.
    Blog / 17 May 2019
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer