Fonctions membres publiques statiques
static	action ( $i, $task, $prefix='', $activeTitle='', $inactiveTitle='', $tip=false, $activeClass='', $inactiveClass='', $enabled=true, $translate=true, $checkbox='cb', $formId=null)

static	state ($states, $value, $i, $prefix='', $enabled=true, $translate=true, $checkbox='cb', $formId=null)

static	published ( $value, $i, $prefix='', $enabled=true, $checkbox='cb', $publishUp=null, $publishDown=null, $formId=null)

static	isdefault ($value, $i, $prefix='', $enabled=true, $checkbox='cb', $formId=null, $active_class='icon-color-featured icon-star', $inactive_class='icon-unfeatured')

static	publishedOptions ($config=array())

static	checkedout ($i, $editorName, $time, $prefix='', $enabled=false, $checkbox='cb', $formId=null)

static	orderUp ($i, $task='orderup', $prefix='', $text='JLIB_HTML_MOVE_UP', $enabled=true, $checkbox='cb', $formId=null)

static	orderDown ( $i, $task='orderdown', $prefix='', $text='JLIB_HTML_MOVE_DOWN', $enabled=true, $checkbox='cb', $formId=null)

Description détaillée

Utility class for creating HTML Grids

Depuis: 1.6

Documentation des fonctions membres

◆ action()

static action	(	$i,
		$task,
		$prefix = `''`,
		$activeTitle = `''`,
		$inactiveTitle = `''`,
		$tip = `false`,
		$activeClass = `''`,
		$inactiveClass = `''`,
		$enabled = `true`,
		$translate = `true`,
		$checkbox = `'cb'`,
		$formId = `null`
	)

static

Returns an action on a grid

Paramètres

integer	$i	The row index
string	$task	The task to fire
string \| array	$prefix	An optional task prefix or an array of options
string	$activeTitle	An optional active tooltip to display if $enable is true
string	$inactiveTitle	An optional inactive tooltip to display if $enable is true
boolean	$tip	An optional setting for tooltip
string	$activeClass	An optional active HTML class
string	$inactiveClass	An optional inactive HTML class
boolean	$enabled	An optional setting for access control on the action.
boolean	$translate	An optional setting for translation.
string	$checkbox	An optional prefix for checkboxes.
string	$formId	An optional form selector.

Renvoie: string The HTML markup

Depuis: 1.6

Références $enabled, $formId, $html, $i, $options, $prefix, $task, $title, Text\_(), et null.

◆ checkedout()

static checkedout	(	$i,
		$editorName,
		$time,
		$prefix = `''`,
		$enabled = `false`,
		$checkbox = `'cb'`,
		$formId = `null`
	)

static

Returns a checked-out icon

Paramètres

integer	$i	The row index.
string	$editorName	The name of the editor.
string	$time	The time that the object was checked out.
string \| array	$prefix	An optional task prefix or an array of options
boolean	$enabled	True to enable the action.
string	$checkbox	An optional prefix for checkboxes.
string	$formId	An optional form selector.

Renvoie: string The HTML markup

Depuis: 1.6

◆ isdefault()

static isdefault	(	$value,
		$i,
		$prefix = `''`,
		$enabled = `true`,
		$checkbox = `'cb'`,
		$formId = `null`,
		$active_class = `'icon-color-featured icon-star'`,
		$inactive_class = `'icon-unfeatured'`
	)

static

Returns an isDefault state on a grid

Paramètres

integer	$value	The state value.
integer	$i	The row index
string \| array	$prefix	An optional task prefix or an array of options
boolean	$enabled	An optional setting for access control on the action.
string	$checkbox	An optional prefix for checkboxes.
string	$formId	An optional form selector.
string	$active_class	The class for active items.
string	$inactive_class	The class for inactive items.

Renvoie: string The HTML markup

Voir également: JHtmlJGrid::state()

Depuis: 1.6

◆ orderDown()

static orderDown	(	$i,
		$task = `'orderdown'`,
		$prefix = `''`,
		$text = `'JLIB_HTML_MOVE_DOWN'`,
		$enabled = `true`,
		$checkbox = `'cb'`,
		$formId = `null`
	)

static

Creates an order-down action icon.

Paramètres

integer	$i	The row index.
string	$task	An optional task to fire.
string \| array	$prefix	An optional task prefix or an array of options
string	$text	An optional text to display
boolean	$enabled	An optional setting for access control on the action.
string	$checkbox	An optional prefix for checkboxes.
string	$formId	An optional form selector.

Renvoie: string The HTML markup

Depuis: 1.6

◆ orderUp()

static orderUp	(	$i,
		$task = `'orderup'`,
		$prefix = `''`,
		$text = `'JLIB_HTML_MOVE_UP'`,
		$enabled = `true`,
		$checkbox = `'cb'`,
		$formId = `null`
	)

static

Creates an order-up action icon.

Paramètres

integer	$i	The row index.
string	$task	An optional task to fire.
string \| array	$prefix	An optional task prefix or an array of options
string	$text	An optional text to display
boolean	$enabled	An optional setting for access control on the action.
string	$checkbox	An optional prefix for checkboxes.
string	$formId	An optional form selector.

Renvoie: string The HTML markup

Depuis: 1.6

◆ published()

static published	(	$value,
		$i,
		$prefix = `''`,
		$enabled = `true`,
		$checkbox = `'cb'`,
		$publishUp = `null`,
		$publishDown = `null`,
		$formId = `null`
	)

static

Returns a published state on a grid

Paramètres

integer	$value	The state value.
integer	$i	The row index
string \| array	$prefix	An optional task prefix or an array of options
boolean	$enabled	An optional setting for access control on the action.
string	$checkbox	An optional prefix for checkboxes.
string	$publishUp	An optional start publishing date.
string	$publishDown	An optional finish publishing date.
string	$formId	An optional form selector.

Renvoie: string The HTML markup

Voir également: JHtmlJGrid::state()

Depuis: 1.6

◆ publishedOptions()

static publishedOptions ( $config = array() )

static

Returns an array of standard published state filter options.

Paramètres

array $config An array of configuration options. This array can contain a list of key/value pairs where values are boolean and keys can be taken from 'published', 'unpublished', 'archived', 'trash', 'all'. These pairs determine which values are displayed.

Renvoie: array The array of standard published state filter options

Depuis: 1.6

◆ state()

static state	(	$states,
		$value,
		$i,
		$prefix = `''`,
		$enabled = `true`,
		$translate = `true`,
		$checkbox = `'cb'`,
		$formId = `null`
	)

static

Returns a state on a grid

Paramètres

array	$states	array of value/state. Each state is an array of the form (task, text, active title, inactive title, tip (boolean), HTML active class, HTML inactive class) or ('task'=>task, 'text'=>text, 'active_title'=>active title, 'inactive_title'=>inactive title, 'tip'=>boolean, 'active_class'=>html active class, 'inactive_class'=>html inactive class)
integer	$value	The state value.
integer	$i	The row index
string \| array	$prefix	An optional task prefix or an array of options
boolean	$enabled	An optional setting for access control on the action.
boolean	$translate	An optional setting for translation.
string	$checkbox	An optional prefix for checkboxes.
string	$formId	An optional form selector.

Renvoie: string The HTML markup

Depuis: 1.6

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

JGrid.php

Fonctions membres publiques statiques

Description détaillée

Documentation des fonctions membres

◆ action()

◆ checkedout()

◆ isdefault()

◆ orderDown()

◆ orderUp()

◆ published()

◆ publishedOptions()

◆ state()