SiteSettings implements SettingsInterface, JsonSerializable

Read onlyYes
FinalYes

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<string|int, mixed>
getAllFlat()  : array<string|int, mixed>
getIdentifiers()  : array<string|int, mixed>
getMap()  : array<string|int, mixed>
has()  : bool
isEmpty()  : bool
jsonSerialize()  : mixed

Methods

__construct()

public __construct(SettingsInterface $settings, array<string|int, mixed> $settingsTree, array<string|int, mixed> $flattenedArrayValues) : mixed
Parameters
$settings : SettingsInterface
$settingsTree : array<string|int, mixed>
$flattenedArrayValues : array<string|int, mixed>
Internal

to be constructed by create() or createFromSettingsTree()

__set_state()

public static __set_state(array<string|int, mixed> $state) : static
Parameters
$state : array<string|int, mixed>
Return values
static

createFromSettingsTree()

public static createFromSettingsTree(array<string|int, mixed> $settingsTree) : self
Parameters
$settingsTree : array<string|int, mixed>
Internal
Return values
self

get()

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

getAll()

public getAll() : array<string|int, mixed>
Return values
array<string|int, mixed>

getAllFlat()

public getAllFlat() : array<string|int, mixed>
Return values
array<string|int, mixed>

getIdentifiers()

public getIdentifiers() : array<string|int, mixed>
Return values
array<string|int, mixed>

getMap()

public getMap() : array<string|int, mixed>
Return values
array<string|int, mixed>

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

        
    


            

                    

        

    

        

            
Search results