SiteFinder

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

Properties

$mappingRootPageIdToIdentifier  : array
Short-hand to quickly fetch a site based on a rootPageId
$siteConfiguration  : SiteConfiguration
$sites  : Site[]

Methods

__construct()  : mixed
Fetches all existing configurations as Site objects
getAllSites()  : Site[]
Return a list of all configured sites
getSiteByIdentifier()  : Site
Find a site by given identifier
getSiteByPageId()  : Site
Traverses the rootline of a page up until a Site was found.
getSiteByRootPageId()  : Site
Find a site by given root page id
fetchAllSites()  : void

Properties

$mappingRootPageIdToIdentifier

Short-hand to quickly fetch a site based on a rootPageId

protected array $mappingRootPageIdToIdentifier = []

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

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

fetchAllSites()

protected fetchAllSites([bool $useCache = true ]) : void

Parameters

$useCache : bool = true
On this page