PHP Класс Ublaboo\DataGrid\Column\Column

Наследование: extends Ublaboo\DataGrid\Object
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$align string
$default_hide boolean
$editable_callback callable
$editable_element array
$el_cache array Cached html elements
$header_escaping boolean
$renderer Renderer | null
$replacements array
$sort array
$sortable boolean | string
$sortable_callback null | callable
$sortable_reset_pagination boolean
$template string
$template_escaping boolean
$template_variables array

Открытые методы

Метод Описание
addAttributes ( array $attrs ) : static Set attributes for both th and td element
applyReplacements ( Row $row ) : array Apply replacements
getAlign ( ) : string Get column alignment
getColumn ( ) : string
getColumnName ( ) : string Get column name
getColumnValue ( Row $row ) : mixed Get column value of row item
getDefaultHide ( )
getEditableCallback ( ) : callable Return callback that is used after inline editing
getEditableInputType ( ) : array [getEditableInputType description]
getElementPrototype ( string $tag, string $key = NULL, Row $row = NULL ) : Nette\Utils\Html Get th/td column element
getName ( ) : string
getRenderer ( ) : Renderer | null Return custom renderer callback
getSortNext ( ) : array What sorting will be applied after next click?
getSortableCallback ( ) : callable | null Get custom ORDER BY clause
getSortingColumn ( ) : string Get column to sort by
getTemplate ( ) : string Get column template path
getTemplateVariables ( ) : array Column can have variables that will be passed to custom template scope
hasAlign ( ) : boolean Has column some alignment?
hasReplacements ( ) : boolean Tell whether columns has replacements
hasSortNext ( ) : boolean
hasTemplate ( ) : boolean Tell whether column has its owntemplate
isEditable ( ) : boolean Is column editable?
isHeaderEscaped ( )
isSortAsc ( ) : boolean Is sorting ascending?
isSortable ( ) : boolean Tell whether column is sortable
isSortedBy ( ) : boolean Tell whether data source is sorted by this collumn
isTemplateEscaped ( )
render ( Row $row ) : mixed Render row item into template
setAlign ( string $align ) Set column alignment
setDefaultHide ( boolean $default_hide = TRUE ) : static
setEditableCallback ( callable $editable_callback ) Set callback that will be called after inline editing
setEditableInputType ( string $el_type, array $attrs = [] ) : static Element is by default textarea, user can change that
setEditableInputTypeSelect ( array $options = [] ) : static Change small inline edit input type to select
setFitContent ( boolean $fit_content = TRUE ) Set column content fit
setHeaderEscaping ( boolean $header_escaping = FALSE ) Should be column header escaped in latte?
setRenderer ( callable $renderer, $condition_callback = NULL ) Set renderer callback and (it may be optional - the condition callback will decide)
setRendererOnCondition ( callable $renderer, $condition_callback ) Set renderer callback just if condition is truthy
setReplacement ( array $replacements ) : Column Set column replacements
setSort ( array $sort ) Tell column his sorting options
setSortable ( boolean | string $sortable = TRUE ) Set column sortable or not
setSortableCallback ( callable $sortable_callback ) : static Set custom ORDER BY clause
setSortableResetPagination ( boolean $sortable_reset_pagination = TRUE ) : static Shoud be the pagination reseted after sorting?
setTemplate ( string $template, array $template_variables = [] ) Column may have its own template
setTemplateEscaping ( boolean $template_escaping = TRUE ) Should be column values escaped in latte?
sortableResetPagination ( ) : boolean Do reset pagination after sorting?
useRenderer ( Row $row ) : mixed Try to render item with custom renderer

Защищенные методы

Метод Описание
getItemParams ( Row $row, array $params_list ) : array Get row item params (E.g. action may be called id => $item->id, name => $item->name, .

Описание методов

addAttributes() публичный Метод

Set attributes for both th and td element
public addAttributes ( array $attrs ) : static
$attrs array
Результат static

applyReplacements() публичный Метод

Apply replacements
public applyReplacements ( Row $row ) : array
$row Ublaboo\DataGrid\Row
Результат array

getAlign() публичный Метод

Get column alignment
public getAlign ( ) : string
Результат string

getColumn() публичный Метод

public getColumn ( ) : string
Результат string

getColumnName() публичный Метод

Get column name
public getColumnName ( ) : string
Результат string

getColumnValue() публичный Метод

Get column value of row item
public getColumnValue ( Row $row ) : mixed
$row Ublaboo\DataGrid\Row
Результат mixed

getDefaultHide() публичный Метод

public getDefaultHide ( )

getEditableCallback() публичный Метод

Return callback that is used after inline editing
public getEditableCallback ( ) : callable
Результат callable

getEditableInputType() публичный Метод

[getEditableInputType description]
public getEditableInputType ( ) : array
Результат array

getElementPrototype() публичный Метод

Get th/td column element
public getElementPrototype ( string $tag, string $key = NULL, Row $row = NULL ) : Nette\Utils\Html
$tag string th|td
$key string
$row Ublaboo\DataGrid\Row
Результат Nette\Utils\Html

getItemParams() защищенный Метод

..)
protected getItemParams ( Row $row, array $params_list ) : array
$row Ublaboo\DataGrid\Row
$params_list array
Результат array

getName() публичный Метод

public getName ( ) : string
Результат string

getRenderer() публичный Метод

Return custom renderer callback
public getRenderer ( ) : Renderer | null
Результат Renderer | null

getSortNext() публичный Метод

What sorting will be applied after next click?
public getSortNext ( ) : array
Результат array

getSortableCallback() публичный Метод

