Poppy\MgrPage\Classes\Form\Field | Lemon Framework API Documentation

class Field implements Renderable

Class Field.

Traits

Macroable

Constants

FILE_DELETE_FLAG

FILE_SORT_FLAG

Properties

array\|Closure	$creationRules	The validation rules for creation.
array\|Closure	$updateRules	The validation rules for updates.
bool	$isJsonType
protected array\|string	$id	Element id.
protected mixed	$value	Element value.
protected mixed	$data	Data of all original columns of value.
protected mixed	$original	Field original value.
protected mixed	$default	Field default value.
protected string	$label	Element label.
protected string\|array	$column	Column name.
protected string	$elementName	Form element name.
protected array	$elementClass	Form element classes.
protected array	$variables	Variables of elements.
protected array	$options	Options for specify elements.
protected array	$checked	Checked for specify elements.
protected array\|Closure	$rules	Validation rules.
protected Closure	$validator
protected array	$validationMessages	Validation messages.
protected array	$attributes	Element attributes.
protected Form	$form	Parent form.
protected string	$view	View for field to render.
protected array	$help	Help block.
protected mixed	$errorKey	Key for errors.
protected string\|array	$placeholder	Placeholder for this field.
protected bool	$showHelp
protected array	$width	Width for label and field.
protected bool	$horizontal	If the form horizontal layout.
protected Closure	$customFormat	column data format.
protected bool	$display
protected array	$labelClass
protected array	$groupClass
protected Closure	$callback

Methods

__construct($column = '', array $arguments = [])

Field constructor.

$this

setElementName(string $name)

Set form element name.

void

fill(array $data)

Fill data to the field.

$this

customFormat(Closure $call)

custom format form column data when edit.

void

setOriginal(array $data)

Set original value to the field.

$this

setForm(Form $form = null)

No description

$this

setWidth(int $field = 8, int $label = 2)

Set width for field and label.

$this

options(array $options = [])

Set the field options.

$this

checked(array $checked = [])

Set the field option checked.

$this

rules(array $rules = [], array $messages = [])

Set the validation rules for the field.

$this

updateRules(array|callable $rules = [], array $messages = [])

Set the update validation rules for the field.

$this

creationRules(array|callable $rules = [], array $messages = [])

Set the creation validation rules for the field.

array|mixed

getValidationMessages()

Get validation messages for the field.

$this

setValidationMessages(string $key, array $messages)

Set validation messages for column.

$this

validator(callable $validator)

Set field validator.

string

getErrorKey()

Get key for error message.

$this

setErrorKey(string $key)

Set key for error message.

mixed

value(null $value = null)

Set or get value of the field.

$this

data(array $data = null)

Set or get data.

$this

default($default)

Set default value for field.

mixed

getDefault()

Get default value.

Field

help(string $text = '', bool $show_help = true, string $icon = 'bi-info-circle')

Set help block for current field.

string

column()

Get column of the field.

string

label()

Get label of the field.

mixed

original()

Get original value of the field.

bool|Validator|mixed

getValidator(array $input)

Get validator for this field.

Field

attribute(array|string $attribute, mixed $value = null)

Add html attributes to elements.

$this

style(string $attr, string $value)

Set Field style.

$this

width(string $width)

Set Field width.

$this

autofocus()

Set the field automatically get focus.

$this

readonly()

Set the field as readonly mode.

Field

disable() deprecated

Set field as disabled.

Field

disabled()

Set field as disabled.html 标准属性

$this

placeholder(string $placeholder = '')

Set field placeholder.

string

getPlaceholder()

Get placeholder.

mixed

prepare($value)

Prepare for a field value before update or insert.

$this

disableHorizontal()

No description

array

getViewElementClasses()

No description

array

getElementClass()

Get element class.

$this

setElementClass(string|array $class)

Set form element class.

$this

addElementClass($class)

Add the element class.

$this

removeElementClass($class)

Remove element class.

$this

resetElementClassName(string $className, string $resetClassName)

reset field className.

string

getLabelClass()

No description

Field

setLabelClass(array $labelClass)

No description

array

variables()

Get the view variables of this field.

string

getView()

Get view of this field.

string

setView(string $view)

Set view of current field.

string

getType()

No description

$this

setDisplay(bool $display)

To set this field should render or not.

Field

with(Closure $callback)

No description

Factory|View|string

render()

Render this filed.

string

__toString()

No description

string

getRules()

Get field validation rules.

array|mixed|string

formatName(string $column)

Format the name of the field.

mixed

formatColumn(string $column = '')

Format the field column name.

string|array

formatId(string|array $column)

Format the field element id.

string

