Site
class Site implements TreeInterface, ObjectInterface, ObjectInterface, JsonSerializable (View source)
Traits
Properties
| protected Liaison | $siteConfig | The site configuration repository. |
|
| protected int | $siteID | The site identifier. |
|
| protected int | $pThemeID | The ID of the theme. |
|
| protected | $pThemeSkinIdentifier | A theme skin to use for this site. |
|
| protected bool | $siteIsDefault | Is this the default site? |
|
| protected string | $siteHandle | The site handle. |
|
| protected Locale[]|ArrayCollection | $locales | The language sections of this site. |
|
| protected Type|null | $type | The site type. |
Methods
No description
No description
Sets the attribute of a user info object to the specified value, and saves it in the database.
No description
No description
No description
No description
Get the site configuration repository.
Get the language sections of this site.
Get the ID of the home page.
No description
Get the default locale (if set).
No description
Get the home page of the default language.
Get the ID of the site.
Get the handle of the site.
Set the handle of the site.
Is this the default site?
Is this the default site?
Get the name of the site.
Set the name of the site.
Get the main site canonical URL.
Get the alternative site canonical URL.
Get the HTTPS site canonical URL (it may be the main or the alternative canonical URL).
Get the site time zone identifier.
Get the ID of the theme.
Set the ID of the theme.
No description
No description
No description
Details
CategoryInterface
getObjectAttributeCategory()
No description
AttributeValueInterface|null
getAttributeValueObject(AttributeKeyInterface|string $ak, bool $createIfNotExists = false)
No description
getAttribute($ak, $mode = false)
No description
Value
getAttributeValue($ak)
No description
clearAttribute($ak, bool $doReindexImmediately = true)
No description
Value
setAttribute($ak, mixed $value, bool $doReindexImmediately = true)
Sets the attribute of a user info object to the specified value, and saves it in the database.
__construct(Repository $appConfigRepository)
Initialize the instance.
getPermissionObjectIdentifier()
No description
getPermissionResponseClassName()
No description
getPermissionAssignmentClassName()
No description
getPermissionObjectKeyCategoryHandle()
No description
updateSiteConfigRepository(Repository $appConfigRepository)
Set the site configuration repository.
Liaison
getConfigRepository()
Get the site configuration repository.
Type|null
getType()
Get the site type object.
setType(Type|null $type)
Set the site type object.
Locale[]|ArrayCollection
getLocales()
Get the language sections of this site.
setLocales(Locale[]|ArrayCollection $locales)
Set the language sections of this site.
int|null
getSiteHomePageID()
Get the ID of the home page.
int|null
getSiteTreeID()
No description
Locale|null
getDefaultLocale()
Get the default locale (if set).
Tree|null
getSiteTreeObject()
No description
Page|null
getSiteHomePageObject(string|int $version = 'RECENT')
Get the home page of the default language.
int
getSiteID()
Get the ID of the site.
string
getSiteHandle()
Get the handle of the site.
setSiteHandle(string $siteHandle)
Set the handle of the site.
bool
isDefault()
Is this the default site?
setIsDefault(bool $siteIsDefault)
Is this the default site?
string|mixed
getSiteName()
Get the name of the site.
bool
setSiteName(string|mixed $name)
Set the name of the site.
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).
string
getTimezone()
Get the site time zone identifier.
int
getThemeID()
Get the ID of the theme.
setThemeID(int $pThemeID)
Set the ID of the theme.
jsonSerialize()
No description
mixed
getThemeSkinIdentifier()
No description
void
setThemeSkinIdentifier(mixed $pThemeSkinIdentifier)
No description