Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5
Source code for file /joomla/document/renderer.php

Documentation is available at renderer.php

  1. <?php
  2. /**
  3. * @version        $Id: renderer.php 6472 2007-02-03 10:47:26Z pasamio $
  4. * @package        Joomla.Framework
  5. * @subpackage    Document
  6. * @copyright    Copyright (C) 2005 - 2007 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.  * @author        Johan Janssens <[email protected]>
  23.  * @package        Joomla.Framework
  24.  * @subpackage    Document
  25.  * @since        1.5
  26.  */
  27. class JDocumentRenderer extends JObject
  28. {
  29.    /**
  30.     * reference to the JDocument object that instantiated the renderer
  31.     *
  32.     * @var        object 
  33.     * @access    protected
  34.     */
  35.     var    $_doc = null;
  36.  
  37.     /**
  38.      * Renderer mime type
  39.      *
  40.      * @var        string 
  41.      * @access    private
  42.      */
  43.      var $_mime = "text/html";
  44.  
  45.    /**
  46.     * Class constructor
  47.     *
  48.     * @access protected
  49.     * @param object A reference to the JDocument object that instantiated the renderer
  50.     */
  51.     function __construct(&$doc) {
  52.         $this->_doc =& $doc;
  53.     }
  54.  
  55.     /**
  56.      * Renders a script and returns the results as a string
  57.      *
  58.      * @abstract
  59.      * @access public
  60.      * @param string     $name        The name of the element to render
  61.      * @param array     $array        Array of values
  62.      * @param string     $content    Override the output of the renderer
  63.      * @return string    The output of the script
  64.      */
  65.     function render( $name, $params = array(), $content = null )
  66.     {
  67.  
  68.     }
  69.  
  70.     /**
  71.      * Return the content type of the renderer
  72.      *
  73.      * @return string The contentType
  74.      */
  75.     function getContentType() {
  76.         return $this->_mime;
  77.     }
  78. }
  79. ?>
Documentation generated on Mon, 05 Mar 2007 21:20:08 +0000 by phpDocumentor 1.3.1