formatLabel(array $arguments = [])

Format the label value.

formatValue()

Format value by passing custom formater.

addRequiredAttribute(array $rules)

Add required attribute to current field if has required rule, except file and image fields.

addRequiredAttributeFromRules()

If has required rule, add required attribute to this field.

array

formatRules(array|string $rules)

Format validation rules.

array|Closure

mergeRules(string|array|Closure $input, string|array $original)

No description

void

removeRule(string $rule)

Remove a specific rule by keyword.

array

sanitizeInput(array $input, string $column)

Sanitize input data.

string

formatAttributes()

Format the field attributes.

mixed

getElementClassString()

Get element class string.

string|array

getElementClassSelector()

Get element class selector.

string

getGroupClass(bool $default = false)

Get element class.

Field

setGroupClass(string|array $class)

Set form group class.

Field

addVariables(array $variables = [])

Add variables to field view.

bool

shouldRender()

If this field should render.

Details

at line 251
`__construct($column = '', array $arguments = [])`

Field constructor.

Parameters

	$column
array	$arguments

at line 267
`$this setElementName(string $name)`

Set form element name.

Parameters

string

$name

Return Value

$this

at line 281
`void fill(array $data)`

Fill data to the field.

Parameters

array

$data

Return Value

void

at line 305
`$this customFormat(Closure $call)`

custom format form column data when edit.

Parameters

Closure

$call

Return Value

$this

at line 319
`void setOriginal(array $data)`

Set original value to the field.

Parameters

array

$data

Return Value

void

at line 337
`$this setForm(Form $form = null)`

No description

Parameters

Form

$form

Return Value

$this

at line 352
`$this setWidth(int $field = 8, int $label = 2)`

Set width for field and label.

Parameters

int	$field
int	$label

Return Value

$this

at line 369
`$this options(array $options = [])`

Set the field options.

Parameters

array

$options

Return Value

$this

at line 387
`$this checked(array $checked = [])`

Set the field option checked.

Parameters

array

$checked

Return Value

$this

at line 406
`$this rules(array $rules = [], array $messages = [])`

Set the validation rules for the field.

Parameters

array	$rules
array	$messages

Return Value

$this

at line 423
`$this updateRules(array|callable $rules = [], array $messages = [])`

Set the update validation rules for the field.

Parameters

array\|callable	$rules
array	$messages

Return Value

$this

at line 440
`$this creationRules(array|callable $rules = [], array $messages = [])`

Set the creation validation rules for the field.

Parameters

array\|callable	$rules
array	$messages

Return Value

$this

at line 454
`array|mixed getValidationMessages()`

Get validation messages for the field.

Return Value

array|mixed

at line 477
`$this setValidationMessages(string $key, array $messages)`

Set validation messages for column.

Parameters

string	$key
array	$messages

Return Value

$this

at line 491
`$this validator(callable $validator)`

Set field validator.

Parameters

callable

$validator

Return Value

$this

at line 503
`string getErrorKey()`

Get key for error message.

Return Value

string

at line 515
`$this setErrorKey(string $key)`

Set key for error message.

Parameters

string

$key

Return Value

$this

at line 529
`mixed value(null $value = null)`

Set or get value of the field.

Parameters

null

$value

Return Value

mixed

at line 545
`$this data(array $data = null)`

Set or get data.

Parameters

array

$data

Return Value

$this

at line 563
`$this default($default)`

Set default value for field.

Parameters

$default

Return Value

$this

at line 575
`mixed getDefault()`

Get default value.

Return Value

mixed

at line 592
`Field help(string $text = '', bool $show_help = true, string $icon = 'bi-info-circle')`

Set help block for current field.

Parameters

string	$text
bool	$show_help
string	$icon

Return Value

Field

at line 604
`string column()`

Get column of the field.

Return Value

string

at line 614
`string label()`

Get label of the field.

Return Value

string

at line 624
`mixed original()`

Get original value of the field.

Return Value

mixed

at line 636
`bool|Validator|mixed getValidator(array $input)`

Get validator for this field.

Parameters

array

$input

Return Value

bool|Validator|mixed

at line 677
`Field attribute(array|string $attribute, mixed $value = null)`

Add html attributes to elements.

Parameters

array\|string	$attribute
mixed	$value

Return Value

Field

at line 697
`$this style(string $attr, string $value)`

Set Field style.

Parameters

string	$attr
string	$value

Return Value

$this

at line 709
`$this width(string $width)`

Set Field width.

Parameters

string

$width

Return Value

$this

at line 719
`$this autofocus()`

Set the field automatically get focus.

Return Value

$this

at line 729
`$this readonly()`

