Source for file Renderer.php

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+
// | PHP version 4                                                        |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2004 The PHP Group                                |
// +----------------------------------------------------------------------+
// | This source file is subject to version 3.0 of the PHP license,       |
// | that is bundled with this package in the file LICENSE, and is        |
// | available through the world-wide-web at the following url:           |
// | http://www.php.net/license/3_0.txt.                                  |
// | If you did not receive a copy of the PHP license and are unable to   |
// | obtain it through the world-wide-web, please send a note to          |
// | license@php.net so we can mail you a copy immediately.               |
// +----------------------------------------------------------------------+
// | Authors: Frederic Poeydomenge <frederic.poeydomenge@free.fr>         |
// +----------------------------------------------------------------------+
//
// $Id:
 
require_once 'PEAR.php';
 
/**
 * A base class for Var_Dump renderers, must be inherited by all such.
 *
 * @package Var_Dump
 * @category PHP
 * @author Frederic Poeydomenge <frederic.poeydomenge@free.fr>
 */
 
class Var_Dump_Renderer
{
 
    /**
     * Run-time configuration options.
     * @var    array 
     * @access public
     */
    var $options = array();
 
    /**
     * Default configuration options.
     * See Var_Dump/Renderer/*.php for the complete list of options
     * @var    array 
     * @access public
     */
    var $defaultOptions = array();
 
    /**
     * Array containing the element family : start/finish group, start/finish element
     * @var    array 
     * @access public
     */
    var $family;
 
    /**
     * Array containing the element depths
     * @var    array 
     * @access public
     */
    var $depth;
 
    /**
     * Array containing the element types
     * @var    array 
     * @access public
     */
    var $type;
 
    /**
     * Array containing the element values
     * @var    array 
     * @access public
     */
    var $value;
 
    /**
     * Array containing the strlen of keys for all the nested arrays
     * @var    array 
     * @access public
     */
    var $keyLen;
 
    // {{{ constructor
    /**
     * Class constructor.
     * @param  array  $options Parameters for the rendering.
     * @access public
     */
    function Var_Dump_Renderer($options = array())
    {
        $this->setOptions($options);
    }
    // }}}
 
    // {{{ singleton()
    /**
     * Attempt to return a concrete singleton Var_Dump_Renderer instance.
     * @param  string $mode    Name of the renderer.
     * @param  array  $options Parameters for the rendering.
     * @access public
     */
    function & singleton($mode, $options)
    {
        static $instances;
        if (!isset($instances)) {
            $instances = array();
        }
        if (!isset($instances[$mode])) {
            @include_once 'Var_Dump/Renderer/' . $mode . '.php';
            $className = 'Var_Dump_Renderer_' . $mode;
            if (class_exists($className)) {
                $instances[$mode] = new $className($options);
            } else {
                return PEAR::raiseError('Var_Dump: renderer "' . $mode . '" not found', TRUE);
            }
        } else {
            $obj = & $instances[$mode];
            $obj->setOptions($options);
        }
        return $instances[$mode];
    }
    // }}}
 
    // {{{ setOptions()
    /**
     * Set run-time configuration options for the renderer
     * @param  array  $options Run-time configuration options.
     * @access public
     */
    function setOptions($options = array())
    {
        $this->options = array_merge (
            $this->defaultOptions,
            //$this->options,
            $options
        );
    }
    // }}}
 
    // {{{ initialize()
    /**
     * Initialize internal data structures for the rendering.
     * @param  array $family Containing the element family.
     * @param  array $depth  Containing the element depths.
     * @param  array $type   Containing the element types.
     * @param  array $value  Containing the element values.
     * @param  array $keyLen Strlen of keys for all the nested arrays
     * @access public
     */
    function initialize(&$family, &$depth, &$type, &$value, &$keyLen)
    {
        $this->family = $family;
        $this->depth  = $depth;
        $this->type   = $type;
        $this->value  = $value;
        $this->keyLen = $keyLen;
    }
    // }}}
 
    // {{{ toString()
    /**
     * Returns the string representation of a variable
     * @return string The string representation of the variable.
     * @access public
     * @abstract
     */
    function toString()
    {
    }
    // }}}
 
}
 
?>