1. class
  2. Onspli
  3. \
  4. Eladmin
  5. \
  6. Modules
  7. \
  8. Crud
  9. \
  10. Chainset
  11. \
  12. Column

Column

class Column extends Child

Properties

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

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
Chainset
_getParent()

No description

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

Place child just before $target.

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

Place child just after $target.

from Child
final
string
getName()

Get internal name of the column.

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

Extract value of the column from $row array

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

Eval property

raw()

Output raw value (i.e. HTML)

default($value)

Set default value

escaped()

Output escaped value.

nonlistable()

Do not show the column in the table.

listable()

Show the column in the table.

nonsearchable()

Do not use the column for searching.

searchable()

Use the column for searching.

nonsortable()

Do not sort by the column.

sortable()

Use the column for sorting.

noneditable()

Hide the column in the edit form.

editable()

Show the column in the edit form.

disabled()

Disable editing column's value.

enabled()

Enable editing column's value.

limit($len)

Max length of value to be shown in the table.

input($type)

Set the type of input.

password()

Set the type of input to password Add nonlistable flag

textarea()

Set the type of input to textarea.

select($options = [])

Set the type of input to select.

hidden()

Shortcut for nonlistable && noneditable && disabled

list($func)

Format for listing

get($func)

Format for editing

set($func)

Format user input for updating the entry

validate($func)

Validate user input

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

at line 86
final string getName()

Get internal name of the column.

Return Value

string

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

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

Eval property

Parameters

string $prop
array $row

at line 125
raw()

Output raw value (i.e. HTML)

at line 133
default($value)

Set default value

Parameters

$value

at line 141
escaped()

Output escaped value.

at line 149
nonlistable()

Do not show the column in the table.

at line 157
listable()

Show the column in the table.

at line 165
nonsearchable()

Do not use the column for searching.

at line 173
searchable()

Use the column for searching.

at line 181
nonsortable()

Do not sort by the column.

at line 189
sortable()

Use the column for sorting.

at line 197
noneditable()

Hide the column in the edit form.

at line 205
editable()

Show the column in the edit form.

at line 213
disabled()

Disable editing column's value.

at line 221
enabled()

Enable editing column's value.

at line 230
limit($len)

Max length of value to be shown in the table.

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

Parameters

$len

at line 238
input($type)

Set the type of input.

Parameters

$type

at line 247
password()

Set the type of input to password Add nonlistable flag

at line 256
textarea()

Set the type of input to textarea.

at line 264
select($options = [])

Set the type of input to select.

Parameters

$options

at line 273
hidden()

Shortcut for nonlistable && noneditable && disabled

at line 283
list($func)

Format for listing

Parameters

$func

at line 291
get($func)

Format for editing

Parameters

$func

at line 299
set($func)

Format user input for updating the entry

Parameters

$func

at line 307
validate($func)

Validate user input

Parameters

$func