Copied!

LocationList

LocationList.php : 25
Extends ValueObject
Implements IteratorAggregate, TotalCountAwareInterface

This class represents a queried location list holding a totalCount and a partial list of locations (by offset/limit parameters and permission filters).

Properties

public $locations read-only

LocationList.php 
public array<string|int, Location> $locations
  • the partial list of Locations controlled by offset/limit.

protected $locations

LocationList.php : 41

the partial list of locations controlled by offset/limit.

 
protected array<string|int, Location> $locations = []

public $totalCount read-only

LocationList.php 
public int $totalCount
  • the total count of found locations (filtered by permissions)

protected $totalCount

LocationList.php : 34

The total count of non-paginated Locations (filtered by permissions).

 
protected int $totalCount = 0

Use getTotalCount to fetch it.

Methods

public__construct()

ValueObject.php : 31

Construct object optionally with a set of properties.

 
public __construct([array<string, mixed> $properties = [] ])

Readonly properties values must be set using $properties as they aren't writable anymore after object has been created.

Parameters

Name Type Default value Description
$properties array<string, mixed> [] -

publicgetIterator()

LocationList.php : 46 
public getIterator() : array<string|int, Location>|Traversable

Return values

array<string|int, Location>|Traversable

publicgetTotalCount()

LocationList.php : 51

Get a total number of items matched by criteria, regardless of slice (page, collection) size.

 
public getTotalCount() : int

Return values

int

protectedgetProperties()

ValueObject.php : 54

Returns list of available properties' names.

 
protected getProperties([array<int, string> $dynamicProperties = [] ]) : array<int, string>

Override to add dynamic properties.

Parameters

Name Type Default value Description
$dynamicProperties array<int, string> []

Additional dynamic properties exposed on the object

Return values

array<int, string>

Tags
Serializerignore

()