public static
string
|
#
action( integer $i, string $task, string|array $prefix = '', string $text = '', string $active_title = '', string $inactive_title = '', boolean $tip = false, string $active_class = '', string $inactive_class = '', boolean $enabled = true, boolean $translate = true, string $checkbox = 'cb' )
Returns an action on a grid
Returns an action on a grid
Parameters
- $i
integer - $i The row index- $task
string - $task The task to fire- $prefix
string|array - $prefix An optional task prefix or an array of options- $text
string - $text An optional text to display [unused - @deprecated 4.0]- $active_title
string - $active_title An optional active tooltip to display if $enable is true- $inactive_title
string - $inactive_title An optional inactive tooltip to display if $enable is true- $tip
boolean - $tip An optional setting for tooltip- $active_class
string - $active_class An optional active HTML class- $inactive_class
string - $inactive_class An optional inactive HTML class- $enabled
boolean - $enabled An optional setting for access control on the action.- $translate
boolean - $translate An optional setting for translation.- $checkbox
string - $checkbox An optional prefix for checkboxes. Returns
string - The HTML markup
Since
1.6
|
public static
string
|
#
state( array $states, integer $value, integer $i, string|array $prefix = '', boolean $enabled = true, boolean $translate = true, string $checkbox = 'cb' )
Returns a state on a grid
Returns a state on a grid
Parameters
- $states
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)- $value
integer - $value The state value.- $i
integer - $i The row index- $prefix
string|array - $prefix An optional task prefix or an array of options- $enabled
boolean - $enabled An optional setting for access control on the action.- $translate
boolean - $translate An optional setting for translation.- $checkbox
string - $checkbox An optional prefix for checkboxes. Returns
string - The HTML markup
Since
1.6
|
public static
string
|
#
published( integer $value, integer $i, string|array $prefix = '', boolean $enabled = true, string $checkbox = 'cb', string $publish_up = null, string $publish_down = null )
Returns a published state on a grid
Returns a published state on a grid
Parameters
- $value
integer - $value The state value.- $i
integer - $i The row index- $prefix
string|array - $prefix An optional task prefix or an array of options- $enabled
boolean - $enabled An optional setting for access control on the action.- $checkbox
string - $checkbox An optional prefix for checkboxes.- $publish_up
string - $publish_up An optional start publishing date.- $publish_down
string - $publish_down An optional finish publishing date. Returns
string - The HTML markup
Since
1.6
See
|
public static
string
|
#
isdefault( integer $value, integer $i, string|array $prefix = '', boolean $enabled = true, string $checkbox = 'cb' )
Returns an isDefault state on a grid
Returns an isDefault state on a grid
Parameters
- $value
integer - $value The state value.- $i
integer - $i The row index- $prefix
string|array - $prefix An optional task prefix or an array of options- $enabled
boolean - $enabled An optional setting for access control on the action.- $checkbox
string - $checkbox An optional prefix for checkboxes. Returns
string - The HTML markup
Since
1.6
See
|
public static
string
|
#
publishedOptions( array $config = array() )
Returns an array of standard published state filter options.
Returns an array of standard published state filter options.
Parameters
- $config
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. Returns
string - The HTML markup
Since
1.6
|
public static
string
|
#
checkedout( integer $i, string $editorName, string $time, string|array $prefix = '', boolean $enabled = false, string $checkbox = 'cb' )
Returns a checked-out icon
Returns a checked-out icon
Parameters
- $i
integer - $i The row index.- $editorName
string - $editorName The name of the editor.- $time
string - $time The time that the object was checked out.- $prefix
string|array - $prefix An optional task prefix or an array of options- $enabled
boolean - $enabled True to enable the action.- $checkbox
string - $checkbox An optional prefix for checkboxes. Returns
string - The HTML markup
Since
1.6
|
public static
string
|
#
orderUp( integer $i, string $task = 'orderup', string|array $prefix = '', string $text = 'JLIB_HTML_MOVE_UP', boolean $enabled = true, string $checkbox = 'cb' )
Creates an order-up action icon.
Creates an order-up action icon.
Parameters
- $i
integer - $i The row index.- $task
string - $task An optional task to fire.- $prefix
string|array - $prefix An optional task prefix or an array of options- $text
string - $text An optional text to display- $enabled
boolean - $enabled An optional setting for access control on the action.- $checkbox
string - $checkbox An optional prefix for checkboxes. Returns
string - The HTML markup
Since
1.6
|
public static
string
|
#
orderDown( integer $i, string $task = 'orderdown', string|array $prefix = '', string $text = 'JLIB_HTML_MOVE_DOWN', boolean $enabled = true, string $checkbox = 'cb' )
Creates an order-down action icon.
Creates an order-down action icon.
Parameters
- $i
integer - $i The row index.- $task
string - $task An optional task to fire.- $prefix
string|array - $prefix An optional task prefix or an array of options- $text
string - $text An optional text to display- $enabled
boolean - $enabled An optional setting for access control on the action.- $checkbox
string - $checkbox An optional prefix for checkboxes. Returns
string - The HTML markup
Since
1.6
|
