Docs For Class JHtmlList

Description

Utility class for creating different select lists

abstract:
since: 1.5

Located in /libraries/cms/html/list.php (line 19)

Method Summary

static array genericordering (string $query, [integer $chop = 30])

static array images (string $name, [string $active = null], [string $javascript = null], [string $directory = null], [string $extensions = "bmp|gif|jpg|png"])

static string ordering (integer $name, string $query, [string $attribs = null], [string $selected = null], [integer $neworder = null])

static array positions (string $name, [string $active = null], [string $javascript = null], [boolean $none = true], [boolean $center = true], [boolean $left = true], [boolean $right = true], [boolean $id = false])

static string users (string $name, string $active, [integer $nouser = 0], [string $javascript = null], [string $order = 'name'])

Methods

static genericordering (line 89)

Returns an array of options

return: An array of objects formatted for JHtml list processing
since: 1.5
access: public

static array genericordering (string $query, [integer $chop = 30])

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

static images (line 34)

Build the select list to choose an image

return: Image names
since: 1.5
access: public

static array images (string $name, [string $active = null], [string $javascript = null], [string $directory = null], [string $extensions = "bmp|gif|jpg|png"])

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

static ordering (line 140)

Build the select list for Ordering derived from a query

return: HTML markup for the select list
since: 1.6
access: public

static string ordering (integer $name, string $query, [string $attribs = null], [string $selected = null], [integer $neworder = null])

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

static positions (line 233)

Select list of positions - generally used for location of images

return: The positions
since: 1.5
access: public

static array positions (string $name, [string $active = null], [string $javascript = null], [boolean $none = true], [boolean $center = true], [boolean $left = true], [boolean $right = true], [boolean $id = false])

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

static users (line 182)

Select list of active users

return: The HTML for a list of users list of users
since: 1.5
access: public

static string users (string $name, string $active, [integer $nouser = 0], [string $javascript = null], [string $order = 'name'])

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