[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/HTML/Helpers/ -> Grid.php (summary)

Joomla! Content Management System

Copyright: (C) 2011 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 270 lines (10 kb)
Included or required:0 times
Referenced: 2 times
Includes or requires: 0 files

Defines 8 functions

  sort()
  checkall()
  id()
  checkedOut()
  published()
  state()
  order()
  _checkedOut()

Functions
Functions that are not part of a class:

sort($title, $order, $direction = 'asc', $selected = '', $task = null, $newDirection = 'asc', $tip = '', $form = null)   X-Ref
Method to sort a column in a grid

param: string  $title         The link title
param: string  $order         The order field for the column
param: string  $direction     The current direction
param: string  $selected      The selected ordering
param: string  $task          An optional task override
param: string  $newDirection  An optional direction for the new column
param: string  $tip           An optional text shown as tooltip title instead of $title
param: string  $form          An optional form selector
return: string

checkall($name = 'checkall-toggle', $action = 'Joomla.checkAll(this)   X-Ref
Method to check all checkboxes in a grid

param: string  $name    The name of the form element
param: string  $action  The action to perform on clicking the checkbox
return: string

id($rowNum, $recId, $checkedOut = false, $name = 'cid', $stub = 'cb', $title = '', $formId = null)   X-Ref
Method to create a checkbox for a grid row.

param: integer  $rowNum      The row index
param: integer  $recId       The record id
param: boolean  $checkedOut  True if item is checked out
param: string   $name        The name of the form element
param: string   $stub        The name of stub identifier
param: string   $title       The name of the item
param: string   $formId      An optional form selector.
return: mixed    String of html with a checkbox if item is not checked out, null if checked out.

checkedOut(&$row, $i, $identifier = 'id')   X-Ref
Displays a checked out icon.

param: object   $row         A data object (must contain checked out as a property).
param: integer  $i           The index of the row.
param: string   $identifier  The property name of the primary key or index of the row.
return: string

published($value, $i, $img1 = 'tick.png', $img0 = 'publish_x.png', $prefix = '')   X-Ref
Method to create a clickable icon to change the state of an item

param: mixed    $value   Either the scalar value or an object (for backward compatibility, deprecated)
param: integer  $i       The index
param: string   $img1    Image for a positive or on value
param: string   $img0    Image for the empty or off value
param: string   $prefix  An optional prefix for the task
return: string

state($filterState = '*', $published = 'JPUBLISHED', $unpublished = 'JUNPUBLISHED', $archived = null, $trashed = null)   X-Ref
Method to create a select list of states for filtering
By default the filter shows only published and unpublished items

param: string  $filterState  The initial filter state
param: string  $published    The Text string for published
param: string  $unpublished  The Text string for Unpublished
param: string  $archived     The Text string for Archived
param: string  $trashed      The Text string for Trashed
return: string

order($rows, $image = 'filesave.png', $task = 'saveorder')   X-Ref
Method to create an icon for saving a new ordering in a grid

param: array   $rows   The array of rows of rows
param: string  $image  The image [UNUSED]
param: string  $task   The task to use, defaults to save order
return: string

_checkedOut(&$row, $overlib = true)   X-Ref
Method to create a checked out icon with optional overlib in a grid.

param: object   $row      The row object
param: boolean  $overlib  True if an overlib with checkout information should be created.
return: string   HTMl for the icon and overlib



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer