1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Entity
  7. \
  8. Site
  9. \
  10. Site

Site

class Site implements TreeInterface, ObjectInterface, ObjectInterface (View source)

Traits

ObjectTrait

Properties

protected $siteConfig
protected $siteID
protected $pThemeID
protected $siteIsDefault
protected $siteHandle
protected $locales
protected $type

Methods

CategoryInterface
getObjectAttributeCategory()

No description

AttributeValueInterface|null
getAttributeValueObject(AttributeKeyInterface|string $ak, bool $createIfNotExists = false)

No description

getAttribute($ak, $mode = false)

No description

from  ObjectTrait
Value
getAttributeValue($ak)

No description

from  ObjectTrait
clearAttribute($ak)

No description

from  ObjectTrait
Value
setAttribute($ak, mixed $value)

Sets the attribute of a user info object to the specified value, and saves it in the database.

from  ObjectTrait
getPermissionObjectIdentifier()

No description

getPermissionResponseClassName()

No description

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

No description

__construct($appConfigRepository)

No description

updateSiteConfigRepository($appConfigRepository)

No description

getConfigRepository()

No description

mixed
getType()

No description

setType(mixed $type)

No description

mixed
getLocales()

No description

setLocales(mixed $locales)

No description

mixed
getSiteHomePageID()

No description

int|null
getSiteTreeID()

No description

getDefaultLocale()

No description

Tree|null
getSiteTreeObject()

No description

getSiteHomePageObject($version = 'RECENT')

No description

mixed
getSiteID()

No description

mixed
getSiteHandle()

No description

setSiteHandle(mixed $siteHandle)

No description

mixed
isDefault()

No description

setIsDefault(mixed $siteIsDefault)

No description

mixed
getSiteName()

No description

setSiteName($name)

No description

string
getSiteCanonicalURL()

Get the main site canonical URL.

string
getSiteAlternativeCanonicalURL()

Get the alternative site canonical URL.

string
getSiteSSLCanonicalURL()

Get the HTTPS site canonical URL (it may be the main or the alternative canonical URL).

getTimezone()

No description

mixed
getThemeID()

No description

setThemeID(mixed $pThemeID)

No description

Details

at line 42
CategoryInterface getObjectAttributeCategory()

No description

Return Value

CategoryInterface

at line 47
AttributeValueInterface|null getAttributeValueObject(AttributeKeyInterface|string $ak, bool $createIfNotExists = false)

No description

Parameters

AttributeKeyInterface|string $ak

An attribute key instance (or its handle)
bool $createIfNotExists

Shall the generic attribute value be created if it does not already exist?

Return Value

AttributeValueInterface|null

in ObjectTrait at line 24
getAttribute($ak, $mode = false)

No description

Parameters

$ak
$mode

in ObjectTrait at line 36
Value getAttributeValue($ak)

No description

Parameters

$ak

Return Value

Value

in ObjectTrait at line 47
clearAttribute($ak)

No description

Parameters

$ak

in ObjectTrait at line 68
Value setAttribute($ak, mixed $value)

Sets the attribute of a user info object to the specified value, and saves it in the database.

Parameters

$ak
mixed $value

Return Value

Value

at line 22
getPermissionObjectIdentifier()

No description

at line 27
getPermissionResponseClassName()

No description

at line 32
getPermissionAssignmentClassName()

No description

at line 37
getPermissionObjectKeyCategoryHandle()

No description

at line 91
__construct($appConfigRepository)

No description

Parameters

$appConfigRepository

at line 97
updateSiteConfigRepository($appConfigRepository)

No description

Parameters

$appConfigRepository

at line 102
getConfigRepository()

No description

at line 126
mixed getType()

No description

Return Value

mixed

at line 134
setType(mixed $type)

No description

Parameters

mixed $type

at line 142
mixed getLocales()

No description

Return Value

mixed

at line 150
setLocales(mixed $locales)

No description

Parameters

mixed $locales

at line 158
mixed getSiteHomePageID()

No description

Return Value

mixed

at line 166
int|null getSiteTreeID()

No description

Return Value

int|null

at line 174
getDefaultLocale()

No description

at line 183
Tree|null getSiteTreeObject()

No description

Return Value

Tree|null

at line 194
getSiteHomePageObject($version = 'RECENT')

No description

Parameters

$version

at line 205
mixed getSiteID()

No description

Return Value

mixed

at line 213
mixed getSiteHandle()

No description

Return Value

mixed

at line 221
setSiteHandle(mixed $siteHandle)

No description

Parameters

mixed $siteHandle

at line 229
mixed isDefault()

No description

Return Value

mixed

at line 237
setIsDefault(mixed $siteIsDefault)

No description

Parameters

mixed $siteIsDefault

at line 245
mixed getSiteName()

No description

Return Value

mixed

at line 250
setSiteName($name)

No description

Parameters

$name

at line 260
string getSiteCanonicalURL()

Get the main site canonical URL.

Return Value

string

empty string if it's not set

at line 270
string getSiteAlternativeCanonicalURL()

Get the alternative site canonical URL.

Return Value

string

empty string if it's not set

at line 280
string getSiteSSLCanonicalURL()

Get the HTTPS site canonical URL (it may be the main or the alternative canonical URL).

Return Value

string

empty string if it's not set

at line 296
getTimezone()

No description

at line 312
mixed getThemeID()

No description

Return Value

mixed

at line 320
setThemeID(mixed $pThemeID)

No description

Parameters

mixed $pThemeID