Poppy\MgrPage\Classes\Form\_Back\Embeds | Lemon Framework API Documentation

class Embeds extends Field

Traits

Macroable

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 mixed	$default	Field default value.	from Field
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 string\|array	$placeholder	Placeholder for this field.	from Field
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 Closure	$builder

Methods

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

Create a new HasMany field instance.

$this

setElementName(string $name)

Set form element name.

from Field

void

fill(array $data)

Fill data to the field.

from Field

$this

customFormat(Closure $call)

custom format form column data when edit.

from Field

void

setOriginal(array $data)

Set original value to the field.

from Field

$this

setForm(Form $form = null)

No description

from Field

$this

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

Set width for field and label.

from Field

$this

options(array $options = [])

Set the field options.

from Field

$this

checked(array $checked = [])

Set the field option checked.

from Field

$this

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

Set the validation rules for the field.

from Field

$this

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

Set the update validation rules for the field.

from Field

$this

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

Set the creation validation rules for the field.

from Field

array|mixed

getValidationMessages()

Get validation messages for the field.

from Field

$this

setValidationMessages(string $key, array $messages)

Set validation messages for column.

from Field

$this

validator(callable $validator)

Set field validator.

from Field

string

getErrorKey()

Get key for error message.

from Field

$this

setErrorKey(string $key)

Set key for error message.

from Field

mixed

value(null $value = null)

Set or get value of the field.

from Field

$this

data(array $data = null)

Set or get data.

from Field

$this

default($default)

Set default value for field.

from Field

mixed

getDefault()

Get default value.

from Field

$this

help(string $text = '', string $icon = 'fa-info-circle')

Set help block for current field.

from Field

string|array

column()

Get column of the field.

from Field

string

label()

Get label of the field.

from Field

mixed

original()

Get original value of the field.

from Field

bool|Validator|mixed

getValidator(array $input)

No description

$this

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

Add html attributes to elements.

from Field

$this

style(string $attr, string $value)

Set Field style.

from Field

$this

width(string $width)

Set Field width.

from Field

$this

autofocus()

Set the field automatically get focus.

from Field

$this

readonly()

Set the field as readonly mode.

from Field

$this

disable()

Set field as disabled.

from Field

$this

placeholder(string $placeholder = '')

Set field placeholder.

from Field

string

getPlaceholder()

Get placeholder.

from Field

mixed

prepare(array $input)

Prepare input data for insert or update.

$this

disableHorizontal()

No description

from Field

array

getViewElementClasses()

No description

from Field

array

getElementClass()

Get element class.

from Field

$this

setElementClass(string|array $class)

Set form element class.

from Field

$this

addElementClass($class)

Add the element class.

from Field

$this

removeElementClass($class)

Remove element class.

from Field

$this

resetElementClassName(string $className, string $resetClassName)

reset field className.

from Field

string

getLabelClass()

No description

from Field

Field

setLabelClass(array $labelClass)

No description

from Field

array

variables()

Get the view variables of this field.

from Field

string

getView()

Get view of this field.

from Field

string

setView(string $view)

Set view of current field.

from Field

string

getType()

No description

from Field

$this

setDisplay(bool $display)

To set this field should render or not.

from Field

Field

with(Closure $callback)

No description

from Field

Factory|View|string

render()

Render the form.

string

__toString()

No description

from Field

string

getRules()

Get field validation rules.

from Field

array|mixed|string

formatName(string $column)

Format the name of the field.

from Field

array

skeleton()

No description

from Field

mixed

formatColumn(string $column = '')

Format the field column name.

from Field

string|array

formatId(string|array $column)

Format the field element id.

from Field

string

formatLabel(array $arguments = [])

Format the label value.

from Field

formatValue()

Format value by passing custom formater.

from Field

addRequiredAttribute(array $rules)

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

from Field

addRequiredAttributeFromRules()

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

from Field

array

formatRules(array|string $rules)

Format validation rules.

from Field

array|Closure

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

No description

from Field

void

removeRule(string $rule)

Remove a specific rule by keyword.

from Field

array

sanitizeInput(array $input, string $column)

Sanitize input data.

from Field

string

formatAttributes()

Format the field attributes.

from Field

mixed

getElementClassString()

Get element class string.

from Field

string|array

getElementClassSelector()

Get element class selector.

from Field

string

getGroupClass(bool $default = false)

Get element class.

from Field

Field

setGroupClass(string|array $class)

Set form group class.

from Field

Field

