Copied!

TemplateConfiguration

TemplateConfiguration.php : 14
Final
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.

Properties

public $userGroupSkeletonLocations

TemplateConfiguration.php : 25 
public array<string|int, mixed> $userGroupSkeletonLocations

Methods

public__construct()

ValueObject.php : 32

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

publicfromTemplate()

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

Parameters

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

Return values

TemplateConfiguration

publicgetDesign()

TemplateConfiguration.php : 75 
public getDesign() : string

Return values

string

publicgetIdentifier()

TemplateConfiguration.php : 55 
public getIdentifier() : string

Return values

string

publicgetName()

TemplateConfiguration.php : 65 
public getName() : string

Return values

string

publicgetParentLocation()

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

Return values

Location|null

publicgetSiteAccessGroup()

TemplateConfiguration.php : 60 
public getSiteAccessGroup() : string

Return values

string

publicgetSiteSkeletonLocation()

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

Return values

Location|null

publicgetThumbnail()

TemplateConfiguration.php : 70 
public getThumbnail() : string

Return values

string

publicgetUserGroupSkeletonLocations()

TemplateConfiguration.php : 93 
public getUserGroupSkeletonLocations() : array<int, Location>

Return values

array<int, Location>

protectedgetProperties()

ValueObject.php : 53

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>

Attributes
#[Ignore]