SiteConfiguration

Responsibility: Handles the format of the configuration (currently yaml), and the location of the file system folder

Reads all available site configuration options, and puts them into Site objects.

Internal
Attributes
#[Autoconfigure]
$public: true

Table of Contents

Properties

$cache  : PhpFrontend
$configPath  : string
$eventDispatcher  : EventDispatcherInterface
$runtimeCache  : FrontendInterface
$setRegistry  : SetRegistry
$siteSettingsFactory  : SiteSettingsFactory

Methods

__construct()  : mixed
getAllExistingSites()  : array<string|int, Site>
Return all site objects which have been found in the filesystem.
getAllSiteConfigurationPaths()  : array<string|int, mixed>
Returns an array of paths in which a site configuration is found.
load()  : array<string|int, mixed>
Load plain configuration without additional settings.
resolveAllExistingSites()  : array<string|int, Site>
Resolve all site objects which have been found in the filesystem.
resolveAllExistingSitesRaw()  : array<string|int, Site>
Resolve all site objects which have been found in the filesystem containing settings only from the `config.yaml` file ignoring values from the `settings.yaml` and `csp.yaml` file.
siteConfigurationChanged()  : void
warmupCaches()  : void
determineInvalidSets()  : void
getAllSiteConfigurationFromFiles()  : array<string|int, mixed>
Read the site configuration from config files.
getContentSecurityPolicies()  : array<string|int, mixed>
getSiteTSconfig()  : SiteTSconfig|null
getSiteTypoScript()  : SiteTypoScript|null

Properties

$configPath

protected string $configPath
Attributes
#[Autowire]
'%env(TYPO3:configPath)%/sites'

$eventDispatcher

protected EventDispatcherInterface $eventDispatcher

Methods

__construct()

public __construct(string $configPath, SiteSettingsFactory $siteSettingsFactory, SetRegistry $setRegistry, EventDispatcherInterface $eventDispatcher, PhpFrontend $cache, YamlFileLoader $yamlFileLoader, FrontendInterface $runtimeCache) : mixed
Parameters
$configPath : string
$siteSettingsFactory : SiteSettingsFactory
$setRegistry : SetRegistry
$eventDispatcher : EventDispatcherInterface
$cache : PhpFrontend
$yamlFileLoader : YamlFileLoader
$runtimeCache : FrontendInterface

getAllExistingSites()

Return all site objects which have been found in the filesystem.

public getAllExistingSites([bool $useCache = true ]) : array<string|int, Site>
Parameters
$useCache : bool = true
Return values
array<string|int, Site>

getAllSiteConfigurationPaths()

Returns an array of paths in which a site configuration is found.

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

load()

Load plain configuration without additional settings.

public load(string $siteIdentifier) : array<string|int, mixed>

This method should only be used in case the original configuration as it exists in the file should be loaded, for example for writing / editing configuration.

All read related actions should be performed on the site entity.

Parameters
$siteIdentifier : string
Return values
array<string|int, mixed>

resolveAllExistingSites()

Resolve all site objects which have been found in the filesystem.

public resolveAllExistingSites([bool $useCache = true ]) : array<string|int, Site>
Parameters
$useCache : bool = true
Return values
array<string|int, Site>

resolveAllExistingSitesRaw()

Resolve all site objects which have been found in the filesystem containing settings only from the `config.yaml` file ignoring values from the `settings.yaml` and `csp.yaml` file.

public resolveAllExistingSitesRaw() : array<string|int, Site>
Internal

Not part of public API. Used as intermediate solution until settings are handled by a dedicated GUI.

Return values
array<string|int, Site>

siteConfigurationChanged()

public siteConfigurationChanged() : void
Attributes
#[AsEventListener]
$event: SiteConfigurationChangedEvent::class

determineInvalidSets()

protected determineInvalidSets(Site $site) : void
Parameters
$site : Site

getAllSiteConfigurationFromFiles()

Read the site configuration from config files.

protected getAllSiteConfigurationFromFiles([bool $useCache = true ]) : array<string|int, mixed>
Parameters
$useCache : bool = true
Tags
throws
InvalidDataException
Return values
array<string|int, mixed>

getContentSecurityPolicies()

protected getContentSecurityPolicies(string $siteIdentifier) : array<string|int, mixed>
Parameters
$siteIdentifier : string
Return values
array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results