Joomla! API

Download
Launch

JHtmlList

Utility class for creating different select lists

abstract
since

1.5
package

Joomla.Libraries

Methods

genericordering

Returns an array of options

genericordering(string $query, integer $chop = 30) : array
static
since

1.5

Arguments

$query

stringSQL with 'ordering' AS value and 'name field' AS text

$chop

integerThe length of the truncated headline

Response

arrayAn array of objects formatted for JHtml list processing

images

Build the select list to choose an image

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

1.5

Arguments

$name

stringThe name of the field

$active

stringThe selected item

$javascript

stringAlternative javascript

$directory

stringDirectory the images are stored in

$extensions

stringAllowed extensions

Response

arrayImage names

ordering

Build the select list for Ordering derived from a query

ordering(integer $name, string $query, string $attribs = null, string $selected = null, integer $neworder = null) : string
static
since

1.6

Arguments

$name

integerThe scalar value

$query

stringThe query

$attribs

stringHTML tag attributes

$selected

stringThe selected item

$neworder

integer1 if new and first, -1 if new and last, 0 or null if existing item

Response

stringHTML markup for the select list

positions

Select list of positions - generally used for location of images

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

1.5

Arguments

$name

stringName of the field

$active

stringThe active value

$javascript

stringAlternative javascript

$none

booleanNull if not assigned

$center

booleanNull if not assigned

$left

booleanNull if not assigned

$right

booleanNull if not assigned

$id

booleanNull if not assigned

Response

arrayThe positions

users

Select list of active users

users(string $name, string $active, integer $nouser, string $javascript = null, string $order = 'name') : string
static
since

1.5

Arguments

$name

stringThe name of the field

$active

stringThe active user

$nouser

integerIf set include an option to select no user

$javascript

stringCustom javascript

$order

stringSpecify a field to order by

Response

stringThe HTML for a list of users list of users

  • \ \
  • \ JHtmlList