Source for file usergrouplist.php

Documentation is available at usergrouplist.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Libraries
  4.  * @subpackage  Form
  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('JPATH_BASE') or die;
  11.  
  12. JFormHelper::loadFieldClass('list');
  13.  
  14. /**
  15.  * Field to load a list of available users statuses
  16.  *
  17.  * @package     Joomla.Libraries
  18.  * @subpackage  Form
  19.  * @since       3.2
  20.  */
  21. class JFormFieldUserGroupList extends JFormFieldList
  22. {
  23.     /**
  24.      * The form field type.
  25.      *
  26.      * @var        string 
  27.      * @since   3.2
  28.      */
  29.     protected $type = 'UserGroupList';
  30.  
  31.     /**
  32.      * Cached array of the category items.
  33.      *
  34.      * @var    array 
  35.      * @since  3.2
  36.      */
  37.     protected static $options = array();
  38.  
  39.     /**
  40.      * Method to get the options to populate list
  41.      *
  42.      * @return  array  The field option objects.
  43.      *
  44.      * @since   3.2
  45.      */
  46.     protected function getOptions()
  47.     {
  48.         // Hash for caching
  49.         $hash = md5($this->element);
  50.  
  51.         if (!isset(static::$options[$hash]))
  52.         {
  53.             static::$options[$hash] = parent::getOptions();
  54.  
  55.             $options = array();
  56.  
  57.             $db = JFactory::getDbo();
  58.             $query = $db->getQuery(true)
  59.                 ->select('a.id AS value')
  60.                 ->select('a.title AS text')
  61.                 ->select('COUNT(DISTINCT b.id) AS level')
  62.                 ->from('#__usergroups as a')
  63.                 ->join('LEFT', '#__usergroups  AS b ON a.lft > b.lft AND a.rgt < b.rgt')
  64.                 ->group('a.id, a.title, a.lft, a.rgt')
  65.                 ->order('a.lft ASC');
  66.             $db->setQuery($query);
  67.  
  68.             if ($options = $db->loadObjectList())
  69.             {
  70.                 foreach ($options as &$option)
  71.                 {
  72.                     $option->text = str_repeat('- ', $option->level) . $option->text;
  73.                 }
  74.  
  75.                 static::$options[$hash] = array_merge(static::$options[$hash], $options);
  76.             }
  77.         }
  78.  
  79.         return static::$options[$hash];
  80.     }
  81. }

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