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
PaginatedPageArray
.
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Paginated
class also inherits all the methods and properties of: WireArray and Wire.
Common
Name | Return | Summary | |
---|---|---|---|
Paginated Paginated Paginated | string | ) Renders pagination, when MarkupPageArray module installed |
Retrieval
Name | Return | Summary | |
---|---|---|---|
Paginated Paginated Paginated | int | Get the limit that was used in pagination. | |
Paginated Paginated Paginated | int | Get the starting offset number that was used for pagination. | |
Paginated Paginated Paginated | int | Get the total number of items in the WireArray, including all paginations. |
Manipulation
Name | Return | Summary | |
---|---|---|---|
Paginated Paginated Paginated | $this | Set the limit that was used in pagination. | |
Paginated Paginated Paginated | $this | Set the starting offset number to use for pagination. | |
Paginated Paginated Paginated | $this | Set the total number of items, if more than are in the WireArray. |
Other
Name | Return | Summary | |
---|---|---|---|
Paginated Paginated Paginated | string | Get a "1 to 10 of 50" type of string useful for pagination headlines. | |
Paginated Paginated Paginated | mixed | Get a property of the PageArray | |
Paginated Paginated Paginated | bool | Is there a next pagination containing more items in this Paginated | |
Paginated Paginated Paginated | bool | Does this WireArray have more than one pagination? | |
Paginated Paginated Paginated | bool | Is there a previous pagination before the current one? |
Additional methods and properties
In addition to the methods and properties above, Paginated
API reference based on ProcessWire core version 3.0.236