1. class
  2. Filament
  3. \
  4. Forms
  5. \
  6. FormsComponent

FormsComponent

abstract class FormsComponent extends Component implements HasForms (View source)

Traits

InteractsWithForms
HasFormComponentActions
ResolvesDynamicLivewireProperties
WithFileUploads

Properties

string[] $mountedFormComponentActions from  HasFormComponentActions
array<string,array<string,mixed>> $mountedFormComponentActionsArguments from  HasFormComponentActions
array<string,array<string,mixed>> $mountedFormComponentActionsData from  HasFormComponentActions
string[] $mountedFormComponentActionsComponents from  HasFormComponentActions
ComponentContainer $mountedFormComponentActionForm from  HasFormComponentActions
array $componentFileAttachments from  InteractsWithForms
protected Form> $cachedForms from  InteractsWithForms
protected bool $hasCachedForms from  InteractsWithForms
protected bool $isCachingForms from  InteractsWithForms
protected bool $hasFormsModalRendered from  InteractsWithForms
protected array<string,mixed> $oldFormState from  InteractsWithForms

Methods

mixed
callMountedFormComponentAction(array $arguments = [])

No description

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

No description

from  HasFormComponentActions
void
cacheMountedFormComponentActionForm(Action|null $mountedAction = null)

No description

from  HasFormComponentActions
bool
mountedFormComponentActionShouldOpenModal(Action|null $mountedAction = null)

No description

from  HasFormComponentActions
bool
mountedFormComponentActionHasForm(Action|null $mountedAction = null)

No description

from  HasFormComponentActions
Action|null
getMountedFormComponentAction(int|null $actionNestingIndex = null)

No description

from  HasFormComponentActions
Form|null
getMountedFormComponentActionForm(int|null $actionNestingIndex = null, Action|null $mountedAction = null)

No description

from  HasFormComponentActions
Component|null
getMountedFormComponentActionComponent(int|null $actionNestingIndex = null)

No description

from  HasFormComponentActions
void
resetMountedFormComponentActionProperties()

No description

from  HasFormComponentActions
string|null
popMountedFormComponentAction()

No description

from  HasFormComponentActions
void
unmountFormComponentAction(bool $shouldCancelParentActions = true, bool $shouldCloseModal = true)

No description

from  HasFormComponentActions
void
closeFormComponentActionModal(bool $shouldCloseModal = true)

No description

from  HasFormComponentActions
void
openFormComponentActionModal()

No description

from  HasFormComponentActions
mixed
__get(string $property)

No description

from  ResolvesDynamicLivewireProperties
void
dispatchFormEvent(mixed ...$args)

No description

from  InteractsWithForms
void
fillFormDataForTesting(array $state = [])

No description

from  InteractsWithForms
void
unsetMissingNumericArrayKeys(array $target, array $state)

No description

from  InteractsWithForms
TemporaryUploadedFile|null
getFormComponentFileAttachment(string $statePath)

No description

from  InteractsWithForms
string|null
getFormComponentFileAttachmentUrl(string $statePath)

No description

from  InteractsWithForms
array
getFormSelectOptionLabels(string $statePath)

No description

from  InteractsWithForms
string|null
getFormSelectOptionLabel(string $statePath)

No description

from  InteractsWithForms
array
getFormSelectOptions(string $statePath)

No description

from  InteractsWithForms
array
getFormSelectSearchResults(string $statePath, string $search)

No description

from  InteractsWithForms
void
deleteUploadedFile(string $statePath, string $fileKey)

No description

from  InteractsWithForms
array|null
getFormUploadedFiles(string $statePath)

No description

from  InteractsWithForms
void
removeFormUploadedFile(string $statePath, string $fileKey)

No description

from  InteractsWithForms
void
reorderFormUploadedFiles(string $statePath, array $fileKeys)

No description

from  InteractsWithForms
array
validate($rules = null, array<string,string> $messages = [], array<string,string> $attributes = [])

No description

from  InteractsWithForms
array<string,mixed>
validateOnly(string $field, array<string,array> $rules = null, array<string,string> $messages = [], array<string,string> $attributes = [], array<string,string> $dataOverrides = [])

No description

from  InteractsWithForms
void
onValidationError(ValidationException $exception)

No description

from  InteractsWithForms
array
prepareForValidation(array<string,mixed> $attributes)

No description

from  InteractsWithForms
string|null
getFilamentTranslatableContentDriver()

No description

from  InteractsWithForms
TranslatableContentDriver|null
makeFilamentTranslatableContentDriver()

No description

from  InteractsWithForms
string|null
getActiveFormsLocale()

No description

from  InteractsWithForms
void
updatingInteractsWithForms(string $statePath)

