Deprecated method to change access level in a grid
static
string
access
(integer &$row, integer $i, [boolean $archived = null])
-
integer
&$row: Row id
-
integer
$i: Row index
-
boolean
$archived: True if the item is archived
Method to build the behavior script and add it to the document head.
static
void
behavior
()
Display a boolean setting widget.
static
string
boolean
(integer $i, integer $value, [string $taskOn = null], [string $taskOff = null])
-
integer
$i: The row index.
-
integer
$value: The value of the boolean field.
-
string
$taskOn: Task to turn the boolean setting on.
-
string
$taskOff: Task to turn the boolean setting off.
Displays a checked out icon.
static
string
checkedOut
(object &$row, integer $i, [string $identifier = 'id'])
-
object
&$row: A data object (must contain checkedout as a property).
-
integer
$i: The index of the row.
-
string
$identifier: The property name of the primary key or index of the row.
Method to create a checkbox for a grid row.
static
mixed
id
(integer $rowNum, integer $recId, [boolean $checkedOut = false], [string $name = 'cid'])
-
integer
$rowNum: The row index
-
integer
$recId: The record id
-
boolean
$checkedOut: True if item is checke out
-
string
$name: The name of the form element
Method to create an icon for saving a new ordering in a grid
static
string
order
(array $rows, [string $image = 'filesave.png'], [string $task = 'saveorder'])
-
array
$rows: The array of rows of rows
-
string
$image: The image
-
string
$task: The task to use, defaults to save order
Method to create a clickable icon to change the state of an item
static
string
published
(mixed $value, integer $i, [string $img1 = 'tick.png'], [string $img0 = 'publish_x.png'], [string $prefix = ''])
-
mixed
$value: Either the scalar value or an object (for backward compatibility, deprecated)
-
integer
$i: The index
-
string
$img1: Image for a positive or on value
-
string
$img0: Image for the empty or off value
-
string
$prefix: An optional prefix for the task
Method to sort a column in a grid
static
string
sort
(string $title, string $order, [string $direction = 'asc'], [string $selected = 0], [string $task = null], [string $new_direction = 'asc'])
-
string
$title: The link title
-
string
$order: The order field for the column
-
string
$direction: The current direction
-
string
$selected: The selected ordering
-
string
$task: An optional task override
-
string
$new_direction: An optional direction for the new column
Method to create a select list of states for filtering By default the filter shows only published and unpublished items
static
string
state
([string $filter_state = '*'], [string $published = 'Published'], [string $unpublished = 'Unpublished'], [string $archived = null], [string $trashed = null])
-
string
$filter_state: The initial filter state
-
string
$published: The JText string for published
-
string
$unpublished: The JText string for Unpublished
-
string
$archived: The JText string for Archived
-
string
$trashed: The JText string for Trashed
Method to create a checked out icon with optional overlib in a grid.
static
string
_checkedOut
(object &$row, [boolean $overlib = 1])
-
object
&$row: The row object
-
boolean
$overlib: True if an overlib with checkout information should be created.