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

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

 isNoCheckbox ($tree_item)
 
 isNoOtherColumns ($tree_item)
 
 isNoDraggable ($tree_item)
 
 isNoRedMarker ($tree_item)
 
 isDisabledCheckbox ($tree_item)
 
 getCallbackResult ($callback_name, $tree_item)
 
 setCallbacks (array $callback_list)
 
 setChecked (array $fliped_keys)
 
 isChecked ($id)
 
 getCheckboxName ()
 
 setCheckboxName ($name)
 
 setTools (TableType\Actions $tools)
 
 getTools ($row=null)
 
 setMainColumn (TableType\AbstractType $main_column)
 
 setOtherColumns (array $columns)
 
 setHeadButtons (array $head_buttons)
 
 getMainColumn ($row=null)
 
 getOtherColumns ($row=null)
 
 getHeadButtons ()
 
 setData (AbstractTreeListIterator $data)
 
 getData ($with_root=true)
 
 setPathToFirst (array $path_to_first)
 
 getPathToFirst ()
 
 setRootItem (array $element)
 
 getView ($local_options=null)
 
 setDisabledField ($field)
 
 setDisabledValue ($value)
 
 setClassField ($field)
 
 setSortIdField ($field)
 
 setSortUrl ($url)
 
 setActiveField ($field)
 
 setActiveValue ($field)
 
 setSortable ($bool)
 
 setInlineButtons (array $buttons)
 
 setUnselectedTitle ($title)
 
 getPathView ()
 
 setMaxLevels ($number)
 
- Открытые члены унаследованные от AbstractHtml
 __construct (array $options=[])
 
 setOptions (array $options)
 
 setOption ($key, $value)
 
 getOption ($key, $default=null)
 
- Открытые члены унаследованные от ElementInterface
 getView ()
 

Поля данных

const VIEWTYPE_BIGTREE = 'bigtree'
 
const VIEWTYPE_INLINE = 'inline'
 
const VALID_CALLBACKS
 
- Поля данных унаследованные от AbstractHtml
 $options = []
 
 $option_prefixes = ['set', 'add']
 

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

 getCellValue ($row, $field)
 

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

 $checked = []
 
 $checkbox_name = 'chk[]'
 
 $tools
 
 $main_column
 
 $other_columns
 
 $head_buttons
 
 $path_to_first = []
 
 $data
 
 $callbacks = []
 
- Защищенные данные унаследованные от AbstractHtml
 $url
 

Методы

getCallbackResult (   $callback_name,
  $tree_item 
)

Возвращает результат выполнения указанного callback-а если указанный callback не установлен - возвращает значение свойства элемента с таким же именем

Аргументы
string$callback_name- имя callback-а
array | object$tree_item- элемент для которого вызывается callback
Возвращает
mixed
getCellValue (   $row,
  $field 
)
protected

Возвращает значение для отображение в ячейке

Аргументы
mixed$row- ORM объект или ассоциативный массив для одной строки данных
string$field- поле, которое необходимо вывести
Возвращает
mixed
getCheckboxName ( )

Возвращает имя переменной для checkbox'ов

Возвращает
string
getData (   $with_root = true)
getHeadButtons ( )

Возвращает кнопки, находящиеся над деревом объектов

Возвращает
array
getMainColumn (   $row = null)

Возвращает главную ячейку для конкретной строки

Аргументы
mixed$row- ORM объект или ассоциативный массив с данными
Возвращает
TableType
getOtherColumns (   $row = null)

Возвращает ячейки, которые выводятся справа от основного элемента для одной строки данных

Аргументы
mixed$row- ORM объект или ассоциативный массив с данными
Возвращает
array
getPathToFirst ( )

Возвращает путь к корневому элементу

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

Возвращает HTML цепочки до текущей папки

Возвращает
string
Исключения
\SmartyException
getTools (   $row = null)

Возвращает набор инструментов для конкретной строки элемента

Аргументы
mixed$row
Возвращает
TableType
getView (   $local_options = null)

Возвращает HTML древовидного списка

Аргументы
array$local_options- дополнительные настройки отображения
Возвращает
string
Исключения
\SmartyException
isChecked (   $id)

Возвращает true, если елемент с заданным id выделен

Аргументы
mixed$id
Возвращает
bool
isDisabledCheckbox (   $tree_item)

