Source for file users.php

Documentation is available at users.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. /**
  13.  * Users component helper.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_users
  17.  * @since       1.6
  18.  */
  19. class UsersHelper
  20. {
  21.     /**
  22.      * @var    JObject  A cache for the available actions.
  23.      * @since  1.6
  24.      */
  25.     protected static $actions;
  26.  
  27.     /**
  28.      * Configure the Linkbar.
  29.      *
  30.      * @param   string  $vName  The name of the active view.
  31.      *
  32.      * @return  void 
  33.      *
  34.      * @since   1.6
  35.      */
  36.     public static function addSubmenu($vName)
  37.     {
  38.         JHtmlSidebar::addEntry(
  39.             JText::_('COM_USERS_SUBMENU_USERS'),
  40.             'index.php?option=com_users&view=users',
  41.             $vName == 'users'
  42.         );
  43.  
  44.         // Groups and Levels are restricted to core.admin
  45.         $canDo = self::getActions();
  46.  
  47.         if ($canDo->get('core.admin'))
  48.         {
  49.             JHtmlSidebar::addEntry(
  50.                 JText::_('COM_USERS_SUBMENU_GROUPS'),
  51.                 'index.php?option=com_users&view=groups',
  52.                 $vName == 'groups'
  53.             );
  54.             JHtmlSidebar::addEntry(
  55.                 JText::_('COM_USERS_SUBMENU_LEVELS'),
  56.                 'index.php?option=com_users&view=levels',
  57.                 $vName == 'levels'
  58.             );
  59.             JHtmlSidebar::addEntry(
  60.                 JText::_('COM_USERS_SUBMENU_NOTES'),
  61.                 'index.php?option=com_users&view=notes',
  62.                 $vName == 'notes'
  63.             );
  64.  
  65.             $extension = JFactory::getApplication()->input->getString('extension');
  66.             JHtmlSidebar::addEntry(
  67.                 JText::_('COM_USERS_SUBMENU_NOTE_CATEGORIES'),
  68.                 'index.php?option=com_categories&extension=com_users',
  69.                 $vName == 'categories' || $extension == 'com_users'
  70.             );
  71.         }
  72.     }
  73.  
  74.     /**
  75.      * Gets a list of the actions that can be performed.
  76.      *
  77.      * @return  JObject 
  78.      *
  79.      * @since   1.6
  80.      * @todo    Refactor to work with notes
  81.      */
  82.     public static function getActions()
  83.     {
  84.         if (empty(self::$actions))
  85.         {
  86.             $user = JFactory::getUser();
  87.             self::$actions = new JObject;
  88.  
  89.             $actions = JAccess::getActions('com_users');
  90.  
  91.             foreach ($actions as $action)
  92.             {
  93.                 self::$actions->set($action->name, $user->authorise($action->name, 'com_users'));
  94.             }
  95.         }
  96.  
  97.         return self::$actions;
  98.     }
  99.  
  100.     /**
  101.      * Get a list of filter options for the blocked state of a user.
  102.      *
  103.      * @return  array  An array of JHtmlOption elements.
  104.      *
  105.      * @since   1.6
  106.      */
  107.     public static function getStateOptions()
  108.     {
  109.         // Build the filter options.
  110.         $options = array();
  111.         $options[] = JHtml::_('select.option', '0', JText::_('JENABLED'));
  112.         $options[] = JHtml::_('select.option', '1', JText::_('JDISABLED'));
  113.  
  114.         return $options;
  115.     }
  116.  
  117.     /**
  118.      * Get a list of filter options for the activated state of a user.
  119.      *
  120.      * @return  array  An array of JHtmlOption elements.
  121.      *
  122.      * @since   1.6
  123.      */
  124.     public static function getActiveOptions()
  125.     {
  126.         // Build the filter options.
  127.         $options = array();
  128.         $options[] = JHtml::_('select.option', '0', JText::_('COM_USERS_ACTIVATED'));
  129.         $options[] = JHtml::_('select.option', '1', JText::_('COM_USERS_UNACTIVATED'));
  130.  
  131.         return $options;
  132.     }
  133.  
  134.     /**
  135.      * Get a list of the user groups for filtering.
  136.      *
  137.      * @return  array  An array of JHtmlOption elements.
  138.      *
  139.      * @since   1.6
  140.      */
  141.     public static function getGroups()
  142.     {
  143.         $db = JFactory::getDbo();
  144.         $query = $db->getQuery(true)
  145.             ->select('a.id AS value')
  146.             ->select('a.title AS text')
  147.             ->select('COUNT(DISTINCT b.id) AS level')
  148.             ->from('#__usergroups as a')
  149.             ->join('LEFT', '#__usergroups  AS b ON a.lft > b.lft AND a.rgt < b.rgt')
  150.             ->group('a.id, a.title, a.lft, a.rgt')
  151.             ->order('a.lft ASC');
  152.         $db->setQuery($query);
  153.  
  154.         try
  155.         {
  156.             $options = $db->loadObjectList();
  157.         }
  158.         catch (RuntimeException $e)
  159.         {
  160.             JError::raiseNotice(500, $e->getMessage());
  161.             return null;
  162.         }
  163.  
  164.         foreach ($options as &$option)
  165.         {
  166.             $option->text = str_repeat('- ', $option->level).$option->text;
  167.         }
  168.  
  169.         return $options;
  170.     }
  171.  
  172.     /**
  173.      * Creates a list of range options used in filter select list
  174.      * used in com_users on users view
  175.      *
  176.      * @return  array 
  177.      *
  178.      * @since   2.5
  179.      */
  180.     public static function getRangeOptions()
  181.     {
  182.         $options = array(
  183.             JHtml::_('select.option', 'today', JText::_('COM_USERS_OPTION_RANGE_TODAY')),
  184.             JHtml::_('select.option', 'past_week', JText::_('COM_USERS_OPTION_RANGE_PAST_WEEK')),
  185.             JHtml::_('select.option', 'past_1month', JText::_('COM_USERS_OPTION_RANGE_PAST_1MONTH')),
  186.             JHtml::_('select.option', 'past_3month', JText::_('COM_USERS_OPTION_RANGE_PAST_3MONTH')),
  187.             JHtml::_('select.option', 'past_6month', JText::_('COM_USERS_OPTION_RANGE_PAST_6MONTH')),
  188.             JHtml::_('select.option', 'past_year', JText::_('COM_USERS_OPTION_RANGE_PAST_YEAR')),
  189.             JHtml::_('select.option', 'post_year', JText::_('COM_USERS_OPTION_RANGE_POST_YEAR')),
  190.         );
  191.         return $options;
  192.     }
  193.  
  194.     /**
  195.      * Creates a list of two factor authentication methods used in com_users
  196.      * on user view
  197.      *
  198.      * @return  array 
  199.      *
  200.      * @since   3.2.0
  201.      */
  202.     public static function getTwoFactorMethods()
  203.     {
  204.         // Load the Joomla! RAD layer
  205.         if (!defined('FOF_INCLUDED'))
  206.         {
  207.             include_once JPATH_LIBRARIES . '/fof/include.php';
  208.         }
  209.  
  210.         FOFPlatform::getInstance()->importPlugin('twofactorauth');
  211.         $identities = FOFPlatform::getInstance()->runPlugins('onUserTwofactorIdentify', array());
  212.  
  213.         $options = array(
  214.             JHtml::_('select.option', 'none', JText::_('COM_USERS_OPTION_OTPMETHOD_NONE'), 'value', 'text'),
  215.         );
  216.  
  217.         if (!empty($identities))
  218.         {
  219.             foreach ($identities as $identity)
  220.             {
  221.                 if (!is_object($identity))
  222.                 {
  223.                     continue;
  224.                 }
  225.  
  226.                 $options[] = JHtml::_('select.option', $identity->method, $identity->title, 'value', 'text');
  227.             }
  228.         }
  229.  
  230.         return $options;
  231.     }
  232. }

Documentation generated on Tue, 19 Nov 2013 15:16:38 +0100 by phpDocumentor 1.4.3