Référence de la classe ListHelper

Fonctions membres publiques statiques
static	images ($name, $active=null, $javascript=null, $directory=null, $extensions='bmp|gif|jpg|png')
static	genericordering ($query, $chop=30)
static	ordering ($name, $query, $attribs=null, $selected=null, $neworder=null, ?string $id=null)
static	users ($name, $active, $nouser=0, $javascript=null, $order='name')
static	positions ( $name, $active=null, $javascript=null, $none=true, $center=true, $left=true, $right=true, $id=false)

Description détaillée

Utility class for creating different select lists

Depuis

1.5

Documentation des fonctions membres

genericordering()

static genericordering (   $query,   $chop = 30  )

static

Returns an array of options

Paramètres

DatabaseQuery | string	$query	SQL with 'ordering' AS value and 'name field' AS text
integer	$chop	The length of the truncated headline

Renvoie

array An array of objects formatted for JHtml list processing

Depuis

1.5

Références $db, $i, $items, $n, $options, $query, $text, Text\_(), HTMLHelper\_(), Factory\getDbo(), text, et value.

images()

static images (   $name,   $active = null,   $javascript = null,   $directory = null,   $extensions = 'bmp|gif|jpg|png'  )

static

Build the select list to choose an image

Paramètres

string	$name	The name of the field
string	$active	The selected item
string	$javascript	Alternative javascript
string	$directory	Directory the images are stored in
string	$extensions	Allowed extensions

Renvoie

array Image names

Depuis

1.5

Références $active, $images, $name, Text\_(), HTMLHelper\_(), et JPATH_SITE.

ordering()

static ordering (   $name,   $query,   $attribs = null,   $selected = null,   $neworder = null, ?string  $id = null  )

static

Build the select list for Ordering derived from a query

Paramètres

integer	$name	The scalar value
string	$query	The query
string	$attribs	HTML tag attributes
string	$selected	The selected item
integer	$neworder	1 if new and first, -1 if new and last, 0 or null if existing item
string	$id	ID attribute for the resulting <select> element

Renvoie

string HTML markup for the select list

Depuis

1.6

Références $attribs, $html, $id, $name, $query, $selected, $text, Text\_(), HTMLHelper\_(), et elseif.

positions()

static positions (   $name,   $active = null,   $javascript = null,   $none = true,   $center = true,   $left = true,   $right = true,   $id = false  )

static

Select list of positions - generally used for location of images

Paramètres

string	$name	Name of the field
string	$active	The active value
string	$javascript	Alternative javascript
boolean	$none	Null if not assigned
boolean	$center	Null if not assigned
boolean	$left	Null if not assigned
boolean	$right	Null if not assigned
boolean	$id	Null if not assigned

Renvoie

array The positions

Depuis

1.5

Références $active, $id, $name, $positions, Text\_(), HTMLHelper\_(), et null.

users()

static users (   $name,   $active,   $nouser = 0,   $javascript = null,   $order = 'name'  )

static

Select list of active users

Paramètres

string	$name	The name of the field
string	$active	The active user
integer	$nouser	If set include an option to select no user
string	$javascript	Custom javascript
string	$order	Specify a field to order by

Renvoie

string The HTML for a list of users list of users

Depuis

1.5

Références $active, $db, $name, $query, Text\_(), HTMLHelper\_(), et Factory\getDbo().

---

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

• ListHelper.php