SiteFinder

readonly class \TYPO3\CMS\Core\Site\SiteFinder

Is used in backend and frontend for all places where to read / identify sites and site languages.

Table of Contents

Methods

__construct()  : mixed
getAllSites()  : Site[]
Return a list of all configured sites
getSiteByIdentifier()  : Site
Find a site by given identifier
getSiteByPage()  : Site
Finds the site of an already resolved page. Only the root line of its parent page is needed, which is usually already known when rendering menus or links.
getSiteByPageId()  : Site
Traverses the rootline of a page up until a Site was found.
getSiteByRootPageId()  : Site
Find a site by given root page id
siteConfigurationChanged()  : void

Methods

getAllSites()

Return a list of all configured sites

public getAllSites([bool $useCache = true ]) : Site[]

Parameters

$useCache : bool = true

Return values

Site[]

getSiteByIdentifier()

Find a site by given identifier

public getSiteByIdentifier(string $identifier) : Site

Parameters

$identifier : string

Tags

throws
SiteNotFoundException

Return values

Site

getSiteByPage()

Finds the site of an already resolved page. Only the root line of its parent page is needed, which is usually already known when rendering menus or links.

public getSiteByPage(Page $page[, string $mountPointParameter = '' ]) : Site

Parameters

$page : Page
$mountPointParameter : string = ''

Tags

throws
SiteNotFoundException

Return values

Site

getSiteByPageId()

Traverses the rootline of a page up until a Site was found.

public getSiteByPageId(int $pageId[, array|null $rootLine = null ][, string|null $mountPointParameter = null ]) : Site

Parameters

$pageId : int
$rootLine : array|null = null
$mountPointParameter : string|null = null

Tags

throws
SiteNotFoundException

Return values

Site

getSiteByRootPageId()

Find a site by given root page id

public getSiteByRootPageId(int $rootPageId) : Site

Parameters

$rootPageId : int

the page ID (default language)

Tags

throws
SiteNotFoundException

Return values

Site

siteConfigurationChanged()

public siteConfigurationChanged() : void

Attributes

#[AsEventListener]
$event: SiteConfigurationChangedEvent::class
On this page