Wallogit.com
2017 © Pedro Peláez
Symfony DirectoryLoaderBundle to recursively import directories of configuration
Recursively import directories of configuration., (*1)
This works for your main configuration files and the router., (*2)
See https://github.com/symfony/symfony-standard/issues/599, (*3)
Since https://github.com/symfony/symfony/pull/14700 has been merged (Symfony 2.8+), the directory loader is included by default in Symfony. The documentation is kept here however for reference purposes., (*4)
Please refer to http://symfony.com/doc/current/cookbook/configuration/configuration_organization.html for further use-cases of the DirectoryLoader., (*5)
Add the following in your root composer.json file:, (*6)
{
"require": {
"wemakecustom/directory-loader-bundle": "^1.0"
},
}
And modify your app/AppKernel.php:, (*7)
getResolver();
$resolver->addLoader(new DirectoryFileLoader($container, $locator));
return $loader;
}
?>
Strictly speaking, registering the Bundle is only necessary if you want the fonctionnality in the routing files and overloading the ContainerLoader is only necessary for the main configuration files, but you do what you want., (*8)
The main goal of this bundle is to drop configuration files in folder without modifying
the main config.yml. This way, each file can group all (and only) the configuration
related to a specific bundle., (*9)
Instead of using config_ENV.yml, one may use a directory for each environment., (*10)
For example:, (*11)
└── app ├── config │ ├── common │ │ └── assetic.yml │ │ └── framework.yml │ │ └── security.yml │ ├── dev │ │ └── framework.yml │ │ └── assetic.yml │ ├── prod │ │ └── assetic.yml │ │ └── google_analytics.yml │ ├── config.yml │ └── parameters.yml └── AppKernel.php
<?php
// app/AppKernel.php
public function registerContainerConfiguration(LoaderInterface $loader)
{
$loader->load(__DIR__.'/config/config.yml');
$loader->load(__DIR__.'/config/' . $this->getEnvironment() . '/');
}
?>
# app/config/config.yml
imports:
- { resource: 'parameters.yml' }
- { resource: 'common/' }
Parameters can be loaded as directories as well in the same fashion., (*12)
Moreover, an interesting concept is to have a folder for core parameters, global to your application and local parameters, specific to each installation., (*13)
For example:, (*14)
└── app ├── config │ └── … ├── parameters │ └── common │ │ └── core.yml │ │ └── i18n.yml │ ├── dist │ │ └── mailer.yml │ ├── local │ │ └── .gitignore │ └── config.yml └── AppKernel.php
app/parameters/local/*.yml will be ignored and its content will be the files from
app/parameters/dist, copied and modified accordingly., (*15)
You can then modify your config.yml:, (*16)
# app/config/config.yml
imports:
- { resource: 'parameters/common/' }
- { resource: 'parameters/local/' }
- { resource: 'common/' }
To fill the missing files on each composer run, you can replace the native parameters
builder by wemakecustom/composer-script-utils
and configure your composer.json, replacing Incenteev\ParameterHandler\ScriptHandler, (*17)
{
"require": {
# ...
"wemakecustom/directory-loader-bundle": "^1.0",
"wemakecustom/composer-script-utils": "^0.3"
},
"scripts": {
"post-install-cmd": [
"WMC\\Composer\\Utils\\ConfigFile\\ConfigDir::updateDirs",
# remove this: "Incenteev\\ParameterHandler\\ScriptHandler::buildParameters"
# ...
],
"post-update-cmd": [
"WMC\\Composer\\Utils\\ConfigFile\\ConfigDir::updateDirs",
# remove this: "Incenteev\\ParameterHandler\\ScriptHandler::buildParameters"
# ...
]
},
"extra": {
"update-config-dirs": {
"app/config/parameters/dist": "app/config/parameters/local"
},
# # remove this:
# "incenteev-parameters": {
# "file": "app/config/parameters.yml"
# },
}
}
You can see the final configuration tree here: https://github.com/wemakecustom/symfony-kickstart/tree/master/dist, (*18)
It is also possible to use this library without registering with Symfony., (*19)
To do so, simply add the proper loader to your LoaderResolver., (*20)
Example with routing:, (*21)
addLoader(new DirectoryFileLoader($locator)); ?>
Example with DI can be found above., (*22)
AsseticBundle features a PHP directory loader to be able to parse Controllers. This directory loader superseeds it: if it tries to do the job of Assetic’s loader, it works correctly, but not the other way around., (*23)
Therefore, this bundle inserts itself before Assetic to ensure it is run before.
A way to prevent this is to specify type: directory in the router import, but there is
currently a bug around this method. See symfony/AsseticBundle#289 and symfony/symfony#11018., (*24)
Symfony DirectoryLoaderBundle to recursively import directories of configuration
MIT
Symfony DirectoryLoaderBundle to recursively import directories of configuration
MIT