SiteSettingsFactory
Read onlyYes
Attributes
- #[Autoconfigure]
- $public: true
Table of Contents
Properties
- $cache : PhpFrontend
- $cacheIdentifier : PackageDependentCacheIdentifier
- $configPath : string
- $setRegistry : SetRegistry
- $settingsFactory : SettingsFactory
- $settingsFileName : string
- $settingsTypeRegistry : SettingsTypeRegistry
- $yamlFileLoader : YamlFileLoader
Methods
- __construct() : mixed
- composeSettings() : SiteSettings
- createSettings() : SiteSettings
- Fetch the settings for a specific site and return the parsed Site Settings object.
- getSettings() : SiteSettings
- loadLocalSettings() : array<string|int, mixed>|null
- Load settings from config/sites/{$siteIdentifier}/settings.yaml.
- getSettingsProviders() : array<string|int, SiteSettingsProvider>
Properties
$cache
protected
PhpFrontend
$cache
Attributes
- #[Autowire]
- $service: 'cache.core'
$cacheIdentifier
protected
PackageDependentCacheIdentifier
$cacheIdentifier
Attributes
- #[Autowire]
- $expression: 'service("package-dependent-cache-identifier").withPrefix("SiteSettings")'
$configPath
protected
string
$configPath
Attributes
- #[Autowire]
- '%env(TYPO3:configPath)%/sites'
$setRegistry
protected
SetRegistry
$setRegistry
$settingsFactory
protected
SettingsFactory
$settingsFactory
$settingsFileName
protected
string
$settingsFileName
= 'settings.yaml'
$settingsTypeRegistry
protected
SettingsTypeRegistry
$settingsTypeRegistry
$yamlFileLoader
protected
YamlFileLoader
$yamlFileLoader
Methods
__construct()
public
__construct(string $configPath, SetRegistry $setRegistry, SettingsTypeRegistry $settingsTypeRegistry, SettingsFactory $settingsFactory, YamlFileLoader $yamlFileLoader, PhpFrontend $cache, PackageDependentCacheIdentifier $cacheIdentifier[, string $settingsFileName = 'settings.yaml' ]) : mixed
Parameters
- $configPath : string
- $setRegistry : SetRegistry
- $settingsTypeRegistry : SettingsTypeRegistry
- $settingsFactory : SettingsFactory
- $yamlFileLoader : YamlFileLoader
- $cache : PhpFrontend
- $cacheIdentifier : PackageDependentCacheIdentifier
- $settingsFileName : string = 'settings.yaml'
composeSettings()
public
composeSettings(array<string|int, mixed> $rawSettings, array<string|int, mixed> $sets) : SiteSettings
Parameters
- $rawSettings : array<string|int, mixed>
- $sets : array<string|int, mixed>
Return values
SiteSettingscreateSettings()
Fetch the settings for a specific site and return the parsed Site Settings object.
public
createSettings([array<string|int, mixed> $sets = [] ][, string|null $siteIdentifier = null ][, array<string|int, mixed> $inlineSettings = [] ]) : SiteSettings
Parameters
- $sets : array<string|int, mixed> = []
- $siteIdentifier : string|null = null
- $inlineSettings : array<string|int, mixed> = []
Tags
Return values
SiteSettingsgetSettings()
public
getSettings(string $siteIdentifier, array<string|int, mixed> $siteConfiguration) : SiteSettings
Parameters
- $siteIdentifier : string
- $siteConfiguration : array<string|int, mixed>
Return values
SiteSettingsloadLocalSettings()
Load settings from config/sites/{$siteIdentifier}/settings.yaml.
public
loadLocalSettings(string $siteIdentifier) : array<string|int, mixed>|null
Parameters
- $siteIdentifier : string
Return values
array<string|int, mixed>|nullgetSettingsProviders()
protected
getSettingsProviders(array<string|int, mixed> $settings, array<string|int, mixed> $sets) : array<string|int, SiteSettingsProvider>
Parameters
- $settings : array<string|int, mixed>
- $sets : array<string|int, mixed>