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/html/renderer/module.php

Documentation is available at module.php

  1. <?php
  2. /**
  3. * @version        $Id: module.php 6673 2007-02-19 05:12:48Z louis $
  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.  * JDocument Module renderer
  20.  *
  21.  * @author        Johan Janssens <[email protected]>
  22.  * @package        Joomla.Framework
  23.  * @subpackage    Document
  24.  * @since        1.5
  25.  */
  26. class JDocumentRenderer_Module extends JDocumentRenderer
  27. {
  28.     /**
  29.      * Renders a module script and returns the results as a string
  30.      *
  31.      * @access public
  32.      * @param string     $name        The name of the module to render
  33.      * @param array     $params        Associative array of values
  34.      * @return string    The output of the script
  35.      */
  36.     function render( $module, $params = array(), $content = null )
  37.     {
  38.         if (!is_object($module))
  39.         {
  40.             $module =& JModuleHelper::getModule($module);
  41.  
  42.             if (!is_object($module))
  43.             {
  44.                 if (is_null($content)) {
  45.                     return '';
  46.                 } else {
  47.                     /**
  48.                      * If module isn't found in the database but data has been pushed in the buffer
  49.                      * we want to render it
  50.                      */
  51.                     $tmp = $module;
  52.                     $module = new stdClass();
  53.                     $module->params = null;
  54.                     $module->module = $tmp;
  55.                     $module->id = 0;
  56.                     $module->user = 0;
  57.                 }
  58.             }
  59.         }
  60.  
  61.         // get the user and configuration object
  62.         $user =& JFactory::getUser();
  63.         $conf =& JFactory::getConfig();
  64.  
  65.         // set the module content
  66.         if (!is_null($content)) {
  67.             $module->content = $content;
  68.         }
  69.  
  70.         //get module parameters
  71.         $mod_params = new JParameter( $module->params );
  72.  
  73.         $cache =& JFactory::getCache( $module->module );
  74.  
  75.         $cache->setCaching( $mod_params->get( 'cache', 0 ) && $conf->getValue( 'config.caching' ) );
  76.         $cache->setLifeTime( $mod_params->get( 'cache_time', $conf->getValue( 'config.cachetime' ) ) );
  77.         $cache->setCacheValidation(true);
  78.  
  79.         return $cache->get( array('JModuleHelper', 'renderModule'), array( $module, $params ), $module->id. $user->get('aid', 0) );
  80.     }
  81. }
  82. ?>
Documentation generated on Mon, 05 Mar 2007 21:11:16 +0000 by phpDocumentor 1.3.1