Copied!

Site

Site.php : 13
Extends ValueObject

The base class for all value objects and structs.

Supports read-only properties by marking them as protected. In this case they will only be writable using constructor, and need to be documented using @property-read <type> <$var> annotation in class doc in addition to inline property doc. Writable properties must be public and must be documented inline.

Constants

publicSTATUS_OFFLINE

Site.php : 15
public mixed STATUS_OFFLINE = 0

publicSTATUS_ONLINE

Site.php : 16
public mixed STATUS_ONLINE = 1

Properties

public $created

Site.php : 31
public DateTimeInterface $created

public $id

Site.php : 19
public int $id

public $languages

Site.php : 34
public array<string|int, string> $languages

public $name

Site.php : 28
public string $name

public $publicAccesses

Site.php : 25
public array<string|int, PublicAccess$publicAccesses

public $status

Site.php : 22
public int $status = self::STATUS_OFFLINE

public $template

Site.php : 37
public Template $template

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> [] -

publicgetDesignName()

Site.php : 39
public getDesignName() : string

Return values

string

publicgetFirstSiteAccess()

Site.php : 49
public getFirstSiteAccess() : PublicAccess

Return values

PublicAccess

publicgetTreeRootLocationId()

Site.php : 44
public getTreeRootLocationId() : 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

()