Back to SearchTools class

Method form

public static void
form
(mixed $selector = '.js-stools-form', mixed $options = array())
Load searchtools for a specific form
Parameters
  • mixed $selector Is debugging mode on? [optional]
  • array $options Optional array of parameters for search tools
Returns
  • void
Since
  • 3.2
Class: SearchTools
Project: Joomla

Method form - Source code

/**
 * Load searchtools for a specific form
 *
 * @param   mixed  $selector  Is debugging mode on? [optional]
 * @param   array  $options   Optional array of parameters for search tools
 *
 * @return  void
 *
 * @since   3.2
 */
public static function form($selector = '.js-stools-form', $options = array())
{
    $sig = md5(serialize(array($selector, $options)));
    // Only load once
    if (!isset(static::$loaded[__METHOD__][$sig])) {
        // Add the form selector to the search tools options
        $options['formSelector'] = $selector;
        // Generate options with default values
        $options = static::optionsToRegistry($options);
        // Load the script && css files
        Factory::getApplication()->getDocument()->getWebAssetManager()->useStyle('searchtools')->useScript('searchtools');
        Factory::getDocument()->addScriptOptions('searchtools', $options);
        static::$loaded[__METHOD__][$sig] = true;
    }
}
OSZAR »