Source for file modules.php

Documentation is available at modules.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.  * Modules Component Module Model
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_modules
  17.  * @since       1.5
  18.  */
  19. class ModulesModelModules 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.                 'id', 'a.id',
  34.                 'title', 'a.title',
  35.                 'checked_out', 'a.checked_out',
  36.                 'checked_out_time', 'a.checked_out_time',
  37.                 'published', 'a.published',
  38.                 'access', 'a.access', 'access_level',
  39.                 'ordering', 'a.ordering',
  40.                 'module', 'a.module',
  41.                 'language', 'a.language', 'language_title',
  42.                 'publish_up', 'a.publish_up',
  43.                 'publish_down', 'a.publish_down',
  44.                 'client_id', 'a.client_id',
  45.                 'position', 'a.position',
  46.                 'pages',
  47.                 'name', 'e.name',
  48.             );
  49.         }
  50.  
  51.         parent::__construct($config);
  52.     }
  53.  
  54.     /**
  55.      * Method to auto-populate the model state.
  56.      *
  57.      * Note. Calling getState in this method will result in recursion.
  58.      *
  59.      * @since   1.6
  60.      */
  61.     protected function populateState($ordering = null, $direction = null)
  62.     {
  63.         $app = JFactory::getApplication('administrator');
  64.  
  65.         // Load the filter state.
  66.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  67.         $this->setState('filter.search', $search);
  68.  
  69.         $accessId = $this->getUserStateFromRequest($this->context . '.filter.access', 'filter_access', null, 'int');
  70.         $this->setState('filter.access', $accessId);
  71.  
  72.         $state = $this->getUserStateFromRequest($this->context . '.filter.state', 'filter_state', '', 'string');
  73.         $this->setState('filter.state', $state);
  74.  
  75.         $position = $this->getUserStateFromRequest($this->context . '.filter.position', 'filter_position', '', 'string');
  76.         $this->setState('filter.position', $position);
  77.  
  78.         $module = $this->getUserStateFromRequest($this->context . '.filter.module', 'filter_module', '', 'string');
  79.         $this->setState('filter.module', $module);
  80.  
  81.         $clientId = $this->getUserStateFromRequest($this->context . '.filter.client_id', 'filter_client_id', 0, 'int', false);
  82.         $previousId = $app->getUserState($this->context . '.filter.client_id_previous', null);
  83.         if ($previousId != $clientId || $previousId === null)
  84.         {
  85.             $this->getUserStateFromRequest($this->context . '.filter.client_id_previous', 'filter_client_id_previous', 0, 'int', true);
  86.             $app->setUserState($this->context . '.filter.client_id_previous', $clientId);
  87.         }
  88.         $this->setState('filter.client_id', $clientId);
  89.  
  90.         $language = $this->getUserStateFromRequest($this->context . '.filter.language', 'filter_language', '');
  91.         $this->setState('filter.language', $language);
  92.  
  93.         // Load the parameters.
  94.         $params = JComponentHelper::getParams('com_modules');
  95.         $this->setState('params', $params);
  96.  
  97.         // List state information.
  98.         parent::populateState('position', 'asc');
  99.     }
  100.  
  101.     /**
  102.      * Method to get a store id based on model configuration state.
  103.      *
  104.      * This is necessary because the model is used by the component and
  105.      * different modules that might need different sets of data or different
  106.      * ordering requirements.
  107.      *
  108.      * @param   string    A prefix for the store id.
  109.      *
  110.      * @return  string    A store id.
  111.      */
  112.     protected function getStoreId($id = '')
  113.     {
  114.         // Compile the store id.
  115.         $id .= ':' . $this->getState('filter.search');
  116.         $id .= ':' . $this->getState('filter.access');
  117.         $id .= ':' . $this->getState('filter.state');
  118.         $id .= ':' . $this->getState('filter.position');
  119.         $id .= ':' . $this->getState('filter.module');
  120.         $id .= ':' . $this->getState('filter.client_id');
  121.         $id .= ':' . $this->getState('filter.language');
  122.  
  123.         return parent::getStoreId($id);
  124.     }
  125.  
  126.     /**
  127.      * Returns an object list
  128.      *
  129.      * @param   string The query
  130.      * @param   int    Offset
  131.      * @param   int    The number of records
  132.      * @return  array 
  133.      */
  134.     protected function _getList($query, $limitstart = 0, $limit = 0)
  135.     {
  136.         $ordering = $this->getState('list.ordering', 'ordering');
  137.         if (in_array($ordering, array('pages', 'name')))
  138.         {
  139.             $this->_db->setQuery($query);
  140.             $result = $this->_db->loadObjectList();
  141.             $this->translate($result);
  142.             JArrayHelper::sortObjects($result, $ordering, $this->getState('list.direction') == 'desc' ? -1 : 1, true, true);
  143.             $total = count($result);
  144.             $this->cache[$this->getStoreId('getTotal')] = $total;
  145.             if ($total < $limitstart)
  146.             {
  147.                 $limitstart = 0;
  148.                 $this->setState('list.start', 0);
  149.             }
  150.             return array_slice($result, $limitstart, $limit ? $limit : null);
  151.         }
  152.         else
  153.         {
  154.             if ($ordering == 'ordering')
  155.             {
  156.                 $query->order('a.position ASC');
  157.                 $ordering = 'a.ordering';
  158.             }
  159.             if ($ordering == 'language_title')
  160.             {
  161.                 $ordering = 'l.title';
  162.             }
  163.             $query->order($this->_db->quoteName($ordering) . ' ' . $this->getState('list.direction'));
  164.             if ($ordering == 'position')
  165.             {
  166.                 $query->order('a.ordering ASC');
  167.             }
  168.             $result = parent::_getList($query, $limitstart, $limit);
  169.             $this->translate($result);
  170.             return $result;
  171.         }
  172.     }
  173.  
  174.     /**
  175.      * Translate a list of objects
  176.      *
  177.      * @param   array The array of objects
  178.      * @return  array The array of translated objects
  179.      */
  180.     protected function translate(&$items)
  181.     {
  182.         $lang = JFactory::getLanguage();
  183.         $client = $this->getState('filter.client_id') ? 'administrator' : 'site';
  184.  
  185.         foreach ($items as $item)
  186.         {
  187.             $extension = $item->module;
  188.             $source = constant('JPATH_' . strtoupper($client)) . "/modules/$extension";
  189.             $lang->load("$extension.sys", constant('JPATH_' . strtoupper($client)), null, false, true)
  190.                 || $lang->load("$extension.sys", $source, null, false, true);
  191.             $item->name = JText::_($item->name);
  192.             if (is_null($item->pages))
  193.             {
  194.                 $item->pages = JText::_('JNONE');
  195.             }
  196.             elseif ($item->pages < 0)
  197.             {
  198.                 $item->pages = JText::_('COM_MODULES_ASSIGNED_VARIES_EXCEPT');
  199.             }
  200.             elseif ($item->pages > 0)
  201.             {
  202.                 $item->pages = JText::_('COM_MODULES_ASSIGNED_VARIES_ONLY');
  203.             }
  204.             else
  205.             {
  206.                 $item->pages = JText::_('JALL');
  207.             }
  208.         }
  209.     }
  210.  
  211.     /**
  212.      * Build an SQL query to load the list data.
  213.      *
  214.      * @return  JDatabaseQuery 
  215.      */
  216.     protected function getListQuery()
  217.     {
  218.         // Create a new query object.
  219.         $db = $this->getDbo();
  220.         $query = $db->getQuery(true);
  221.  
  222.         // Select the required fields from the table.
  223.         $query->select(
  224.             $this->getState(
  225.                 'list.select',
  226.                 'a.id, a.title, a.note, a.position, a.module, a.language,' .
  227.                     'a.checked_out, a.checked_out_time, a.published+2*(e.enabled-1) as published, a.access, a.ordering, a.publish_up, a.publish_down'
  228.             )
  229.         );
  230.         $query->from($db->quoteName('#__modules') . ' AS a');
  231.  
  232.         // Join over the language
  233.         $query->select('l.title AS language_title')
  234.             ->join('LEFT', $db->quoteName('#__languages') . ' AS l ON l.lang_code = a.language');
  235.  
  236.         // Join over the users for the checked out user.
  237.         $query->select('uc.name AS editor')
  238.             ->join('LEFT', '#__users AS uc ON uc.id=a.checked_out');
  239.  
  240.         // Join over the asset groups.
  241.         $query->select('ag.title AS access_level')
  242.             ->join('LEFT', '#__viewlevels AS ag ON ag.id = a.access');
  243.  
  244.         // Join over the module menus
  245.         $query->select('MIN(mm.menuid) AS pages')
  246.             ->join('LEFT', '#__modules_menu AS mm ON mm.moduleid = a.id');
  247.  
  248.         // Join over the extensions
  249.         $query->select('e.name AS name')
  250.             ->join('LEFT', '#__extensions AS e ON e.element = a.module')
  251.             ->group(
  252.                 'a.id, a.title, a.note, a.position, a.module, a.language,a.checked_out,' .
  253.                     'a.checked_out_time, a.published, a.access, a.ordering,l.title, uc.name, ag.title, e.name,' .
  254.                     'l.lang_code, uc.id, ag.id, mm.moduleid, e.element, a.publish_up, a.publish_down,e.enabled'
  255.             );
  256.  
  257.         // Filter by access level.
  258.         if ($access = $this->getState('filter.access'))
  259.         {
  260.             $query->where('a.access = ' . (int) $access);
  261.         }
  262.  
  263.         // Filter by published state
  264.         $state = $this->getState('filter.state');
  265.         if (is_numeric($state))
  266.         {
  267.             $query->where('a.published = ' . (int) $state);
  268.         }
  269.         elseif ($state === '')
  270.         {
  271.             $query->where('(a.published IN (0, 1))');
  272.         }
  273.  
  274.         // Filter by position
  275.         $position = $this->getState('filter.position');
  276.         if ($position && $position != 'none')
  277.         {
  278.             $query->where('a.position = ' . $db->quote($position));
  279.         }
  280.  
  281.         elseif ($position == 'none')
  282.         {
  283.             $query->where('a.position = ' . $db->quote(''));
  284.         }
  285.  
  286.         // Filter by module
  287.         $module = $this->getState('filter.module');
  288.         if ($module)
  289.         {
  290.             $query->where('a.module = ' . $db->quote($module));
  291.         }
  292.  
  293.         // Filter by client.
  294.         $clientId = $this->getState('filter.client_id');
  295.         if (is_numeric($clientId))
  296.         {
  297.             $query->where('a.client_id = ' . (int) $clientId . ' AND e.client_id =' . (int) $clientId);
  298.         }
  299.  
  300.         // Filter by search in title
  301.         $search = $this->getState('filter.search');
  302.         if (!empty($search))
  303.         {
  304.             if (stripos($search, 'id:') === 0)
  305.             {
  306.                 $query->where('a.id = ' . (int) substr($search, 3));
  307.             }
  308.             else
  309.             {
  310.                 $search = $db->quote('%' . $db->escape($search, true) . '%');
  311.                 $query->where('(' . 'a.title LIKE ' . $search . ' OR a.note LIKE ' . $search . ')');
  312.             }
  313.         }
  314.  
  315.         // Filter on the language.
  316.         if ($language = $this->getState('filter.language'))
  317.         {
  318.             $query->where('a.language = ' . $db->quote($language));
  319.         }
  320.  
  321.         //echo nl2br(str_replace('#__','jos_',$query));
  322.         return $query;
  323.     }
  324. }

Documentation generated on Tue, 19 Nov 2013 15:08:52 +0100 by phpDocumentor 1.4.3