Версия: 6.x
burger close
Класс Element
Граф наследования:Element:
AbstractHtml ElementInterface

Открытые члены

 __construct (array $options, $data=null)
 
 setColumns (array $columns)
 
 addColumn (Type\AbstractType $column, $pos=null)
 
 getColumns ($apply_custom_order=true)
 
 getColumn ($n)
 
 setRowAttrParam ($field)
 
 getCustomizableColumns ()
 
 setTableAttr (array $attr)
 
 getTableAttr ()
 
 setRowAttr ($n, array $attr)
 
 getRowAttr ($n)
 
 setAnyRowAttr ($n, array $attr)
 
 getAnyRowAttr ($n)
 
 setColumnsOrder ($index_field)
 
 getColumnsOrder ()
 
 setSortColumn ($column, $direction)
 
 getSortColumn ()
 
 setData ($data)
 
 getData ()
 
 loadFromArray ($data)
 
 setAfterLoadDataCallback ($callable)
 
 insertAnyRow (array $columns, $numrow=null)
 
 getOptions ($key=null, $default=null)
 
 getAnyRows ($n=null)
 
 getRows ()
 
 getView ()
 
 removeColumn ($n)
 
- Открытые члены унаследованные от AbstractHtml
 __construct (array $options=[])
 
 setOptions (array $options)
 
 setOption ($key, $value)
 
 getOption ($key, $default=null)
 

Поля данных

 $table_attr
 
- Поля данных унаследованные от AbstractHtml
 $options = []
 
 $option_prefixes = ['set', 'add']
 

Защищенные члены

 applyCustomOrder ($columns)
 

Защищенные данные

 $data
 
- Защищенные данные унаследованные от AbstractHtml
 $url
 

Конструктор(ы)

__construct ( array  $options,
  $data = null 
)

Методы

addColumn ( Type\AbstractType  $column,
  $pos = null 
)

Добавляет колонку в отображение таблицы

Аргументы
Type\AbstractType$column
integer$pos- порядковый номер колонки слева направо. Допустимо отрицательное число, тогда справа налево.
Возвращает
Element
applyCustomOrder (   $columns)
protected

Применяет произвольную сортировку колонок к списку колонок

Аргументы
array$columnsмассив с колонками в оригинальном порядке
Возвращает
mixed
getAnyRowAttr (   $n)

Возвращает аттрибуты для вставленных вручную строк

Аргументы
integer$n- номер строки
Возвращает
string
getAnyRows (   $n = null)

Возвращает произвольные строки

Аргументы
integer$n- номер строки
Возвращает
array | false
getColumn (   $n)

Возвращает одну колонку

Аргументы
integer$nномер колонки
Возвращает
Type
getColumns (   $apply_custom_order = true)

Возвращает список колонок таблицы

Аргументы
bool$apply_custom_orderЕсли true, то порядок колонок будет модифицирован
Возвращает
Type[]
getColumnsOrder ( )

Возвращает произвольный порядок колонок, если таковой установлен

Возвращает
array
getCustomizableColumns ( )

Возвращает список колонок, которые пользователь может включить/отключить

Возвращает
array
getData ( )

Возвращает установленный ранее набор данных

Возвращает
array
getOptions (   $key = null,
  $default = null 
)

Возвращает значение опции key

Аргументы
string$key
mixed$default
Возвращает
mixed
getRowAttr (   $n)

Возвращает аттрибуты для строки

Аргументы
integer$n- номер строки
Возвращает
string
getRows ( )

Возвращает строки, подготовленные для отображения таблицы

Возвращает
array
getSortColumn ( )

Возвращает объект колонки, по которой установлена сортировка или null

Возвращает
Type|null
getTableAttr ( )

Возвращает аттрибуты элемента таблицы

Возвращает
string
getView ( )

Возвращает HTML для текущей таблицы

Возвращает
string

Замещает ElementInterface.

insertAnyRow ( array  $columns,
  $numrow = null 
)

Вставляет произвольную строку в таблицу

Возвращает
Element
loadFromArray (   $data)

Загружает сведения из набора данных

Аргументы
array$data
Возвращает
void
removeColumn (   $n)

Удаляет колонку из списка

Аргументы
integer$nномер колонки
Возвращает
Element
setAfterLoadDataCallback (   $callable)

Устанавливает callback, который будет вызван после загрузки данных

Аргументы
$callable
Возвращает
void
setAnyRowAttr (   $n,
array  $attr 
)

Устанавливает аттрибуты для вставленных вручную строк

Аргументы
integer$n- номер строки
array$attr
setColumns ( array  $columns)

Устанавливает колонки, которые должны присутствовать в таблице

Аргументы
arrayof Type $columns
Возвращает
Element
setColumnsOrder (   $index_field)

Устанавливает произольный порядок колонок в таблице

Аргументы
array$index_fieldМассив, состоящий из нового порядкоого номера колонки в ключе и оригинального порядкового номера колонки в значении.

Пример: [4, 5, 6]. Означает, что колонки 4,5,6 будут идти вначале таблицы.

setData (   $data)

Устанавливает набор данных для таблицы

Аргументы
array$data
Возвращает
Element
setRowAttr (   $n,
array  $attr 
)

Устанавливает аттрибуты для элемента строки таблицы

Аргументы
integer$n- номер строки, начиная с нуля.
array$attr- аттрибуты
Возвращает
Element
setRowAttrParam (   $field)

Устанавливает ключ в наборе данных, в котором ожидать параметры для строки таблицы

Аргументы
string$field- имя поля
Возвращает
Element
setSortColumn (   $column,
  $direction 
)

Устанавливает колонку, по которой сортируются строки

Аргументы
mixed$columnномер колонки
stringASC|DESC $direction направление сортировки
setTableAttr ( array  $attr)

Устанавливает аттрибуты для Dom элемента таблицы

Аргументы
array$attr
Возвращает
Element

Поля

$data
protected
$table_attr
Инициализатор
= ['class' => 'rs-table'],
$row_attr_param,
$tr_param = [],
$columns = [],
$columns_order = [],
$rows = [],
$anyrows = [],
$any_row_attr = [],
$row_attr = [],
$after_load_data_callback