Joomla! API

下载
启动

Grid

用于创建 HTML 网格的实用程序类

抽象
自版本

1.5
包

Joomla CMS

方法

_checkedOut

用于在网格中创建带可选 overlib 的签出图标的方法。

_checkedOut( &row,  overlib = true) :
静态
自版本

1.5

参数

row

object行对象

overlib

bool如果应创建带有签出信息的 overlib，则为 True。

返回值

string图标和 overlib 的 HTMl

checkall

用于检查网格中所有复选框的方法

checkall( name = 'checkall-toggle',  action = 'Joomla.checkAll(this)') :
静态
自版本

3.1.2

参数

name

string表单元素的名称

action

string单击复选框时要执行的操作

返回值

字符串

checkedOut

显示签出图标。

checkedOut( &row,  i,  identifier = 'id') :
静态
自版本

1.5

参数

row

object数据对象（必须包含 checked out 作为属性）。

i

int行的索引。

identifier

string主键的属性名称或行的索引。

返回值

字符串

id

用于为网格行创建复选框的方法。

id( rowNum,  recId,  checkedOut = false,  name = 'cid',  stub = 'cb',  title = '',  formId = null) :
静态
自版本

1.5

参数

rowNum

int行索引

recId

int记录 ID

checkedOut

bool如果项目已签出，则为 True

name

string表单元素的名称

stub

string存根标识符的名称

title

string项目的名称

formId

string可选的表单选择器。

返回值

mixed如果项目未签出，则为包含复选框的 html 字符串，如果已签出，则为 null。

order

用于创建在网格中保存新排序的图标的方法

order(mixed||string|int rows,  image = 'filesave.png',  task = 'saveorder') :
静态
自版本

1.5

参数

rows

array<string|int, mixed>行数组

image

string图像 [未使用]

task

string要使用的任务，默认为保存排序

返回值

字符串

published

用于创建可点击图标以更改项目状态的方法

published( value,  i,  img1 = 'tick.png',  img0 = 'publish_x.png',  prefix = '') :
静态
自版本

1.5

参数

value

mixed标量值或对象（为了向后兼容，已弃用）

i

int索引

img1

string正值或开启值的图像

img0

string空值或关闭值的图像

prefix

string任务的可选前缀

返回值

字符串

sort

用于对网格中的列进行排序的方法

sort( title,  order,  direction = 'asc',  selected = '',  task = null,  newDirection = 'asc',  tip = '',  form = null) :
静态
自版本

1.5

参数

title

string链接标题

order

string列的排序字段

direction

string当前方向

selected

string选定的排序

task

string可选的任务覆盖

newDirection

string新列的可选方向

tip

string作为工具提示标题显示的可选文本，而不是 $title

form

string可选的表单选择器

返回值

字符串

state

用于创建状态选择列表以进行过滤的方法 默认情况下，过滤器仅显示已发布和未发布的项目

state( filterState = '*',  published = 'JPUBLISHED',  unpublished = 'JUNPUBLISHED',  archived = null,  trashed = null) :
静态
自版本

1.5

参数

filterState

string初始过滤器状态

published

string已发布的文本字符串

unpublished

string未发布的文本字符串

archived

string">已归档的文本字符串

trashed

string">已删除的文本字符串

返回值

字符串

  • \ Joomla
  • \ CMS
  • \ HTML
  • \ Helpers
  • \ Grid