Changeset 18 for trunk/patXMLPretty/Renderer

Timestamp:

01/09/06 21:23:34 (3 years ago)

Author:

argh

Message:

Added some documentation; Implemented the renderXMLDeclaration option; Implemented the _renderDoctype method; Implemented the replaceEntities option.

Files:

• trunk/patXMLPretty/Renderer/HTML/Simple.php (modified) (9 diffs)

trunk/patXMLPretty/Renderer/HTML/Simple.php

@@ -3 +3 @@
-class patXMLPretty_Renderer_HTML_Simple extends patXMLPretty_Renderer
-{
+   /**
+    * Stores available renderer options:
+    *
+    * <ul>
+    *   <li>
+    *       <b>renderXMLDeclaration</b> [yes|no] Default: yes<br/>
+    *       Sets whether to include the XML declaration in the highlighted code. Note: this also affects the doctype declaration, which is only included if the XML declaration is on.
+    *   </li>
+    *   <li>
+    *       <b>replaceEntities</b> [yes|no] Default: no<br/>
+    *       Sets whether to replace entities by their content instead of displaying the entity's name (the default behavior).
+    *   </li>
+    *   <li>
+    *       <b>indentCharacter</b> Default: nonbreaking space<br/>
+    *       Sets which character to use as indenting character. Note that this also depends on the indent and baseIndent configuration settings of the active configuration reader.
+    * </ul>
+    *
+    * @access   private
+    * @var
+    */
+    var $options = array(
+        'renderXMLDeclaration' => 'yes',
+        'replaceEntities' => 'no',
+        'indentCharacter' => '&#160;',
+    );
+
+   /**
+    * Intelligent CDATA renderer which wraps and indents
+    * content naturally for easiest reading.
+    *
+    * @access   private
+    * @param    string
+    * @param    string
+    * @param    int
+    * @return   string
+    */
-    function _renderCDATA( $tagName, $data, $depth )
-    {
@@ -44 +80 @@
-    }
-
+   /**
+    * Renders the content used to display the indentation
+    * for the given depth.
+    *
+    * @access   private
+    * @param    int
+    * @return   string
+    */
-    function _renderIndent( $depth )
-    {
-'&#160;'
+$this->getOption( 'indentCharacter' )
-        return $indent;
-    }
-
+   /**
+    * Renders the content required to highlight the selected content
+    * in the specified colour.
+    *
+    * @access   private
+    * @param    string
+    * @param    string  Hexadecimal value.
+    * @return   string
+    */
-    function _renderColor( $content, $color )
-    {
@@ -56 +109 @@
-    }
-
+   /**
+    * Renders an attribute collection with the specified colours.
+    *
+    * @access   private
+    * @param    array   Associative array with name => value pairs.
+    * @param    string
+    * @param    string
+    * @return   string
+    */
-    function _renderAttributes( $attributes, $attribColor = null, $valueColor = null )
-    {
@@ -75 +137 @@
-    }
-
+   /**
+    * Escapes the given string for output to screen.
+    *
+    * @access   private
+    * @param    string
+    * @return   string
+    */
-    function _escapeOutput( $output )
-    {
@@ -81 +150 @@
-    }
-
-
+
+
+
+
+
+
+
+
+
+
+
-    {
-        $render = '<div style="white-space:nowrap;">';
-
+
+
+
+
+
+
-        $render .= $this->_renderElement( $elementsTree, 0 );
-        $render .= '</div>';
@@ -96 +180 @@
-        $render .= $this->_renderAttributes( $documentInfo, $this->configReader->getColor( 'xmlDeclarationAttribName' ), $this->configReader->getColor( 'xmlDeclarationAttribValue' ) );
-        $render .= $this->_renderColor( ' ?&gt;', $this->configReader->getColor( 'xmlDeclarationTag' ) );
+        $render .= '<br/>';
+
+        return $render;
+    }
+
+    function _renderDoctype( $doctype )
+    {
+        // no doctype detected
+        if( is_null( $doctype ) ) {
+            $render = '';
+            return $render;
+        }
+
+        // tag colors
+        $tagColor = $this->configReader->getColor( 'xmlDeclarationTag' );
+        $nameColor = $this->configReader->getColor( 'xmlDeclarationAttribName' );
+        $elementsColor = $this->configReader->getColor( 'xmlDeclarationAttribValue' );
+
+        // render the doctype
+        $render = $this->_renderColor( '&lt;!DOCTYPE ', $tagColor );
+        $render .= $this->_renderColor( $doctype['name'], $nameColor );
+        $render .= $this->_renderColor( ' [', $tagColor );
+        $render .= '<br/>';
+        foreach( $doctype['elements'] as $element ) {
+            $element = $this->_escapeOutput( $element );
+            $render .= $this->_renderIndent( 1 );
+            $render .= $this->_renderColor( $element, $elementsColor );
+            $render .= '<br/>';
+        }
+        $render .= $this->_renderColor( ']&gt;', $tagColor );
-        $render .= '<br/>';
-
@@ -148 +262 @@
-    }
-
+   /**
+    * Renders a comment and returns the highlighted source
+    *
+    * @access   private
+    * @param    array
+    * @param    int
+    * @return   string
+    */
-    function _renderElement_comment( $element, $depth )
-    {
@@ -160 +282 @@
-    }
-
+   /**
+    * Renders the content of a cdata section and returns
+    * the highlighted source.
+    *
+    * @access   private
+    * @param    array
+    * @param    int
+    * @return   string
+    */
-    function _renderElement_cdata( $element, $depth )
-    {
+        // process the cdata content. This is done by splitting it by
+        // newlines and separately rendering each line to make sure the
+        // indent and everything else is in the right place.
-        $cdata = trim( $element['text'] );
-        $lines = explode( "\n", $cdata );
@@ -175 +309 @@
-        }
-
+        // flatten the rendered individual lines
-        $cdata = implode( '<br/>', $lines );
-
+        // colors we'll use
+        $tagC = $this->configReader->getColor( 'cdataTag' );
+        $contentC = $this->configReader->getColor( 'cdataContent' );
+
+        // render the cdata
-        $render = $this->_renderIndent( $depth );
-his->configReader->getColor( 'cdataTag' )
-
-this->configReader->getColor( 'cdataContent' )
+agC
+
+contentC
-        $render .= '<br/>';
-        $render .= $this->_renderIndent( $depth );
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    function _renderElement_entityReference( $element, $depth )
-    {
+        if( $this->getOption( 'replaceEntities' ) == 'yes' ){
+            $render = $this->_renderIndent( $depth );
+            $render .= $this->_renderColor( $this->_escapeOutput( $element['text'] ), $this->configReader->getColor( 'cdata' ) );
+            $render .= '<br/>';
+            return $render;
+        }
+
+        // render the entity as an entity placeholder
-        $content = $this->_escapeOutput( '&'.$element['name'].';' );
-
-        $render = $this->_renderIndent( $depth );
-        $render .= '<span title="Entity value: '.$this->_escapeOutput( '"'.$element['text'].'"' ).'">';
-cdataTag
+entityReference
-        $render .= '</span>';
-        $render .= '<br/>';