Возвращает блокировать ли checkbox у элемента

Аргументы
array | object$tree_item- элемент для которого вызывается callback
Возвращает
bool
isNoCheckbox (   $tree_item)

Возвращает скрывать ли checkbox у элемента

Аргументы
array | object$tree_item- элемент для которого вызывается callback
Возвращает
bool
isNoDraggable (   $tree_item)

Возвращает запрещать ли перемещать элемент

Аргументы
array | object$tree_item- элемент для которого вызывается callback
Возвращает
bool
isNoOtherColumns (   $tree_item)

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

Аргументы
array | object$tree_item- элемент для которого вызывается callback
Возвращает
bool
isNoRedMarker (   $tree_item)

Возвращает скрывать ли красную полоску справа (видна при выделении элемента)

Аргументы
array | object$tree_item- элемент для которого вызывается callback
Возвращает
bool
setActiveField (   $field)

Устанавливает поле, значение в котором система будет сравнивать с activeValue. Если значение совпадет, то строка с данными будет выделена, как текущая

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

Устанавливает значение текущего выделенного элемента.

Аргументы
string$field- имя поля
Возвращает
Element
setCallbacks ( array  $callback_list)

Устанавливает список callback-ов

Аргументы
array$callback_list
setCheckboxName (   $name)

Устанавливает имя переменной для checkbox'ов

Аргументы
mixed$name
Возвращает
Element
setChecked ( array  $fliped_keys)

Задает массив выделенных элементов. id Выделенных элементов должны быть в ключах массива

Аргументы
array$fliped_keys
Возвращает
Element
setClassField (   $field)

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

Аргументы
string$field- имя поля
Возвращает
Element
setData ( AbstractTreeListIterator  $data)
setDisabledField (   $field)

Устанавливает поле, в котором содержится информация об активности строки(неактивная строка - бледная)

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

Устанавливает значение, которое если содержится в поле disabledField, то означает, что строка - неактивная

Аргументы
mixed$value
Возвращает
Element
setHeadButtons ( array  $head_buttons)

Устанавливает кнопки, которые выводятся над деревом

Аргументы
array$head_buttons
Возвращает
Element
setInlineButtons ( array  $buttons)

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

setMainColumn ( TableType\AbstractType  $main_column)

Устанавливает главную ячейку с данными

Аргументы
TableType\AbstractType$main_column
Возвращает
Element
setMaxLevels (   $number)

Устанавливает максимальный уровень допустимой вложенности

Аргументы
$number
Возвращает
void
setOtherColumns ( array  $columns)

Устанавливает ячейки, которые выводятся справа от основного элемента

Аргументы
TableType\AbstractType[]$columns
Возвращает
Element
setPathToFirst ( array  $path_to_first)

Устанавливает путь от текущего элемента к корню дерева

Аргументы
array$path_to_first- массив элементов начиная с поседнего листа заканчивая корнем дерева.
Возвращает
Element
setRootItem ( array  $element)

Устанавливает корневой элемент, если таковой существует

Аргументы
array$elementэлемент
Возвращает
void
setSortable (   $bool)

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

Аргументы
bool$bool- если true, то сортировка будет присутствовать в дереве элементов
Возвращает
Element
setSortIdField (   $field)

Устанавливает поле, значение из которого необходимо передавать контроллеру при сортировке элементов

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

Устанавливает url для сортировки элементов

Аргументы
string$url
Возвращает
Element
setTools ( TableType\Actions  $tools)

Устанавливает набор инструментов, выводимых в каждой строке элемента

Аргументы
TableType\Actions$tools
Возвращает
Element
setUnselectedTitle (   $title)

Устанавливает текст, который будет отображаться в сокращенном виде, если не выбран ни один элемент

Аргументы
string$title- текст

Поля

$callbacks = []
protected
$checkbox_name = 'chk[]'
protected
$checked = []
protected
$data
protected
$head_buttons
protected
$main_column
protected
$other_columns
protected
$path_to_first = []
protected
$tools
protected
const VALID_CALLBACKS
Инициализатор
= [
'noCheckbox',
'noOtherColumns',
'noDraggable',
'noRedMarker',
'disabledCheckbox',
]
const VIEWTYPE_BIGTREE = 'bigtree'
const VIEWTYPE_INLINE = 'inline'