Advanced Configuration Tricks
Advanced Configuration Tricks
Configuration of zend-mvc applications happens in several steps:
- Initial configuration is passed to the
Application
instance and used to seed theModuleManager
andServiceManager
. In this tutorial, we will call this configuration system configuration. - The
ModuleManager
'sConfigListener
aggregates configuration and merges it while modules are being loaded. In this tutorial, we will call this configurationapplication configuration. - Once configuration is aggregated from all modules, the
ConfigListener
will also merge application configuration globbed in specified directories (typicallyconfig/autoload/
). - Finally, immediately prior to the merged application configuration being passed to the
ServiceManager
, it is passed to a specialEVENT_MERGE_CONFIG
event to allow further modification.
In this tutorial, we'll look at the exact sequence, and how you can tie into it.
System configuration
To begin module loading, we have to tell the Application
instance about the available modules and where they live, optionally provide some information to the default module listeners (e.g., where application configuration lives, and what files to load; whether to cache merged configuration, and where; etc.), and optionally seed the ServiceManager
. For purposes of this tutorial we will call this the system configuration.
When using the skeleton application, the system configuration is by default inconfig/application.config.php
. The defaults look like this:
return [
// Retrieve list of modules used in this application.
'modules' => require __DIR__ . '/modules.config.php',
// These are various options for the listeners attached to the ModuleManager
'module_listener_options' => [
// This should be an array of paths in which modules reside.
// If a string key is provided, the listener will consider that a module
// namespace, the value of that key the specific path to that module's
// Module class.
'module_paths' => [
'./module',
'./vendor',
],
// An array of paths from which to glob configuration files after
// modules are loaded. These effectively override configuration
// provided by modules themselves. Paths may use GLOB_BRACE notation.
'config_glob_paths' => [
realpath(__DIR__) . '/autoload/{{,*.}global,{,*.}local}.php',
],
// Whether or not to enable a configuration cache.
// If enabled, the merged configuration will be cached and used in
// subsequent requests.
'config_cache_enabled' => true,
// The key used to create the configuration cache file name.
'config_cache_key' => 'application.config.cache',
// Whether or not to enable a module class map cache.
// If enabled, creates a module class map cache which will be used
// by in future requests, to reduce the autoloading process.
'module_map_cache_enabled' => true,
// The key used to create the class map cache file name.
'module_map_cache_key' => 'application.module.cache',
// The path in which to cache merged configuration.
'cache_dir' => 'data/cache/',
// Whether or not to enable modules dependency checking.
// Enabled by default, prevents usage of modules that depend on other modules
// that weren't loaded.
// 'check_dependencies' => true,
],
// Used to create an own service manager. May contain one or more child arrays.
//'service_listener_options' => [
// [
// 'service_manager' => $stringServiceManagerName,
// 'config_key' => $stringConfigKey,
// 'interface' => $stringOptionalInterface,
// 'method' => $stringRequiredMethodName,
// ],
// ],
// Initial configuration with which to seed the ServiceManager.
// Should be compatible with Zend\ServiceManager\Config.
// 'service_manager' => [],
];
The system configuration is for the bits and pieces related to the MVC that run before your application is ready. The configuration is usually brief, and quite minimal.
Also, system configuration is used immediately, and is not merged with any other configuration — which means, with the exception of the values under theservice_manager
key, it cannot be overridden by a module.
This leads us to our first trick: how do you provide environment-specific system configuration?
Environment-specific system configuration
What happens when you want to change the set of modules you use based on the environment? Or if the configuration caching should be enabled based on environment?
It is for this reason that the default system configuration we provide in the skeleton application is in PHP; providing it in PHP means you can programmatically manipulate it.
As an example, let's make the following requirements:
- We want to use the
ZendDeveloperTools
module in development only. - We want to have configuration caching on in production only.
zfcampus/zf-development-mode provides a concise and conventions-based approach to switching between specifically production and development. The package is installed by default with version 3+ skeletons, and can be installed with existing v2 skeletons using the following:
$ composer require zfcampus/zf-development-mode
The approach it takes is as follows:
- The user provides production settings in
config/application.config.php
. - The user provides development settings in
config/development.config.php.dist
to override bootstrap-level settings such as modules and configuration caching, and optionally also inconfig/autoload/development.local.php.dist
(to override application settings). - The bootstrap script (
public/index.php
) checks forconfig/development.config.php
, and, if found, merges its configuration with the application configuration prior to configuring theApplication
instance.
When you execute:
$ ./vendor/bin/zf-development-mode enable
The .dist
files are copied to versions removing the suffix; doing so ensures they will then be used when invoking the application.
As such, to accomplish our goals, we will do the following:
- In
config/development.config.php.dist
, addZendDeveloperTools
to the list of modules:
'modules' => [
'ZendDeveloperTools',
],
- Also in
config/development.config.php.dist
, we will disable config caching:
'config_cache_enable' => false,
- In
config/application.config.php
, we will enable config caching:
'config_cache_enable' => true,
Enabling development mode now enables the selected module, and disables configuration caching; disabling development mode enables configuration caching. (Also, either operation clears the configuration cache.)
If you require additional environments, you can extend zf-development-mode to address them using the same workflow.
Environment-specific application configuration
Sometimes you want to change application configuration to load things such as database adapters, log writers, cache adapters, and more based on the environment. These are typically managed in the service manager, and may be defined by modules. You can override them at the application level viaZend\ModuleManager\Listener\ConfigListener
, by specifying a glob path in thesystem configuration — the module_listener_options.config_glob_paths
key from the previous examples.
The default value for this is config/autoload/{{,*.}global,{,*.}local}.php
. What this means is that it will look for application configuration files in theconfig/autoload
directory, in the following order:
global.php
*.global.php
local.php
*.local.php
This allows you to define application-level defaults in "global" configuration files, which you would then commit to your version control system, and environment-specific overrides in your "local" configuration files, which you would omit from version control.
Additional glob patterns for development mode
When using zf-development-mode, as detailed in the previous section, the shipped
config/development.config.php.dist
file provides an additional glob pattern for specifying development configuration:
config/autoload/{,*.}{global,local}-development.php
This will match files such as:
- database.global-development.php
- database.local-development.php
These will only be considered when development mode is enabled!
This is a great solution for development, as it allows you to specify alternate configuration that's specific to your development environment without worrying about accidently deploying it. However, what if you have more environments &mdash such as a "testing" or "staging" environment — and they each have their own specific overrides?
To accomplish this, we'll provide an environment variable via our web server configuration, APP_ENV
. In Apache, you'd put a directive like the following in either your system-wide apache.conf or httpd.conf, or in the definition for your virtual host; alternately, it can be placed in an .htaccess file.
SetEnv "APP_ENV" "development"
For other web servers, consult the web server documentation to determine how to set environment variables.
To simplify matters, we'll assume the environment is "production" if no environment variable is present.
With that in place, We can alter the glob path in the system configuration slightly:
'config_glob_paths' => [
realpath(__DIR__) . sprintf('config/autoload/{,*.}{global,%s,local}.php', getenv('APP_ENV') ?: 'production')
],
The above will allow you to define an additional set of application configuration files per environment; furthermore, these will be loaded only if that environment is detected!
As an example, consider the following tree of configuration files:
config/
autoload/
global.php
local.php
users.development.php
users.testing.php
users.local.php
If $env
evaluates to testing
, then the following files will be merged, in the following order:
global.php
users.testing.php
local.php
users.local.php
Note that users.development.php
is not loaded — this is because it will not match the glob pattern!
Also, because of the order in which they are loaded, you can predict which values will overwrite the others, allowing you to both selectively overwrite as well as debug later.
Order of config merging
The files under
config/autoload/
are merged after your module configuration, detailed in next section. We have detailed it here, however, as setting up the application configuration glob path happens within thesystem configuration (config/application.config.php
).
Module Configuration
One responsibility of modules is to provide their own configuration to the application. Modules have two general mechanisms for doing this.
First, modules that either implementZend\ModuleManager\Feature\ConfigProviderInterface
and/or a getConfig()
method can return their configuration. The default, recommended implementation of the getConfig()
method is:
public function getConfig()
{
return include __DIR__ . '/config/module.config.php';
}
where module.config.php
returns a PHP array. From that PHP array you can provide general configuration as well as configuration for all the availableManager
classes provided by the ServiceManager. Please refer to theConfiguration mapping table to see which configuration key is used for each specific Manager
.
Second, modules can implement a number of interfaces and/or methods related to specific service manager or plugin manager configuration. You will find an overview of all interfaces and their matching Module Configuration functions inside the Configuration mapping table.
Most interfaces are in the Zend\ModuleManager\Feature
namespace (some have moved to the individual components), and each is expected to return an array of configuration for a service manager, as denoted in the section on default service configuration.
Configuration mapping table
Manager name | Interface name | Module method name | Config key name |
---|---|---|---|
ControllerPluginManager |
ControllerPluginProviderInterface |
getControllerPluginConfig() |
controller_plugins |
ControllerManager |
ControllerProviderInterface |
getControllerConfig() |
controllers |
FilterManager |
FilterProviderInterface |
getFilterConfig() |
filters |
FormElementManager |
FormElementProviderInterface |
getFormElementConfig() |
form_elements |
HydratorManager |
HydratorProviderInterface |
getHydratorConfig() |
hydrators |
InputFilterManager |
InputFilterProviderInterface |
getInputFilterConfig() |
input_filters |
RoutePluginManager |
RouteProviderInterface |
getRouteConfig() |
route_manager |
SerializerAdapterManager |
SerializerProviderInterface |
getSerializerConfig() |
serializers |
ServiceLocator |
ServiceProviderInterface |
getServiceConfig() |
service_manager |
ValidatorManager |
ValidatorProviderInterface |
getValidatorConfig() |
validators |
ViewHelperManager |
ViewHelperProviderInterface |
getViewHelperConfig() |
view_helpers |
LogProcessorManager |
LogProcessorProviderInterface |
getLogProcessorConfig |
log_processors |
LogWriterManager |
LogWriterProviderInterface |
getLogWriterConfig |
log_writers |
Configuration Priority
Considering that you may have service configuration in your module configuration file, what has precedence?
The order in which they are merged is:
- configuration returned by the various service configuration methods in a module class
- configuration returned by
getConfig()
In other words, your getConfig()
wins over the various service configuration methods. Additionally, and of particular note: the configuration returned from those methods will not be cached.
Use cases for service configuration methods
Use the various service configuration methods when you need to define closures or instance callbacks for factories, abstract factories, and initializers. This prevents caching problems, and also allows you to write your configuration files in other markup formats.
Manipulating merged configuration
Occasionally you will want to not just override an application configuration key, but actually remove it. Since merging will not remove keys, how can you handle this?
Zend\ModuleManager\Listener\ConfigListener
triggers a special event,Zend\ModuleManager\ModuleEvent::EVENT_MERGE_CONFIG
, after merging all configuration, but prior to it being passed to the ServiceManager
. By listening to this event, you can inspect the merged configuration and manipulate it.
The ConfigListener
itself listens to the event at priority 1000 (i.e., very high), which is when the configuration is merged. You can tie into this to modify the merged configuration from your module, via the init()
method.
namespace Foo;
use Zend\ModuleManager\ModuleEvent;
use Zend\ModuleManager\ModuleManager;
class Module
{
public function init(ModuleManager $moduleManager)
{
$events = $moduleManager->getEventManager();
// Registering a listener at default priority, 1, which will trigger
// after the ConfigListener merges config.
$events->attach(ModuleEvent::EVENT_MERGE_CONFIG, array($this, 'onMergeConfig'));
}
public function onMergeConfig(ModuleEvent $e)
{
$configListener = $e->getConfigListener();
$config = $configListener->getMergedConfig(false);
// Modify the configuration; here, we'll remove a specific key:
if (isset($config['some_key'])) {
unset($config['some_key']);
}
// Pass the changed configuration back to the listener:
$configListener->setMergedConfig($config);
}
}
At this point, the merged application configuration will no longer contain the key some_key
.
Cached configuration and merging
If a cached config is used by the
ModuleManager
, theEVENT_MERGE_CONFIG
event will not be triggered. However, typically that means that what is cached will be what was originally manipulated by your listener.
Configuration merging workflow
To cap off the tutorial, let's review how and when configuration is defined and merged.
- System configuration
- Defined in
config/application.config.php
- No merging occurs
- Allows manipulation programmatically, which allows the ability to:
- Alter flags based on computed values
- Alter the configuration glob path based on computed values
- Configuration is passed to the
Application
instance, and then theModuleManager
in order to initialize the system.
- Application configuration
- The
ModuleManager
loops through each module class in the order defined in the system configuration- Service configuration defined in
Module
class methods is aggregated - Configuration returned by
Module::getConfig()
is aggregated - Files detected from the service configuration
config_glob_paths
setting are merged, based on the order they resolve in the glob path. ConfigListener
triggersEVENT_MERGE_CONFIG
:ConfigListener
merges configuration- Any other event listeners manipulate the configuration
- Merged configuration is finally passed to the
ServiceManager
- Service configuration defined in
Advanced Configuration Tricks的更多相关文章
- openwrt advanced configuration
openwrt高级配置(汗 照着标题就翻译过来了) openwrt Kamikaze 8.09的一般配置文件都在目录 /etc/config 下面,可以使用脚本来调用参数和设置参数. 比如 sbin/ ...
- Bing Advanced Search Tricks You Should Know
Bing is one of the world's most popular search engines that has gained many fans with its ease of us ...
- Google Analytics Advanced Configuration - Google Analytics 高级配置
该文档提供了Android SDK v3的部分元素的高级配置说明. Overview - 概述 Android Google Analytics SDK提供了Tracker类,应用可以用它给Googl ...
- Nginx - Configuration File Syntax
Configuration Directives The Nginx configuration file can be described as a list of directives organ ...
- Jmeter-Maven-Plugin高级应用:Remote Server Configuration
Remote Server Configuration Pages 12 Home Adding additional libraries to the classpath Advanced Conf ...
- Jmeter-Maven-Plugin高级应用:Proxy Configuration
Proxy Configuration Pages 12 Home Adding additional libraries to the classpath Advanced Configuratio ...
- Spring Boot Reference Guide
Spring Boot Reference Guide Authors Phillip Webb, Dave Syer, Josh Long, Stéphane Nicoll, Rob Winch, ...
- App Distribution Guide--(三)---Configuring Your Xcode Project for Distribution
Configuring Your Xcode Project for Distribution You can edit your project settings anytime, but some ...
- gentoo 安装
加载完光驱后 1进行ping命令查看网络是否通畅 2设置硬盘的标识为GPT(主要用于64位且启动模式为UEFI,还有一个是MBR,主要用于32位且启动模式为bois) parted -a optima ...
随机推荐
- EntityFramework版本下载和更新
安装指定版本的Package(例如:EntityFramework 5.0): PM> Install-Package EntityFramework -ProjectName MusicSto ...
- 《深入Java虚拟机学习笔记》- 第2章 平台无关
Java虚拟机学习笔记(二)平台无关
- win7(64位)+IE8+QC9.0
环境win7(64位)+IE8+QC9.0出现的问题IE8访问QC9.0有时访问登录显示正常,但是有时访问QC页面无法显示正常,然后在ie8中安全中设置“启用内存保护帮助减少联机攻击*”也无法找到该项 ...
- grails2.3.11第一课
以指令的方式Getting Started 1. 创建一个项目 grails create-app HelloGrails 2. 因为我环境变量中配置的jdk是1.8的,所以我要把这个项目搞到IDEA ...
- Delphi外挂开发网站
http://cheatengine.org/http://wenku.baidu.com/view/2d5de818964bcf84b9d57b15.html [delphi外G]http:// ...
- nyoj 49 开心的小明
开心的小明 时间限制:1000 ms | 内存限制:65535 KB 难度:4 描述 小明今天很开心,家里购置的新房就要领钥匙了,新房里有一间他自己专用的很宽敞的房间.更让他高兴的是,妈妈昨天 ...
- DOS/Windows下黑客攻防(一)——神秘黑客大曝光
一.认识神秘的黑客 谈到网络安全,人们不自觉间就会联想到黑客,人们往往会将他们同破坏网络安全.盗取用户账号.偷窃个人私密信息联系起来.其实黑客也有好坏之分,他们并不全是网络上的捣乱分子,其中也有一部分 ...
- 【Stage3D学习笔记续】真正的3D世界(三):纹理效果
混合模式: 代码 示例是<Stage3D指南>中的直接弄出来的,可以通过点击键盘上的Q.W.E这3个按键,更换混合模式.模型和纹理,可以直观的查看不同混合模式的效果,住:下方的地形使用&q ...
- eclipse内使用tomcat项目究竟被部署到了哪里
笔者在使用eclipse+tomcat做本地调试,项目没跑起来,原因就很奇怪啊(某前辈说过:奇怪源于无知),然后就想它究竟是把项目放到哪个目录下呢,我的tomcat/webapps目录下并没有啊. 默 ...
- 在ubuntu上面配置nginx实现反向代理
1.下载nginx 官网:http://nginx.org/en/download.html 直接在服务器上下载 wget http://nginx.org/download/nginx- ...