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

Documentation is available at helper.php

  1. <?php
  2. /**
  3. * @version        $Id: helper.php 6748 2007-03-01 22:49:19Z hackwar $
  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. /**
  19. * Plugin helper class
  20. *
  21. * @static
  22. * @author        Johan Janssens <[email protected]>
  23. * @package        Joomla.Framework
  24. * @subpackage    Application
  25. * @since        1.5
  26. */
  27. class JPluginHelper
  28. {
  29.     /**
  30.      * Get the plugin data of a group if no specific plugin is specified
  31.      * otherwise only the specific plugin data is returned
  32.      *
  33.      * @access public
  34.      * @param string     $group     The group name, relates to the sub-directory in the plugins directory
  35.      * @param string     $plugin    The plugin name
  36.      * @return mixed     An array of plugin data objects, or a plugin data object
  37.      */
  38.     function &getPlugin($group, $plugin = null)
  39.     {
  40.         $result = array();
  41.  
  42.         $plugins = JPluginHelper::_load();
  43.  
  44.         $total = count($plugins);
  45.         for($i = 0; $i < $total; $i++) {
  46.  
  47.             if(is_null($plugin))
  48.             {
  49.                 if($plugins[$i]->folder == $group) {
  50.                     $result[] = $plugins[$i];
  51.                 }
  52.             }
  53.             else
  54.             {
  55.                 if($plugins[$i]->folder == $group && $plugins[$i]->element == $plugin) {
  56.                     $result = $plugins[$i];
  57.                     break;
  58.                 }
  59.             }
  60.  
  61.         }
  62.  
  63.         return $result;
  64.     }
  65.  
  66.     /**
  67.     * Loads all the plugin files for a particular group if no specific plugin is specified
  68.     * otherwise only the specific pugin is loaded.
  69.     *
  70.     * @access public
  71.     * @param string     $group     The group name, relates to the sub-directory in the plugins directory
  72.     * @param string     $plugin    The plugin name
  73.     * @return boolean True if success
  74.     */
  75.     function importPlugin($group, $plugin = null)
  76.     {
  77.         $result = false;
  78.  
  79.         $plugins = JPluginHelper::_load();
  80.  
  81.         $total = count($plugins);
  82.         for($i = 0; $i < $total; $i++) {
  83.             if($plugins[$i]->folder == $group && ($plugins[$i]->element == $plugin ||  $plugin === null)) {
  84.                 JPluginHelper::_import( $plugins[$i]->folder, $plugins[$i]->element, $plugins[$i]->published, $plugins[$i]->params );
  85.                 $result = true;
  86.             }
  87.         }
  88.  
  89.         return $result;
  90.     }
  91.  
  92.     /**
  93.      * Loads the plugin file
  94.      *
  95.      * @access private
  96.      * @param string The folder (group)
  97.      * @param string The elements (name of file without extension)
  98.      * @param int Published state
  99.      * @param string The params for the bot
  100.      * @return boolean True if success
  101.      */
  102.     function _import( $folder, $element, $published, $params='' )
  103.     {
  104.         static $paths;
  105.  
  106.         if (!$paths) {
  107.             $paths = array();
  108.         }
  109.  
  110.         $result    = false;
  111.         $path    = JPATH_PLUGINS.DS.$folder.DS.$element.'.php';
  112.  
  113.         if (isset( $paths[$path] ))
  114.         {
  115.             $result = $paths[$path];
  116.         }
  117.         else
  118.         {
  119.             if (file_exists( $path ))
  120.             {
  121.                 //needed for backwards compatibility
  122.                 global $_MAMBOTS, $mainframe;
  123.  
  124.                 require_once( $path );
  125.  
  126.                 //Jinx :: if plugins need languages they need to load them themselves
  127.                 //$lang =& JFactory::getLanguage();
  128.                 //$lang->load( 'plg_'.trim( $folder ).'_'.trim( $element ), JPATH_ADMINISTRATOR );
  129.  
  130.                 $paths[$path] = true;
  131.             }
  132.             else
  133.             {
  134.                 $paths[$path] = false;
  135.             }
  136.         }
  137.         return $paths[$path];
  138.     }
  139.  
  140.     /**
  141.      * Loads the plugin data
  142.      *
  143.      * @access private
  144.      */
  145.     function _load()
  146.     {
  147.         static $plugins;
  148.  
  149.         if (isset($plugins)) {
  150.             return $plugins;
  151.         }
  152.  
  153.         $db        =& JFactory::getDBO();
  154.         $user    =& JFactory::getUser();
  155.  
  156.         if (isset($user)) 
  157.         {
  158.             $aid = $user->get('aid', 0);
  159.  
  160.             $query = 'SELECT id, name, folder, element, published, params'
  161.                 . ' FROM #__plugins'
  162.                 . ' WHERE published >= 1'
  163.                 . ' AND access <= ' . (int) $aid
  164.                 . ' ORDER BY ordering';
  165.         } 
  166.         else 
  167.         {
  168.             $query = 'SELECT id, name, folder, element, published, params'
  169.                 . ' FROM #__plugins'
  170.                 . ' WHERE published >= 1'
  171.                 . ' ORDER BY ordering';
  172.         }
  173.  
  174.         $db->setQuery( $query );
  175.  
  176.         if (!($plugins = $db->loadObjectList())) {
  177.             JError::raiseWarning( 'SOME_ERROR_CODE', "Error loading Plugins: " . $db->getErrorMsg());
  178.             return false;
  179.         }
  180.  
  181.         return $plugins;
  182.     }
  183.  
  184. }
  185. ?>
Documentation generated on Mon, 05 Mar 2007 21:05:33 +0000 by phpDocumentor 1.3.1