Copied!

Template

Template.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 $design

Template.php : 29 
public string $design

public $identifier

Template.php : 23 
public string $identifier

public $name

Template.php : 20 
public string $name

public $parentLocation

Template.php : 38 
public Location|null $parentLocation

public $siteAccessGroup

Template.php : 17 
public string $siteAccessGroup

public $siteSkeletonLocation

Template.php : 35 
public Location|null $siteSkeletonLocation

public $thumbnail

Template.php : 26 
public string $thumbnail

public $userGroupSkeletonLocations

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

Methods

public__construct()

Template.php : 40

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 aren't 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 -

publicfromConfiguration()

Template.php : 60 
public static fromConfiguration(TemplateConfiguration $templateConfiguration) : Template

Parameters

Name Type Default value Description
$templateConfiguration TemplateConfiguration - -

Return values

Template

publicgetDesign()

Template.php : 94 
public getDesign() : string

Return values

string

publicgetIdentifier()

Template.php : 84 
public getIdentifier() : string

Return values

string

publicgetName()

Template.php : 79 
public getName() : string

Return values

string

publicgetParentLocation()

Template.php : 104 
public getParentLocation() : Location|null

Return values

Location|null

publicgetSiteAccessGroup()

Template.php : 74 
public getSiteAccessGroup() : string

Return values

string

publicgetSiteSkeletonLocation()

Template.php : 99 
public getSiteSkeletonLocation() : Location|null

Return values

Location|null

publicgetThumbnail()

Template.php : 89 
public getThumbnail() : string

Return values

string

publicgetUserGroupSkeletonLocations()

Template.php : 112 
public getUserGroupSkeletonLocations() : array<string|int, Location>

Return values

array<string|int, Location>

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

()