horros / agavi2

src/config/ConfigHandler.class.php

<?php

// +---------------------------------------------------------------------------+
// | This file is part of the Agavi package.                                   |
// | Copyright (c) 2005-2011 the Agavi Project.                                |
// | Based on the Mojavi3 MVC Framework, Copyright (c) 2003-2005 Sean Kerr.    |
// |                                                                           |
// | For the full copyright and license information, please view the LICENSE   |
// | file that was distributed with this source code. You can also view the    |
// | LICENSE file online at http://www.agavi.org/LICENSE.txt                   |
// |   vi: set noexpandtab:                                                    |
// |   Local Variables:                                                        |
// |   indent-tabs-mode: t                                                     |
// |   End:                                                                    |
// +---------------------------------------------------------------------------+

namespace Agavi\Config;

use Agavi\Util\Toolkit;

/**
 * ConfigHandler allows a developer to create a custom formatted
 * configuration file pertaining to any information they like and still
 * have it auto-generate PHP code.
 *
 * @package    agavi
 * @subpackage config
 *
 * @author     Sean Kerr <skerr@mojavi.org>
 * @author     Dominik del Bondio <ddb@bitxtender.com>
 * @author     David Zülke <dz@bitxtender.com>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      0.9.0
 *
 * @deprecated Superseded by AgaviXmlConfigHandler, will be removed in Agavi 1.1
 *
 * @version    $Id$
 */
abstract class ConfigHandler extends BaseConfigHandler implements LegacyConfigHandlerInterface
{
    /**
     * @var        string An absolute filesystem path to a validation filename.
     */
    protected $validationFile = null;

    /**
     * @var        string A class name of the class which should be used to parse
     *                    Input files of this config handler.
     */
    protected $parser = null;
    
    /**
     * Retrieve the parameter node values of the given item's parameters element.
     *
     * @param      ConfigValueHolder $itemNode   The node that contains a parameters child.
     * @param      array             $oldValues  As associative array of parameters that will
     *                                           be overwritten if appropriate.
     * @param      boolean           $literalize Whether or not values should be literalized.
     *
     * @return     array An associative array of parameters
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    protected function getItemParameters($itemNode, $oldValues = array(), $literalize = true)
    {
        $data = array();
        if ($itemNode->hasChildren('parameters')) {
            foreach ($itemNode->parameters as $node) {

The property parameters does not exist on object<Agavi\Config\ConfigValueHolder>. Since you implemented __get, maybe consider adding a @property annotation.

                if (!$node->hasAttribute('name')) {
                    // create a new entry in in the array and get they key of the new
                    // created entry (the last in the array). The value doesn't matter
                    // since it will be overwritten anyways
                    $data[] = 0;
                    end($data);
                    $name = key($data);
                } else {
                    $name = $node->getAttribute('name');
                }
                if ($node->hasChildren('parameters')) {
                    $data[$name] = (isset($oldValues[$name]) && is_array($oldValues[$name])) ? $oldValues[$name] : array();
                    $data[$name] = $this->getItemParameters($node, $data[$name], $literalize);
                } else {
                    $data[$name] = $literalize ? Toolkit::literalize($node->getValue()) : $node->getValue();
                }
            }
        }
        // we can NOT use array_merge here, since it would break numeric keys
        foreach ($data as $key => $value) {
            $oldValues[$key] = $value;
        }
        return $oldValues;
    }

    /**
     * Initialize this ConfigHandler.
     *
     * @param      string $validationFile The path to a validation file for this config handler.
     * @param      string $parser         The parser class to use.
     * @param      array  $parameters     An associative array of initialization parameters.
     *
     * @throws     <b>InitializationException</b> If an error occurs while
     *                                                 initializing the
     *                                                 ConfigHandler
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.9.0
     */
    public function initialize($validationFile = null, $parser = null, $parameters = array())
    {
        $this->validationFile = $validationFile;
        $this->parser = $parser;
        $this->setParameters($parameters);
    }
    
    /**
     * Retrieves the stored validation filename.
     *
     * @return     string An absolute filesystem path to a validation filename.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    public function getValidationFile()
    {
        return $this->validationFile;
    }
    
    /**
     * Builds a proper regular expression from the input pattern to test against
     * the given subject. This is for "environment" and "context" attributes of
     * configuration blocks in the files.
     *
     * @param      string $pattern A regular expression chunk without delimiters/anchors.
     * @param      string $subject The subject to test against
     *
     * @return     bool Whether or not the subject matched the pattern.
     *
     * @see        XmlConfigParser::testPattern()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public static function testPattern($pattern, $subject)
    {
        return XmlConfigParser::testPattern($pattern, $subject);
    }

    /**
     * Returns a properly ordered array of ConfigValueHolder configuration
     * elements for given env and context.
     *
     * @param      ConfigValueHolder $configurations The root config element
     * @param      string            $environment    An environment name.
     * @param      string            $context        A context name.
     * @param      bool              $autoloadParser Whether the parser class should be
     *                                               autoloaded or not.
     *
     * @return     ConfigValueHolder[] An array of ConfigValueHolder configuration elements.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function orderConfigurations(ConfigValueHolder $configurations, $environment = null, $context = null, $autoloadParser = true)
    {
        $configs = array();

        if ($configurations->hasAttribute('parent')) {
            $parent = Toolkit::literalize($configurations->getAttribute('parent'));
            $parentConfigs = $this->orderConfigurations(ConfigCache::parseConfig($parent, $autoloadParser, $this->getValidationFile(), $this->parser)->configurations, $environment, $context, $autoloadParser);

The property configurations does not exist on object<Agavi\Config\ConfigValueHolder>. Since you implemented __get, maybe consider adding a @property annotation.

The method Agavi\Config\ConfigCache::parseConfig() has been deprecated with message: New-style config handlers don't call this method anymore. To be removed in Agavi 1.1

            $configs = array_merge($configs, $parentConfigs);
        }

        foreach ($configurations as $cfg) {
            if (!$cfg->hasAttribute('environment') && !$cfg->hasAttribute('context')) {
                $configs[] = $cfg;
            }
        }
        foreach ($configurations as $cfg) {

This code seems to be duplicated across your project.

            if ($environment !== null && $cfg->hasAttribute('environment') && self::testPattern($cfg->getAttribute('environment'), $environment) && !$cfg->hasAttribute('context')) {
                $configs[] = $cfg;
            }
        }
        foreach ($configurations as $cfg) {

This code seems to be duplicated across your project.

            if (!$cfg->hasAttribute('environment') && $context !== null && $cfg->hasAttribute('context') && self::testPattern($cfg->getAttribute('context'), $context)) {
                $configs[] = $cfg;
            }
        }
        foreach ($configurations as $cfg) {
            if ($environment !== null && $cfg->hasAttribute('environment') && self::testPattern($cfg->getAttribute('environment'), $environment) && $context !== null && $cfg->hasAttribute('context') && self::testPattern($cfg->getAttribute('context'), $context)) {
                $configs[] = $cfg;
            }
        }

        return $configs;
    }
}