root/trunk/patXMLPretty/Renderer.php

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

/**
 * Error: abstract method called
 */
 define( 'PATXMLPRETTY_RENDERER_ERROR_ABSTRACT_METHOD', 'patXMLPretty_Renderer:01' );

/**
 * Base renderer class that renderers extend for common functionality.
 *
 * @package        patXMLPretty
 * @subpackage     Renderer
 * @author        Sebastian 'The Argh' Mordziol <argh@php-tools.net>
 * @version        0.1.0
 * @license        LGPL
 * @link        http://www.php-tools.net
 */
class patXMLPretty_Renderer extends patXMLPretty_Module
{
   /**
    * Stores the configuration reader object used to load
    * and access tag syntax definitions.
    *
    * @access    private
    * @var        object patXMLReader_ConfigReader
    * @see         setConfigReader()
    */
    var $configReader = 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 rendering engine could not start.',
        'warning' => 'XML rendering engine could not be initialized properly',
        'notice' => 'XML rendering engine misconfiguration'
    );

   /**
    * Sets the configuration reader to use to load and access the tag
    * coloring and syntax definitions.
    *
    * @access    public
    * @param    object patXMLPretty_ConfigReader
    * @see         $configReader
    */
    function setConfigReader( &$configReader )
    {
        $this->configReader =& $configReader;
    }

   /**
    * Main render method that patXMLPretty automatically
    * calls to trigger the highlighting of the elements
    * tree collected by the selected parsing engine.
    *
    * @abstract
    * @access    public
    * @param    array
    * @param     array
    * @param     array|null
    * @return    string|patError
    */
    function render( $documentInfo, $elementsTree, $doctype )
    {
        $error = patErrorManager::raiseError(
            PATXMLPRETTY_RENDERER_ERROR_ABSTRACT_METHOD,
            $this->userMessages['error'],
            'The [render] renderer 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 renderer '.
            'class you are using does not implement it. For reference, my class name is ['.get_class( $this ).'].'
        );

        return $error;
    }
}

?>