Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class SearchTools - list of methods

Searchtools elements.
Package: Joomla\CMS\HTML\Helpers
Copyright: (C) 2013 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/HTML/Helpers/SearchTools.php
Project: Joomla

Method Summary

public static void
(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
Show source code of this method: form Source Code

private static \Joomla\Registry\Registry
(mixed $options)

Function to receive & pre-process javascript options
Parameters
  • mixed $options Associative array/Registry object with options
Returns
  • \Joomla\Registry\Registry Options converted to Registry object
Show source code of this method: optionsToRegistry Source Code

public static string
(mixed $title, mixed $order, mixed $direction = 'asc', mixed $selected = 0, mixed $task = null, mixed $newDirection = 'asc', mixed $tip = '', mixed $icon = null, mixed $formName = 'adminForm')

Method to sort a column in a grid
Parameters
  • string $title The link title
  • string $order The order field for the column
  • string $direction The current direction
  • mixed $selected The selected ordering
  • string $task An optional task override
  • string $newDirection An optional direction for the new column
  • string $tip An optional text shown as tooltip title instead of $title
  • string $icon Icon to show
  • string $formName Name of the form to submit
Returns
  • string
Show source code of this method: sort Source Code

Properties Summary

protected static array
$loaded
Since
  • 3.2

Tags Summary

Since
3.2