Checkbox
class Checkbox extends MultipleSelect
Traits
Constants
| FILE_DELETE_FLAG |
|
| FILE_SORT_FLAG |
|
Properties
| array|Closure | $creationRules | The validation rules for creation. |
from Field |
| array|Closure | $updateRules | The validation rules for updates. |
from Field |
| bool | $isJsonType | from Field | |
| protected array|string | $id | Element id. |
from Field |
| protected mixed | $value | Element value. |
from Field |
| protected mixed | $data | Data of all original columns of value. |
from Field |
| protected mixed | $original | Field original value. |
from Field |
| protected | $default | ||
| protected string | $label | Element label. |
from Field |
| protected string|array | $column | Column name. |
from Field |
| protected string | $elementName | Form element name. |
from Field |
| protected array | $elementClass | Form element classes. |
from Field |
| protected array | $variables | Variables of elements. |
from Field |
| protected array | $options | Options for specify elements. |
from Field |
| protected array | $checked | Checked for specify elements. |
from Field |
| protected array|Closure | $rules | Validation rules. |
from Field |
| protected Closure | $validator | from Field | |
| protected array | $validationMessages | Validation messages. |
from Field |
| protected array | $attributes | Element attributes. |
from Field |
| protected Form | $form | Parent form. |
from Field |
| protected string | $view | View for field to render. |
from Field |
| protected array | $help | Help block. |
from Field |
| protected mixed | $errorKey | Key for errors. |
from Field |
| protected | $placeholder | from Select | |
| protected bool | $showHelp | from Field | |
| protected array | $width | Width for label and field. |
from Field |
| protected bool | $horizontal | If the form horizontal layout. |
from Field |
| protected Closure | $customFormat | column data format. |
from Field |
| protected bool | $display | from Field | |
| protected array | $labelClass | from Field | |
| protected array | $groupClass | from Field | |
| protected Closure | $callback | from Field | |
| protected array | $groups | from Select | |
| protected array | $config | from Select | |
| protected string | $otherKey | Other key for many-to-many relation. |
from MultipleSelect |
| protected bool | $inline | 是否行内显示 | |
| protected bool | $canCheckAll | 是否可以全选 |
Methods
No description
Set options.
Set the validation rules for the field.
Set the update validation rules for the field.
Set the creation validation rules for the field.
Set validation messages for column.
默认值, 当没有数据做填充的时候会取这个默认值(null 值的时候)
Set help block for current field.
reset field className.
No description
Add required attribute to current field if has required rule,
except file and image fields.
If has required rule, add required attribute to this field.
Load options from current selected resource(s).
Add a checkbox above this component, so you can select all checkboxes by click on it.
Details
in
Field at line 251
__construct($column = '', array $arguments = [])
Field constructor.
in
Field at line 267
$this
setElementName(string $name)
Set form element name.
at line 33
void
fill(array $data)
No description
in
MultipleSelect at line 57
void
setOriginal(array $data)
No description
in
Field at line 352
$this
setWidth(int $field = 8, int $label = 2)
Set width for field and label.
at line 47
$this
options(array $options = [])
Set options.
in
Field at line 387
$this
checked(array $checked = [])
Set the field option checked.
in
Field at line 406
$this
rules(array $rules = [], array $messages = [])
Set the validation rules for the field.
in
Field at line 423
$this
updateRules(array|callable $rules = [], array $messages = [])
Set the update validation rules for the field.
in
Field at line 440
$this
creationRules(array|callable $rules = [], array $messages = [])
Set the creation validation rules for the field.
in
Field at line 454
array|mixed
getValidationMessages()
Get validation messages for the field.
in
Field at line 477
$this
setValidationMessages(string $key, array $messages)
Set validation messages for column.
in
Field at line 491
$this
validator(callable $validator)
Set field validator.
in
Field at line 503
string
getErrorKey()
Get key for error message.
in
Field at line 515
$this
setErrorKey(string $key)
Set key for error message.
in
Field at line 529
mixed
value(null $value = null)
Set or get value of the field.
in
Field at line 545
$this
data(array $data = null)
Set or get data.
at line 68
$this
default($default)
默认值, 当没有数据做填充的时候会取这个默认值(null 值的时候)
in
Field at line 575
mixed
getDefault()
Get default value.
in
Field at line 592
Field
help(string $text = '', bool $show_help = true, string $icon = 'bi-info-circle')
Set help block for current field.
in
Field at line 604
string
column()
Get column of the field.
in
Field at line 614
string
label()
Get label of the field.
in
Field at line 624
mixed
original()
Get original value of the field.
in
Field at line 636
bool|Validator|mixed
getValidator(array $input)
Get validator for this field.
in
Field at line 677
Field
attribute(array|string $attribute, mixed $value = null)
Add html attributes to elements.
in
Field at line 697
$this
style(string $attr, string $value)
Set Field style.
in
Field at line 709
$this
width(string $width)
Set Field width.
in
Field at line 719
$this
autofocus()
Set the field automatically get focus.
in
Field at line 729
$this
readonly()
Set the field as readonly mode.
此属性不适用于 select
in
Field at line 764
$this
placeholder(string $placeholder = '')
Set field placeholder.
in
Field at line 776
string
getPlaceholder()
Get placeholder.
in
MultipleSelect at line 88
mixed
prepare($value)
Prepare for a field value before update or insert.
in
Field at line 798
$this
disableHorizontal()
No description
in
Field at line 808
array
getViewElementClasses()
No description
in
Field at line 830
array
getElementClass()
Get element class.
in
Field at line 842
$this
setElementClass(string|array $class)
Set form element class.
in
Field at line 856
$this
addElementClass($class)
Add the element class.
in
Field at line 872
$this
removeElementClass($class)
Remove element class.
in
Field at line 897
$this
resetElementClassName(string $className, string $resetClassName)
reset field className.
in
Field at line 909
string
getLabelClass()
No description
in
Field at line 931
array
variables()
Get the view variables of this field.
in
Field at line 956
string
getView()
Get view of this field.
in
Field at line 974
string
setView(string $view)
Set view of current field.
in
Field at line 981
string
getType()
No description
in
Field at line 994
$this
setDisplay(bool $display)
To set this field should render or not.
at line 77
Factory|View|string
render()
No description
in
Field at line 1035
string
__toString()
No description
in
Field at line 1045
string
getRules()
Get field validation rules.
in
Field at line 1091
array|mixed|string
formatName(string $column)
Format the name of the field.
in
Field at line 1132
protected mixed
formatColumn(string $column = '')
Format the field column name.
in
Field at line 1150
protected string|array
formatId(string|array $column)
Format the field element id.
in
Field at line 1162
protected string
formatLabel(array $arguments = [])
Format the label value.
in
Field at line 1174
protected
formatValue()
Format value by passing custom formater.
in
Field at line 1187
protected
addRequiredAttribute(array $rules)
Add required attribute to current field if has required rule,
except file and image fields.
in
Field at line 1197
protected
addRequiredAttributeFromRules()
If has required rule, add required attribute to this field.
in
Field at line 1218
protected array
formatRules(array|string $rules)
Format validation rules.
in
Field at line 1233
protected array|Closure
mergeRules(string|array|Closure $input, string|array $original)
No description
in
Field at line 1256
protected void
removeRule(string $rule)
Remove a specific rule by keyword.
in
Field at line 1279
protected array
sanitizeInput(array $input, string $column)
Sanitize input data.
in
Field at line 1294
protected string
formatAttributes()
Format the field attributes.
in
Field at line 1310
protected mixed
getElementClassString()
Get element class string.
in
Field at line 1333
protected string|array
getElementClassSelector()
Get element class selector.
in
Field at line 1357
protected string
getGroupClass(bool $default = false)
Get element class.
in
Field at line 1388
protected Field
addVariables(array $variables = [])
Add variables to field view.
in
Field at line 1403
protected bool
shouldRender()
If this field should render.
in
Select at line 99
$this
groups(array $groups)
Set option groups.
eg: $group = [ [ 'label' => 'xxxx', 'options' => [ 1 => 'foo', 2 => 'bar', ... ], ... ]
in
Select at line 115
$this
model(string $model, string $idField = 'id', string $textField = 'name')
Load options from current selected resource(s).
in
Select at line 171
$this
config(string $key, mixed $val)
Set config for select2.
all configurations see https://select2.org/configuration/options-api
in
MultipleSelect at line 102
protected string
getOtherKey()
Get other key for this many-to-many relation.
at line 91
Checkbox
canCheckAll()
Add a checkbox above this component, so you can select all checkboxes by click on it.
at line 102
Checkbox
inline()
Draw inline checkboxes.
at line 113
Checkbox
stacked()
Draw stacked checkboxes.