Template

Template.php : 14 Copy path

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.

Properties¶

$design ¶

Template.php : 29 Copy path

public string $design

$identifier ¶

Template.php : 23 Copy path

public string $identifier

$name ¶

Template.php : 20 Copy path

public string $name

$parentLocation ¶

Template.php : 38 Copy path

public Location|null $parentLocation

$siteAccessGroup ¶

Template.php : 17 Copy path

public string $siteAccessGroup

$siteSkeletonLocation ¶

Template.php : 35 Copy path

public Location|null $siteSkeletonLocation

$thumbnail ¶

Template.php : 26 Copy path

public string $thumbnail

$userGroupSkeletonLocations ¶

Template.php : 32 Copy path

public array<string|int, Location> $userGroupSkeletonLocations

Methods¶

__construct() ¶

Template.php : 40 Copy path

Construct object optionally with a set of properties.

public __construct(string $identifier, string $siteAccessGroup, string $name, string $thumbnail, string $design, array<string|int, mixed> $userGroupSkeletonLocations[, Location|null $siteSkeletonLocation = null ][, Location|null $parentLocation = null ])

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
$identifier	string	-	-
$siteAccessGroup	string	-	-
$name	string	-	-
$thumbnail	string	-	-
$design	string	-	-
$userGroupSkeletonLocations	array<string\|int, mixed>	-	-
$siteSkeletonLocation	Location\|null	null	-
$parentLocation	Location\|null	null	-

fromConfiguration() ¶

Template.php : 60 Copy path

public static fromConfiguration(TemplateConfiguration $templateConfiguration) : Template

Parameters

Name	Type	Default value	Description
$templateConfiguration	TemplateConfiguration	-	-

Return values

Template

getDesign() ¶

Template.php : 94 Copy path

public getDesign() : string

Return values

string

getIdentifier() ¶

Template.php : 84 Copy path

public getIdentifier() : string

Return values

string

getName() ¶

Template.php : 79 Copy path

public getName() : string

Return values

string

getParentLocation() ¶

Template.php : 104 Copy path

public getParentLocation() : Location|null

Return values

Location|null

getSiteAccessGroup() ¶

Template.php : 74 Copy path

public getSiteAccessGroup() : string

Return values

string

getSiteSkeletonLocation() ¶

Template.php : 99 Copy path

public getSiteSkeletonLocation() : Location|null

Return values

Location|null

getThumbnail() ¶

Template.php : 89 Copy path

public getThumbnail() : string

Return values

string

getUserGroupSkeletonLocations() ¶

Template.php : 112 Copy path

public getUserGroupSkeletonLocations() : array<string|int, Location>

Return values

array<string|int, Location>

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>