Source for file plugins.php

Documentation is available at plugins.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_plugins
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. /**
  13.  * Methods supporting a list of plugin records.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_plugins
  17.  * @since       1.6
  18.  */
  19. class PluginsModelPlugins extends JModelList
  20. {
  21.     /**
  22.      * Constructor.
  23.      *
  24.      * @param   array  An optional associative array of configuration settings.
  25.      * @see     JController
  26.      * @since   1.6
  27.      */
  28.     public function __construct($config = array())
  29.     {
  30.         if (empty($config['filter_fields']))
  31.         {
  32.             $config['filter_fields'] = array(
  33.                 'extension_id', 'a.extension_id',
  34.                 'name', 'a.name',
  35.                 'folder', 'a.folder',
  36.                 'element', 'a.element',
  37.                 'checked_out', 'a.checked_out',
  38.                 'checked_out_time', 'a.checked_out_time',
  39.                 'state', 'a.state',
  40.                 'enabled', 'a.enabled',
  41.                 'access', 'a.access', 'access_level',
  42.                 'ordering', 'a.ordering',
  43.                 'client_id', 'a.client_id',
  44.             );
  45.         }
  46.  
  47.         parent::__construct($config);
  48.     }
  49.  
  50.     /**
  51.      * Method to auto-populate the model state.
  52.      *
  53.      * Note. Calling getState in this method will result in recursion.
  54.      *
  55.      * @param   string  $ordering   An optional ordering field.
  56.      * @param   string  $direction  An optional direction (asc|desc).
  57.      *
  58.      * @return  void 
  59.      *
  60.      * @since   1.6
  61.      */
  62.     protected function populateState($ordering = null, $direction = null)
  63.     {
  64.         // Load the filter state.
  65.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  66.         $this->setState('filter.search', $search);
  67.  
  68.         $accessId = $this->getUserStateFromRequest($this->context . '.filter.access', 'filter_access', null, 'int');
  69.         $this->setState('filter.access', $accessId);
  70.  
  71.         $state = $this->getUserStateFromRequest($this->context . '.filter.enabled', 'filter_enabled', '', 'string');
  72.         $this->setState('filter.enabled', $state);
  73.  
  74.         $folder = $this->getUserStateFromRequest($this->context . '.filter.folder', 'filter_folder', null, 'cmd');
  75.         $this->setState('filter.folder', $folder);
  76.  
  77.         $language = $this->getUserStateFromRequest($this->context . '.filter.language', 'filter_language', '');
  78.         $this->setState('filter.language', $language);
  79.  
  80.         // Load the parameters.
  81.         $params = JComponentHelper::getParams('com_plugins');
  82.         $this->setState('params', $params);
  83.  
  84.         // List state information.
  85.         parent::populateState('folder', 'asc');
  86.     }
  87.  
  88.     /**
  89.      * Method to get a store id based on model configuration state.
  90.      *
  91.      * This is necessary because the model is used by the component and
  92.      * different modules that might need different sets of data or different
  93.      * ordering requirements.
  94.      *
  95.      * @param   string    A prefix for the store id.
  96.      *
  97.      * @return  string    A store id.
  98.      */
  99.     protected function getStoreId($id = '')
  100.     {
  101.         // Compile the store id.
  102.         $id .= ':' . $this->getState('filter.search');
  103.         $id .= ':' . $this->getState('filter.access');
  104.         $id .= ':' . $this->getState('filter.state');
  105.         $id .= ':' . $this->getState('filter.folder');
  106.         $id .= ':' . $this->getState('filter.language');
  107.  
  108.         return parent::getStoreId($id);
  109.     }
  110.  
  111.     /**
  112.      * Returns an object list
  113.      *
  114.      * @param   string The query
  115.      * @param   int    Offset
  116.      * @param   int    The number of records
  117.      * @return  array 
  118.      */
  119.     protected function _getList($query, $limitstart = 0, $limit = 0)
  120.     {
  121.         $search = $this->getState('filter.search');
  122.         $ordering = $this->getState('list.ordering', 'ordering');
  123.         if ($ordering == 'name' || (!empty($search) && stripos($search, 'id:') !== 0))
  124.         {
  125.             $this->_db->setQuery($query);
  126.             $result = $this->_db->loadObjectList();
  127.             $this->translate($result);
  128.             if (!empty($search))
  129.             {
  130.                 foreach ($result as $i => $item)
  131.                 {
  132.                     if (!preg_match("/$search/i", $item->name))
  133.                     {
  134.                         unset($result[$i]);
  135.                     }
  136.                 }
  137.             }
  138.  
  139.             $direction = ($this->getState('list.direction') == 'desc') ? -1 : 1;
  140.             JArrayHelper::sortObjects($result, $ordering, $direction, true, true);
  141.  
  142.             $total = count($result);
  143.             $this->cache[$this->getStoreId('getTotal')] = $total;
  144.             if ($total < $limitstart)
  145.             {
  146.                 $limitstart = 0;
  147.                 $this->setState('list.start', 0);
  148.             }
  149.             return array_slice($result, $limitstart, $limit ? $limit : null);
  150.         }
  151.         else
  152.         {
  153.             if ($ordering == 'ordering')
  154.             {
  155.                 $query->order('a.folder ASC');
  156.                 $ordering = 'a.ordering';
  157.             }
  158.             $query->order($this->_db->quoteName($ordering) . ' ' . $this->getState('list.direction'));
  159.  
  160.             if ($ordering == 'folder')
  161.             {
  162.                 $query->order('a.ordering ASC');
  163.             }
  164.             $result = parent::_getList($query, $limitstart, $limit);
  165.             $this->translate($result);
  166.             return $result;
  167.         }
  168.     }
  169.  
  170.     /**
  171.      * Translate a list of objects
  172.      *
  173.      * @param   array The array of objects
  174.      * @return  array The array of translated objects
  175.      */
  176.     protected function translate(&$items)
  177.     {
  178.         $lang = JFactory::getLanguage();
  179.  
  180.         foreach ($items as &$item)
  181.         {
  182.             $source = JPATH_PLUGINS . '/' . $item->folder . '/' . $item->element;
  183.             $extension = 'plg_' . $item->folder . '_' . $item->element;
  184.             $lang->load($extension . '.sys', JPATH_ADMINISTRATOR, null, false, true)
  185.                 || $lang->load($extension . '.sys', $source, null, false, true);
  186.             $item->name = JText::_($item->name);
  187.         }
  188.     }
  189.  
  190.     /**
  191.      * Build an SQL query to load the list data.
  192.      *
  193.      * @return  JDatabaseQuery 
  194.      */
  195.     protected function getListQuery()
  196.     {
  197.         // Create a new query object.
  198.         $db = $this->getDbo();
  199.         $query = $db->getQuery(true);
  200.  
  201.         // Select the required fields from the table.
  202.         $query->select(
  203.             $this->getState(
  204.                 'list.select',
  205.                 'a.extension_id , a.name, a.element, a.folder, a.checked_out, a.checked_out_time,' .
  206.                     ' a.enabled, a.access, a.ordering'
  207.             )
  208.         )
  209.             ->from($db->quoteName('#__extensions') . ' AS a')
  210.             ->where($db->quoteName('type') . ' = ' . $db->quote('plugin'));
  211.  
  212.         // Join over the users for the checked out user.
  213.         $query->select('uc.name AS editor')
  214.             ->join('LEFT', '#__users AS uc ON uc.id=a.checked_out');
  215.  
  216.         // Join over the asset groups.
  217.         $query->select('ag.title AS access_level')
  218.             ->join('LEFT', '#__viewlevels AS ag ON ag.id = a.access');
  219.  
  220.         // Filter by access level.
  221.         if ($access = $this->getState('filter.access'))
  222.         {
  223.             $query->where('a.access = ' . (int) $access);
  224.         }
  225.  
  226.         // Filter by published state
  227.         $published = $this->getState('filter.enabled');
  228.         if (is_numeric($published))
  229.         {
  230.             $query->where('a.enabled = ' . (int) $published);
  231.         }
  232.         elseif ($published === '')
  233.         {
  234.             $query->where('(a.enabled IN (0, 1))');
  235.         }
  236.  
  237.         // Filter by state
  238.         $query->where('a.state >= 0');
  239.  
  240.         // Filter by folder.
  241.         if ($folder = $this->getState('filter.folder'))
  242.         {
  243.             $query->where('a.folder = ' . $db->quote($folder));
  244.         }
  245.  
  246.         // Filter by search in name or id
  247.         $search = $this->getState('filter.search');
  248.         if (!empty($search))
  249.         {
  250.             if (stripos($search, 'id:') === 0)
  251.             {
  252.                 $query->where('a.extension_id = ' . (int) substr($search, 3));
  253.             }
  254.         }
  255.  
  256.         return $query;
  257.     }
  258. }

Documentation generated on Tue, 19 Nov 2013 15:10:51 +0100 by phpDocumentor 1.4.3