PHP Класс Neos\Flow\Configuration\ConfigurationManager

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$cacheNeedsUpdate boolean
$configurationSource Neos\Flow\Configuration\Source\YamlSource
$configurationTypes array Defines which Configuration Type is processed by which logic
$configurations array Storage of the raw special configurations
$context Neos\Flow\Core\ApplicationContext The application context of the configuration to manage
$orderedListOfContextNames array Example: Development, Development/Foo, Development/Foo/Bar
$packages array Active packages to load the configuration for
$subRoutesRecursionLevel integer Counts how many SubRoutes have been loaded. If this number exceeds MAXIMUM_SUBROUTE_RECURSIONS, an exception is thrown
$temporaryDirectoryPath string An absolute file path to store configuration caches in. If null no cache will be active.

Открытые методы

Метод Описание
__construct ( ApplicationContext $context ) Constructs the configuration manager
flushConfigurationCache ( ) : void If a cache file with previously saved configuration exists, it is removed.
getAvailableConfigurationTypes ( ) : array Get the available configuration-types
getConfiguration ( string $configurationType, string $configurationPath = null ) : array Returns the specified raw configuration.
injectConfigurationSource ( YamlSource $configurationSource ) : void Injects the configuration source
isSplitSourceAllowedForConfigurationType ( string $configurationType ) : boolean Check the allowSplitSource setting for the configuration type.
loadConfigurationCache ( ) : boolean If a cache file with previously saved configuration exists, it is loaded.
registerConfigurationType ( string $configurationType, string $configurationProcessingType = self::CONFIGURATION_PROCESSING_TYPE_DEFAULT, boolean $allowSplitSource = false ) : void Registers a new configuration type with the given configuration processing type.
resolveConfigurationProcessingType ( string $configurationType ) : string Resolve the processing type for the configuration type.
setPackages ( array $packages ) : void Sets the active packages to load the configuration for
setTemporaryDirectoryPath ( string $temporaryDirectoryPath ) Set an absolute file path to store configuration caches in. If null no cache will be active.
shutdown ( ) : void Shuts down the configuration manager.
warmup ( ) : void Warms up the complete configuration cache, i.e. fetching every configured configuration type in order to be able to store it into the cache, if configured to do so.

Защищенные методы

Метод Описание
buildSubRouteConfigurations ( array $routesConfiguration, array $subRoutesConfiguration, string $subRouteKey, array $subRouteOptions ) : array Merges all routes in $routesConfiguration with the sub routes in $subRoutesConfiguration
constructConfigurationCachePath ( ) : string Constructs a path to the configuration cache PHP file.
emitConfigurationManagerReady ( ConfigurationManager $configurationManager ) : void Emits a signal after The ConfigurationManager has been loaded
includeSubRoutesFromSettings ( array &$routeDefinitions ) : void Merges routes from Neos.Flow.mvc.routes settings into $routeDefinitions NOTE: Routes from settings will always be appended to existing route definitions from the main Routes configuration!
loadConfiguration ( string $configurationType, array $packages ) : void Loads special configuration defined in the specified packages and merges them with those potentially existing in the global configuration folders. The result is stored in the configuration manager's configuration registry and can be retrieved with the getConfiguration() method.
mergePolicyConfiguration ( array $firstConfigurationArray, array $secondConfigurationArray ) : array Merges two policy configuration arrays.
mergeRoutesWithSubRoutes ( array &$routesConfiguration ) : void Loads specified sub routes and builds composite routes.
postProcessConfiguration ( array &$configurations ) : void Post processes the given configuration array by replacing constants with their actual value.
replacePlaceholders ( string $string, array $variables ) : string Replaces placeholders in the format with the corresponding variable of the specified $variables collection.
replaceVariablesInValue ( string $value ) : mixed Replaces variables (in the format %CONSTANT% or %ENV::ENVIRONMENT_VARIABLE) in the given (configuration) value string.
saveConfigurationCache ( ) : void Saves the current configuration into a cache file and creates a cache inclusion script in the context's Configuration directory.
validatePolicyConfiguration ( array $policyConfiguration, Neos\Flow\Package\PackageInterface $package ) : void Validates the given $policyConfiguration and throws an exception if its not valid

