Contents

System\Classes\SiteManager

Overview

SiteManager class manages sites

Extends

Public Properties

There are no public properties in the class.

Show inherited public properties

Inherited Public Properties

Protected Properties

protected array $sites

sites collection of sites

protected array $siteIdCache

siteIdCache caches sites by their identifier

protected array $emitterSingleEventCollection

emitterSingleEventCollection of events to be fired once only

protected array $emitterEventCollection

emitterEventCollection of all registered events

protected array $emitterEventSorted

emitterEventSorted collection

protected mixed $editSiteCache

protected bool $globalContext

globalContext disables site filters globally.

protected SiteDefinition|null $siteContext

siteContext overrides the current site context.

Show inherited protected properties

Inherited Protected Properties


Public Methods

public applyActiveSite()

public applyActiveSite($site): void

applyActiveSite applies active site configuration values to the application, typically used for frontend requests.

public applyActiveSiteId()

public applyActiveSiteId($id): void

public applyEditSite()

public applyEditSite($site): void

applyEditSite applies edit site configuration values to the application, typically used for backend requests.

public applyEditSiteId()

public applyEditSiteId($id): void

public bindEvent()

public bindEvent($event, $callback, $priority = 0): void 

bindEvent creates a new event binding

public bindEventOnce()

public bindEventOnce($event, $callback, $priority = 0): void 

bindEventOnce creates a new event binding that fires once only

public fireEvent()

public fireEvent(
    string $event,
    array $params = [],
    boolean $halt = false
): array 

fireEvent and call the listeners

public getActiveSite()

public getActiveSite(): void

public getActiveSiteId()

public getActiveSiteId(): void

public getAnyEditSite()

public getAnyEditSite(): void

hasAnyEditSite returns true if there are edit sites

public getAnySite()

public getAnySite(): void

getAnySite returns any site, with priority to primary

public getEditSite()

public getEditSite(): void

getEditSite returns the edit theme

public getEditSiteFromRequest()

public getEditSiteFromRequest(): void

getEditSiteFromRequest resolves the edit site from the current request by checking cookie, user preference, and falling back to any edit site.

public getEditSiteId()

public getEditSiteId(): void

public getLocaleKeyChain()

public getLocaleKeyChain($locale): array 

getLocaleKeyChain returns locale lookup keys in priority order, where a regional locale (fr-CA) degrades to its base language (fr).

public getLocalesFromBrowser()

public getLocalesFromBrowser($acceptedStr): array 

getLocalesFromBrowser based on an accepted string, e.g. en-GB,en-US;q=0.9,en;q=0.8 Returns a sorted array in format of [(string) locale => (float) priority]

public getPrimarySite()

public getPrimarySite(): void

public getSiteCodeFromContext()

public getSiteCodeFromContext(): string|null 

public getSiteForLocale()

public getSiteForLocale($locale): void

public getSiteFromBrowser()

public getSiteFromBrowser($acceptLanguage, $groupId = null): void

getSiteFromBrowser locates the site based on the browser locale, e.g. HTTP_ACCEPT_LANGUAGE

public getSiteFromContext()

public getSiteFromContext(): SiteDefinition 

public getSiteFromId()

public getSiteFromId($id): void

public getSiteFromRequest()

public getSiteFromRequest($rootUrl, $uri): void

getSiteFromRequest locates the site based on the hostname and URI

public getSiteGroupIdFromContext()

public getSiteGroupIdFromContext(): int 

getSiteGroupIdFromContext returns the site group id for the active site.

public getSiteIdFromContext()

public getSiteIdFromContext(): int|null 

public hasAnyEditSite()

public hasAnyEditSite(): bool 

hasAnyEditSite returns true if there are edit sites

public hasAnySite()

public hasAnySite(): bool 

hasAnySite returns true if there is a frontend

public hasFeature()

public hasFeature($name = null): bool 

hasFeature returns true if a multisite feature is enabled

public hasGlobalContext()

public hasGlobalContext(): bool 

public hasMultiEditSite()

public hasMultiEditSite(): bool 

hasMultiEditSite returns true if there are multiple sites for editing

public hasMultiSite()

public hasMultiSite(): bool 

hasMultiSite returns true if there are multiple sites

public hasSiteGroups()

public hasSiteGroups(): bool 

public static instance()

public static instance(): static 

instance creates a new instance of this singleton

public isModelMultisite()

public isModelMultisite($model, $attribute = null): bool 

isModelMultisite returns true if the model implements multisite. If an attribute it will check that the attribute is multisite enabled (not propagated)

public isModelMultisiteGroup()

public isModelMultisiteGroup($model): bool 

isModelMultisiteGroup returns true if the model implements multisite group scoping

public listEditEnabled()

public listEditEnabled(): void

public listEditSites()

public listEditSites(): void

public listEnabled()

public listEnabled(): void

public listSiteIds()

public listSiteIds(): void

public listSiteIdsInContext()

public listSiteIdsInContext(): void

public listSiteIdsInGroup()

public listSiteIdsInGroup($siteId = null): void

public listSiteIdsInLocale()

public listSiteIdsInLocale($siteId = null): void

public listSites()

public listSites(): void

public resetCache()

public resetCache(): void

resetCache resets any memory or cache involved with the sites

public setActiveSite()

public setActiveSite($site): void

public setActiveSiteId()

public setActiveSiteId($id): void

setActiveSite

public setEditSite()

public setEditSite($site): void

public setEditSiteId()

public setEditSiteId($id): void

public storeEditSitePreference()

public storeEditSitePreference($id): void

storeEditSitePreference persists the edit site selection to user preference and cookie when the user actively switches sites.

public unbindEvent()

public unbindEvent($event = null): void 

unbindEvent destroys an event binding

public withContext()

public withContext($siteId, $callback): void

public withGlobalContext()

public withGlobalContext($callback): void

Show inherited public methods

Inherited Public Methods

Protected Methods

protected broadcastSiteChange()

protected broadcastSiteChange($siteId): void

broadcastSiteChange is a generic event used when the site changes

protected emitterEventSortEvents()

protected emitterEventSortEvents($eventName, $combined = []): array 

emitterEventSortEvents sorts the listeners for a given event by priority

protected listSitesForManifest()

protected listSitesForManifest($sites): void

protected listSitesFromManifest()

protected listSitesFromManifest($sites): void

Show inherited protected methods

Inherited Protected Methods