Copied!

Page

Page.php : 14
Extends ValueObject

The base class for all value objects and structs.

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

Constants

publicSTATUS_ONLINE

Page.php : 16
public mixed STATUS_ONLINE = 1

Properties

protected $languages

Page.php : 25
protected array<string|int, string> $languages

protected $name

Page.php : 22
protected string $name

protected $status

Page.php : 19
protected int $status

protected $treeRootLocation

Page.php : 28
protected Location|null $treeRootLocation

Methods

public__construct()

Page.php : 33

Construct object optionally with a set of properties.

public __construct(string $name, array<string|int, string> $languages, Location|null $treeRootLocation)

Parameters

Name Type Default value Description
$name string - -
$languages array<string|int, string> - -
$treeRootLocation Location|null - -

publicgetLanguages()

Page.php : 57
public getLanguages() : array<string|int, string>

Return values

array<string|int, string>

publicgetName()

Page.php : 49
public getName() : string

Return values

string

publicgetStatus()

Page.php : 44
public getStatus() : int

Return values

int

publicgetTreeRootLocation()

Page.php : 65

Tree root Location will be empty when user does not have permission to load it.

public getTreeRootLocation() : Location|null

Return values

Location|null

protectedgetProperties()

ValueObject.php : 50

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>