Référence de la classe SearchTools

Fonctions membres publiques statiques
static	form ($selector='.js-stools-form', $options=array())
static	sort ( $title, $order, $direction='asc', $selected=0, $task=null, $newDirection='asc', $tip='', $icon=null, $formName='adminForm')

Attributs protégés statiques
static	$loaded = array()

Fonctions membres privées statiques
static	optionsToRegistry ($options)

Description détaillée

Searchtools elements.

Depuis

3.2

Documentation des fonctions membres

form()

static form (   $selector = '.js-stools-form',   $options = array()  )

static

Load searchtools for a specific form

Paramètres

mixed	$selector	Is debugging mode on? [optional]
array	$options	Optional array of parameters for search tools

Renvoie

void

Depuis

3.2

Références $options, $selector, Factory\getApplication(), et Factory\getDocument().

optionsToRegistry()

static optionsToRegistry (   $options )

staticprivate

Function to receive & pre-process javascript options

Paramètres

mixed

$options

Associative array/Registry object with options

Renvoie

Registry Options converted to Registry object

Références $options.

sort()

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

static

Method to sort a column in a grid

Paramètres

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

Renvoie

string

Références $data, $direction, $icon, $selected, $task, $title, et LayoutHelper\render().

Documentation des champs

$loaded

$loaded = array()

staticprotected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• SearchTools.php