Описание методов

__construct() публичный Метод

Constructs the configuration manager
public __construct ( ApplicationContext $context )
$context Neos\Flow\Core\ApplicationContext The application context to fetch configuration for

buildSubRouteConfigurations() защищенный Метод

Merges all routes in $routesConfiguration with the sub routes in $subRoutesConfiguration
protected buildSubRouteConfigurations ( array $routesConfiguration, array $subRoutesConfiguration, string $subRouteKey, array $subRouteOptions ) : array
$routesConfiguration array
$subRoutesConfiguration array
$subRouteKey string the key of the sub route:
$subRouteOptions array
Результат array the merged route configuration

constructConfigurationCachePath() защищенный Метод

Derived from the temporary path and application context.
protected constructConfigurationCachePath ( ) : string
Результат string

emitConfigurationManagerReady() защищенный Метод

Emits a signal after The ConfigurationManager has been loaded
protected emitConfigurationManagerReady ( ConfigurationManager $configurationManager ) : void
$configurationManager ConfigurationManager
Результат void

flushConfigurationCache() публичный Метод

If a cache file with previously saved configuration exists, it is removed.
public flushConfigurationCache ( ) : void
Результат void

getAvailableConfigurationTypes() публичный Метод

Get the available configuration-types
public getAvailableConfigurationTypes ( ) : array
Результат array

getConfiguration() публичный Метод

The actual configuration will be merged from different sources in a defined order. Note that this is a low level method and mostly makes sense to be used by Flow internally. If possible just use settings and have them injected.
public getConfiguration ( string $configurationType, string $configurationPath = null ) : array
$configurationType string The kind of configuration to fetch - must be one of the CONFIGURATION_TYPE_* constants
$configurationPath string The path inside the configuration to fetch
Результат array The configuration

includeSubRoutesFromSettings() защищенный Метод

Merges routes from Neos.Flow.mvc.routes settings into $routeDefinitions NOTE: Routes from settings will always be appended to existing route definitions from the main Routes configuration!
protected includeSubRoutesFromSettings ( array &$routeDefinitions ) : void
$routeDefinitions array
Результат void

injectConfigurationSource() публичный Метод

Injects the configuration source
public injectConfigurationSource ( YamlSource $configurationSource ) : void
$configurationSource Neos\Flow\Configuration\Source\YamlSource
Результат void

isSplitSourceAllowedForConfigurationType() публичный Метод

Check the allowSplitSource setting for the configuration type.
public isSplitSourceAllowedForConfigurationType ( string $configurationType ) : boolean
$configurationType string
Результат boolean

loadConfiguration() защищенный Метод

Loads special configuration defined in the specified packages and merges them with those potentially existing in the global configuration folders. The result is stored in the configuration manager's configuration registry and can be retrieved with the getConfiguration() method.
protected loadConfiguration ( string $configurationType, array $packages ) : void
$configurationType string The kind of configuration to load - must be one of the CONFIGURATION_TYPE_* constants
$packages array An array of Package objects (indexed by package key) to consider
Результат void

loadConfigurationCache() публичный Метод

If a cache file with previously saved configuration exists, it is loaded.
public loadConfigurationCache ( ) : boolean
Результат boolean If cached configuration was loaded or not

mergePolicyConfiguration() защищенный Метод

Merges two policy configuration arrays.
protected mergePolicyConfiguration ( array $firstConfigurationArray, array $secondConfigurationArray ) : array
$firstConfigurationArray array
$secondConfigurationArray array
Результат array

mergeRoutesWithSubRoutes() защищенный Метод

Loads specified sub routes and builds composite routes.
protected mergeRoutesWithSubRoutes ( array &$routesConfiguration ) : void
$routesConfiguration array
Результат void

postProcessConfiguration() защищенный Метод

Post processes the given configuration array by replacing constants with their actual value.
protected postProcessConfiguration ( array &$configurations ) : void
$configurations array
Результат void

registerConfigurationType() публичный Метод

