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/application/module/helper.php

Documentation is available at helper.php

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