SiteList

SiteList.php : 17 Copy path

Extends ValueObject

The base class for all value objects and structs.

Properties¶

$sites read-only ¶

SiteList.php Copy path

public array<string|int, Site> $sites

$totalCount read-only ¶

SiteList.php Copy path

public int $totalCount

$pages ¶

SiteList.php : 30 Copy path

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

$sites ¶

SiteList.php : 27 Copy path

protected array<string|int, Site> $sites = []

$totalCount ¶

SiteList.php : 24 Copy path

The total count of found sites.

protected int $totalCount

Methods¶

__construct() ¶

SiteList.php : 32 Copy path

Construct object optionally with a set of properties.

    
                        public __construct([int $totalCount = 0 ][, array<string|int, mixed> $sites = [] ][, array<string|int, mixed> $pages = [] ])

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
$totalCount	int	0	-
$sites	array<string\|int, mixed>	[]	-
$pages	array<string\|int, mixed>	[]	-

getPages() ¶

SiteList.php : 46 Copy path

public getPages() : array<string|int, mixed>

Return values

array<string|int, mixed>

getSites() ¶

SiteList.php : 41 Copy path

public getSites() : array<string|int, mixed>

Return values

array<string|int, mixed>

getProperties() ¶

ValueObject.php : 50 Copy path

Function where list of properties are returned.

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

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>