LocationList
This class represents a queried location list holding a totalCount and a partial list of locations (by offset/limit parameters and permission filters).
Properties¶
$locations
¶
|
|
|
- the partial list of Locations controlled by offset/limit.
$totalCount
¶
|
|
|
- the total count of found locations (filtered by permissions)
$locations
¶
the partial list of locations controlled by offset/limit.
|
|
|
$totalCount
¶
The total count of non-paginated Locations (filtered by permissions).
|
|
|
Use getTotalCount to fetch it.
Methods¶
__construct()
¶
Construct object optionally with a set of properties.
|
|
|
Readonly properties values must be set using $properties as they are not writable anymore after object has been created.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $properties | array<string|int, mixed> | [] | - |
getIterator()
¶
|
|
|
Return values
array<string|int, Location>|Traversable
getTotalCount()
¶
Get a total number of items matched by criteria, regardless of slice (page, collection) size.
|
|
|
Return values
int
getProperties()
¶
Function where list of properties are returned.
|
|
|
Used by attributes(), override to add dynamic properties
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $dynamicProperties | array<string|int, mixed> | [] |
Additional dynamic properties exposed on the object |
Return values
array<string|int, mixed>