root/trunk/patXMLPretty/ConfigReader.php

<?php
/**
 * File containing the patXMLPretty_ConfigReader class.
 *
 * @access        public
 * @package        patXMLPretty
 * @subpackage    ConfigReader
 * @see            patXMLPretty_ConfigReader
 */

/**
 * The default color that will be used when some color definitions
 * are missing. This is ugly on purpose to quickly spot missing
 * colors.
 *
 */
 define( 'PATXMLPRETTY_CONFIGREADER_DEFAULT_COLOR', 'ff00ff' );

/**
 * Configuration reader base class that is extended by the
 * actual configuration reader classes.
 *
 * @access        public
 * @package        patXMLPretty
 * @subpackage    ConfigReader
 * @author        Sebastian 'The Argh' Mordziol <argh@php-tools.net>
 * @link         http://www.php-tools.net
 * @link        http://sebastian.mordziol.de
 * @see            patXMLPretty_Module
 */
class patXMLPretty_ConfigReader extends patXMLPretty_Module
{
   /**
    * Stores color definitions for the available elements
    *
    * @access    private
    * @var        array
    * @see         getColor()
    */
    var $colors = array(
        'cdata' => null,
        'tag' => null,
        'attribName' => null,
        'attribValue' => null,
        'externalEntity' => null,
        'namespace' => null,
        'brackets' => null,
        'commentBrackets' => null,
        'commentValue' => null,
        'xmlDeclaration' => null,
        'xmlDeclarationAttribName' => null,
        'xmlDeclarationAttribValue' => null,
        'xmlDeclarationTag' => null,
        'cdataTag' => null,
        'cdataContent' => null,
        'entityReference' => null,
    );

   /**
    * List of tag names and the colours to render them in.
    *
    * @access    private
    * @var        array
    * @see        getTagColor()
    */
    var $tagColors = array();

   /**
    * List of namespaces and the colours to render them in.
    *
    * @access    private
    * @var        array
    * @see        getNamespaceColor()
    */
    var $namespaceColors = array();

   /**
    * List of tag names to keep the line in (not to make
    * linebreaks for CDATA in those tags)
    *
    * @access    private
    * @var        array
    * @see        keepLine()
    */
    var $keepLine = array();

   /**
    * The maximum string length up to which to automatically
    * keep a line. If a tag's CDATA content does not exceed
    * this length, the line will automatically be kept. Set to
    * 0 to disable this feature.
    *
    * @access    private
    * @var        int
    * @see        cdataKeepLine()
    */
    var $cdataKeepLine = 0;

   /**
    * CDATA wrap length: if the content of a CDATA section
    * exceeds the specified length, it will automatically
    * be wrapped to this length.
    *
    * @access    private
    * @var        int
    * @see        getContentWrapLength()
    */
    var $contentWrapLength = null;

   /**
    * List of tag names in which to hide the CDATA content
    *
    * @access    private
    * @var        array
    * @see        hideCDATA()
    */
    var $hideCDATA = array();

   /**
    * Stores the definition for the inline documentation.
    *
    * @access    private
    * @var        array
    * @see        hasInlineDoc()
    * @see         getInlineDoc()
    */
    var $inlineDoc = array();

   /**
    * The indent amount, i.e. the amount of times
    * the indent character will be repeated for each
    * level of indentation in the generated source.
    *
    * Example: setting this to 4 will by default generate
    * 4 spaces for each indentation level.
    *
    * Note: the way the indentation is rendered depends
    * on the selected renderer.
    *
    * @access    private
    * @var        int
    * @see        getIndent()
    */
    var $indent = 0;

   /**
    * Stores the base indentation amount to use for the
    * whole document - this will be applied to all lines
    * in the document on top of the indentation amount
    * for each level.
    *
    * @access    private
    * @var        int
    * @see        getIndent()
    */
    var $baseIndent = 0;

