PPI\Framework\ServiceManager\Config\AbstractConfig

Complexity

Total Complexity

6

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getConfigurationReference()	0	4	1
	processConfiguration()	0	1	?
A	mergeConfiguration()	0	4	1
A	getAlias()	0	10	2
A	getParameters()	0	6	2

<?php
/**
 * This file is part of the PPI Framework.
 *
 * @copyright   Copyright (c) 2011-2016 Paul Dragoonis <paul@ppi.io>
 * @license     http://opensource.org/licenses/mit-license.php MIT
 *
 * @link        http://www.ppi.io
 */

namespace PPI\Framework\ServiceManager\Config;

use PPI\Framework\Config\ConfigurationProviderInterface;
use Zend\ServiceManager\Config;
use Zend\ServiceManager\ServiceManager;
use Zend\Stdlib\ArrayUtils;

/**
 * AbstractConfig class.
 *
 * @author     Vítor Brandão <vitor@ppi.io>
 */
abstract class AbstractConfig extends Config implements ConfigurationProviderInterface
{
    /**
     * Returns the mandatory prefix to use when using YAML.
     *
     * This convention is to remove the "Config" postfix from the class
     * name and then lowercase and underscore the result. So:
     *
     *     AcmeHelloConfig
     *
     * becomes
     *
     *     acme_hello
     *
     * This can be overridden in a sub-class to specify the alias manually.
     *
     * @throws \BadMethodCallException When the extension name does not follow conventions
     *
     * @return string The alias
     */
    public function getAlias()
    {
        $className = get_class($this);
        if (substr($className, -6) != 'Config') {
            throw new \BadMethodCallException('This Config class does not follow the naming convention; you must overwrite the getAlias() method.');
        }
        $classBaseName = substr(strrchr($className, '\\'), 1, -6);

        return strtolower($classBaseName);
    }

    /**
     * Returns the configuration reference for this component.
     *
     * @returns array
     */
    public function getConfigurationReference()
    {
        return array($this->getAlias() => array());
    }

    /**
     * @param ServiceManager $serviceManager
     *
     * @return array
     */
    public function getParameters(ServiceManager $serviceManager)
    {
        $config = $serviceManager->get('Config');

        return isset($config['parameters']) ? $config['parameters'] : array();
    }

    /**
     * Process an array with the application configuration.
     *
     * @param array                               $config
     * @param \Zend\ServiceManager\ServiceManager $serviceManager
     *
     * @return array
     */
    abstract protected function processConfiguration(array $config, ServiceManager $serviceManager = null);

    /**
     * Merges configuration.
     */
    protected function mergeConfiguration(array $defaults, array $config)
    {
        return ArrayUtils::merge($defaults, $config);
    }
}