Source for file debuggroup.php

Documentation is available at debuggroup.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_users
  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. require_once JPATH_COMPONENT . '/helpers/debug.php';
  13.  
  14. /**
  15.  * Methods supporting a list of user records.
  16.  *
  17.  * @package     Joomla.Administrator
  18.  * @subpackage  com_users
  19.  * @since       1.6
  20.  */
  21. class UsersModelDebuggroup extends JModelList
  22. {
  23.     /**
  24.      * Get a list of the actions.
  25.      *
  26.      * @return  array 
  27.      * @since   1.6
  28.      */
  29.     public function getDebugActions()
  30.     {
  31.         $component = $this->getState('filter.component');
  32.  
  33.         return UsersHelperDebug::getDebugActions($component);
  34.     }
  35.  
  36.     /**
  37.      * Override getItems method.
  38.      *
  39.      * @return  array 
  40.      * @since   1.6
  41.      */
  42.     public function getItems()
  43.     {
  44.         $groupId = $this->getState('filter.group_id');
  45.  
  46.         if (($assets = parent::getItems()) && $groupId)
  47.         {
  48.  
  49.             $actions = $this->getDebugActions();
  50.  
  51.             foreach ($assets as &$asset)
  52.             {
  53.                 $asset->checks = array();
  54.  
  55.                 foreach ($actions as $action)
  56.                 {
  57.                     $name = $action[0];
  58.                     $level = $action[1];
  59.  
  60.                     // Check that we check this action for the level of the asset.
  61.                     if ($level === null || $level >= $asset->level)
  62.                     {
  63.                         // We need to test this action.
  64.                         $asset->checks[$name] = JAccess::checkGroup($groupId, $name, $asset->name);
  65.                     }
  66.                     else
  67.                     {
  68.                         // We ignore this action.
  69.                         $asset->checks[$name] = 'skip';
  70.                     }
  71.                 }
  72.             }
  73.         }
  74.  
  75.         return $assets;
  76.     }
  77.  
  78.     /**
  79.      * Method to auto-populate the model state.
  80.      *
  81.      * Note. Calling getState in this method will result in recursion.
  82.      *
  83.      * @return  void 
  84.      * @since   1.6
  85.      */
  86.     protected function populateState($ordering = null, $direction = null)
  87.     {
  88.         $app = JFactory::getApplication('administrator');
  89.  
  90.         // Adjust the context to support modal layouts.
  91.         $layout = $app->input->get('layout', 'default');
  92.         if ($layout)
  93.         {
  94.             $this->context .= '.' . $layout;
  95.         }
  96.  
  97.         // Load the filter state.
  98.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  99.         $this->setState('filter.search', $search);
  100.  
  101.         $value = $this->getUserStateFromRequest($this->context . '.filter.group_id', 'group_id', 0, 'int', false);
  102.         $this->setState('filter.group_id', $value);
  103.  
  104.         $levelStart = $this->getUserStateFromRequest($this->context . '.filter.level_start', 'filter_level_start', 0, 'int');
  105.         $this->setState('filter.level_start', $levelStart);
  106.  
  107.         $value = $this->getUserStateFromRequest($this->context . '.filter.level_end', 'filter_level_end', 0, 'int');
  108.         if ($value > 0 && $value < $levelStart)
  109.         {
  110.             $value = $levelStart;
  111.         }
  112.         $this->setState('filter.level_end', $value);
  113.  
  114.         $component = $this->getUserStateFromRequest($this->context . '.filter.component', 'filter_component');
  115.         $this->setState('filter.component', $component);
  116.  
  117.         // Load the parameters.
  118.         $params = JComponentHelper::getParams('com_users');
  119.         $this->setState('params', $params);
  120.  
  121.         // List state information.
  122.         parent::populateState('a.lft', 'asc');
  123.     }
  124.  
  125.     /**
  126.      * Method to get a store id based on model configuration state.
  127.      *
  128.      * This is necessary because the model is used by the component and
  129.      * different modules that might need different sets of data or different
  130.      * ordering requirements.
  131.      *
  132.      * @param   string  $id    A prefix for the store id.
  133.      *
  134.      * @return  string  A store id.
  135.      * @since   1.6
  136.      */
  137.     protected function getStoreId($id = '')
  138.     {
  139.         // Compile the store id.
  140.         $id .= ':' . $this->getState('filter.search');
  141.         $id .= ':' . $this->getState('filter.level_start');
  142.         $id .= ':' . $this->getState('filter.level_end');
  143.         $id .= ':' . $this->getState('filter.component');
  144.  
  145.         return parent::getStoreId($id);
  146.     }
  147.  
  148.     /**
  149.      * Get the group being debugged.
  150.      *
  151.      * @return  JObject 
  152.      * @since   1.6
  153.      */
  154.     public function getGroup()
  155.     {
  156.         $groupId = (int) $this->getState('filter.group_id');
  157.  
  158.         $db = $this->getDbo();
  159.         $query = $db->getQuery(true)
  160.             ->select('id, title')
  161.             ->from('#__usergroups')
  162.             ->where('id = ' . $groupId);
  163.  
  164.         $db->setQuery($query);
  165.  
  166.         try
  167.         {
  168.             $group = $db->loadObject();
  169.         }
  170.         catch (RuntimeException $e)
  171.         {
  172.             $this->setError($e->getMessage());
  173.             return false;
  174.         }
  175.  
  176.         return $group;
  177.     }
  178.  
  179.     /**
  180.      * Build an SQL query to load the list data.
  181.      *
  182.      * @return  JDatabaseQuery 
  183.      * @since   1.6
  184.      */
  185.     protected function getListQuery()
  186.     {
  187.         // Create a new query object.
  188.         $db = $this->getDbo();
  189.         $query = $db->getQuery(true);
  190.  
  191.         // Select the required fields from the table.
  192.         $query->select(
  193.             $this->getState(
  194.                 'list.select',
  195.                 'a.id, a.name, a.title, a.level, a.lft, a.rgt'
  196.             )
  197.         );
  198.         $query->from($db->quoteName('#__assets') . ' AS a');
  199.  
  200.         // Filter the items over the search string if set.
  201.         if ($this->getState('filter.search'))
  202.         {
  203.             // Escape the search token.
  204.             $token = $db->quote('%' . $db->escape($this->getState('filter.search')) . '%');
  205.  
  206.             // Compile the different search clauses.
  207.             $searches = array();
  208.             $searches[] = 'a.name LIKE ' . $token;
  209.             $searches[] = 'a.title LIKE ' . $token;
  210.  
  211.             // Add the clauses to the query.
  212.             $query->where('(' . implode(' OR ', $searches) . ')');
  213.         }
  214.  
  215.         // Filter on the start and end levels.
  216.         $levelStart = (int) $this->getState('filter.level_start');
  217.         $levelEnd = (int) $this->getState('filter.level_end');
  218.         if ($levelEnd > 0 && $levelEnd < $levelStart)
  219.         {
  220.             $levelEnd = $levelStart;
  221.         }
  222.         if ($levelStart > 0)
  223.         {
  224.             $query->where('a.level >= ' . $levelStart);
  225.         }
  226.         if ($levelEnd > 0)
  227.         {
  228.             $query->where('a.level <= ' . $levelEnd);
  229.         }
  230.  
  231.         // Filter the items over the component if set.
  232.         if ($this->getState('filter.component'))
  233.         {
  234.             $component = $this->getState('filter.component');
  235.             $query->where('(a.name = ' . $db->quote($component) . ' OR a.name LIKE ' . $db->quote($component . '.%') . ')');
  236.         }
  237.  
  238.         // Add the list ordering clause.
  239.         $query->order($db->escape($this->getState('list.ordering', 'a.lft')) . ' ' . $db->escape($this->getState('list.direction', 'ASC')));
  240.  
  241.         return $query;
  242.     }
  243. }

Documentation generated on Tue, 19 Nov 2013 14:58:04 +0100 by phpDocumentor 1.4.3