Copied!

PublicAccess

PublicAccess.php : 18
Extends ValueObject

The base class for all value objects and structs.

Constants

publicSTATUS_OFFLINE

PublicAccess.php : 20 
public mixed STATUS_OFFLINE = 0

publicSTATUS_ONLINE

PublicAccess.php : 21 
public mixed STATUS_ONLINE = 1

Properties

public $identifier read-only

PublicAccess.php 
public string $identifier

protected $identifier

PublicAccess.php : 24 
protected string|null $identifier

public $matcherConfiguration read-only

PublicAccess.php 
public SiteAccessMatcherConfiguration $matcherConfiguration

protected $matcherConfiguration

PublicAccess.php : 30 
protected SiteAccessMatcherConfiguration $matcherConfiguration

public $saGroup read-only

PublicAccess.php 
public string $saGroup

protected $saGroup

PublicAccess.php : 27 
protected string $saGroup

protected $config

PublicAccess.php : 33 
protected SiteConfiguration $config

protected $siteId

PublicAccess.php : 39 
protected int $siteId

protected $status

PublicAccess.php : 36 
protected int $status

Methods

public__construct()

PublicAccess.php : 41

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 -

publicgetConfigParameter()

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

Parameters

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

publicgetDesign()

PublicAccess.php : 74 
public getDesign() : string

Return values

string

publicgetMainLanguage()

PublicAccess.php : 59 
public getMainLanguage() : string

Return values

string

publicgetMatcherConfiguration()

PublicAccess.php : 114 
public getMatcherConfiguration() : SiteAccessMatcherConfiguration

Return values

SiteAccessMatcherConfiguration

publicgetSiteAccessGroup()

PublicAccess.php : 79 
public getSiteAccessGroup() : string

Return values

string

publicgetSiteConfiguration()

PublicAccess.php : 89 
public getSiteConfiguration() : SiteConfiguration

Return values

SiteConfiguration

publicgetSiteId()

PublicAccess.php : 109 
public getSiteId() : int

Return values

int

publicgetStatus()

PublicAccess.php : 64 
public getStatus() : int

Return values

int

publicgetTreeRootLocationId()

PublicAccess.php : 84 
public getTreeRootLocationId() : int

Return values

int

publichasConfigParameter()

PublicAccess.php : 99 
public hasConfigParameter(string $namespace, string $name) : mixed

Parameters

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

publicsetStatus()

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

Parameters

Name Type Default value Description
$status int - -

publicsetTreeRootLocationId()

PublicAccess.php : 104 
public setTreeRootLocationId(int $treeRootLocationId) : mixed

Parameters

Name Type Default value Description
$treeRootLocationId int - -

protectedgetProperties()

ValueObject.php : 53

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>

Tags
Serializerignore

()