Source for file limitbox.php

Documentation is available at limitbox.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
  8.  */
  9.  
  10. defined('JPATH_PLATFORM') or die;
  11.  
  12. JFormHelper::loadFieldClass('list');
  13.  
  14. /**
  15.  * Field to load a list of posible item count limits
  16.  *
  17.  * @package     Joomla.Libraries
  18.  * @subpackage  Form
  19.  * @since       3.2
  20.  */
  21. class JFormFieldLimitbox extends JFormFieldList
  22. {
  23.     /**
  24.      * The form field type.
  25.      *
  26.      * @var    string 
  27.      * @since  3.2
  28.      */
  29.     public $type = 'Limitbox';
  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.      * Default options
  41.      *
  42.      * @var  array 
  43.      */
  44.     protected $defaultLimits = array(5, 10, 15, 20, 25, 30, 50, 100);
  45.  
  46.     /**
  47.      * Method to get the options to populate to populate list
  48.      *
  49.      * @return  array  The field option objects.
  50.      *
  51.      * @since   3.2
  52.      */
  53.     protected function getOptions()
  54.     {
  55.         // Accepted modifiers
  56.         $hash = md5($this->element);
  57.  
  58.         if (!isset(static::$options[$hash]))
  59.         {
  60.             static::$options[$hash] = parent::getOptions();
  61.  
  62.             $options = array();
  63.             $limits = $this->defaultLimits;
  64.  
  65.             // Limits manually specified
  66.             if (isset($this->element['limits']))
  67.             {
  68.                 $limits = explode(',', $this->element['limits']);
  69.             }
  70.  
  71.             // User wants to add custom limits
  72.             if (isset($this->element['append']))
  73.             {
  74.                 $limits = array_unique(array_merge($limits, explode(',', $this->element['append'])));
  75.             }
  76.  
  77.             // User wants to remove some default limits
  78.             if (isset($this->element['remove']))
  79.             {
  80.                 $limits = array_diff($limits, explode(',', $this->element['remove']));
  81.             }
  82.  
  83.             // Order the options
  84.             asort($limits);
  85.  
  86.             // Add an option to show all?
  87.             $showAll = isset($this->element['showall']) ? ($this->element['showall'] == "true") : true;
  88.  
  89.             if ($showAll)
  90.             {
  91.                 $limits[] = 0;
  92.             }
  93.  
  94.             if (!empty($limits))
  95.             {
  96.                 foreach ($limits as $value)
  97.                 {
  98.                     $options[] = (object) array(
  99.                         'value' => $value,
  100.                         'text' => ($value != 0) ? JText::_('J' . $value) : JText::_('JALL')
  101.                     );
  102.                 }
  103.  
  104.                 static::$options[$hash] = array_merge(static::$options[$hash], $options);
  105.             }
  106.         }
  107.  
  108.         return static::$options[$hash];
  109.     }
  110. }

Documentation generated on Tue, 19 Nov 2013 15:07:05 +0100 by phpDocumentor 1.4.3