A Flow Application context is something like "Production", "Development",
"Production/StagingSystem", and is set using the FLOW_CONTEXT environment variable.
A context can contain arbitrary sub-contexts, which are delimited with slash
("Production/StagingSystem", "Production/Staging/Server1"). The top-level
contexts, however, must be one of "Testing", "Development" and "Production".
Mainly, you will use $context->isProduction(), $context->isTesting() and
$context->isDevelopment() inside your custom code.
/**
* @test
*/
public function parentContextIsConnectedRecursively()
{
$context = new ApplicationContext('Production/Foo/Bar');
$parentContext = $context->getParent();
$this->assertSame('Production/Foo', (string) $parentContext);
$rootContext = $parentContext->getParent();
$this->assertSame('Production', (string) $rootContext);
}
/**
* @test
*/
public function unfreezePackageEmitsPackageStatesUpdatedSignal()
{
$this->mockApplicationContext->expects($this->atLeastOnce())->method('isDevelopment')->will($this->returnValue(true));
$this->packageManager->createPackage('Some.Package', ['name' => 'some/package', 'type' => 'neos-package']);
$this->packageManager->freezePackage('Some.Package');
$this->mockDispatcher->expects($this->once())->method('dispatch')->with(PackageManager::class, 'packageStatesUpdated');
$this->packageManager->unfreezePackage('Some.Package');
}
/**
* @test
*/
public function initializeFlushesCachesInDevelopmentContextIfRoutingSettingsWhereNotStoredPreviously()
{
$this->mockApplicationContext->expects($this->atLeastOnce())->method('isDevelopment')->will($this->returnValue(true));
$this->mockRouteCache->expects($this->atLeastOnce())->method('get')->with('routingSettings')->will($this->returnValue(false));
$this->mockRouteCache->expects($this->once())->method('flush');
$this->mockResolveCache->expects($this->once())->method('flush');
$this->routerCachingService->_call('initializeObject');
}
/**
* Returns the form definitions for the step
*
* @param FormDefinition $formDefinition
* @return void
*/
protected function buildForm(FormDefinition $formDefinition)
{
$page1 = $formDefinition->createPage('page1');
$page1->setRenderingOption('header', 'Setup complete');
$congratulations = $page1->createElement('congratulationsSection', 'Neos.Form:Section');
$congratulations->setLabel('Congratulations');
$success = $congratulations->createElement('success', 'Neos.Form:StaticText');
$success->setProperty('text', 'You have successfully installed Neos! If you need help getting started, please refer to the Neos documentation.');
$success->setProperty('elementClassAttribute', 'alert alert-success');
$docs = $congratulations->createElement('docsLink', 'Neos.Setup:LinkElement');
$docs->setLabel('Read the documentation');
$docs->setProperty('href', 'https://neos.readthedocs.org/');
$docs->setProperty('target', '_blank');
$contextEnv = Bootstrap::getEnvironmentConfigurationSetting('FLOW_CONTEXT') ?: 'Development';
$applicationContext = new ApplicationContext($contextEnv);
if (!$applicationContext->isProduction()) {
$context = $page1->createElement('contextSection', 'Neos.Form:Section');
$context->setLabel('Define application context');
$contextInfo = $context->createElement('contextInfo', 'Neos.Form:StaticText');
$contextInfo->setProperty('text', 'Your Neos installation is currently not running in "Production" context. If you want to experience Neos with its full speed, you should now change your FLOW_CONTEXT environment variable to "Production".');
$contextDocs = $context->createElement('contextDocsLink', 'Neos.Setup:LinkElement');
$contextDocs->setLabel('Read about application contexts');
$contextDocs->setProperty('href', 'http://flowframework.readthedocs.org/en/stable/TheDefinitiveGuide/PartIII/Bootstrapping.html#the-typo3-flow-application-context');
$contextDocs->setProperty('target', '_blank');
}
$frontend = $page1->createElement('frontendSection', 'Neos.Form:Section');
$frontend->setLabel('View the site');
$link = $frontend->createElement('link', 'Neos.Setup:LinkElement');
$link->setLabel('Go to the frontend');
$link->setProperty('href', '/');
$link->setProperty('elementClassAttribute', 'btn btn-large btn-primary');
$backend = $page1->createElement('backendSection', 'Neos.Form:Section');
$backend->setLabel('Start editing');
$backendLink = $backend->createElement('backendLink', 'Neos.Setup:LinkElement');
$backendLink->setLabel('Go to the backend');
$backendLink->setProperty('href', '/neos');
$backendLink->setProperty('elementClassAttribute', 'btn btn-large btn-primary');
$loggedOut = $page1->createElement('loggedOut', 'Neos.Form:StaticText');
$loggedOut->setProperty('text', 'You have automatically been logged out for security reasons since this is the final step. Refresh the page to log in again if you missed something.');
$loggedOut->setProperty('elementClassAttribute', 'alert alert-info');
}
/**
* Builds a boot sequence starting all modules necessary for the runtime state.
* This includes all of the "essentials" sequence.
*
* @return Sequence
* @api
*/
public function buildRuntimeSequence()
{
$sequence = $this->buildEssentialsSequence('runtime');
$sequence->addStep(new Step('neos.flow:objectmanagement:proxyclasses', [Scripts::class, 'initializeProxyClasses']), 'neos.flow:systemlogger');
$sequence->addStep(new Step('neos.flow:classloader:cache', [Scripts::class, 'initializeClassLoaderClassesCache']), 'neos.flow:objectmanagement:proxyclasses');
$sequence->addStep(new Step('neos.flow:objectmanagement:runtime', [Scripts::class, 'initializeObjectManager']), 'neos.flow:classloader:cache');
if (!$this->context->isProduction()) {
$sequence->addStep(new Step('neos.flow:systemfilemonitor', [Scripts::class, 'initializeSystemFileMonitor']), 'neos.flow:objectmanagement:runtime');
$sequence->addStep(new Step('neos.flow:objectmanagement:recompile', [Scripts::class, 'recompileClasses']), 'neos.flow:systemfilemonitor');
}
$sequence->addStep(new Step('neos.flow:reflectionservice', [Scripts::class, 'initializeReflectionService']), 'neos.flow:objectmanagement:runtime');
$sequence->addStep(new Step('neos.flow:resources', [Scripts::class, 'initializeResources']), 'neos.flow:reflectionservice');
$sequence->addStep(new Step('neos.flow:session', [Scripts::class, 'initializeSession']), 'neos.flow:resources');
return $sequence;
}
/**
* 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.
*
* @param string $configurationType The kind of configuration to load - must be one of the CONFIGURATION_TYPE_* constants
* @param array $packages An array of Package objects (indexed by package key) to consider
* @throws Exception\InvalidConfigurationTypeException
* @throws Exception\InvalidConfigurationException
* @return void
*/
protected function loadConfiguration($configurationType, array $packages)
{
$this->cacheNeedsUpdate = true;
$configurationProcessingType = $this->resolveConfigurationProcessingType($configurationType);
$allowSplitSource = $this->isSplitSourceAllowedForConfigurationType($configurationType);
switch ($configurationProcessingType) {
case self::CONFIGURATION_PROCESSING_TYPE_SETTINGS:
// Make sure that the Flow package is the first item of the packages array:
if (isset($packages['Neos.Flow'])) {
$flowPackage = $packages['Neos.Flow'];
unset($packages['Neos.Flow']);
$packages = array_merge(['Neos.Flow' => $flowPackage], $packages);
unset($flowPackage);
}
$settings = [];
/** @var $package PackageInterface */
foreach ($packages as $packageKey => $package) {
if (Arrays::getValueByPath($settings, $packageKey) === null) {
$settings = Arrays::setValueByPath($settings, $packageKey, []);
}
$settings = Arrays::arrayMergeRecursiveOverrule($settings, $this->configurationSource->load($package->getConfigurationPath() . $configurationType, $allowSplitSource));
}
$settings = Arrays::arrayMergeRecursiveOverrule($settings, $this->configurationSource->load(FLOW_PATH_CONFIGURATION . $configurationType, $allowSplitSource));
foreach ($this->orderedListOfContextNames as $contextName) {
/** @var $package PackageInterface */
foreach ($packages as $package) {
$settings = Arrays::arrayMergeRecursiveOverrule($settings, $this->configurationSource->load($package->getConfigurationPath() . $contextName . '/' . $configurationType, $allowSplitSource));
}
$settings = Arrays::arrayMergeRecursiveOverrule($settings, $this->configurationSource->load(FLOW_PATH_CONFIGURATION . $contextName . '/' . $configurationType, $allowSplitSource));
}
if ($this->configurations[$configurationType] !== []) {
$this->configurations[$configurationType] = Arrays::arrayMergeRecursiveOverrule($this->configurations[$configurationType], $settings);
} else {
$this->configurations[$configurationType] = $settings;
}
$this->configurations[$configurationType]['Neos']['Flow']['core']['context'] = (string) $this->context;
break;
case self::CONFIGURATION_PROCESSING_TYPE_OBJECTS:
$this->configurations[$configurationType] = [];
/** @var $package PackageInterface */
foreach ($packages as $packageKey => $package) {
$configuration = $this->configurationSource->load($package->getConfigurationPath() . $configurationType);
$configuration = Arrays::arrayMergeRecursiveOverrule($configuration, $this->configurationSource->load(FLOW_PATH_CONFIGURATION . $configurationType));
foreach ($this->orderedListOfContextNames as $contextName) {
$configuration = Arrays::arrayMergeRecursiveOverrule($configuration, $this->configurationSource->load($package->getConfigurationPath() . $contextName . '/' . $configurationType));
$configuration = Arrays::arrayMergeRecursiveOverrule($configuration, $this->configurationSource->load(FLOW_PATH_CONFIGURATION . $contextName . '/' . $configurationType));
}
$this->configurations[$configurationType][$packageKey] = $configuration;
}
break;
case self::CONFIGURATION_PROCESSING_TYPE_POLICY:
if ($this->context->isTesting()) {
$testingPolicyPathAndFilename = $this->temporaryDirectoryPath . 'Policy';
if ($this->configurationSource->has($testingPolicyPathAndFilename)) {
$this->configurations[$configurationType] = $this->configurationSource->load($testingPolicyPathAndFilename);
break;
}
}
$this->configurations[$configurationType] = [];
/** @var $package PackageInterface */
foreach ($packages as $package) {
$packagePolicyConfiguration = $this->configurationSource->load($package->getConfigurationPath() . $configurationType, $allowSplitSource);
$this->validatePolicyConfiguration($packagePolicyConfiguration, $package);
$this->configurations[$configurationType] = $this->mergePolicyConfiguration($this->configurations[$configurationType], $packagePolicyConfiguration);
}
$this->configurations[$configurationType] = $this->mergePolicyConfiguration($this->configurations[$configurationType], $this->configurationSource->load(FLOW_PATH_CONFIGURATION . $configurationType, $allowSplitSource));
foreach ($this->orderedListOfContextNames as $contextName) {
/** @var $package PackageInterface */
foreach ($packages as $package) {
$packagePolicyConfiguration = $this->configurationSource->load($package->getConfigurationPath() . $contextName . '/' . $configurationType, $allowSplitSource);
$this->validatePolicyConfiguration($packagePolicyConfiguration, $package);
$this->configurations[$configurationType] = $this->mergePolicyConfiguration($this->configurations[$configurationType], $packagePolicyConfiguration);
}
$this->configurations[$configurationType] = $this->mergePolicyConfiguration($this->configurations[$configurationType], $this->configurationSource->load(FLOW_PATH_CONFIGURATION . $contextName . '/' . $configurationType, $allowSplitSource));
}
break;
case self::CONFIGURATION_PROCESSING_TYPE_DEFAULT:
$this->configurations[$configurationType] = [];
/** @var $package PackageInterface */
foreach ($packages as $package) {
$this->configurations[$configurationType] = Arrays::arrayMergeRecursiveOverrule($this->configurations[$configurationType], $this->configurationSource->load($package->getConfigurationPath() . $configurationType, $allowSplitSource));
}
$this->configurations[$configurationType] = Arrays::arrayMergeRecursiveOverrule($this->configurations[$configurationType], $this->configurationSource->load(FLOW_PATH_CONFIGURATION . $configurationType, $allowSplitSource));
foreach ($this->orderedListOfContextNames as $contextName) {
/** @var $package PackageInterface */
foreach ($packages as $package) {
$this->configurations[$configurationType] = Arrays::arrayMergeRecursiveOverrule($this->configurations[$configurationType], $this->configurationSource->load($package->getConfigurationPath() . $contextName . '/' . $configurationType, $allowSplitSource));
}
$this->configurations[$configurationType] = Arrays::arrayMergeRecursiveOverrule($this->configurations[$configurationType], $this->configurationSource->load(FLOW_PATH_CONFIGURATION . $contextName . '/' . $configurationType, $allowSplitSource));
}
break;
case self::CONFIGURATION_PROCESSING_TYPE_ROUTES:
// load main routes
$this->configurations[$configurationType] = [];
foreach (array_reverse($this->orderedListOfContextNames) as $contextName) {
$this->configurations[$configurationType] = array_merge($this->configurations[$configurationType], $this->configurationSource->load(FLOW_PATH_CONFIGURATION . $contextName . '/' . $configurationType));
}
$this->configurations[$configurationType] = array_merge($this->configurations[$configurationType], $this->configurationSource->load(FLOW_PATH_CONFIGURATION . $configurationType));
// load subroutes from Routes.yaml and Settings.yaml and merge them with main routes recursively
$this->includeSubRoutesFromSettings($this->configurations[$configurationType]);
$this->mergeRoutesWithSubRoutes($this->configurations[$configurationType]);
break;
case self::CONFIGURATION_PROCESSING_TYPE_APPEND:
$this->configurations[$configurationType] = [];
/** @var $package PackageInterface */
foreach ($packages as $package) {
$this->configurations[$configurationType] = array_merge($this->configurations[$configurationType], $this->configurationSource->load($package->getConfigurationPath() . $configurationType, $allowSplitSource));
}
$this->configurations[$configurationType] = array_merge($this->configurations[$configurationType], $this->configurationSource->load(FLOW_PATH_CONFIGURATION . $configurationType, $allowSplitSource));
foreach ($this->orderedListOfContextNames as $contextName) {
foreach ($packages as $package) {
$this->configurations[$configurationType] = array_merge($this->configurations[$configurationType], $this->configurationSource->load($package->getConfigurationPath() . $contextName . '/' . $configurationType, $allowSplitSource));
}
$this->configurations[$configurationType] = array_merge($this->configurations[$configurationType], $this->configurationSource->load(FLOW_PATH_CONFIGURATION . $contextName . '/' . $configurationType, $allowSplitSource));
}
break;
default:
throw new Exception\InvalidConfigurationTypeException('Configuration type "' . $configurationType . '" cannot be loaded with loadConfiguration().', 1251450613);
}
$this->postProcessConfiguration($this->configurations[$configurationType]);
}
/**
* Exports the internal reflection data into the ReflectionData cache
*
* This method is triggered by a signal which is connected to the bootstrap's
* shutdown sequence.
*
* If the reflection data has previously been loaded from the runtime cache,
* saving it is omitted as changes are not expected.
*
* In Production context the whole cache is written at once and then frozen in
* order to be consistent. Frozen cache data in Development is only produced for
* classes contained in frozen packages.
*
* @return void
* @throws Exception if no cache has been injected
*/
public function saveToCache()
{
if ($this->hasFrozenCacheInProduction()) {
return;
}
if (!$this->initialized) {
$this->initialize();
}
if ($this->loadFromClassSchemaRuntimeCache === true) {
return;
}
if (!$this->reflectionDataCompiletimeCache instanceof FrontendInterface) {
throw new Exception('A cache must be injected before initializing the Reflection Service.', 1232044697);
}
if ($this->updatedReflectionData !== []) {
$this->updateReflectionData();
}
if ($this->context->isProduction()) {
$this->saveProductionData();
return;
}
$this->saveDevelopmentData();
}
