POSITIONS
POSITIONS = array('top', 'bottom', 'both', 'before-field', 'after-field', 'to-field')
Defines a custom action on a page.
Actions are buttons on a page which execute user definded functions.
__construct(string $value, string $label, callable $callback = null, string $position = 'both', string $fieldname = '') : \Alddesign\Crudkit\Classes\Action
Constructor. Params are basically the properies of this class.
| string | $value | The text for the action button itselft |
| string | $label | The text of the label for the action |
| callable | $callback | The function to execute |
| string | $position | 'top','bottom','both', 'before-field', 'after-field', 'to-field' |
| string | $fieldname | reference fieldname for $position |
setValue(\Alddesign\Crudkit\Classes\string $value) : \Alddesign\Crudkit\Classes\Action
The text for the action itselft
| \Alddesign\Crudkit\Classes\string | $value |
setLabel(\Alddesign\Crudkit\Classes\string $label) : \Alddesign\Crudkit\Classes\Action
The text of the label for the action
| \Alddesign\Crudkit\Classes\string | $label |
setOnList(\Alddesign\Crudkit\Classes\bool $onList = true) : \Alddesign\Crudkit\Classes\Action
Show/hide on list pages
| \Alddesign\Crudkit\Classes\bool | $onList |
setOnCard(\Alddesign\Crudkit\Classes\bool $onCard = true) : \Alddesign\Crudkit\Classes\Action
Show/hide on card pages.
| \Alddesign\Crudkit\Classes\bool | $onCard |
setOnUpdate(\Alddesign\Crudkit\Classes\bool $onUpdate = true) : \Alddesign\Crudkit\Classes\Action
Show/hides on update pages.
| \Alddesign\Crudkit\Classes\bool | $onUpdate |
setFaIcon(\Alddesign\Crudkit\Classes\string $faIcon) : \Alddesign\Crudkit\Classes\Action
The icon for the button (font awesome icon name)
| \Alddesign\Crudkit\Classes\string | $faIcon |
setBtnClass(\Alddesign\Crudkit\Classes\string $btnClass = 'default') : \Alddesign\Crudkit\Classes\Action
Defines the button appearance. Admin LTE button type. '','default','primary','info','success','danger','warning','accent'. '' = no button, just a link.
| \Alddesign\Crudkit\Classes\string | $btnClass |
setEnabled(\Alddesign\Crudkit\Classes\bool $enabled = true) : \Alddesign\Crudkit\Classes\Action
Enableds/disables the action
| \Alddesign\Crudkit\Classes\bool | $enabled |
setVisible(\Alddesign\Crudkit\Classes\bool $visible = true) : \Alddesign\Crudkit\Classes\Action
Show/hide on all pages
| \Alddesign\Crudkit\Classes\bool | $visible |
setCallback(callable $callback) : \Alddesign\Crudkit\Classes\Action
The callback function for the action
| callable | $callback |
setPosition(\Alddesign\Crudkit\Classes\string $position) : \Alddesign\Crudkit\Classes\Action
'top','bottom','both', 'before-field', 'after-field', 'to-field'. Use togehter with setFieldname() $fieldname.
| \Alddesign\Crudkit\Classes\string | $position |
setFieldname(\Alddesign\Crudkit\Classes\string $fieldname) : \Alddesign\Crudkit\Classes\Action
The reference fieldname for setPosition() $position
| \Alddesign\Crudkit\Classes\string | $fieldname |
setData( $data) : \Alddesign\Crudkit\Classes\Action
Additional data which can be set when creatig the action. (Can be accessed in the callback function)
| $data |