• Home
• Neos
• Flow
• Configuration
• ConfigurationManager

PHP Class Neos\Flow\Configuration\ConfigurationManager

Datei anzeigen Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property	Type	Description
$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.

Public Methods

Method	Description
__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.

Protected Methods

Method	Description
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

Method Details

Property Details