Copied!

PublicAccess

PublicAccess.php : 22
Final
Extends ValueObject

The base class for all value objects and structs.

Constants

publicSTATUS_OFFLINE

PublicAccess.php : 24 
public mixed STATUS_OFFLINE = 0

publicSTATUS_ONLINE

PublicAccess.php : 25 
public mixed STATUS_ONLINE = 1

Properties

protected $config

PublicAccess.php : 36 
protected SiteConfiguration $config

protected $identifier

PublicAccess.php : 27 
protected string $identifier

protected $matcherConfiguration

PublicAccess.php : 29 
protected SiteAccessMatcherConfiguration $matcherConfiguration

protected $saGroup

PublicAccess.php : 34 
protected string $saGroup

protected $siteId

PublicAccess.php : 33 
protected int|null $siteId

protected $status

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

protected $treeRootLocationId

PublicAccess.php : 38 
protected int|null $treeRootLocationId = null

Methods

public__construct()

PublicAccess.php : 31

Construct object optionally with a set of properties.

 
public __construct(string|null $identifier, int|null $siteId, string $saGroup, SiteAccessMatcherConfiguration $matcherConfiguration, SiteConfiguration $config[, int $status = self::STATUS_ONLINE ][, int|null $treeRootLocationId = 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|null - -
$siteId int|null - -
$saGroup string - -
$matcherConfiguration SiteAccessMatcherConfiguration - -
$config SiteConfiguration - -
$status int PublicAccess::STATUS_ONLINE -
$treeRootLocationId int|null null -

publicgetConfigParameter()

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

Parameters

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

publicgetDesign()

PublicAccess.php : 61 
public getDesign() : string

Return values

string

publicgetMainLanguage()

PublicAccess.php : 46 
public getMainLanguage() : string

Return values

string

publicgetMatcherConfiguration()

PublicAccess.php : 105 
public getMatcherConfiguration() : SiteAccessMatcherConfiguration

Return values

SiteAccessMatcherConfiguration

publicgetSiteAccessGroup()

PublicAccess.php : 66 
public getSiteAccessGroup() : string

Return values

string

publicgetSiteConfiguration()

PublicAccess.php : 80 
public getSiteConfiguration() : SiteConfiguration

Return values

SiteConfiguration

publicgetSiteId()

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

Return values

int|null

publicgetStatus()

PublicAccess.php : 51 
public getStatus() : int

Return values

int

publicgetTreeRootLocationId()

PublicAccess.php : 71 
public getTreeRootLocationId() : int

Return values

int

publichasConfigParameter()

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

Parameters

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

Return values

bool

publicsetStatus()

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

Parameters

Name Type Default value Description
$status int - -

publicsetTreeRootLocationId()

PublicAccess.php : 95 
public setTreeRootLocationId(int|null $treeRootLocationId) : void

Parameters

Name Type Default value Description
$treeRootLocationId int|null - -

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]