Inheritance diagram for TYPO3\CMS\Core\Configuration\SiteConfiguration:

Public Member Functions
	__construct (string $configPath, EventDispatcherInterface $eventDispatcher, PhpFrontend $coreCache=null)

Site[]	getAllExistingSites (bool $useCache=true)

	createNewBasicSite (string $identifier, int $rootPageId, string $base)

Site[]	resolveAllExistingSites (bool $useCache=true)

	getAllSiteConfigurationPaths ()

	load (string $siteIdentifier)

	writeSettings (string $siteIdentifier, array $settings)

	write (string $siteIdentifier, array $configuration, bool $protectPlaceholders=false)

	rename (string $currentIdentifier, string $newIdentifier)

	delete (string $siteIdentifier)

	warmupCaches (CacheWarmupEvent $event)

Protected Member Functions
	getAllSiteConfigurationFromFiles (bool $useCache=true)

	getSiteSettings (string $siteIdentifier, array $siteConfiguration)

	getContentSecurityPolicies (string $siteIdentifier)

array< string, protectPlaceholders(array $existingConfiguration, array $modifiedConfiguration):array { try { return GeneralUtility::makeInstance(YamlPlaceholderGuard::class, $existingConfiguration) ->	process ($modifiedConfiguration)

catch(YamlPlaceholderException $exception)	sortConfiguration (array $newConfiguration)

Static Protected Member Functions
static	findModified (array $currentConfiguration, array $newConfiguration)

static	findRemoved (array $currentConfiguration, array $newConfiguration)

Protected Attributes
PhpFrontend	$cache

string	$configPath

string	$configFileName = 'config.yaml'

string	$settingsFileName = 'settings.yaml'

string	$contentSecurityFileName = 'csp.yaml'

string	$cacheIdentifier = 'sites-configuration'

array null	$firstLevelCache

EventDispatcherInterface	$eventDispatcher

Detailed Description

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.

Definition at line 46 of file SiteConfiguration.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Configuration\SiteConfiguration::__construct	(	string	$configPath,
		EventDispatcherInterface	$eventDispatcher,
		PhpFrontend	$coreCache = `null`
	)

Parameters

PhpFrontend | null $coreCache

Definition at line 91 of file SiteConfiguration.php.

References TYPO3\CMS\Core\Configuration\SiteConfiguration\$configPath, and TYPO3\CMS\Core\Configuration\SiteConfiguration\$eventDispatcher.

Member Function Documentation

◆ createNewBasicSite()

TYPO3\CMS\Core\Configuration\SiteConfiguration::createNewBasicSite	(	string	$identifier,
		int	$rootPageId,
		string	$base
	)

Creates a site configuration with one language "English" which is the de-facto default language for TYPO3 in general.

Exceptions

SiteConfigurationWriteException

Definition at line 119 of file SiteConfiguration.php.

References TYPO3\CMS\Core\Configuration\SiteConfiguration\write().

◆ delete()

TYPO3\CMS\Core\Configuration\SiteConfiguration::delete ( string $siteIdentifier )

Removes the config.yaml file of a site configuration. Also clears the cache.

Exceptions

SiteNotFoundException|SiteConfigurationWriteException

Definition at line 334 of file SiteConfiguration.php.

References TYPO3\CMS\Core\Configuration\SiteConfiguration\$configFileName, TYPO3\CMS\Webhooks\Message\$siteIdentifier, and TYPO3\CMS\Core\Configuration\SiteConfiguration\getAllExistingSites().

◆ findModified()

static TYPO3\CMS\Core\Configuration\SiteConfiguration::findModified	(	array	$currentConfiguration,
		array	$newConfiguration
	)

staticprotected

Definition at line 381 of file SiteConfiguration.php.

◆ findRemoved()

static TYPO3\CMS\Core\Configuration\SiteConfiguration::findRemoved	(	array	$currentConfiguration,
		array	$newConfiguration
	)

staticprotected

Definition at line 401 of file SiteConfiguration.php.

◆ getAllExistingSites()

Site [] TYPO3\CMS\Core\Configuration\SiteConfiguration::getAllExistingSites ( bool $useCache = true )

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

Returns: ‪Site[]

Definition at line 106 of file SiteConfiguration.php.

References TYPO3\CMS\Core\Configuration\SiteConfiguration\$firstLevelCache, and TYPO3\CMS\Core\Configuration\SiteConfiguration\resolveAllExistingSites().

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\delete().

◆ getAllSiteConfigurationFromFiles()

TYPO3\CMS\Core\Configuration\SiteConfiguration::getAllSiteConfigurationFromFiles ( bool $useCache = true )

protected

Read the site configuration from config files.

Exceptions

InvalidDataException

Definition at line 192 of file SiteConfiguration.php.

References $finder, and TYPO3\CMS\Webhooks\Message\$identifier.

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\resolveAllExistingSites(), and TYPO3\CMS\Core\Configuration\SiteConfiguration\warmupCaches().

◆ getAllSiteConfigurationPaths()

TYPO3\CMS\Core\Configuration\SiteConfiguration::getAllSiteConfigurationPaths ( )

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

Definition at line 170 of file SiteConfiguration.php.

References $finder.

◆ getContentSecurityPolicies()

TYPO3\CMS\Core\Configuration\SiteConfiguration::getContentSecurityPolicies ( string $siteIdentifier )

protected

Definition at line 251 of file SiteConfiguration.php.

References TYPO3\CMS\Core\Configuration\SiteConfiguration\$contentSecurityFileName, TYPO3\CMS\Webhooks\Message\$siteIdentifier, and TYPO3\CMS\Core\Configuration\Loader\YamlFileLoader\PROCESS_IMPORTS.

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\resolveAllExistingSites().

◆ getSiteSettings()

TYPO3\CMS\Core\Configuration\SiteConfiguration::getSiteSettings	(	string	$siteIdentifier,
		array	$siteConfiguration
	)

protected

Fetch the settings for a specific site and return the parsed Site Settings object.

Definition at line 239 of file SiteConfiguration.php.

References TYPO3\CMS\Core\Configuration\SiteConfiguration\$settingsFileName, TYPO3\CMS\Webhooks\Message\$siteIdentifier, and TYPO3\CMS\Core\Configuration\Loader\YamlFileLoader\PROCESS_IMPORTS.

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\resolveAllExistingSites().

◆ load()

TYPO3\CMS\Core\Configuration\SiteConfiguration::load ( string $siteIdentifier )

Load plain configuration without additional settings.

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

string $siteIdentifier

Definition at line 229 of file SiteConfiguration.php.

References TYPO3\CMS\Core\Configuration\SiteConfiguration\$configFileName, TYPO3\CMS\Webhooks\Message\$siteIdentifier, and TYPO3\CMS\Core\Configuration\Loader\YamlFileLoader\PROCESS_IMPORTS.

Referenced by TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate\getSitePathsToMigrate().

◆ process()

array<string, protectPlaceholders(array $existingConfiguration, array $modifiedConfiguration): array { try { return GeneralUtility::makeInstance(YamlPlaceholderGuard::class, $existingConfiguration) -> TYPO3\CMS\Core\Configuration\SiteConfiguration::process ( $modifiedConfiguration )

protected

Detects placeholders that have been introduced and handles* them. (*) currently throws an exception, but could be purged or escaped as well

Parameters

array<string,mixed>	‪$existingConfiguration
array<string,mixed>	‪$modifiedConfiguration

Returns: ‪array<string, mixed> sanitized configuration (currently not used, exception thrown before)

Exceptions

SiteConfigurationWriteException

◆ rename()

TYPO3\CMS\Core\Configuration\SiteConfiguration::rename	(	string	$currentIdentifier,
		string	$newIdentifier
	)

Renames a site identifier (and moves the folder)

Exceptions

SiteConfigurationWriteException

Definition at line 319 of file SiteConfiguration.php.

◆ resolveAllExistingSites()

Site [] TYPO3\CMS\Core\Configuration\SiteConfiguration::resolveAllExistingSites ( bool $useCache = true )

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

Returns: ‪Site[]

Definition at line 146 of file SiteConfiguration.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Core\Configuration\SiteConfiguration\getAllSiteConfigurationFromFiles(), TYPO3\CMS\Core\Configuration\SiteConfiguration\getContentSecurityPolicies(), and TYPO3\CMS\Core\Configuration\SiteConfiguration\getSiteSettings().

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\getAllExistingSites().

◆ sortConfiguration()

catch (YamlPlaceholderException $exception) TYPO3\CMS\Core\Configuration\SiteConfiguration::sortConfiguration ( array $newConfiguration )

protected

Definition at line 370 of file SiteConfiguration.php.

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\write().

◆ warmupCaches()

TYPO3\CMS\Core\Configuration\SiteConfiguration::warmupCaches ( CacheWarmupEvent $event )

Definition at line 418 of file SiteConfiguration.php.

References TYPO3\CMS\Core\Configuration\SiteConfiguration\getAllSiteConfigurationFromFiles(), and TYPO3\CMS\Core\Cache\Event\CacheWarmupEvent\hasGroup().

◆ write()

TYPO3\CMS\Core\Configuration\SiteConfiguration::write	(	string	$siteIdentifier,
		array	$configuration,
		bool	$protectPlaceholders = `false`
	)

Add or update a site configuration

Parameters

bool $protectPlaceholders ‪whether to disallow introducing new placeholders

Todo:: ‪enforce $protectPlaceholders with TYPO3 v13.0

Exceptions

SiteConfigurationWriteException

Definition at line 277 of file SiteConfiguration.php.

References TYPO3\CMS\Core\Configuration\SiteConfiguration\$configFileName, TYPO3\CMS\Webhooks\Message\$siteIdentifier, TYPO3\CMS\Core\Utility\GeneralUtility\mkdir_deep(), TYPO3\CMS\Core\Configuration\SiteConfiguration\sortConfiguration(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\createNewBasicSite().

◆ writeSettings()

TYPO3\CMS\Core\Configuration\SiteConfiguration::writeSettings	(	string	$siteIdentifier,
		array	$settings
	)

Definition at line 261 of file SiteConfiguration.php.

References TYPO3\CMS\Core\Configuration\SiteConfiguration\$settingsFileName, TYPO3\CMS\Webhooks\Message\$siteIdentifier, and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

Member Data Documentation

◆ $cache

PhpFrontend TYPO3\CMS\Core\Configuration\SiteConfiguration::$cache

protected

Definition at line 48 of file SiteConfiguration.php.

◆ $cacheIdentifier

string TYPO3\CMS\Core\Configuration\SiteConfiguration::$cacheIdentifier = 'sites-configuration'

protected

Identifier to store all configuration data in cache_core cache.

Definition at line 78 of file SiteConfiguration.php.

◆ $configFileName

string TYPO3\CMS\Core\Configuration\SiteConfiguration::$configFileName = 'config.yaml'

protected

Config yaml file name.

Definition at line 57 of file SiteConfiguration.php.

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\delete(), TYPO3\CMS\Core\Configuration\SiteConfiguration\load(), and TYPO3\CMS\Core\Configuration\SiteConfiguration\write().

◆ $configPath

string TYPO3\CMS\Core\Configuration\SiteConfiguration::$configPath

protected

Definition at line 50 of file SiteConfiguration.php.

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\__construct().

◆ $contentSecurityFileName

string TYPO3\CMS\Core\Configuration\SiteConfiguration::$contentSecurityFileName = 'csp.yaml'

protected

YAML file name with all settings related to Content-Security-Policies.

Definition at line 71 of file SiteConfiguration.php.

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\getContentSecurityPolicies().

◆ $eventDispatcher

EventDispatcherInterface TYPO3\CMS\Core\Configuration\SiteConfiguration::$eventDispatcher

protected

Definition at line 86 of file SiteConfiguration.php.

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\__construct().

◆ $firstLevelCache

array null TYPO3\CMS\Core\Configuration\SiteConfiguration::$firstLevelCache

protected

Cache stores all configuration as Site objects, as long as they haven't been changed. This drastically improves performance as SiteFinder utilizes SiteConfiguration heavily

Definition at line 85 of file SiteConfiguration.php.

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\getAllExistingSites().

◆ $settingsFileName

string TYPO3\CMS\Core\Configuration\SiteConfiguration::$settingsFileName = 'settings.yaml'

protected

YAML file name with all settings.

Definition at line 64 of file SiteConfiguration.php.

Referenced by TYPO3\CMS\Core\Configuration\SiteConfiguration\getSiteSettings(), and TYPO3\CMS\Core\Configuration\SiteConfiguration\writeSettings().

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createNewBasicSite()

◆ delete()

◆ findModified()

◆ findRemoved()

◆ getAllExistingSites()

◆ getAllSiteConfigurationFromFiles()

◆ getAllSiteConfigurationPaths()

◆ getContentSecurityPolicies()

◆ getSiteSettings()

◆ load()

◆ process()

◆ rename()

◆ resolveAllExistingSites()

◆ sortConfiguration()

◆ warmupCaches()

◆ write()

◆ writeSettings()

Member Data Documentation

◆ $cache

◆ $cacheIdentifier

◆ $configFileName

◆ $configPath

◆ $contentSecurityFileName

◆ $eventDispatcher

◆ $firstLevelCache

◆ $settingsFileName