SearchTools
Searchtools elements.
abstract
| since |
3.2 |
|---|---|
| package |
Joomla CMS |
Methods
form
Load searchtools for a specific form
form( selector = '.js-stools-form', mixed||string|int options = []) :
static
| since |
3.2 |
|---|
Arguments
- selector
mixedIs debugging mode on? [optional]- options
array<string|int, mixed>Optional array of parameters for search tools
Response
void
optionsToRegistry
Function to receive & pre-process javascript options
optionsToRegistry( options) : \Joomla\Registry\Registry
static
Arguments
- options
mixedAssociative array/Registry object with options
Response
RegistryOptions converted to Registry object
sort
Method to sort a column in a grid
sort( title, order, direction = 'asc', selected, task = null, newDirection = 'asc', tip = '', icon = null, formName = 'adminForm') :
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<string|int, mixed>