Source for file select.php

Documentation is available at select.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_modules
  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.  * Module model.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_modules
  17.  * @since       1.6
  18.  */
  19. class ModulesModelSelect extends JModelList
  20. {
  21.     /**
  22.      * Method to auto-populate the model state.
  23.      *
  24.      * Note. Calling getState in this method will result in recursion.
  25.      *
  26.      * @since   1.6
  27.      */
  28.     protected function populateState($ordering = null, $direction = null)
  29.     {
  30.         $app = JFactory::getApplication('administrator');
  31.  
  32.         // Load the filter state.
  33.         $clientId = $app->getUserState('com_modules.modules.filter.client_id', 0);
  34.         $this->setState('filter.client_id', (int) $clientId);
  35.  
  36.         // Load the parameters.
  37.         $params = JComponentHelper::getParams('com_modules');
  38.         $this->setState('params', $params);
  39.  
  40.         // Manually set limits to get all modules.
  41.         $this->setState('list.limit', 0);
  42.         $this->setState('list.start', 0);
  43.         $this->setState('list.ordering', 'a.name');
  44.         $this->setState('list.direction', 'ASC');
  45.     }
  46.  
  47.     /**
  48.      * Method to get a store id based on model configuration state.
  49.      *
  50.      * This is necessary because the model is used by the component and
  51.      * different modules that might need different sets of data or different
  52.      * ordering requirements.
  53.      *
  54.      * @param   string    A prefix for the store id.
  55.      *
  56.      * @return  string    A store id.
  57.      */
  58.     protected function getStoreId($id = '')
  59.     {
  60.         // Compile the store id.
  61.         $id .= ':' . $this->getState('filter.client_id');
  62.  
  63.         return parent::getStoreId($id);
  64.     }
  65.  
  66.     /**
  67.      * Build an SQL query to load the list data.
  68.      *
  69.      * @return  JDatabaseQuery 
  70.      */
  71.     protected function getListQuery()
  72.     {
  73.         // Create a new query object.
  74.         $db = $this->getDbo();
  75.         $query = $db->getQuery(true);
  76.  
  77.         // Select the required fields from the table.
  78.         $query->select(
  79.             $this->getState(
  80.                 'list.select',
  81.                 'a.extension_id, a.name, a.element AS module'
  82.             )
  83.         );
  84.         $query->from($db->quoteName('#__extensions') . ' AS a');
  85.  
  86.         // Filter by module
  87.         $query->where('a.type = ' . $db->quote('module'));
  88.  
  89.         // Filter by client.
  90.         $clientId = $this->getState('filter.client_id');
  91.         $query->where('a.client_id = ' . (int) $clientId);
  92.  
  93.         // Filter by enabled
  94.         $query->where('a.enabled = 1');
  95.  
  96.         // Add the list ordering clause.
  97.         $query->order($db->escape($this->getState('list.ordering', 'a.ordering')) . ' ' . $db->escape($this->getState('list.direction', 'ASC')));
  98.  
  99.         //echo nl2br(str_replace('#__','jos_',$query));
  100.         return $query;
  101.     }
  102.  
  103.     /**
  104.      * Method to get a list of items.
  105.      *
  106.      * @return  mixed  An array of objects on success, false on failure.
  107.      */
  108.     public function getItems()
  109.     {
  110.         // Get the list of items from the database.
  111.         $items = parent::getItems();
  112.  
  113.         $client = JApplicationHelper::getClientInfo($this->getState('filter.client_id', 0));
  114.         $lang = JFactory::getLanguage();
  115.  
  116.         // Loop through the results to add the XML metadata,
  117.         // and load language support.
  118.         foreach ($items as &$item)
  119.         {
  120.             $path = JPath::clean($client->path . '/modules/' . $item->module . '/' . $item->module . '.xml');
  121.             if (file_exists($path))
  122.             {
  123.                 $item->xml = simplexml_load_file($path);
  124.             }
  125.             else
  126.             {
  127.                 $item->xml = null;
  128.             }
  129.  
  130.             // 1.5 Format; Core files or language packs then
  131.             // 1.6 3PD Extension Support
  132.             $lang->load($item->module . '.sys', $client->path, null, false, true)
  133.                 || $lang->load($item->module . '.sys', $client->path . '/modules/' . $item->module, null, false, true);
  134.             $item->name = JText::_($item->name);
  135.  
  136.             if (isset($item->xml) && $text = trim($item->xml->description))
  137.             {
  138.                 $item->desc = JText::_($text);
  139.             }
  140.             else
  141.             {
  142.                 $item->desc = JText::_('COM_MODULES_NODESCRIPTION');
  143.             }
  144.         }
  145.         $items = JArrayHelper::sortObjects($items, 'name', 1, true, true);
  146.  
  147.         // TODO: Use the cached XML from the extensions table?
  148.  
  149.         return $items;
  150.     }
  151. }

Documentation generated on Tue, 19 Nov 2013 15:12:48 +0100 by phpDocumentor 1.4.3