Get custom ORDER BY clause
public getSortableCallback ( ) : callable | null
Результат callable | null

getSortingColumn() публичный Метод

Get column to sort by
public getSortingColumn ( ) : string
Результат string

getTemplate() публичный Метод

Get column template path
public getTemplate ( ) : string
Результат string

getTemplateVariables() публичный Метод

Column can have variables that will be passed to custom template scope
public getTemplateVariables ( ) : array
Результат array

hasAlign() публичный Метод

Has column some alignment?
public hasAlign ( ) : boolean
Результат boolean [description]

hasReplacements() публичный Метод

Tell whether columns has replacements
public hasReplacements ( ) : boolean
Результат boolean

hasSortNext() публичный Метод

public hasSortNext ( ) : boolean
Результат boolean

hasTemplate() публичный Метод

Tell whether column has its owntemplate
public hasTemplate ( ) : boolean
Результат boolean

isEditable() публичный Метод

Is column editable?
public isEditable ( ) : boolean
Результат boolean

isHeaderEscaped() публичный Метод

public isHeaderEscaped ( )

isSortAsc() публичный Метод

Is sorting ascending?
public isSortAsc ( ) : boolean
Результат boolean

isSortable() публичный Метод

Tell whether column is sortable
public isSortable ( ) : boolean
Результат boolean

isSortedBy() публичный Метод

Tell whether data source is sorted by this collumn
public isSortedBy ( ) : boolean
Результат boolean

isTemplateEscaped() публичный Метод

public isTemplateEscaped ( )

render() публичный Метод

Render row item into template
public render ( Row $row ) : mixed
$row Ublaboo\DataGrid\Row
Результат mixed

setAlign() публичный Метод

Set column alignment
public setAlign ( string $align )
$align string

setDefaultHide() публичный Метод

public setDefaultHide ( boolean $default_hide = TRUE ) : static
$default_hide boolean
Результат static

setEditableCallback() публичный Метод

Set callback that will be called after inline editing
public setEditableCallback ( callable $editable_callback )
$editable_callback callable

setEditableInputType() публичный Метод

Element is by default textarea, user can change that
public setEditableInputType ( string $el_type, array $attrs = [] ) : static
$el_type string
$attrs array
Результат static

setEditableInputTypeSelect() публичный Метод

Change small inline edit input type to select
public setEditableInputTypeSelect ( array $options = [] ) : static
$options array
Результат static

setFitContent() публичный Метод

Set column content fit
public setFitContent ( boolean $fit_content = TRUE )
$fit_content boolean

setHeaderEscaping() публичный Метод

Should be column header escaped in latte?
public setHeaderEscaping ( boolean $header_escaping = FALSE )
$header_escaping boolean

setRenderer() публичный Метод

Set renderer callback and (it may be optional - the condition callback will decide)
public setRenderer ( callable $renderer, $condition_callback = NULL )
$renderer callable

setRendererOnCondition() публичный Метод

Set renderer callback just if condition is truthy
public setRendererOnCondition ( callable $renderer, $condition_callback )
$renderer callable

setReplacement() публичный Метод

Set column replacements
public setReplacement ( array $replacements ) : Column
$replacements array
Результат Column

setSort() публичный Метод

Tell column his sorting options
public setSort ( array $sort )
$sort array

setSortable() публичный Метод

Set column sortable or not
public setSortable ( boolean | string $sortable = TRUE )
$sortable boolean | string

setSortableCallback() публичный Метод

Set custom ORDER BY clause
public setSortableCallback ( callable $sortable_callback ) : static
$sortable_callback callable
Результат static

setSortableResetPagination() публичный Метод

Shoud be the pagination reseted after sorting?
public setSortableResetPagination ( boolean $sortable_reset_pagination = TRUE ) : static
$sortable_reset_pagination boolean
Результат static

setTemplate() публичный Метод

Column may have its own template
public setTemplate ( string $template, array $template_variables = [] )
$template string
$template_variables array

setTemplateEscaping() публичный Метод

Should be column values escaped in latte?
public setTemplateEscaping ( boolean $template_escaping = TRUE )
$template_escaping boolean

sortableResetPagination() публичный Метод

Do reset pagination after sorting?
public sortableResetPagination ( ) : boolean
Результат boolean

useRenderer() публичный Метод

Try to render item with custom renderer
public useRenderer ( Row $row ) : mixed
$row Ublaboo\DataGrid\Row
Результат mixed

Описание свойств

$align защищенное свойство

protected string $align
Результат string

$default_hide защищенное свойство

protected bool $default_hide
Результат boolean

$editable_callback защищенное свойство

protected callable $editable_callback
Результат callable

$editable_element защищенное свойство

protected array $editable_element
Результат array

$el_cache защищенное свойство

Cached html elements
protected array $el_cache
Результат array

$header_escaping защищенное свойство

protected bool $header_escaping
Результат boolean

$renderer защищенное свойство

protected Renderer,Ublaboo\DataGrid\Column|NULL $renderer
Результат Renderer | null

$replacements защищенное свойство

protected array $replacements
Результат array

$sort защищенное свойство

protected array $sort
Результат array

$sortable защищенное свойство

protected bool|string $sortable
Результат boolean | string

$sortable_callback защищенное свойство

protected null|callable $sortable_callback
Результат null | callable

$sortable_reset_pagination защищенное свойство

protected bool $sortable_reset_pagination
Результат boolean

$template защищенное свойство

protected string $template
Результат string

$template_escaping защищенное свойство

protected bool $template_escaping
Результат boolean

$template_variables защищенное свойство

protected array $template_variables
Результат array