Set the field as readonly mode.

此属性不适用于 select

Return Value

$this

at line 742
`Field disable() deprecated`

deprecated 4.2

Set field as disabled.

Return Value

Field

at line 752
`Field disabled()`

Set field as disabled.html 标准属性

Return Value

Field

at line 764
`$this placeholder(string $placeholder = '')`

Set field placeholder.

Parameters

string

$placeholder

Return Value

$this

at line 776
`string getPlaceholder()`

Get placeholder.

Return Value

string

at line 790
`mixed prepare($value)`

Prepare for a field value before update or insert.

Parameters

$value

Return Value

mixed

at line 798
`$this disableHorizontal()`

No description

Return Value

$this

at line 808
`array getViewElementClasses()`

No description

Return Value

array

at line 830
`array getElementClass()`

Get element class.

Return Value

array

at line 842
`$this setElementClass(string|array $class)`

Set form element class.

Parameters

string|array

$class

Return Value

$this

at line 856
`$this addElementClass($class)`

Add the element class.

Parameters

$class

Return Value

$this

at line 872
`$this removeElementClass($class)`

Remove element class.

Parameters

$class

Return Value

$this

at line 897
`$this resetElementClassName(string $className, string $resetClassName)`

reset field className.

Parameters

string	$className
string	$resetClassName

Return Value

$this

at line 909
`string getLabelClass()`

No description

Return Value

string

at line 919
`Field setLabelClass(array $labelClass)`

No description

Parameters

array

$labelClass

Return Value

Field

at line 931
`array variables()`

Get the view variables of this field.

Return Value

array

at line 956
`string getView()`

Get view of this field.

Return Value

string

at line 974
`string setView(string $view)`

Set view of current field.

Parameters

string

$view

Return Value

string

at line 981
`string getType()`

No description

Return Value

string

at line 994
`$this setDisplay(bool $display)`

To set this field should render or not.

Parameters

bool

$display

Return Value

$this

at line 1006
`Field with(Closure $callback)`

No description

Parameters

Closure

$callback

Return Value

Field

at line 1018
`Factory|View|string render()`

Render this filed.

Return Value

Factory|View|string

at line 1035
`string __toString()`

No description

Return Value

string

Exceptions

Throwable

at line 1045
`string getRules()`

Get field validation rules.

Return Value

string

at line 1091
`array|mixed|string formatName(string $column)`

Format the name of the field.

Parameters

string

$column

Return Value

array|mixed|string

at line 1132
`protected mixed formatColumn(string $column = '')`

Format the field column name.

Parameters

string

$column

Return Value

mixed

at line 1150
`protected string|array formatId(string|array $column)`

Format the field element id.

Parameters

string|array

$column

Return Value

string|array

at line 1162
`protected string formatLabel(array $arguments = [])`

Format the label value.

Parameters

array

$arguments

Return Value

string

at line 1174
`protected formatValue()`

Format value by passing custom formater.

at line 1187
`protected addRequiredAttribute(array $rules)`

Add required attribute to current field if has required rule, except file and image fields.

Parameters

array

$rules

at line 1197
`protected addRequiredAttributeFromRules()`

If has required rule, add required attribute to this field.

at line 1218
`protected array formatRules(array|string $rules)`

Format validation rules.

Parameters

array|string

$rules

Return Value

array

at line 1233
`protected array|Closure mergeRules(string|array|Closure $input, string|array $original)`

No description

Parameters

string\|array\|Closure	$input
string\|array	$original

Return Value

array|Closure

at line 1256
`protected void removeRule(string $rule)`

Remove a specific rule by keyword.

Parameters

string

$rule

Return Value

void

at line 1279
`protected array sanitizeInput(array $input, string $column)`

Sanitize input data.

Parameters

array	$input
string	$column

Return Value

array

at line 1294
`protected string formatAttributes()`

Format the field attributes.

Return Value

string

at line 1310
`protected mixed getElementClassString()`

Get element class string.

Return Value

mixed

at line 1333
`protected string|array getElementClassSelector()`

Get element class selector.

Return Value

string|array

at line 1357
`protected string getGroupClass(bool $default = false)`

Get element class.

Parameters

bool

$default

Return Value

string

at line 1369
`Field setGroupClass(string|array $class)`

Set form group class.

Parameters

string|array

$class

Return Value

Field

at line 1388
`protected Field addVariables(array $variables = [])`

Add variables to field view.

Parameters

array

$variables

Return Value

Field

at line 1403
`protected bool shouldRender()`

If this field should render.

Return Value

bool

Field

Traits

Constants

Properties

Methods

Details

