class Site implements TreeInterface, ObjectInterface, ObjectInterface (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 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

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

No description

getAttribute($ak, $mode = false)

No description

Value
getAttributeValue($ak)

No description

Value
setAttribute(AttributeKeyInterface $ak, mixed $value)

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

__construct(Repository $appConfigRepository)

Initialize the instance.

updateSiteConfigRepository(Repository $appConfigRepository)

Set the site configuration repository.

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.

Details

CategoryInterface getObjectAttributeCategory()

Return Value

CategoryInterface

See also

\Concrete\Core\Attribute\ObjectInterface::getObjectAttributeCategory()

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

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

See also

\Concrete\Core\Attribute\ObjectInterface::getAttributeValueObject()

getAttribute($ak, $mode = false)

Parameters

$ak
$mode

Value getAttributeValue($ak)

Parameters

$ak

Return Value

Value

clearAttribute(AttributeKeyInterface $ak)

Parameters

AttributeKeyInterface $ak | string $ak

Value setAttribute(AttributeKeyInterface $ak, mixed $value)

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

Parameters

AttributeKeyInterface $ak | string $ak
mixed $value

Return Value

Value

__construct(Repository $appConfigRepository)

Initialize the instance.

Parameters

Repository $appConfigRepository The site configuration repository

getPermissionObjectIdentifier()

See also

\Concrete\Core\Permission\ObjectInterface::getPermissionObjectIdentifier()

getPermissionResponseClassName()

See also

\Concrete\Core\Permission\ObjectInterface::getPermissionResponseClassName()

getPermissionAssignmentClassName()

See also

\Concrete\Core\Permission\ObjectInterface::getPermissionAssignmentClassName()

getPermissionObjectKeyCategoryHandle()

See also

\Concrete\Core\Permission\ObjectInterface::getPermissionObjectKeyCategoryHandle()

updateSiteConfigRepository(Repository $appConfigRepository)

Set the site configuration repository.

Parameters

Repository $appConfigRepository

Liaison getConfigRepository()

Get the site configuration repository.

Return Value

Liaison

Type|null getType()

Get the site type object.

Return Value

Type|null

setType(Type|null $type)

Set the site type object.

Parameters

Type|null $type

Locale[]|ArrayCollection getLocales()

Get the language sections of this site.

Return Value

Locale[]|ArrayCollection

setLocales(Locale[]|ArrayCollection $locales)

Set the language sections of this site.

Parameters

Locale[]|ArrayCollection $locales

int|null getSiteHomePageID()

Get the ID of the home page.

Return Value

int|null

int|null getSiteTreeID()

Return Value

int|null

See also

\Concrete\Core\Site\Tree\TreeInterface::getSiteTreeID()

Locale|null getDefaultLocale()

Get the default locale (if set).

Return Value

Locale|null

Tree|null getSiteTreeObject()

Return Value

Tree|null

See also

\Concrete\Core\Site\Tree\TreeInterface::getSiteTreeObject()

Page|null getSiteHomePageObject(string|int $version = 'RECENT')

Get the home page of the default language.

Parameters

string|int $version 'ACTIVE', 'RECENT' or a specific page version ID

Return Value

Page|null

int getSiteID()

Get the ID of the site.

Return Value

int

string getSiteHandle()

Get the handle of the site.

Return Value

string

setSiteHandle(string $siteHandle)

Set the handle of the site.

Parameters

string $siteHandle

bool isDefault()

Is this the default site?

Return Value

bool

setIsDefault(bool $siteIsDefault)

Is this the default site?

Parameters

bool $siteIsDefault

string|mixed getSiteName()

Get the name of the site.

Return Value

string|mixed

bool setSiteName(string|mixed $name)

Set the name of the site.

Parameters

string|mixed $name

Return Value

bool returns true if the name has been correctly set, false otherwise

string getSiteCanonicalURL()

Get the main site canonical URL.

Return Value

string empty string if it's not set

string getSiteAlternativeCanonicalURL()

Get the alternative site canonical URL.

Return Value

string empty string if it's not set

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

string getTimezone()

Get the site time zone identifier.

Return Value

string

int getThemeID()

Get the ID of the theme.

Return Value

int

setThemeID(int $pThemeID)

Set the ID of the theme.

Parameters

int $pThemeID