Copied!

PublicAccess

PublicAccess.php : 20
Final
Extends ValueObject

The base class for all value objects and structs.

Constants

publicSTATUS_OFFLINE

PublicAccess.php : 22 
public mixed STATUS_OFFLINE = 0

publicSTATUS_ONLINE

PublicAccess.php : 23 
public mixed STATUS_ONLINE = 1

Properties

protected $config

PublicAccess.php : 34 
protected SiteConfiguration|null $config = null

protected $identifier

PublicAccess.php : 25 
protected string $identifier

protected $matcherConfiguration

PublicAccess.php : 27 
protected SiteAccessMatcherConfiguration $matcherConfiguration

protected $saGroup

PublicAccess.php : 32 
protected string $saGroup

protected $siteId

PublicAccess.php : 31 
protected int|null $siteId

protected $status

PublicAccess.php : 35 
protected int $status = self::STATUS_ONLINE

Methods

public__construct()

PublicAccess.php : 29

Construct object optionally with a set of properties.

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

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

publicgetConfigParameter()

PublicAccess.php : 78 
public getConfigParameter(string $namespace, string $name) : mixed

Parameters

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

publicgetDesign()

PublicAccess.php : 58 
public getDesign() : string

Return values

string

publicgetMainLanguage()

PublicAccess.php : 43 
public getMainLanguage() : string

Return values

string

publicgetMatcherConfiguration()

PublicAccess.php : 98 
public getMatcherConfiguration() : SiteAccessMatcherConfiguration

Return values

SiteAccessMatcherConfiguration

publicgetSiteAccessGroup()

PublicAccess.php : 63 
public getSiteAccessGroup() : string

Return values

string

publicgetSiteConfiguration()

PublicAccess.php : 73 
public getSiteConfiguration() : SiteConfiguration

Return values

SiteConfiguration

publicgetSiteId()

PublicAccess.php : 93 
public getSiteId() : int|null

Return values

int|null

publicgetStatus()

PublicAccess.php : 48 
public getStatus() : int

Return values

int

publicgetTreeRootLocationId()

PublicAccess.php : 68 
public getTreeRootLocationId() : int

Return values

int

publichasConfigParameter()

PublicAccess.php : 83 
public hasConfigParameter(string $namespace, string $name) : bool

Parameters

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

Return values

bool

publicsetStatus()

PublicAccess.php : 53 
public setStatus(int $status) : void

Parameters

Name Type Default value Description
$status int - -

publicsetTreeRootLocationId()

PublicAccess.php : 88 
public setTreeRootLocationId(int $treeRootLocationId) : void

Parameters

Name Type Default value Description
$treeRootLocationId int - -

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]