No description

from  InteractsWithForms
mixed
getOldFormState(string $statePath)

No description

from  InteractsWithForms
void
updatedInteractsWithForms(string $statePath)

No description

from  InteractsWithForms
Form|null
cacheForm(string $name, Form|Closure|null $form)

No description

from  InteractsWithForms
array
cacheForms()

No description

from  InteractsWithForms
array
getTraitForms()

No description

from  InteractsWithForms
bool
hasCachedForm(string $name)

No description

from  InteractsWithForms
Form|null
getForm(string $name)

No description

from  InteractsWithForms
array
getCachedForms()

No description

from  InteractsWithForms
array
getForms()

No description

from  InteractsWithForms
Form
form(Form $form)

No description

from  InteractsWithForms
Model|string|null
getFormModel() deprecated

No description

from  InteractsWithForms
array
getFormSchema() deprecated

No description

from  InteractsWithForms
string|null
getFormContext() deprecated

No description

from  InteractsWithForms
string|null
getFormStatePath() deprecated

No description

from  InteractsWithForms
array
getRules()

No description

from  InteractsWithForms
array
getValidationAttributes()

No description

from  InteractsWithForms
Form
makeForm()

No description

from  InteractsWithForms
bool
isCachingForms()

No description

from  InteractsWithForms
Infolist
mountedFormComponentActionInfolist()

No description

from  InteractsWithForms

Details

in HasFormComponentActions at line 44
mixed callMountedFormComponentAction(array $arguments = [])

No description

Parameters

array $arguments

Return Value

mixed

in HasFormComponentActions at line 128
mixed mountFormComponentAction(string $component, string $name, array $arguments = [])

No description

Parameters

string $component
string $name
array $arguments

Return Value

mixed

in HasFormComponentActions at line 184
protected void cacheMountedFormComponentActionForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

void