addVariables(array $variables = [])

Add variables to field view.

from Field

bool

shouldRender()

If this field should render.

from Field

array

formatValidationAttribute(array $input, string $label, string $column)

Format validation attributes.

resetInputKey(array $input, array $column)

Reset input key for validation.

array

getEmbeddedData()

Get data for Embedded form.

EmbeddedForm

buildEmbeddedForm()

Build a Embedded Form and fill data.

Details

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

Create a new HasMany field instance.

Parameters

	$column
array	$arguments

in Field at line 245
`$this setElementName(string $name)`

Set form element name.

Parameters

string

$name

Return Value

$this

in Field at line 259
`void fill(array $data)`

Fill data to the field.

Parameters

array

$data

Return Value

void

in Field at line 283
`$this customFormat(Closure $call)`

custom format form column data when edit.

Parameters

Closure

$call

Return Value

$this

in Field at line 297
`void setOriginal(array $data)`

Set original value to the field.

Parameters

array

$data

Return Value

void

in Field at line 315
`$this setForm(Form $form = null)`

No description

Parameters

Form

$form

Return Value

$this

in Field at line 330
`$this setWidth(int $field = 8, int $label = 2)`

Set width for field and label.

Parameters

int	$field
int	$label

Return Value

$this

in Field at line 347
`$this options(array $options = [])`

Set the field options.

Parameters

array

$options

Return Value

$this

in Field at line 365
`$this checked(array $checked = [])`

Set the field option checked.

Parameters

array

$checked

Return Value

$this

in Field at line 384
`$this rules(array $rules = [], array $messages = [])`

Set the validation rules for the field.

Parameters

array	$rules
array	$messages

Return Value

$this

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

Set the update validation rules for the field.

Parameters

array\|callable	$rules
array	$messages

Return Value

$this

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

Set the creation validation rules for the field.

Parameters

array\|callable	$rules
array	$messages

Return Value

$this

in Field at line 432
`array|mixed getValidationMessages()`

Get validation messages for the field.

Return Value

array|mixed

in Field at line 455
`$this setValidationMessages(string $key, array $messages)`

Set validation messages for column.

Parameters

string	$key
array	$messages

Return Value

$this

in Field at line 469
`$this validator(callable $validator)`

Set field validator.

Parameters

callable

$validator

Return Value

$this

in Field at line 481
`string getErrorKey()`

Get key for error message.

Return Value

string

in Field at line 493
`$this setErrorKey(string $key)`

Set key for error message.

Parameters

string

$key

Return Value

$this

in Field at line 507
`mixed value(null $value = null)`

Set or get value of the field.

Parameters

null

$value

Return Value

mixed

in Field at line 523
`$this data(array $data = null)`

Set or get data.

Parameters

array

$data

Return Value

$this

in Field at line 541
`$this default($default)`

Set default value for field.

Parameters

$default

Return Value

$this

in Field at line 553
`mixed getDefault()`

Get default value.

Return Value

mixed

in Field at line 570
`$this help(string $text = '', string $icon = 'fa-info-circle')`

Set help block for current field.

Parameters

string	$text
string	$icon

Return Value

$this

in Field at line 582
`string|array column()`

Get column of the field.

Return Value

string|array

in Field at line 592
`string label()`

Get label of the field.

Return Value

string

in Field at line 602
`mixed original()`

Get original value of the field.

Return Value

mixed

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

No description

Parameters

array

$input

Return Value

bool|Validator|mixed

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

Add html attributes to elements.

Parameters

array\|string	$attribute
mixed	$value

Return Value

$this

in Field at line 675
`$this style(string $attr, string $value)`

Set Field style.

Parameters

string	$attr
string	$value

Return Value

$this

in Field at line 687
`$this width(string $width)`

Set Field width.

Parameters

string

$width

Return Value

$this

in Field at line 697
`$this autofocus()`

Set the field automatically get focus.

Return Value

$this

in Field at line 707
`$this readonly()`

Set the field as readonly mode.

Return Value

$this

in Field at line 717
`$this disable()`

Set field as disabled.

Return Value

$this

in Field at line 729
`$this placeholder(string $placeholder = '')`

Set field placeholder.

Parameters

string

$placeholder

Return Value

$this

in Field at line 741
`string getPlaceholder()`

Get placeholder.

Return Value

string

at line 45
`mixed prepare(array $input)`

Prepare input data for insert or update.

Parameters

array

$input

Return Value

mixed

in Field at line 763
`$this disableHorizontal()`