   /**
    * Checks whether to keep contents on the same line
    * for the specified tag.
    *
    * @access    public
    * @param    string
    * @return    bool
    * @see         $keepLine
    */
    function keepLine( $tag )
    {
        $tag = strtolower( $tag );
        $result = in_array( $tag, $this->keepLine );
        return $result;
    }

    function wrapCDATA()
    {
        $result = !is_null( $this->contentWrapLength );
        return $result;
    }

    function getContentWrapLength()
    {
        return $this->contentWrapLength;
    }

    function cdataKeepLine( $data )
    {
        $len = strlen( $data );
        if( $len <= $this->cdataKeepLine ) {
            return true;
        }

        return false;
    }

   /**
    * Checks whether to hide cdata in the given tag
    *
    * @access    public
    * @param    string
    * @return    bool
    * @see         $hideCDATA
    */
    function hideCDATA( $tag )
    {
        $tag = strtolower( $tag );
        $result = in_array( $tag, $this->hideCDATA );
        return $result;
    }

   /**
    * Retrieves the indent value for the given tag depth.
    *
    * @access    public
    * @param    int
    * @return    int
    * @see         $indent
    * @see         $baseIndent
    */
    function getIndent( $depth )
    {
        $indent = ( $this->indent * $depth ) + $this->baseIndent;
        return $indent;
    }

   /**
    * Retrieves the color for the specified element.
    *
    * Available elements:
    * <ul>
    *     <li>cdata</li>
    *     <li>tag</li>
    *     <li>attribName</li>
    *     <li>attribValue</li>
    *     <li>externalEntity</li>
    *     <li>namespace</li>
    *     <li>brackets</li>
    *     <li>commentBrackets</li>
    *     <li>commentValue</li>
    *     <li>xmlDeclaration</li>
    *     <li>xmlDeclarationAttribName</li>
    *     <li>xmlDeclarationAttribValue</li>
    *     <li>xmlDeclarationTag</li>
    *     <li>cdataTag</li>
    *     <li>cdataContent</li>
    *     <li>entityReference</li>
    * </ul>
    *
    * @access    public
    * @param    string
    * @return    string
    * @see         getTagColor()
    * @see         getNamespaceColor()
    * @see         $colors
    */
    function getColor( $element )
    {
        if( !isset( $this->colors[$element] ) ) {
            return PATXMLPRETTY_CONFIGREADER_DEFAULT_COLOR;
        }

        return $this->colors[$element];
    }

   /**
    * Retrieves the color for a specific tag. If no custom color
    * is defined for that tag, the global tag color is used.
    *
    * @access    public
    * @param    string
    * @return    string
    * @see         getColor()
    * @see         $tagColors
    */
    function getTagColor( $tag )
    {
        $tag = strtolower( $tag );
        if( isset( $this->tagColors[$tag] ) ) {
            return $this->tagColors[$tag];
        }

        return $this->getColor( 'tag' );
    }

   /**
    * Retrieves the color of a specific namespace. If there is
    * no custom color for that namespace, the global namespace
    * color is used.
    *
    * @access    public
    * @param    string
    * @return    string
    * @see         getColor()
    * @see         $namespaceColors
    */
    function getNamespaceColor( $namespace )
    {
        $namespace = strtolower( $namespace );
        if( isset( $this->namespaceColors[$namespace] ) ) {
            return $this->namespaceColors[$namespace];
        }

        return $this->getColor( 'namespace' );
    }

    function read()
    {
        $result = true;
        return $result;
    }


    function hasInlineDoc( $tag, $attribute = null )
    {
        $tag = strtolower( $tag );
        if( !isset( $this->inlineDoc[$tag] ) ) {
            return false;
        }

        if( !is_null( $attribute ) ) {
            $attribute = strtolower( $attribute );
            if( !isset( $this->inlineDoc[$tag]['attribs'][$attribute] ) ) {
                return false;
            }
        }

        return true;
    }

}

?>