illchuk/zend-config-cacheproof

Create *.cacheproof.php config files that skip the cache, with custom loading.

v0.1.1 2017-10-14 04:35 UTC

Requires

• php: ^5.5|^7.0
• zendframework/zend-modulemanager: ^2.2
• zendframework/zend-servicemanager: ^3.0

Requires (Dev)

• phpunit/phpunit: ~4.0

MIT

• Derek Illchuk

• cache
• config
• zf3
• zend-config

README

Purpose

Caching your config is nice (i.e. using 'module_listener_options' => ['config_cache_enabled' => true]), but this locks your config down tight. What if you need to tweak things a bit for, say, running tests? Enter ZendConfigCacheproof.

Install with composer require illchuk/zend-config-cacheproof.

Then reference in modules.config.php:

return [
    ..., 'ZendConfigCacheproof', ...
];

Easy Start

In your config/autoload, create *.cacheproof.php config files. (As opposed to the usual *.global.php and *.local.php files.) These will be loaded every time.

Useful Start

You may want your configuration to change based on environment variables; install a cacheproof_loaders factory -- see config/cacheproof.global.php.dist -- like the following:

namespace Application\Cacheproof;

use Interop\Container\ContainerInterface;
use Zend\ServiceManager\Factory\FactoryInterface;
use ZendConfigCacheproof\Loader\EnvironmentVariable as EnvLoader;

class LoaderFactory implements FactoryInterface {

    const GLOB_LIVE = './config/autoload/{{,*.}live}.php';
    const ENV_VAR_LIVE = 'INSTANCE_LIVE';

    public function __invoke(
    ContainerInterface $container, $requestedName, array $options = null
    ) {
        $loader = new EnvLoader(static::ENV_VAR_LIVE);
        $loader->setGlob(static::GLOB_LIVE);
        return $loader;
    }

}

Then, your ./config/autoload/{{,*.}live}.php config is live-loaded whenever environment variable INSTANCE_LIVE is true-ish.

Removing Conflicting Config

You may want to remove config too. This can be done as follows:

<?php // in ./config/autoload/cacheproof.php

return [
    'foobar' => new \Zend\Stdlib\ArrayUtils\MergeRemoveKey, // toast it
]