No description

Return Value

$this

in Field at line 773
`array getViewElementClasses()`

No description

Return Value

array

in Field at line 795
`array getElementClass()`

Get element class.

Return Value

array

in Field at line 807
`$this setElementClass(string|array $class)`

Set form element class.

Parameters

string|array

$class

Return Value

$this

in Field at line 821
`$this addElementClass($class)`

Add the element class.

Parameters

$class

Return Value

$this

in Field at line 837
`$this removeElementClass($class)`

Remove element class.

Parameters

$class

Return Value

$this

in Field at line 862
`$this resetElementClassName(string $className, string $resetClassName)`

reset field className.

Parameters

string	$className
string	$resetClassName

Return Value

$this

in Field at line 874
`string getLabelClass()`

No description

Return Value

string

in Field at line 884
`Field setLabelClass(array $labelClass)`

No description

Parameters

array

$labelClass

Return Value

Field

in Field at line 896
`array variables()`

Get the view variables of this field.

Return Value

array

in Field at line 921
`string getView()`

Get view of this field.

Return Value

string

in Field at line 939
`string setView(string $view)`

Set view of current field.

Parameters

string

$view

Return Value

string

in Field at line 946
`string getType()`

No description

Return Value

string

in Field at line 959
`$this setDisplay(bool $display)`

To set this field should render or not.

Parameters

bool

$display

Return Value

$this

in Field at line 971
`Field with(Closure $callback)`

No description

Parameters

Closure

$callback

Return Value

Field

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

Render the form.

Return Value

Factory|View|string

in Field at line 1000
`string __toString()`

No description

Return Value

string

Exceptions

Throwable

in Field at line 1010
`string getRules()`

Get field validation rules.

Return Value

string

in Field at line 1056
`array|mixed|string formatName(string $column)`

Format the name of the field.

Parameters

string

$column

Return Value

array|mixed|string

in Field at line 1090
`array skeleton()`

No description

Return Value

array

in Field at line 1102
`protected mixed formatColumn(string $column = '')`

Format the field column name.

Parameters

string

$column

Return Value

mixed

in Field at line 1120
`protected string|array formatId(string|array $column)`

Format the field element id.

Parameters

string|array

$column

Return Value

string|array

in Field at line 1132
`protected string formatLabel(array $arguments = [])`

Format the label value.

Parameters

array

$arguments

Return Value

string

in Field at line 1144
`protected formatValue()`

Format value by passing custom formater.

in Field at line 1157
`protected addRequiredAttribute(array $rules)`

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

Parameters

array

$rules

in Field at line 1167
`protected addRequiredAttributeFromRules()`

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

in Field at line 1188
`protected array formatRules(array|string $rules)`

Format validation rules.

Parameters

array|string

$rules

Return Value

array

