SiteSettings

final readonly class \TYPO3\CMS\Core\Site\Entity\SiteSettings

Implements
SettingsInterface, JsonSerializable

Entity representing all settings for a site. These settings are not overlaid with TypoScript settings / constants which happens in the TypoScript Parser for a specific page.

Table of Contents

Interfaces

SettingsInterface
JsonSerializable

Methods

__construct()  : mixed
__set_state()  : static
create()  : self
createFromSettingsTree()  : self
get()  : mixed
getAll()  : array
getAllFlat()  : array
getIdentifiers()  : array
getMap()  : array
has()  : bool
isEmpty()  : bool
jsonSerialize()  : mixed

Methods

__construct()

public __construct(SettingsInterface $settings, array $settingsTree, array $flattenedArrayValues) : mixed

Parameters

$settings : SettingsInterface
$settingsTree : array
$flattenedArrayValues : array

__set_state()

public static __set_state(array $state) : static

Parameters

$state : array

Return values

static

createFromSettingsTree()

public static createFromSettingsTree(array $settingsTree) : self

Parameters

$settingsTree : array

Return values

self

get()

public get(string $identifier[, mixed $defaultValue = null ]) : mixed

Parameters

$identifier : string
$defaultValue : mixed = null

getAll()

public getAll() : array

Return values

array

getAllFlat()

public getAllFlat() : array

Return values

array

getIdentifiers()

public getIdentifiers() : array

Return values

array

getMap()

public getMap() : array

Return values

array

has()

public has(string $identifier) : bool

Parameters

$identifier : string

Return values

bool

isEmpty()

public isEmpty() : bool

Return values

bool

jsonSerialize()

public jsonSerialize() : mixed

Tags

todo

Update jsonSerialize() to return settings map and settings tree values, or remove altogether.

On this page