root/trunk/patXMLPretty/Engine/Classic.php

<?php

class patXMLPretty_Engine_Classic extends patXMLPretty_Engine
{
   /**
    * Stores the name of the engine
    *
    * @access    private
    * @var        string
    */
    var $name = 'Classic';

   /**
    * Stores the generated output line by line
    *
    * @access    private
    * @var        array
    */
    var    $output    =    array();

   /**
    * Stores a list of all external files present in the XML
    *
    * @access     private
    * @var        array
    */
    var    $externalFiles = array();

   /**
    * Stores the current tag depth in the
    * parsing stage
    *
    * @access     private
    * @var        int
    */
    var $depth = 0;

   /**
    * Stack of tags found in the current parsing stage
    *
    * @access    private
    * @var        array
    */
    var $tagStack = array();

    function parse( $xmlSource )
    {
        return array();

        // init XML Parser
        $parser = xml_parser_create();
        xml_set_object( $parser, $this );
        xml_set_element_handler( $parser, '_handle_startElement', '_handle_endElement' );
        xml_set_character_data_handler( $parser, '_handle_characterData' );
        xml_set_external_entity_ref_handler( $parser, '_handle_externalEntity' );
        xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );

        $success = @xml_parse( $parser, $xmlSource );
        if( !$success ) {
            $error = patErrorManager::raiseError(
                PATXMLPRETTY_ERROR_XML_PARSING_FAILED,
                'XML parsing failed',
                'XML Error ['.xml_error_string( xml_get_error_code( $parser ) ).'] '.
                'at line ['.xml_get_current_line_number( $parser ).']'
            );

            xml_parser_free( $parser );
            return $error;
        }

        echo '<pre>';
        print_r( $this->elementsCollection );
        echo '</pre>';

        xml_parser_free( $parser );
        $result = true;
        return $result;
    }

    var $elementsCollection = array();

    var $infoStack = array();

   /**
    * Handler for XML start elements
    *
    * @access     private
    * @param    int
    * @param    string
    * @param     array
    * @see         endElement()
    */
    function _handle_startElement( $parser, $name, $attributes )
    {
        $parent = $this->lastOpenedTag;
        array_push( $this->tagStack, $name );

        $path = implode( '.', array_slice( $this->tagStack, 0, $this->depth ) );
        $tagInfo = array(
            'name' => $name,
            'attributes' => $attributes,
            'parent' => $parent,
            'path' => $path
        );

        array_push( $this->infoStack, $tagInfo );

        $this->renderer->renderOpeningTag( $name, $attributes, $this->depth );

        $this->mode = 'startElement';
        $this->lastOpenedTag = $name;
        $this->depth++;
    }

/**
*    handle end element
*    if the end element contains a namespace calls the eppropriate handler
*
*    @param    int        $parser        resource id of the current parser
*    @param    string    $name        name of the element
*/
    function _handle_endElement( $parser, $name )
    {
        $this->depth--;

        //    remove the last tag
        array_pop( $this->tagStack );
        $tagInfo = array_pop( $this->infoStack );

        if( !is_array( $this->elementsCollection[$tagInfo['path']] ) ) {
            $this->elementsCollection[$tagInfo['path']] = array();
        }

        $this->elementsCollection[$tagInfo['path']][] = $tagInfo;

        $this->renderer->renderClosingTag( $name, $this->depth );
        return true;
    }

/**
*    handle character data
*    if the character data was found between tags using namespaces, the appropriate namesapce handler will be called
*
*    @param    int        $parser        resource id of the current parser
*    @param    string    $data        character data, that was found
*/
    function _handle_characterData( $parser, $data )
    {
        if( $this->configReader->hideCDATA( $data ) ) {
            $data = str_repeat( "*", strlen( $data ) );
        }

        $tag = array_pop( $this->tagStack );
        array_push( $this->tagStack, $tag );
        $this->renderer->renderCDATA( $tag, $data, $this->depth );
    }

/*
*    parse an external entity
*
*    @param    int        $parser                resource id of the current parser
*    @param    string    $openEntityNames    space-separated list of the names of the entities that are open for the parse of this entity (including the name of the referenced entity)
*    @param    string    $base                currently empty string
*    @param    string    $systemId            system identifier as specified in the entity declaration
*    @param    string    $publicId            publicId, is the public identifier as specified in the entity declaration, or an empty string if none was specified; the whitespace in the public identifier will have been normalized as required by the XML spec
*/

    function _handle_externalEntity( $parser, $openEntityNames, $base, $systemId, $publicId )
    {
        if( $systemId )
        {
            array_push( $this->externalFiles, $systemId );

            if( $this->configReader->parseEntities() ) {
                $this->_parseFile( $systemId );
            } else {
                $url                =    $GLOBALS["PHP_SELF"]."?file=".$systemId;
                $this->output[]        =    array(    "indent"    =>    $this->configReader->getIndent( $this->depth ),
                                                "tag"        =>    "<b><a href=\"".$url."\" onMouseOver=\"popUp('Click to show source of the external entity.')\" onMouseOut=\"hidePopUp();\"><font color=\"".$this->configReader->getColor( 'externalEntity' )."\">&".$openEntityNames.";</font></a></b> <font color=\"".$this->configReader->getColor( 'externalEntity' )."\">(".$systemId.")</font>" );

                $this->mode                =    "endElement";
            }
        }

        return    true;
    }
}
?>