SearchTools

Searchtools elements.

abstract
since

3.2

package

Application

Methods

form

Load searchtools for a specific form

form(mixed selector = '.js-stools-form', array options = array()) : void
static
since

3.2

Arguments

selector

mixedIs debugging mode on? [optional]

options

arrayOptional array of parameters for search tools

optionsToRegistry

Function to receive & pre-process javascript options

optionsToRegistry(mixed options) : \Joomla\Registry\Registry
static

Arguments

options

mixedAssociative array/Registry object with options

Response

\Joomla\Registry\RegistryOptions converted to Registry object

sort

Method to sort a column in a grid

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

Arguments

title

stringThe link title

order

stringThe order field for the column

direction

stringThe current direction

selected

mixedThe selected ordering

task

stringAn optional task override

newDirection

stringAn optional direction for the new column

tip

stringAn optional text shown as tooltip title instead of $title

icon

stringIcon to show

formName

stringName of the form to submit

Response

string

Properties

loaded

Array containing information for loaded files

static
since

3.2

Type(s)

array