root/trunk/patXMLPretty/Engine.php

<?php
/**
 * File containing the patXMLPretty_Engine class.
 *
 * @package        patXMLPretty
 * @subpackage     Engine
 * @author        Sebastian 'The Argh' Mordziol <argh@php-tools.net>
 * @see         patXMLPretty_Engine
 */

/**
 * Error: tried to call an abstract method
 */
 define( 'PATXMLPRETTY_ENGINE_ERROR_ABSTRACT_METHOD', 'patXMLPretty_Engine:01' );

/**
 * Engine renderer class that engine classes extend for common functionality.
 * Engines are used by patXMLPretty to parse the XML source and create the
 * elements description tree used by the renderers to construct the 'prettified'
 * XML source.
 *
 * @package        patXMLPretty
 * @subpackage     Engine
 * @author        Sebastian 'The Argh' Mordziol <argh@php-tools.net>
 * @version        0.1.0
 * @license        LGPL
 * @link        http://www.php-tools.net
 * @see         patXMLPretty_Module
 */
class patXMLPretty_Engine extends patXMLPretty_Module
{
   /**
    * Stores the configuration reader object
    *
    * @access    private
    * @var        object patXMLReader_ConfigReader
    * @see         setConfigReader()
    */
    var $configReader = null;

   /**
    * Stores the renderer object
    *
    * @access    private
    * @var        object patXMLPretty_Renderer
    * @see         setRenderer()
    */
    var $renderer = null;

   /**
    * Stores user-safe error messages. These are used in error
    * objects as the message displayed to the user and are meant
    * not to disclose any critical application information.
    *
    * The detailed error message is stored separately for developers
    * to use for debugging purposes.
    *
    * @access    private
    * @var        array
    * @see        patError
    */
    var $userMessages = array(
        'error' => 'XML parsing engine could not start.',
        'warning' => 'XML parsing engine could not be initialized properly',
        'notice' => 'XML parsing engine misconfiguration'
    );

   /**
    * Sets the configuration reader
    *
    * @access    public
    * @param    object patXMLPretty_ConfigReader
    * @see         $configReader
    */
    function setConfigReader( &$configReader )
    {
        $this->configReader =& $configReader;
    }

   /**
    * Sets the renderer
    *
    * @access    public
    * @param    object patXMLPretty_Renderer
    * @see         $renderer
    */
    function setRenderer( &$renderer )
    {
        $this->renderer =& $renderer;
    }

   /**
    * Main engine method that is called by patXMLPretty to parse the
    * provided XML string and build the renderer-compatible element
    * definitions tree from.
    *
    * @access    public
    * @param    string
    * @return    array|object patError
    */
    function parse( $xmlSource )
    {
        $error = patErrorManager::raiseError(
            PATXMLPRETTY_ENGINE_ERROR_ABSTRACT_METHOD,
            $this->userMessages['error'],
            'The [parse] engine method is an abstract method that cannot be called directly. '.
            'Chances are you either tried to call this method on the base class or the engine '.
            'class you are using does not implement it. For reference, my class name is ['.get_class( $this ).'].'
        );

        return $error;
    }

   /**
    * Tries to detect a doctype in the XML source using
    * regular expressions. If a doctype is matched, this
    * will return an array with two keys:
    *
    * array(
    *     'name' => 'xxxx'      // name of the doctype
    *     'elements' => array() // indexed array with raw doctype declaration elements (element|entity|attlist)
    * );
    *
    * @access    private
    * @param    string
    * @return    array|null
    */
    function _detectDoctype( $xmlSource )
    {
        $preg = '|<!DOCTYPE[\s]+([\w]+)[\s]+\[[\s]+(.+?)\]>|is';
        preg_match( $preg, $xmlSource, $found );
        if( empty( $found ) ) {
            $result = null;
            return $result;
        }

        $doctype = array();
        $doctype['name'] = $found[1];
        $doctype['elements'] = array();

        $itemsPreg = '/<!(?:ELEMENT|ENTITY|ATTLIST).+?>/is';
        preg_match_all( $itemsPreg, $found[2], $items );
        if( empty( $items ) ) {
            return $doctype;
        }

        foreach( $items[0] as $item ) {
            $item = trim( $item );
            $item = str_replace( "\n", '', $item );
            $item = str_replace( "\t", '', $item );
            $doctype['elements'][] = $item;
        }

        return $doctype;
    }
}

?>