JHtmlList
Utility class for creating different select lists
since |
1.5 |
---|---|
package |
Joomla.Libraries |
Methods
genericordering
Returns an array of options
genericordering(string $query, integer $chop = 30) : array
since |
1.5 |
---|
Arguments
- $query
string
SQL with 'ordering' AS value and 'name field' AS text- $chop
integer
The length of the truncated headline
Response
array
An 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
since |
1.5 |
---|
Arguments
- $name
string
The name of the field- $active
string
The selected item- $javascript
string
Alternative javascript- $directory
string
Directory the images are stored in- $extensions
string
Allowed extensions
Response
array
Image 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
since |
1.6 |
---|
Arguments
- $name
integer
The scalar value- $query
string
The query- $attribs
string
HTML tag attributes- $selected
string
The selected item- $neworder
integer
1 if new and first, -1 if new and last, 0 or null if existing item
Response
string
HTML 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
since |
1.5 |
---|
Arguments
- $name
string
Name of the field- $active
string
The active value- $javascript
string
Alternative javascript- $none
boolean
Null if not assigned- $center
boolean
Null if not assigned- $left
boolean
Null if not assigned- $right
boolean
Null if not assigned- $id
boolean
Null if not assigned
Response
array
The positions
users
Select list of active users
users(string $name, string $active, integer $nouser, string $javascript = null, string $order = 'name') : string
since |
1.5 |
---|
Arguments
- $name
string
The name of the field- $active
string
The active user- $nouser
integer
If set include an option to select no user- $javascript
string
Custom javascript- $order
string
Specify a field to order by
Response
string
The HTML for a list of users list of users