PublicAccess

PublicAccess.php : 18 Copy path

Extends ValueObject

The base class for all value objects and structs.

Constants¶

STATUS_OFFLINE ¶

PublicAccess.php : 20 Copy path

public mixed STATUS_OFFLINE = 0

STATUS_ONLINE ¶

PublicAccess.php : 21 Copy path

public mixed STATUS_ONLINE = 1

Properties¶

$identifier read-only ¶

PublicAccess.php Copy path

public string $identifier

$matcherConfiguration read-only ¶

PublicAccess.php Copy path

public SiteAccessMatcherConfiguration $matcherConfiguration

$saGroup read-only ¶

PublicAccess.php Copy path

public string $saGroup

$config ¶

PublicAccess.php : 33 Copy path

protected SiteConfiguration $config

$identifier ¶

PublicAccess.php : 24 Copy path

protected string|null $identifier

$matcherConfiguration ¶

PublicAccess.php : 30 Copy path

protected SiteAccessMatcherConfiguration $matcherConfiguration

$saGroup ¶

PublicAccess.php : 27 Copy path

protected string $saGroup

$siteId ¶

PublicAccess.php : 39 Copy path

protected int $siteId

$status ¶

PublicAccess.php : 36 Copy path

protected int $status

Methods¶

__construct() ¶

PublicAccess.php : 41 Copy path

Construct object optionally with a set of properties.

public __construct(string|null $identifier, int|null $siteId, string $saGroup[, SiteAccessMatcherConfiguration $matcherConfiguration = null ][, SiteConfiguration $config = null ][, int $status = self::STATUS_ONLINE ])

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\|null	-	-
$siteId	int\|null	-	-
$saGroup	string	-	-
$matcherConfiguration	SiteAccessMatcherConfiguration	null	-
$config	SiteConfiguration	null	-
$status	int	PublicAccess::STATUS_ONLINE	-

getConfigParameter() ¶

PublicAccess.php : 94 Copy path

public getConfigParameter(string $namespace, string $name) : mixed

Parameters

Name	Type	Default value	Description
$namespace	string	-	-
$name	string	-	-

getDesign() ¶

PublicAccess.php : 74 Copy path

public getDesign() : string

Return values

string

getMainLanguage() ¶

PublicAccess.php : 59 Copy path

public getMainLanguage() : string

Return values

string

getMatcherConfiguration() ¶

PublicAccess.php : 114 Copy path

public getMatcherConfiguration() : SiteAccessMatcherConfiguration

Return values

SiteAccessMatcherConfiguration

getSiteAccessGroup() ¶

PublicAccess.php : 79 Copy path

public getSiteAccessGroup() : string

Return values

string

getSiteConfiguration() ¶

PublicAccess.php : 89 Copy path

public getSiteConfiguration() : SiteConfiguration

Return values

SiteConfiguration

getSiteId() ¶

PublicAccess.php : 109 Copy path

public getSiteId() : int

Return values

int

getStatus() ¶

PublicAccess.php : 64 Copy path

public getStatus() : int

Return values

int

getTreeRootLocationId() ¶

PublicAccess.php : 84 Copy path

public getTreeRootLocationId() : int

Return values

int

hasConfigParameter() ¶

PublicAccess.php : 99 Copy path

public hasConfigParameter(string $namespace, string $name) : mixed

Parameters

Name	Type	Default value	Description
$namespace	string	-	-
$name	string	-	-

setStatus() ¶

PublicAccess.php : 69 Copy path

public setStatus(int $status) : void

Parameters

Name	Type	Default value	Description
$status	int	-	-

setTreeRootLocationId() ¶

PublicAccess.php : 104 Copy path

public setTreeRootLocationId(int $treeRootLocationId) : mixed

Parameters

Name	Type	Default value	Description
$treeRootLocationId	int	-	-

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>