root/trunk/patXMLPretty/Engine/Unserializer.php

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

/**
 * Warning: cannot find XML unserializer class.
 */
 define( 'PATXMLPRETTY_ENGINE_UNSERIALIZER_WARNING_MISSING_UNSERIALIZER', 'patXMLPretty_Engine_Unserializer:01' );

/**
 * Unserializer XML parsing engine that uses the PEAR::XML_Unserializer
 * to transform the XML structure into the internal elements tree used
 * by patXMLPretty renderers.
 *
 * @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_Engine
 */
class patXMLPretty_Engine_Unserializer extends patXMLPretty_Engine
{
   /**
    * Stores the name of the engine
    *
    * @access    private
    * @var        string
    */
    var $name = 'Unserializer';

   /**
    * Stores the engine's options:
    *
    * <ul>
    *     <li>
    *         <b>parseDoctype</b> [yes|no] default: no<br/>
    *         Sets whether to parse a doctype declaration if present. If the renderer supports it, the doctype will be included in the generated highlighted source.
    *    </li>
    * </ul>
    *
    * @access    private
    * @var         array
    */
    var $options = array(
        'parseDoctype' => 'no',
    );

    var $depth = 0;

    function parse( $xmlSource )
    {
        @include_once 'XML/Unserializer.php';
        if( !class_exists( 'XML_Unserializer' ) ) {
            $error = patErrorManager::raiseWarning(
                PATXMLPRETTY_ENGINE_UNSERIALIZER_WARNING_MISSING_UNSERIALIZER,
                $this->userMessages['warning'],
                'Could not include the PEAR::XML_Unserializer class.'
            );

            return $error;
        }

        $ser =& new XML_Unserializer;
        $ser->setOption( XML_UNSERIALIZER_OPTION_ATTRIBUTES_PARSE, true );
        $ser->setOption( XML_UNSERIALIZER_OPTION_ATTRIBUTES_ARRAYKEY, '_attribs' );
        $ser->unserialize( $xmlSource );

        $data = $ser->getUnserializedData();
        $doctype = null;
        if( $this->getOption( 'parseDoctype' ) == 'yes' ) {
            $doctype = $this->_detectDoctype( $xmlSource );
        }

        // create the output array with document
        // information and the elements tree.
        $output = array(
            'document' => $this->_create_document(),
            'elements' => $this->_create_tree( $ser->getRootName(), $data, array() ),
            'doctype' => $doctype
        );

        return $output;
    }

    function _create_document()
    {
        $document = array(
            'encoding' => 'UTF-8',
            'version' => '1.0',
            'standalone' => 'yes',
        );

        return $document;
    }

    function _create_tree( $parentTag, $tagData )
    {
        // the node data collection
        $nodeData = array();
        $nodeData['name'] = $parentTag;
        $nodeData['type'] = 'default';
        $nodeData['text'] = null;
        $nodeData['attributes'] = null;
        $nodeData['children'] = null;

        // attributeless tag
        if( !is_array( $tagData ) ) {
            $nodeData['name'] = $parentTag;
            $nodeData['text'] = $tagData;
            return $nodeData;
        }

        // collection of subtags, we go through each
        if( isset( $tagData[0] ) ) {
            $nodeData['children'] = array();
            foreach( $tagData as $row => $tagDef ) {
                $nodeData['children'][] = $this->_create_tree( $parentTag, $tagDef );
            }

            return $nodeData;
        }

        // regular tag
        if( isset( $tagData['_attribs'] ) ) {
            $nodeData['attributes'] = $tagData['_attribs'];
        }

        if( isset( $tagData['_content'] ) ) {
            $nodeData['text'] = $tagData['_content'];
        }

        // determine which subtags there are
        $subtags = $this->_getSubtags( $tagData );

        // empty tag?
        if( empty( $subtags ) && is_null( $nodeData['text'] ) ) {
            return $nodeData;
        }

        if( empty( $subtags ) ) {
            return $nodeData;
        }

        $nodeData['children'] = array();
        foreach( $subtags as $subtag ) {
            $nodeData['children'][] = $this->_create_tree( $subtag, $tagData[$subtag] );
        }

        return $nodeData;
    }

    function _getSubtags( $tagData )
    {
        $subtags = array();
        foreach( $tagData as $tagName => $tagDef ) {
            if( $tagName == '_attribs' || $tagName == '_content' || is_numeric( $tagName ) ) {
                continue;
            }

            $subtags[] = $tagName;
        }

        return $subtags;
    }
}

?>