at line 251 __construct($column = '', array $arguments = [])

Parameters

at line 267 $this setElementName(string $name)

Parameters

Return Value

at line 281 void fill(array $data)

Parameters

Return Value

at line 305 $this customFormat(Closure $call)

Parameters

Return Value

at line 319 void setOriginal(array $data)

Parameters

Return Value

at line 337 $this setForm(Form $form = null)

Parameters

Return Value

at line 352 $this setWidth(int $field = 8, int $label = 2)

Parameters

Return Value

at line 369 $this options(array $options = [])

Parameters

Return Value

at line 387 $this checked(array $checked = [])

Parameters

Return Value

at line 406 $this rules(array $rules = [], array $messages = [])

Parameters

Return Value

at line 423 $this updateRules(array|callable $rules = [], array $messages = [])

Parameters

Return Value

at line 440 $this creationRules(array|callable $rules = [], array $messages = [])

Parameters

Return Value

at line 454 array|mixed getValidationMessages()

Return Value

at line 477 $this setValidationMessages(string $key, array $messages)

Parameters

Return Value

at line 491 $this validator(callable $validator)

Parameters

Return Value

at line 503 string getErrorKey()

Return Value

at line 515 $this setErrorKey(string $key)

Parameters

Return Value

at line 529 mixed value(null $value = null)

Parameters

Return Value

at line 545 $this data(array $data = null)

Parameters

Return Value

at line 563 $this default($default)

Parameters

Return Value

at line 575 mixed getDefault()

Return Value

at line 592 Field help(string $text = '', bool $show_help = true, string $icon = 'bi-info-circle')

Parameters

Return Value

at line 604 string column()

Return Value

at line 614 string label()

Return Value

at line 624 mixed original()

Return Value

at line 636 bool|Validator|mixed getValidator(array $input)

Parameters

Return Value

at line 677 Field attribute(array|string $attribute, mixed $value = null)

Parameters

Return Value

at line 251
`__construct($column = '', array $arguments = [])`

at line 267
`$this setElementName(string $name)`

at line 281
`void fill(array $data)`

at line 305
`$this customFormat(Closure $call)`

at line 319
`void setOriginal(array $data)`

at line 337
`$this setForm(Form $form = null)`

at line 352
`$this setWidth(int $field = 8, int $label = 2)`

at line 369
`$this options(array $options = [])`

at line 387
`$this checked(array $checked = [])`

at line 406
`$this rules(array $rules = [], array $messages = [])`

at line 423
`$this updateRules(array|callable $rules = [], array $messages = [])`

at line 440
`$this creationRules(array|callable $rules = [], array $messages = [])`

at line 454
`array|mixed getValidationMessages()`

at line 477
`$this setValidationMessages(string $key, array $messages)`

at line 491
`$this validator(callable $validator)`

at line 503
`string getErrorKey()`

at line 515
`$this setErrorKey(string $key)`

at line 529
`mixed value(null $value = null)`

at line 545
`$this data(array $data = null)`

at line 563
`$this default($default)`

at line 575
`mixed getDefault()`

at line 592
`Field help(string $text = '', bool $show_help = true, string $icon = 'bi-info-circle')`

at line 604
`string column()`

at line 614
`string label()`

at line 624
`mixed original()`

at line 636
`bool|Validator|mixed getValidator(array $input)`

at line 677
`Field attribute(array|string $attribute, mixed $value = null)`

at line 697
`$this style(string $attr, string $value)`

at line 709
`$this width(string $width)`

at line 719
`$this autofocus()`

at line 729
`$this readonly()`

at line 742
`Field disable() deprecated`

at line 752
`Field disabled()`

at line 764
`$this placeholder(string $placeholder = '')`

at line 776
`string getPlaceholder()`

at line 790
`mixed prepare($value)`

at line 798
`$this disableHorizontal()`

at line 808
`array getViewElementClasses()`

at line 830
`array getElementClass()`

at line 842
`$this setElementClass(string|array $class)`

at line 856
`$this addElementClass($class)`

at line 872
`$this removeElementClass($class)`

at line 897
`$this resetElementClassName(string $className, string $resetClassName)`

at line 909
`string getLabelClass()`

at line 919
`Field setLabelClass(array $labelClass)`

at line 931
`array variables()`

at line 956
`string getView()`

at line 974
`string setView(string $view)`

at line 981
`string getType()`

at line 994
`$this setDisplay(bool $display)`

at line 1006
`Field with(Closure $callback)`

at line 1018
`Factory|View|string render()`

at line 1035
`string __toString()`

at line 1045
`string getRules()`

at line 1091
`array|mixed|string formatName(string $column)`