class Column extends Column

Properties

public $label Column label. from Column
public $desc Column description. from Column
public $raw Should we excape the value of the column? from Column
public $listable Should we show the column in the table? from Column
public $editable Should we show the column in the edit form? from Column
public $disabled Can we edit the value in the form? from Column
public $searchable Should we use this column for searching? from Column
public $sortable Can we sort the table by this column? from Column
public $limit Max length of value to be shown in the table. from Column
public $input Input type for the column editation. from Column
public $listformat fromat for listing from Column
public $getformat format for editing from Column
public $setformat format for updating from Column
public $validate validation callback from Column
public $default columns default value from Column

Public Methods

final
__call(string $name, array $arguments)

No description

from Child
final
void
_setKey(string $key)

No description

from Child
final
string
_getKey()

No description

from Child
final
void
_setNext(string|null $key)

No description

from Child
final
string|null
_getNext()

No description

from Child
final
void
_setPrev(string|null $key)

No description

from Child
final
string|null
_getPrev()

No description

from Child
final
void
_setParent(Chainset $obj)

No description

from Child
final
_getParent()

No description

from Child
final
before(string|null $target = null)

Place child just before $target.

from Child
final
after(string|null $target = null)

Place child just after $target.

from Child
final
string
getName()

Get internal name of the column.

from Column
final
string|null
getValue(array $row, $forEditing = false)

Extract value of the column from $row array

from Column
final
evalProperty(string $prop, array $row = [])

Eval property

from Column
raw()

Output raw value (i.e. HTML)

from Column
default($value)

Set default value

from Column
escaped()

Output escaped value.

from Column
nonlistable()

Do not show the column in the table.

from Column
listable()

Show the column in the table.

from Column
nonsearchable()

Do not use the column for searching.

from Column
searchable()

Use the column for searching.

from Column
nonsortable()

Do not sort by the column.

from Column
sortable()

Use the column for sorting.

from Column
noneditable()

Hide the column in the edit form.

from Column
editable()

Show the column in the edit form.

from Column
disabled()

Disable editing column's value.

from Column
enabled()

Enable editing column's value.

from Column
limit(integer $len)

Max length of value to be shown in the table.

from Column
input($type)

Set the type of input.

from Column
password()

Set the type of input to password Add nonlistable flag

from Column
textarea()

Set the type of input to textarea.

from Column
select($options = [])

Set the type of input to select.

from Column
hidden()

Shortcut for nonlistable && noneditable && disabled

from Column
list($func)

Format for listing

from Column
get($func)

Format for editing

from Column
set($func)

Format user input for updating the entry

from Column
validate($func)

Validate user input

from Column
datetime($format, $allowNull = false)

No description

Protected Methods

Private Methods

Details

in Child at line 28
final __call(string $name, array $arguments)

Parameters

string $name
array $arguments

in Child at line 33
final void _setKey(string $key)

Parameters

string $key

Return Value

void

in Child at line 37
final string _getKey()

Return Value

string

in Child at line 41
final void _setNext(string|null $key)

Parameters

string|null $key

Return Value

void

in Child at line 45
final string|null _getNext()

Return Value

string|null

in Child at line 49
final void _setPrev(string|null $key)

Parameters

string|null $key

Return Value

void

in Child at line 53
final string|null _getPrev()

Return Value

string|null

in Child at line 57
final void _setParent(Chainset $obj)

Parameters

Chainset $obj

Return Value

void

in Child at line 61
final Chainset _getParent()

Return Value

Chainset

in Child at line 68
final Child before(string|null $target = null)

Place child just before $target.

Parameters

string|null $target

Return Value

Child

in Child at line 94
final Child after(string|null $target = null)

Place child just after $target.

Parameters

string|null $target

Return Value

Child

in Column at line 86
final string getName()

Get internal name of the column.

Return Value

string

in Column at line 93
final string|null getValue(array $row, $forEditing = false)

Extract value of the column from $row array

Parameters

array $row
$forEditing

Return Value

string|null

in Column at line 109
final evalProperty(string $prop, array $row = [])

Eval property

Parameters

string $prop
array $row

in Column at line 125
raw()

Output raw value (i.e. HTML)

in Column at line 133
default($value)

Set default value

Parameters

$value

in Column at line 141
escaped()

Output escaped value.

in Column at line 149
nonlistable()

Do not show the column in the table.

in Column at line 157
listable()

Show the column in the table.

in Column at line 165
nonsearchable()

Do not use the column for searching.

in Column at line 173
searchable()

Use the column for searching.

in Column at line 181
nonsortable()

Do not sort by the column.

in Column at line 189
sortable()

Use the column for sorting.

in Column at line 197
noneditable()

Hide the column in the edit form.

in Column at line 205
editable()

Show the column in the edit form.

in Column at line 213
disabled()

Disable editing column's value.

in Column at line 221
enabled()

Enable editing column's value.

in Column at line 230
limit(integer $len)

Max length of value to be shown in the table.

Doesn't have any effect on raw (unescaped) columns.

Parameters

integer $len

in Column at line 238
input($type)

Set the type of input.

Parameters

$type

in Column at line 247
password()

Set the type of input to password Add nonlistable flag

in Column at line 256
textarea()

Set the type of input to textarea.

in Column at line 264
select($options = [])

Set the type of input to select.

Parameters

$options

in Column at line 273
hidden()

Shortcut for nonlistable && noneditable && disabled

in Column at line 283
list($func)

Format for listing

Parameters

$func

in Column at line 291
get($func)

Format for editing

Parameters

$func

in Column at line 299
set($func)

Format user input for updating the entry

Parameters

$func

in Column at line 307
validate($func)

Validate user input

Parameters

$func

at line 8
datetime($format, $allowNull = false)

Parameters

$format
$allowNull