File cms/html/formbehavior.php | Joomla! Framework TM

  1 <?php
  2 /**
  3  * @package     Joomla.Libraries
  4  * @subpackage  HTML
  5  *
  6  * @copyright   Copyright (C) 2005 - 2017 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_PLATFORM') or die;
 11 
 12 use Joomla\Registry\Registry;
 13 
 14 /**
 15  * Utility class for form related behaviors
 16  *
 17  * @since  3.0
 18  */
 19 abstract class JHtmlFormbehavior
 20 {
 21     /**
 22      * @var    array  Array containing information for loaded files
 23      * @since  3.0
 24      */
 25     protected static $loaded = array();
 26 
 27     /**
 28      * Method to load the Chosen JavaScript framework and supporting CSS into the document head
 29      *
 30      * If debugging mode is on an uncompressed version of Chosen is included for easier debugging.
 31      *
 32      * @param   string  $selector  Class for Chosen elements.
 33      * @param   mixed   $debug     Is debugging mode on? [optional]
 34      * @param   array   $options   the possible Chosen options as name => value [optional]
 35      *
 36      * @return  void
 37      *
 38      * @since   3.0
 39      */
 40     public static function chosen($selector = '.advancedSelect', $debug = null, $options = array())
 41     {
 42         if (isset(static::$loaded[__METHOD__][$selector]))
 43         {
 44             return;
 45         }
 46 
 47         // If no debugging value is set, use the configuration setting
 48         if ($debug === null)
 49         {
 50             $debug = JDEBUG;
 51         }
 52 
 53         // Default settings
 54         if (!isset($options['disable_search_threshold']))
 55         {
 56             $options['disable_search_threshold'] = 10;
 57         }
 58 
 59         // Allow searching contains space in query
 60         if (!isset($options['search_contains']))
 61         {
 62             $options['search_contains'] = true;
 63         }
 64 
 65         if (!isset($options['allow_single_deselect']))
 66         {
 67             $options['allow_single_deselect'] = true;
 68         }
 69 
 70         if (!isset($options['placeholder_text_multiple']))
 71         {
 72             $options['placeholder_text_multiple'] = JText::_('JGLOBAL_TYPE_OR_SELECT_SOME_OPTIONS');
 73         }
 74 
 75         if (!isset($options['placeholder_text_single']))
 76         {
 77             $options['placeholder_text_single'] = JText::_('JGLOBAL_SELECT_AN_OPTION');
 78         }
 79 
 80         if (!isset($options['no_results_text']))
 81         {
 82             $options['no_results_text'] = JText::_('JGLOBAL_SELECT_NO_RESULTS_MATCH');
 83         }
 84 
 85         $displayData = array(
 86             'debug'     => $debug,
 87             'options'  => $options,
 88             'selector' => $selector,
 89         );
 90 
 91         JLayoutHelper::render('joomla.html.formbehavior.chosen', $displayData);
 92 
 93         static::$loaded[__METHOD__][$selector] = true;
 94 
 95         return;
 96     }
 97 
 98     /**
 99      * Method to load the AJAX Chosen library
100      *
101      * If debugging mode is on an uncompressed version of AJAX Chosen is included for easier debugging.
102      *
103      * @param   Registry  $options  Options in a Registry object
104      * @param   mixed     $debug    Is debugging mode on? [optional]
105      *
106      * @return  void
107      *
108      * @since   3.0
109      */
110     public static function ajaxchosen(Registry $options, $debug = null)
111     {
112         // Retrieve options/defaults
113         $selector       = $options->get('selector', '.tagfield');
114         $type           = $options->get('type', 'GET');
115         $url            = $options->get('url', null);
116         $dataType       = $options->get('dataType', 'json');
117         $jsonTermKey    = $options->get('jsonTermKey', 'term');
118         $afterTypeDelay = $options->get('afterTypeDelay', '500');
119         $minTermLength  = $options->get('minTermLength', '3');
120 
121         // Ajax URL is mandatory
122         if (!empty($url))
123         {
124             if (isset(static::$loaded[__METHOD__][$selector]))
125             {
126                 return;
127             }
128 
129             // Requires chosen to work
130             static::chosen($selector, $debug);
131 
132             $displayData = array(
133                 'url'            => $url,
134                 'debug'          => $debug,
135                 'options'        => $options,
136                 'selector'       => $selector,
137                 'type'           => $type,
138                 'dataType'       => $dataType,
139                 'jsonTermKey'    => $jsonTermKey,
140                 'afterTypeDelay' => $afterTypeDelay,
141                 'minTermLength'  => $minTermLength,
142             );
143 
144             JLayoutHelper::render('joomla.html.formbehavior.ajaxchosen', $displayData);
145 
146             static::$loaded[__METHOD__][$selector] = true;
147         }
148 
149         return;
150     }
151 }
152
Namespaces

Classes

Interfaces

Exceptions

Constants

Functions
