Copied!

TemplateConfiguration

TemplateConfiguration.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.

Properties

public $userGroupSkeletonLocations

TemplateConfiguration.php : 32
public array<string|int, Location$userGroupSkeletonLocations

Methods

public__construct()

ValueObject.php : 30

Construct object optionally with a set of properties.

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

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
$properties array<string|int, mixed> [] -

publicfromTemplate()

TemplateConfiguration.php : 60
public static fromTemplate(string $identifier, string $design, array<string|int, mixed> $template, array<string|int, mixed> $userGroupSkeletonLocations[, Location|null $siteSkeleton = null ][, Location|null $parentLocation = null ]) : TemplateConfiguration

Parameters

Name Type Default value Description
$identifier string - -
$design string - -
$template array<string|int, mixed> - -
$userGroupSkeletonLocations array<string|int, mixed> - -
$siteSkeleton Location|null null -
$parentLocation Location|null null -

Return values

TemplateConfiguration

publicgetDesign()

TemplateConfiguration.php : 100
public getDesign() : string

Return values

string

publicgetIdentifier()

TemplateConfiguration.php : 80
public getIdentifier() : string

Return values

string

publicgetName()

TemplateConfiguration.php : 90
public getName() : string

Return values

string

publicgetParentLocation()

TemplateConfiguration.php : 110
public getParentLocation() : Location|null

Return values

Location|null

publicgetSiteAccessGroup()

TemplateConfiguration.php : 85
public getSiteAccessGroup() : string

Return values

string

publicgetSiteSkeletonLocation()

TemplateConfiguration.php : 105
public getSiteSkeletonLocation() : Location|null

Return values

Location|null

publicgetThumbnail()

TemplateConfiguration.php : 95
public getThumbnail() : string

Return values

string

publicgetUserGroupSkeletonLocations()

TemplateConfiguration.php : 118
public getUserGroupSkeletonLocations() : array<string|int, Location>

Return values

array<string|int, Location>

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>