abstract class FormsComponent extends Component implements HasForms (View source)

Traits

Properties

$mountedFormComponentAction from  HasFormComponentActions
$mountedFormComponentActionArguments from  HasFormComponentActions
$mountedFormComponentActionData from  HasFormComponentActions
$mountedFormComponentActionComponent from  HasFormComponentActions
ComponentContainer $mountedFormComponentActionForm from  HasFormComponentActions
array $componentFileAttachments from  InteractsWithForms
protected array|null $cachedForms from  InteractsWithForms
protected bool $hasCachedForms from  InteractsWithForms
protected bool $isCachingForms from  InteractsWithForms
protected bool $hasModalViewRendered from  InteractsWithForms

Methods

ComponentContainer|null
callMountedFormComponentAction(string|null $arguments = null)

No description

Action|Closure|null
mountFormComponentAction(string $component, string $name, array $arguments = [])

No description

array
getFormComponentActions()

No description

__get($property)

No description

View|null
getModalViewOnce()

No description

void
dispatchFormEvent(...$args)

No description

TemporaryUploadedFile|null
getComponentFileAttachment(string $statePath)

No description

string|null
getComponentFileAttachmentUrl(string $statePath)

No description

array
getSelectOptionLabels(string $statePath)

No description

string|null
getSelectOptionLabel(string $statePath)

No description

array
getSelectOptions(string $statePath)

No description

array
getSelectSearchResults(string $statePath, string $search)

No description

void
deleteUploadedFile(string $statePath, string $fileKey)

No description

array|null
getUploadedFileUrls(string $statePath)

No description

void
removeUploadedFile(string $statePath, string $fileKey)

No description

void
reorderUploadedFiles(string $statePath, array $fileKeys)

No description

validate($rules = null, $messages = [], $attributes = [])

No description

void
onValidationError(ValidationException $exception)

No description

validateOnly($field, $rules = null, $messages = [], $attributes = [])

No description

string|null
getActiveFormLocale()

No description

void
callBeforeAndAfterSyncHooks($name, $value, $callback)

No description

ComponentContainer|null
cacheForm(string $name, ComponentContainer|Closure|null $form)

No description

array
cacheForms()

No description

array
getUncachedForms()

No description

array
getTraitForms()

No description

bool
hasCachedForm($name)

No description

ComponentContainer|null
getCachedForm($name)

No description

array
getCachedForms()

No description

Model|string|null
getFormModel()

No description

array
getFormSchema()

No description

array
getForms()

No description

string|null
getFormContext()

No description

string|null
getFormStatePath()

No description

array
getRules()

No description

array
getValidationAttributes()

No description

Details

protected bool hasMountedFormComponentAction()

No description

Return Value

bool

protected ComponentContainer|null getMountedFormComponentActionForm()

No description

Return Value

ComponentContainer|null

callMountedFormComponentAction(string|null $arguments = null)

No description

Parameters

string|null $arguments

Action|Closure|null getMountedFormComponentAction()

No description

Return Value

Action|Closure|null

mountFormComponentAction(string $component, string $name, array $arguments = [])

No description

Parameters

string $component
string $name
array $arguments

Component|null getMountedFormComponentActionComponent()

No description

Return Value

Component|null

protected array getFormComponentActions()

No description

Return Value

array

__get($property)

No description

Parameters

$property

protected View|null getModalViewOnce()

No description

Return Value

View|null

void dispatchFormEvent(...$args)

No description

Parameters

...$args

Return Value

void

TemporaryUploadedFile|null getComponentFileAttachment(string $statePath)

No description

Parameters

string $statePath

Return Value

TemporaryUploadedFile|null

string|null getComponentFileAttachmentUrl(string $statePath)

No description

Parameters

string $statePath

Return Value

string|null

array getSelectOptionLabels(string $statePath)

No description

Parameters

string $statePath

Return Value

array

string|null getSelectOptionLabel(string $statePath)

No description

Parameters

string $statePath

Return Value

string|null

array getSelectOptions(string $statePath)

No description

Parameters

string $statePath

Return Value

array

array getSelectSearchResults(string $statePath, string $search)

No description

Parameters

string $statePath
string $search

Return Value

array

void deleteUploadedFile(string $statePath, string $fileKey)

No description

Parameters

string $statePath
string $fileKey

Return Value

void

array|null getUploadedFileUrls(string $statePath)

No description

Parameters

string $statePath

Return Value

array|null

void removeUploadedFile(string $statePath, string $fileKey)

No description

Parameters

string $statePath
string $fileKey

Return Value

void

void reorderUploadedFiles(string $statePath, array $fileKeys)

No description

Parameters

string $statePath
array $fileKeys

Return Value

void

validate($rules = null, $messages = [], $attributes = [])

No description

Parameters

$rules
$messages
$attributes

protected void onValidationError(ValidationException $exception)

No description

Parameters

ValidationException $exception

Return Value

void

validateOnly($field, $rules = null, $messages = [], $attributes = [])

No description

Parameters

$field
$rules
$messages
$attributes

string|null getActiveFormLocale()

No description

Return Value

string|null

protected void callBeforeAndAfterSyncHooks($name, $value, $callback)

No description

Parameters

$name
$value
$callback

Return Value

void

protected ComponentContainer|null cacheForm(string $name, ComponentContainer|Closure|null $form)

No description

Parameters

string $name
ComponentContainer|Closure|null $form

Return Value

ComponentContainer|null

protected array cacheForms()

No description

Return Value

array

protected array getUncachedForms()

No description

Return Value

array

protected array getTraitForms()

No description

Return Value

array

protected bool hasCachedForm($name)

No description

Parameters

$name

Return Value

bool

protected ComponentContainer|null getCachedForm($name)

No description

Parameters

$name

Return Value

ComponentContainer|null

protected array getCachedForms()

No description

Return Value

array

protected Model|string|null getFormModel()

No description

Return Value

Model|string|null

protected array getFormSchema()

No description

Return Value

array

protected array getForms()

No description

Return Value

array

protected string|null getFormContext()

No description

Return Value

string|null

protected string|null getFormStatePath()

No description

Return Value

string|null

protected array getRules()

No description

Return Value

array

protected array getValidationAttributes()

No description

Return Value

array

protected ComponentContainer makeForm()

No description

Return Value

ComponentContainer