Référence de la classe Sidebar

Fonctions membres publiques statiques
static	render ()
static	addEntry ($name, $link='', $active=false)
static	getEntries ()
static	addFilter ($label, $name, $options, $noDefault=false)
static	getFilters ()
static	setAction ($action)
static	getAction ()

Attributs protégés statiques
static	$entries = array()
static	$filters = array()
static	$action = ''

Description détaillée

Utility class to render a list view sidebar

Depuis

3.0

Documentation des fonctions membres

addEntry()

static addEntry (   $name,   $link = '',   $active = false  )

static

Method to add a menu item to submenu.

Paramètres

string	$name	Name of the menu item.
string	$link	URL of the menu item.
bool	$active	True if the item is active, false otherwise.

Renvoie

void

Depuis

3.0

Références $active, $link, et $name.

addFilter()

static addFilter (   $label,   $name,   $options,   $noDefault = false  )

static

Method to add a filter to the submenu

Paramètres

string	$label	Label for the menu item.
string	$name	Name for the filter. Also used as id.
string	$options	Options for the select field.
bool	$noDefault	Don't show the label as the empty option

Renvoie

void

Depuis

3.0

Références $filters, $label, $name, et $options.

getAction()

static getAction ( )

static

Get value for the action attribute of the filter form

Renvoie

string

Depuis

3.0

getEntries()

static getEntries ( )

static

Returns an array of all submenu entries

Renvoie

array

Depuis

3.0

getFilters()

static getFilters ( )

static

Returns an array of all filters

Renvoie

array

Depuis

3.0

Références $filters.

render()

static render ( )

static

Render the sidebar.

Renvoie

string The necessary HTML to display the sidebar

Depuis

3.0

Références $data, $layout, et Factory\getApplication().

setAction()

static setAction (   $action )

static

Set value for the action attribute of the filter form

Paramètres

string

$action

Value for the action attribute of the form

Renvoie

void

Depuis

3.0

Documentation des champs

$action

$action = ''

staticprotected

$entries

$entries = array()

staticprotected

$filters

$filters = array()

staticprotected

---

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

• Sidebar.php