Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5. Some parts of this website may be subject to other licenses.
Source code for file /joomla/application/module/helper.php

Documentation is available at helper.php

  1. <?php
  2. /**
  3. * @version        $Id: helper.php 9779 2007-12-31 01:44:42Z jinx $
  4. * @package        Joomla.Framework
  5. * @subpackage    Application
  6. * @copyright    Copyright (C) 2005 - 2008 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. // Import library dependencies
  19. jimport('joomla.application.component.helper');
  20.  
  21. /**
  22.  * Module helper class
  23.  *
  24.  * @static
  25.  * @author        Johan Janssens <johan.janssens@joomla.org>
  26.  * @package        Joomla.Framework
  27.  * @subpackage    Application
  28.  * @since        1.5
  29.  */
  30. class JModuleHelper
  31. {
  32.     /**
  33.      * Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs')
  34.      *
  35.      * @access    public
  36.      * @param    string     $name    The name of the module
  37.      * @return    object    The Module object
  38.      */
  39.     function &getModule($name)
  40.     {
  41.         $result        = null;
  42.         $modules    =& JModuleHelper::_load();
  43.         $total        = count($modules);
  44.         for ($i = 0; $i < $total; $i++)
  45.         {
  46.             if ($modules[$i]->name == $name)
  47.             {
  48.                 $result =& $modules[$i];
  49.                 break;
  50.             }
  51.         }
  52.         // if we didn't find it, and the name is mod_something, create a dummy object
  53.         if (is_null( $result ) && substr( $name, 0, 4 ) == 'mod_')
  54.         {
  55.             $result                = new stdClass;
  56.             $result->id            = 0;
  57.             $result->title        = '';
  58.             $result->module        = $name;
  59.             $result->position    = '';
  60.             $result->content    = '';
  61.             $result->showtitle    = 0;
  62.             $result->control    = '';
  63.             $result->params        = '';
  64.             $result->user        = 0;
  65.         }
  66.  
  67.         return $result;
  68.     }
  69.  
  70.     /**
  71.      * Get modules by position
  72.      *
  73.      * @access public
  74.      * @param string     $position    The position of the module
  75.      * @return array    An array of module objects
  76.      */
  77.     function &getModules($position)
  78.     {
  79.         $position    = strtolower( $position );
  80.         $result        = array();
  81.  
  82.         $modules =& JModuleHelper::_load();
  83.  
  84.         $total = count($modules);
  85.         for($i = 0; $i < $total; $i++) {
  86.             if($modules[$i]->position == $position) {
  87.                 $result[] =& $modules[$i];
  88.             }
  89.         }
  90.  
  91.         return $result;
  92.     }
  93.  
  94.     /**
  95.      * Checks if a module is enabled
  96.      *
  97.      * @access    public
  98.      * @param   string     $module    The module name
  99.      * @return    boolean 
  100.      */
  101.     function isEnabled( $module )
  102.     {
  103.         $result = &JModuleHelper::getModule( $module);
  104.         return (!is_null($result));
  105.     }
  106.  
  107.     function renderModule($module, $attribs = array())
  108.     {
  109.         static $chrome;
  110.         global $mainframe, $option;
  111.         
  112.         $scope = $mainframe->scope; //record the scope
  113.         $mainframe->scope = $module->module;  //set scope to component name
  114.         
  115.         // Handle legacy globals if enabled
  116.         if ($mainframe->getCfg('legacy'))
  117.         {
  118.             // Include legacy globals
  119.             global $my, $database, $acl, $mosConfig_absolute_path;
  120.  
  121.             // Get the task variable for local scope
  122.             $task = JRequest::getString('task');
  123.  
  124.             // For backwards compatibility extract the config vars as globals
  125.             $registry =& JFactory::getConfig();
  126.             foreach (get_object_vars($registry->toObject()) as $k => $v) {
  127.                 $name = 'mosConfig_'.$k;
  128.                 $$name = $v;
  129.             }
  130.             $contentConfig = &JComponentHelper::getParams( 'com_content' );
  131.             foreach (get_object_vars($contentConfig->toObject()) as $k => $v)
  132.             {
  133.                 $name = 'mosConfig_'.$k;
  134.                 $$name = $v;
  135.             }
  136.             $usersConfig = &JComponentHelper::getParams( 'com_users' );
  137.             foreach (get_object_vars($usersConfig->toObject()) as $k => $v)
  138.             {
  139.                 $name = 'mosConfig_'.$k;
  140.                 $$name = $v;
  141.             }
  142.         }
  143.  
  144.         // Get module parameters
  145.         $params = new JParameter( $module->params );
  146.  
  147.         // Get module path
  148.         $module->module = preg_replace('/[^A-Z0-9_\.-]/i', '', $module->module);
  149.         $path = JPATH_BASE.DS.'modules'.DS.$module->module.DS.$module->module.'.php';
  150.  
  151.         // Load the module
  152.         if (!$module->user && file_exists( $path ) && empty($module->content))
  153.         {
  154.             $lang =& JFactory::getLanguage();
  155.             $lang->load($module->module);
  156.  
  157.             $content = '';
  158.             ob_start();
  159.             require $path;
  160.             $module->content = ob_get_contents().$content;
  161.             ob_end_clean();
  162.         }
  163.  
  164.         // Load the module chrome functions
  165.         if (!$chrome) {
  166.             $chrome = array();
  167.         }
  168.  
  169.         require_once (JPATH_BASE.DS.'templates'.DS.'system'.DS.'html'.DS.'modules.php');
  170.         $chromePath = JPATH_BASE.DS.'templates'.DS.$mainframe->getTemplate().DS.'html'.DS.'modules.php';
  171.         if (!isset( $chrome[$chromePath]))
  172.         {
  173.             if (file_exists($chromePath)) {
  174.                 require_once ($chromePath);
  175.             }
  176.             $chrome[$chromePath] = true;
  177.         }
  178.  
  179.         //make sure a style is set
  180.         if(!isset($attribs['style'])) {
  181.             $attribs['style'] = 'none';
  182.         }
  183.  
  184.         //dynamically add outline style
  185.         if(JRequest::getBool('tp')) {
  186.             $attribs['style'] .= ' outline';
  187.         }
  188.  
  189.         foreach(explode(' ', $attribs['style']) as $style)
  190.         {
  191.             $chromeMethod = 'modChrome_'.$style;
  192.  
  193.             // Apply chrome and render module
  194.             if (function_exists($chromeMethod))
  195.             {
  196.                 $module->style = $attribs['style'];
  197.  
  198.                 ob_start();
  199.                 $chromeMethod($module, $params, $attribs);
  200.                 $module->content = ob_get_contents();
  201.                 ob_end_clean();
  202.             }
  203.         }
  204.         
  205.         $mainframe->scope = $scope; //revert the scope
  206.         
  207.         return $module->content;
  208.     }
  209.  
  210.     /**
  211.      * Get the path to a layout for a module
  212.      *
  213.      * @static
  214.      * @param    string    $module    The name of the module
  215.      * @param    string    $layout    The name of the module layout
  216.      * @return    string    The path to the module layout
  217.      * @since    1.5
  218.      */
  219.     function getLayoutPath($module, $layout = 'default')
  220.     {
  221.         global $mainframe;
  222.  
  223.         // Build the template and base path for the layout
  224.         $tPath = JPATH_BASE.DS.'templates'.DS.$mainframe->getTemplate().DS.'html'.DS.$module.DS.$layout.'.php';
  225.         $bPath = JPATH_BASE.DS.'modules'.DS.$module.DS.'tmpl'.DS.$layout.'.php';
  226.  
  227.         // If the template has a layout override use it
  228.         if (file_exists($tPath)) {
  229.             return $tPath;
  230.         } else {
  231.             return $bPath;
  232.         }
  233.     }
  234.  
  235.     /**
  236.      * Load published modules
  237.      *
  238.      * @access    private
  239.      * @return    array 
  240.      */
  241.     function &_load()
  242.     {
  243.         global $mainframe, $Itemid;
  244.  
  245.         static $modules;
  246.  
  247.         if (isset($modules)) {
  248.             return $modules;
  249.         }
  250.  
  251.         $user    =& JFactory::getUser();
  252.         $db        =& JFactory::getDBO();
  253.  
  254.         $aid    = $user->get('aid', 0);
  255.  
  256.         $modules    = array();
  257.  
  258.         $wheremenu = isset( $Itemid ) ? ' AND ( mm.menuid = '. (int) $Itemid .' OR mm.menuid = 0 )' : '';
  259.  
  260.         $query = 'SELECT id, title, module, position, content, showtitle, control, params'
  261.             . ' FROM #__modules AS m'
  262.             . ' LEFT JOIN #__modules_menu AS mm ON mm.moduleid = m.id'
  263.             . ' WHERE m.published = 1'
  264.             . ' AND m.access <= '. (int)$aid
  265.             . ' AND m.client_id = '. (int)$mainframe->getClientId()
  266.             . $wheremenu
  267.             . ' ORDER BY position, ordering';
  268.  
  269.         $db->setQuery( $query );
  270.  
  271.         if (!($modules = $db->loadObjectList())) {
  272.             JError::raiseWarning( 'SOME_ERROR_CODE', "Error loading Modules: " . $db->getErrorMsg());
  273.             return false;
  274.         }
  275.  
  276.         $total = count($modules);
  277.         for($i = 0; $i < $total; $i++)
  278.         {
  279.             //determine if this is a custom module
  280.             $file                    = $modules[$i]->module;
  281.             $custom                 = substr( $file, 0, 4 ) == 'mod_' ?  0 : 1;
  282.             $modules[$i]->user      = $custom;
  283.             // CHECK: custom module name is given by the title field, otherwise it's just 'om' ??
  284.             $modules[$i]->name        = $custom ? $modules[$i]->title : substr( $file, 4 );
  285.             $modules[$i]->style        = null;
  286.             $modules[$i]->position    = strtolower($modules[$i]->position);
  287.         }
  288.  
  289.         return $modules;
  290.     }
  291.  
  292. }
Documentation generated on Tue, 29 Jan 2008 18:47:31 +0000 by phpDocumentor 1.3.1