horros / agavi2

src/config/ConfigParser.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\Config\Util\Dom\XmlConfigDomElement;
use Agavi\Exception\ParseException;

/**
 * ConfigParser parses XML files using XmlConfigParser, but returns
 * old-style ConfigValueHolders.
 *
 * @package    agavi
 * @subpackage config
 *
 * @author     David Zülke <dz@bitxtender.com>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      0.11.0
 *
 * @deprecated Superseded by XmlConfigParser, will be removed in Agavi 1.1
 *
 * @version    $Id$
 */
class ConfigParser
{
    /**
     * @var        string The encoding of the DOMDocument
     */
    protected $encoding = 'utf-8';
    
    /**
     * @var        string The filesystem path to the configuration file.
     */
    protected $config = '';
    
    /**
     * @param      string $config         An absolute filesystem path to a configuration file.
     * @param      array  $validationFile An associative array of validation information.
     *
     * @return     ConfigValueHolder The data handlers use to perform tasks.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function parse($config, $validationFile = null)
    {
        // copy path in case convertEncoding() needs to complain about a missing ICONV extension
        $this->config = $config;
        
        $parser = new XmlConfigParser($config, Config::get('core.environment'), null);
        
        $validation = array(
            XmlConfigParser::STEP_TRANSFORMATIONS_BEFORE => array(),
            XmlConfigParser::STEP_TRANSFORMATIONS_AFTER => array(
                XmlConfigParser::VALIDATION_TYPE_XMLSCHEMA => array(),
            ),
        );
        if ($validationFile !== null) {
            $validation[XmlConfigParser::STEP_TRANSFORMATIONS_AFTER][XmlConfigParser::VALIDATION_TYPE_XMLSCHEMA][] = $validationFile;
        }
        $doc = $parser->execute(array(), $validation);
        
        // remember encoding for convertEncoding()
        $this->encoding = strtolower($doc->encoding);
        
        $rootRes = new ConfigValueHolder();

The class Agavi\Config\ConfigValueHolder has been deprecated with message: Not used anymore by XML config handlers, to be removed in Agavi 1.1

        
        if ($doc->documentElement) {
            $this->parseNodes(array($doc->documentElement), $rootRes);
        }
        
        return $rootRes;
    }

    /**
     * Iterates through a list of nodes and stores to each node in the
     * ConfigValueHolder
     *
     * @param      mixed             $nodes      An array or an object that can be iterated over
     * @param      ConfigValueHolder $parentVh   The storage for the info from the nodes
     * @param      bool              $isSingular Whether this list is the singular form of the parent node
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    protected function parseNodes($nodes, ConfigValueHolder $parentVh, $isSingular = false)

The parameter $isSingular is not used and could be removed.

    {
        /** @var XmlConfigDomElement $node */
        foreach ($nodes as $node) {
            if ($node->nodeType == XML_ELEMENT_NODE && (!$node->namespaceURI || $node->namespaceURI == XmlConfigParser::NAMESPACE_AGAVI_ENVELOPE_0_11)) {
                $vh = new ConfigValueHolder();

The class Agavi\Config\ConfigValueHolder has been deprecated with message: Not used anymore by XML config handlers, to be removed in Agavi 1.1

                $nodeName = $this->convertEncoding($node->localName);
                $vh->setName($nodeName);
                $parentVh->addChildren($nodeName, $vh);

                foreach ($node->attributes as $attribute) {
                    if ((!$attribute->namespaceURI || $attribute->namespaceURI == XmlConfigParser::NAMESPACE_AGAVI_ENVELOPE_0_11)) {
                        $vh->setAttribute($this->convertEncoding($attribute->localName), $this->convertEncoding($attribute->nodeValue));
                    }
                }

                // there are no child nodes so we set the node text contents as the value for the valueholder
                if ($node->getElementsByTagName('*')->length == 0) {
                    $vh->setValue($this->convertEncoding($node->nodeValue));
                }

                if ($node->hasChildNodes()) {
                    $this->parseNodes($node->childNodes, $vh);
                }
            }
        }
    }
    
    /**
     * Handle encoding for a value, i.e. translate from UTF-8 if necessary.
     *
     * @param      string $value A UTF-8 string value from the DomDocument.
     *
     * @return     string A value in the correct encoding of the parsed document.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    protected function convertEncoding($value)
    {
        if ($this->encoding == 'utf-8') {
            return $value;
        } elseif ($this->encoding == 'iso-8859-1') {
            return utf8_decode($value);
        } elseif (function_exists('iconv')) {
            return iconv('UTF-8', $this->encoding, $value);
        } else {
            throw new ParseException('No iconv module available, configuration file "' . $this->config . '" with input encoding "' . $this->encoding . '" cannot be parsed.');
        }
    }
}