in HasFormComponentActions at line 192
bool mountedFormComponentActionShouldOpenModal(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

in HasFormComponentActions at line 199
bool mountedFormComponentActionHasForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

in HasFormComponentActions at line 204
Action|null getMountedFormComponentAction(int|null $actionNestingIndex = null)

No description

Parameters

int|null $actionNestingIndex

Return Value

Action|null

in HasFormComponentActions at line 218
protected Form|null getMountedFormComponentActionForm(int|null $actionNestingIndex = null, Action|null $mountedAction = null)

No description

Parameters

int|null $actionNestingIndex
Action|null $mountedAction

Return Value

Form|null

in HasFormComponentActions at line 240
Component|null getMountedFormComponentActionComponent(int|null $actionNestingIndex = null)

No description

Parameters

int|null $actionNestingIndex

Return Value

Component|null

in HasFormComponentActions at line 262
protected void resetMountedFormComponentActionProperties()

No description

Return Value

void

in HasFormComponentActions at line 270
protected string|null popMountedFormComponentAction()

No description

Return Value

string|null

in HasFormComponentActions at line 281
void unmountFormComponentAction(bool $shouldCancelParentActions = true, bool $shouldCloseModal = true)

No description

Parameters

bool $shouldCancelParentActions
bool $shouldCloseModal

Return Value

void

in HasFormComponentActions at line 315
protected void closeFormComponentActionModal(bool $shouldCloseModal = true)

No description

Parameters

bool $shouldCloseModal

Return Value

void

in HasFormComponentActions at line 324
protected void openFormComponentActionModal()

No description

Return Value

void

in ResolvesDynamicLivewireProperties at line 17
mixed __get(string $property)

No description

Parameters

string $property

Return Value

mixed

Exceptions

PropertyNotFoundException

in InteractsWithForms at line 46
void dispatchFormEvent(mixed ...$args)

No description

Parameters

mixed ...$args

Return Value

void

in InteractsWithForms at line 56
void fillFormDataForTesting(array $state = [])

No description

Parameters

array $state

Return Value

void

in InteractsWithForms at line 83
protected void unsetMissingNumericArrayKeys(array $target, array $state)

No description

Parameters

array $target
array $state

Return Value

void

in InteractsWithForms at line 98
TemporaryUploadedFile|null getFormComponentFileAttachment(string $statePath)

No description

Parameters

string $statePath

Return Value

TemporaryUploadedFile|null

in InteractsWithForms at line 103
string|null getFormComponentFileAttachmentUrl(string $statePath)

No description

Parameters

string $statePath

Return Value

string|null

in InteractsWithForms at line 118
array getFormSelectOptionLabels(string $statePath)

No description

Parameters

string $statePath

Return Value

array

in InteractsWithForms at line 130
string|null getFormSelectOptionLabel(string $statePath)

No description

Parameters

string $statePath

Return Value

string|null

in InteractsWithForms at line 145
array getFormSelectOptions(string $statePath)

No description

Parameters

string $statePath

Return Value

array

in InteractsWithForms at line 160
array getFormSelectSearchResults(string $statePath, string $search)

No description

Parameters

string $statePath
string $search

Return Value

array

in InteractsWithForms at line 172
void deleteUploadedFile(string $statePath, string $fileKey)

No description

Parameters

string $statePath
string $fileKey

Return Value

void

in InteractsWithForms at line 182
array|null getFormUploadedFiles(string $statePath)

No description

Parameters

string $statePath

Return Value

array|null

in InteractsWithForms at line 194
void removeFormUploadedFile(string $statePath, string $fileKey)

No description

Parameters

string $statePath
string $fileKey

Return Value

void

in InteractsWithForms at line 201
void reorderFormUploadedFiles(string $statePath, array $fileKeys)

No description

Parameters

string $statePath
array $fileKeys

Return Value

void

in InteractsWithForms at line 214
array validate($rules = null, array<string,string> $messages = [], array<string,string> $attributes = [])

No description

Parameters

$rules
array<string,string> $messages
array<string,string> $attributes

Return Value

array

in InteractsWithForms at line 235
array<string,mixed> validateOnly(string $field, array<string,array> $rules = null, array<string,string> $messages = [], array<string,string> $attributes = [], array<string,string> $dataOverrides = [])

No description

Parameters

string $field
array<string,array> $rules
array<string,string> $messages
array<string,string> $attributes
array<string,string> $dataOverrides

Return Value

array<string,mixed>

in InteractsWithForms at line 248
protected void onValidationError(ValidationException $exception)

No description

Parameters

ValidationException $exception

Return Value

void

in InteractsWithForms at line 254
protected array prepareForValidation(array<string,mixed> $attributes)

No description

Parameters

array<string,mixed> $attributes

Return Value

array

in InteractsWithForms at line 266
string|null getFilamentTranslatableContentDriver()

No description

Return Value

string|null

| null

in InteractsWithForms at line 271
TranslatableContentDriver|null makeFilamentTranslatableContentDriver()

No description

Return Value

TranslatableContentDriver|null

in InteractsWithForms at line 282
string|null getActiveFormsLocale()

No description

Return Value

string|null

in InteractsWithForms at line 287
void updatingInteractsWithForms(string $statePath)

No description

Parameters

string $statePath

Return Value

void

in InteractsWithForms at line 295
mixed getOldFormState(string $statePath)

No description

Parameters

string $statePath

Return Value

mixed

in InteractsWithForms at line 300
void updatedInteractsWithForms(string $statePath)

No description

Parameters

string $statePath

Return Value

void

in InteractsWithForms at line 307
protected Form|null cacheForm(string $name, Form|Closure|null $form)

No description

Parameters

string $name
Form|Closure|null $form

Return Value

Form|null

in InteractsWithForms at line 327
protected array cacheForms()

No description

Return Value

array

in InteractsWithForms at line 370
array getTraitForms()

No description

Return Value

array

in InteractsWithForms at line 386
protected bool hasCachedForm(string $name)

No description

Parameters

string $name

Return Value

bool

in InteractsWithForms at line 391
Form|null getForm(string $name)

No description

Parameters

string $name

Return Value

Form|null

in InteractsWithForms at line 399
array getCachedForms()

No description

Return Value

array

in InteractsWithForms at line 411
protected array getForms()

No description

Return Value

array

in InteractsWithForms at line 418
Form form(Form $form)

No description

Parameters

Form $form

Return Value

Form

in InteractsWithForms at line 430
protected Model|string|null getFormModel() deprecated

deprecated Override the `form()` method to configure the default form.

No description

Return Value

Model|string|null

in InteractsWithForms at line 440
protected array getFormSchema() deprecated

deprecated Override the `form()` method to configure the default form.

No description

Return Value

array

in InteractsWithForms at line 448
protected string|null getFormContext() deprecated

deprecated Override the `form()` method to configure the default form.

No description

Return Value

string|null

in InteractsWithForms at line 456
protected string|null getFormStatePath() deprecated

deprecated Override the `form()` method to configure the default form.

No description

Return Value

string|null

in InteractsWithForms at line 464
array getRules()

No description

Return Value

array

in InteractsWithForms at line 481
protected array getValidationAttributes()

No description

Return Value

array

in InteractsWithForms at line 495
protected Form makeForm()

No description

Return Value

Form

in InteractsWithForms at line 500
bool isCachingForms()

No description

Return Value

bool

in InteractsWithForms at line 505
Infolist mountedFormComponentActionInfolist()

No description

Return Value

Infolist