[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3  * @version        $Id: renderer.php 14401 2010-01-26 14:10:00Z louis $
   4  * @package        Joomla.Framework
   5  * @subpackage    Document
   6  * @copyright    Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
   7  * @license        GNU/GPL, see LICENSE.php
   8  * Joomla! is free software. This version may have been modified pursuant
   9  * to the GNU General Public License, and as distributed it includes or
  10  * is derivative of works licensed under the GNU General Public License or
  11  * other free or open source software licenses.
  12  * See COPYRIGHT.php for copyright notices and details.
  13  */
  14  
  15  // Check to ensure this file is within the rest of the framework
  16  defined('JPATH_BASE') or die();
  17  
  18  /**
  19   * Abstract class for a renderer
  20   *
  21   * @abstract
  22   * @package        Joomla.Framework
  23   * @subpackage    Document
  24   * @since        1.5
  25   */
  26  class JDocumentRenderer extends JObject
  27  {
  28      /**
  29      * reference to the JDocument object that instantiated the renderer
  30      *
  31      * @var        object
  32      * @access    protected
  33      */
  34      var    $_doc = null;
  35  
  36      /**
  37       * Renderer mime type
  38       *
  39       * @var        string
  40       * @access    private
  41       */
  42       var $_mime = "text/html";
  43  
  44      /**
  45      * Class constructor
  46      *
  47      * @access protected
  48      * @param object A reference to the JDocument object that instantiated the renderer
  49      */
  50  	function __construct(&$doc) {
  51          $this->_doc =& $doc;
  52      }
  53  
  54      /**
  55       * Renders a script and returns the results as a string
  56       *
  57       * @abstract
  58       * @access public
  59       * @param string     $name        The name of the element to render
  60       * @param array     $array        Array of values
  61       * @param string     $content    Override the output of the renderer
  62       * @return string    The output of the script
  63       */
  64  	function render( $name, $params = array(), $content = null )
  65      {
  66  
  67      }
  68  
  69      /**
  70       * Return the content type of the renderer
  71       *
  72       * @return string The contentType
  73       */
  74  	function getContentType() {
  75          return $this->_mime;
  76      }
  77  }