Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe JHtmlJGrid

Fonctions membres publiques statiques

static action ($i, $task, $prefix='', $text='', $active_title='', $inactive_title='', $tip=false, $active_class='', $inactive_class='', $enabled=true, $translate=true, $checkbox='cb')
 
static state ($states, $value, $i, $prefix='', $enabled=true, $translate=true, $checkbox='cb')
 
static published ($value, $i, $prefix='', $enabled=true, $checkbox='cb', $publish_up=null, $publish_down=null)
 
static isdefault ($value, $i, $prefix='', $enabled=true, $checkbox='cb')
 
static publishedOptions ($config=array())
 
static checkedout ($i, $editorName, $time, $prefix='', $enabled=false, $checkbox='cb')
 
static orderUp ($i, $task='orderup', $prefix='', $text='JLIB_HTML_MOVE_UP', $enabled=true, $checkbox='cb')
 
static orderDown ($i, $task='orderdown', $prefix='', $text='JLIB_HTML_MOVE_DOWN', $enabled=true, $checkbox='cb')
 

Description détaillée

Utility class for creating HTML Grids

Depuis
1.6

Documentation des fonctions membres

◆ action()

static action (   $i,
  $task,
  $prefix = '',
  $text = '',
  $active_title = '',
  $inactive_title = '',
  $tip = false,
  $active_class = '',
  $inactive_class = '',
  $enabled = true,
  $translate = true,
  $checkbox = 'cb' 
)
static

Returns an action on a grid

Paramètres
integer$iThe row index
string$taskThe task to fire
string | array$prefixAn optional task prefix or an array of options
string$textAn optional text to display [unused -
Obsolète:
4.0]
Paramètres
string$active_titleAn optional active tooltip to display if $enable is true
string$inactive_titleAn optional inactive tooltip to display if $enable is true
boolean$tipAn optional setting for tooltip
string$active_classAn optional active HTML class
string$inactive_classAn optional inactive HTML class
boolean$enabledAn optional setting for access control on the action.
boolean$translateAn optional setting for translation.
string$checkboxAn optional prefix for checkboxes.
Renvoie
string The HTML markup
Depuis
1.6

Références $enabled, $html, $i, $options, $prefix, $task, et $title.

◆ checkedout()

static checkedout (   $i,
  $editorName,
  $time,
  $prefix = '',
  $enabled = false,
  $checkbox = 'cb' 
)
static

Returns a checked-out icon

Paramètres
integer$iThe row index.
string$editorNameThe name of the editor.
string$timeThe time that the object was checked out.
string | array$prefixAn optional task prefix or an array of options
boolean$enabledTrue to enable the action.
string$checkboxAn optional prefix for checkboxes.
Renvoie
string The HTML markup
Depuis
1.6

◆ isdefault()

static isdefault (   $value,
  $i,
  $prefix = '',
  $enabled = true,
  $checkbox = 'cb' 
)
static

Returns an isDefault state on a grid

Paramètres
integer$valueThe state value.
integer$iThe row index
string | array$prefixAn optional task prefix or an array of options
boolean$enabledAn optional setting for access control on the action.
string$checkboxAn optional prefix for checkboxes.
Renvoie
string The HTML markup
Voir également
JHtmlJGrid::state()
Depuis
1.6

◆ orderDown()

static orderDown (   $i,
  $task = 'orderdown',
  $prefix = '',
  $text = 'JLIB_HTML_MOVE_DOWN',
  $enabled = true,
  $checkbox = 'cb' 
)
static

Creates an order-down action icon.

Paramètres
integer$iThe row index.
string$taskAn optional task to fire.
string | array$prefixAn optional task prefix or an array of options
string$textAn optional text to display
boolean$enabledAn optional setting for access control on the action.
string$checkboxAn optional prefix for checkboxes.
Renvoie
string The HTML markup
Depuis
1.6

◆ orderUp()

static orderUp (   $i,
  $task = 'orderup',
  $prefix = '',
  $text = 'JLIB_HTML_MOVE_UP',
  $enabled = true,
  $checkbox = 'cb' 
)
static

Creates an order-up action icon.

Paramètres
integer$iThe row index.
string$taskAn optional task to fire.
string | array$prefixAn optional task prefix or an array of options
string$textAn optional text to display
boolean$enabledAn optional setting for access control on the action.
string$checkboxAn optional prefix for checkboxes.
Renvoie
string The HTML markup
Depuis
1.6

◆ published()

static published (   $value,
  $i,
  $prefix = '',
  $enabled = true,
  $checkbox = 'cb',
  $publish_up = null,
  $publish_down = null 
)
static

Returns a published state on a grid

Paramètres
integer$valueThe state value.
integer$iThe row index
string | array$prefixAn optional task prefix or an array of options
boolean$enabledAn optional setting for access control on the action.
string$checkboxAn optional prefix for checkboxes.
string$publish_upAn optional start publishing date.
string$publish_downAn optional finish publishing date.
Renvoie
string The HTML markup
Voir également
JHtmlJGrid::state()
Depuis
1.6

◆ publishedOptions()

static publishedOptions (   $config = array())
static

Returns an array of standard published state filter options.

Paramètres
array$configAn 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.
Renvoie
string The HTML markup
Depuis
1.6

◆ state()

static state (   $states,
  $value,
  $i,
  $prefix = '',
  $enabled = true,
  $translate = true,
  $checkbox = 'cb' 
)
static

Returns a state on a grid

Paramètres
array$statesarray 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)
integer$valueThe state value.
integer$iThe row index
string | array$prefixAn optional task prefix or an array of options
boolean$enabledAn optional setting for access control on the action.
boolean$translateAn optional setting for translation.
string$checkboxAn optional prefix for checkboxes.
Renvoie
string The HTML markup
Depuis
1.6

La documentation de cette classe a été générée à partir du fichier suivant :