The processing type must be supported by the ConfigurationManager, see CONFIGURATION_PROCESSING_TYPE_* for what is available.
public registerConfigurationType ( string $configurationType, string $configurationProcessingType = self::CONFIGURATION_PROCESSING_TYPE_DEFAULT, boolean $allowSplitSource = false ) : void
$configurationType string The type to register, may be anything
$configurationProcessingType string One of CONFIGURATION_PROCESSING_TYPE_*, defaults to CONFIGURATION_PROCESSING_TYPE_DEFAULT
$allowSplitSource boolean If TRUE, the type will be used as a "prefix" when looking for split configuration. Only supported for DEFAULT and SETTINGS processing types!
Результат void

replacePlaceholders() защищенный Метод

Replaces placeholders in the format with the corresponding variable of the specified $variables collection.
protected replacePlaceholders ( string $string, array $variables ) : string
$string string
$variables array
Результат string

replaceVariablesInValue() защищенный Метод

Replaces variables (in the format %CONSTANT% or %ENV::ENVIRONMENT_VARIABLE) in the given (configuration) value string.
protected replaceVariablesInValue ( string $value ) : mixed
$value string
Результат mixed

resolveConfigurationProcessingType() публичный Метод

This returns the CONFIGURATION_PROCESSING_TYPE_* to use for the given $configurationType.
public resolveConfigurationProcessingType ( string $configurationType ) : string
$configurationType string
Результат string

saveConfigurationCache() защищенный Метод

Saves the current configuration into a cache file and creates a cache inclusion script in the context's Configuration directory.
protected saveConfigurationCache ( ) : void
Результат void

setPackages() публичный Метод

Sets the active packages to load the configuration for
public setPackages ( array $packages ) : void
$packages array
Результат void

setTemporaryDirectoryPath() публичный Метод

Set an absolute file path to store configuration caches in. If null no cache will be active.
public setTemporaryDirectoryPath ( string $temporaryDirectoryPath )
$temporaryDirectoryPath string

shutdown() публичный Метод

This method writes the current configuration into a cache file if Flow was configured to do so.
public shutdown ( ) : void
Результат void

validatePolicyConfiguration() защищенный Метод

Validates the given $policyConfiguration and throws an exception if its not valid
protected validatePolicyConfiguration ( array $policyConfiguration, Neos\Flow\Package\PackageInterface $package ) : void
$policyConfiguration array
$package Neos\Flow\Package\PackageInterface
Результат void

warmup() публичный Метод

Warms up the complete configuration cache, i.e. fetching every configured configuration type in order to be able to store it into the cache, if configured to do so.
См. также: Neos\Flow\Configuration\ConfigurationManager::shutdown
public warmup ( ) : void
Результат void

Описание свойств

$cacheNeedsUpdate защищенное свойство

protected bool $cacheNeedsUpdate
Результат boolean

$configurationSource защищенное свойство

protected YamlSource,Neos\Flow\Configuration\Source $configurationSource
Результат Neos\Flow\Configuration\Source\YamlSource

$configurationTypes защищенное свойство

Defines which Configuration Type is processed by which logic
protected array $configurationTypes
Результат array

$configurations защищенное свойство

Storage of the raw special configurations
protected array $configurations
Результат array

$context защищенное свойство

The application context of the configuration to manage
protected ApplicationContext,Neos\Flow\Core $context
Результат Neos\Flow\Core\ApplicationContext

$orderedListOfContextNames защищенное свойство

Example: Development, Development/Foo, Development/Foo/Bar
protected array $orderedListOfContextNames
Результат array

$packages защищенное свойство

Active packages to load the configuration for
protected array $packages
Результат array

$subRoutesRecursionLevel защищенное свойство

Counts how many SubRoutes have been loaded. If this number exceeds MAXIMUM_SUBROUTE_RECURSIONS, an exception is thrown
protected int $subRoutesRecursionLevel
Результат integer

$temporaryDirectoryPath защищенное свойство

An absolute file path to store configuration caches in. If null no cache will be active.
protected string $temporaryDirectoryPath
Результат string