Source for file debuguser.php

Documentation is available at debuguser.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 UsersModelDebugUser 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.         $userId = $this->getState('filter.user_id');
  45.  
  46.         if (($assets = parent::getItems()) && $userId)
  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::check($userId, $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.user_id', 'user_id', 0, 'int');
  102.         $this->setState('filter.user_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.user_id');
  142.         $id .= ':' . $this->getState('filter.level_start');
  143.         $id .= ':' . $this->getState('filter.level_end');
  144.         $id .= ':' . $this->getState('filter.component');
  145.  
  146.         return parent::getStoreId($id);
  147.     }
  148.  
  149.     /**
  150.      * Get the user being debugged.
  151.      *
  152.      * @return  JUser 
  153.      * @since   1.6
  154.      */
  155.     public function getUser()
  156.     {
  157.         $userId = $this->getState('filter.user_id');
  158.  
  159.         return JFactory::getUser($userId);
  160.     }
  161.  
  162.     /**
  163.      * Build an SQL query to load the list data.
  164.      *
  165.      * @return  JDatabaseQuery 
  166.      * @since   1.6
  167.      */
  168.     protected function getListQuery()
  169.     {
  170.         // Create a new query object.
  171.         $db = $this->getDbo();
  172.         $query = $db->getQuery(true);
  173.  
  174.         // Select the required fields from the table.
  175.         $query->select(
  176.             $this->getState(
  177.                 'list.select',
  178.                 'a.id, a.name, a.title, a.level, a.lft, a.rgt'
  179.             )
  180.         );
  181.         $query->from($db->quoteName('#__assets') . ' AS a');
  182.  
  183.         // Filter the items over the group id if set.
  184.         if ($groupId = $this->getState('filter.group_id'))
  185.         {
  186.             $query->join('LEFT', '#__user_usergroup_map AS map2 ON map2.user_id = a.id')
  187.                 ->where('map2.group_id = ' . (int) $groupId);
  188.         }
  189.  
  190.         // Filter the items over the search string if set.
  191.         if ($this->getState('filter.search'))
  192.         {
  193.             // Escape the search token.
  194.             $token = $db->quote('%' . $db->escape($this->getState('filter.search')) . '%');
  195.  
  196.             // Compile the different search clauses.
  197.             $searches = array();
  198.             $searches[] = 'a.name LIKE ' . $token;
  199.             $searches[] = 'a.title LIKE ' . $token;
  200.  
  201.             // Add the clauses to the query.
  202.             $query->where('(' . implode(' OR ', $searches) . ')');
  203.         }
  204.  
  205.         // Filter on the start and end levels.
  206.         $levelStart = (int) $this->getState('filter.level_start');
  207.         $levelEnd = (int) $this->getState('filter.level_end');
  208.         if ($levelEnd > 0 && $levelEnd < $levelStart)
  209.         {
  210.             $levelEnd = $levelStart;
  211.         }
  212.         if ($levelStart > 0)
  213.         {
  214.             $query->where('a.level >= ' . $levelStart);
  215.         }
  216.         if ($levelEnd > 0)
  217.         {
  218.             $query->where('a.level <= ' . $levelEnd);
  219.         }
  220.  
  221.         // Filter the items over the component if set.
  222.         if ($this->getState('filter.component'))
  223.         {
  224.             $component = $this->getState('filter.component');
  225.             $query->where('(a.name = ' . $db->quote($component) . ' OR a.name LIKE ' . $db->quote($component . '.%') . ')');
  226.         }
  227.  
  228.         // Add the list ordering clause.
  229.         $query->order($db->escape($this->getState('list.ordering', 'a.lft')) . ' ' . $db->escape($this->getState('list.direction', 'ASC')));
  230.  
  231.         return $query;
  232.     }
  233. }

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