in Field at line 1203
`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

in Field at line 1226
`protected void removeRule(string $rule)`

Remove a specific rule by keyword.

Parameters

string

$rule

Return Value

void

in Field at line 1249
`protected array sanitizeInput(array $input, string $column)`

Sanitize input data.

Parameters

array	$input
string	$column

Return Value

array

in Field at line 1264
`protected string formatAttributes()`

Format the field attributes.

Return Value

string

in Field at line 1280
`protected mixed getElementClassString()`

Get element class string.

Return Value

mixed

in Field at line 1303
`protected string|array getElementClassSelector()`

Get element class selector.

Return Value

string|array

in Field at line 1327
`protected string getGroupClass(bool $default = false)`

Get element class.

Parameters

bool

$default

Return Value

string

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

Set form group class.

Parameters

string|array

$class

Return Value

Field

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

Add variables to field view.

Parameters

array

$variables

Return Value

Field

in Field at line 1373
`protected bool shouldRender()`

If this field should render.

Return Value

bool

at line 145
`protected array formatValidationAttribute(array $input, string $label, string $column)`

Format validation attributes.

Parameters

array	$input
string	$label
string	$column

Return Value

array

at line 181
`resetInputKey(array $input, array $column)`

Reset input key for validation.

Parameters

array	$input
array	$column	$column is the column name array set

at line 212
`protected array getEmbeddedData()`

Get data for Embedded form.

Normally, data is obtained from the database.

When the data validation errors, data is obtained from session flash.

Return Value

array

at line 234
`protected EmbeddedForm buildEmbeddedForm()`

Build a Embedded Form and fill data.

Return Value

EmbeddedForm

Embeds

Traits

Constants

Properties

Methods

Details

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

Parameters

in Field at line 245 $this setElementName(string $name)

Parameters

Return Value

in Field at line 259 void fill(array $data)

Parameters

Return Value

in Field at line 283 $this customFormat(Closure $call)

Parameters

Return Value

in Field at line 297 void setOriginal(array $data)

Parameters

Return Value

in Field at line 315 $this setForm(Form $form = null)

Parameters

Return Value

in Field at line 330 $this setWidth(int $field = 8, int $label = 2)

Parameters

Return Value

in Field at line 347 $this options(array $options = [])

Parameters

Return Value

in Field at line 365 $this checked(array $checked = [])

Parameters

Return Value

in Field at line 384 $this rules(array $rules = [], array $messages = [])

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

in Field at line 432 array|mixed getValidationMessages()

Return Value

in Field at line 455 $this setValidationMessages(string $key, array $messages)

Parameters

Return Value

in Field at line 469 $this validator(callable $validator)

Parameters

Return Value

in Field at line 481 string getErrorKey()

Return Value

in Field at line 493 $this setErrorKey(string $key)

Parameters

Return Value

in Field at line 507 mixed value(null $value = null)

Parameters

Return Value

in Field at line 523 $this data(array $data = null)

Parameters

Return Value

in Field at line 541 $this default($default)

Parameters

Return Value

in Field at line 553 mixed getDefault()

Return Value

in Field at line 570 $this help(string $text = '', string $icon = 'fa-info-circle')

Parameters

Return Value

in Field at line 582 string|array column()

Return Value

in Field at line 592 string label()

Return Value

in Field at line 602 mixed original()

Return Value

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

Parameters

Return Value

in Field at line 655 $this attribute(array|string $attribute, mixed $value = null)

Parameters

Return Value

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

in Field at line 245
`$this setElementName(string $name)`

in Field at line 259
`void fill(array $data)`

in Field at line 283
`$this customFormat(Closure $call)`

in Field at line 297
`void setOriginal(array $data)`

in Field at line 315
`$this setForm(Form $form = null)`

in Field at line 330
`$this setWidth(int $field = 8, int $label = 2)`

in Field at line 347
`$this options(array $options = [])`

in Field at line 365
`$this checked(array $checked = [])`

in Field at line 384
`$this rules(array $rules = [], array $messages = [])`

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

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

in Field at line 432
`array|mixed getValidationMessages()`

in Field at line 455
`$this setValidationMessages(string $key, array $messages)`

in Field at line 469
`$this validator(callable $validator)`

in Field at line 481
`string getErrorKey()`

in Field at line 493
`$this setErrorKey(string $key)`

in Field at line 507
`mixed value(null $value = null)`

in Field at line 523
`$this data(array $data = null)`

in Field at line 541
`$this default($default)`

in Field at line 553
`mixed getDefault()`

in Field at line 570
`$this help(string $text = '', string $icon = 'fa-info-circle')`

in Field at line 582
`string|array column()`

in Field at line 592
`string label()`

in Field at line 602
`mixed original()`

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

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

in Field at line 675
`$this style(string $attr, string $value)`

in Field at line 687
`$this width(string $width)`

in Field at line 697
`$this autofocus()`

in Field at line 707
`$this readonly()`

in Field at line 717
`$this disable()`

in Field at line 729
`$this placeholder(string $placeholder = '')`

in Field at line 741
`string getPlaceholder()`

at line 45
`mixed prepare(array $input)`

in Field at line 763
`$this disableHorizontal()`

in Field at line 773
`array getViewElementClasses()`

in Field at line 795
`array getElementClass()`

in Field at line 807
`$this setElementClass(string|array $class)`

in Field at line 821
`$this addElementClass($class)`

in Field at line 837
`$this removeElementClass($class)`

in Field at line 862
`$this resetElementClassName(string $className, string $resetClassName)`

in Field at line 874
`string getLabelClass()`

in Field at line 884
`Field setLabelClass(array $labelClass)`

in Field at line 896
`array variables()`

in Field at line 921
`string getView()`

in Field at line 939
`string setView(string $view)`

in Field at line 946
`string getType()`

in Field at line 959
`$this setDisplay(bool $display)`

in Field at line 971
`Field with(Closure $callback)`

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

in Field at line 1000
`string __toString()`

in Field at line 1010
`string getRules()`

in Field at line 1056
`array|mixed|string formatName(string $column)`

in Field at line 1090
`array skeleton()`