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

FormsComponent

abstract class FormsComponent extends Component implements HasForms (View source)

Traits

InteractsWithForms
WithFileUploads
HasFormComponentActions

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

bool
hasMountedFormComponentAction()

No description

from  HasFormComponentActions
ComponentContainer|null
getMountedFormComponentActionForm()

No description

from  HasFormComponentActions
callMountedFormComponentAction(string|null $arguments = null)

No description

from  HasFormComponentActions
Action|Closure|null
getMountedFormComponentAction()

No description

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

No description

from  HasFormComponentActions
Component|null
getMountedFormComponentActionComponent()

No description

from  HasFormComponentActions
array
getFormComponentActions()

No description

from  HasFormComponentActions
__get($property)

No description

from  InteractsWithForms
View|null
getModalViewOnce()

No description

from  InteractsWithForms
void
dispatchFormEvent(...$args)

No description

from  InteractsWithForms
TemporaryUploadedFile|null
getComponentFileAttachment(string $statePath)

No description

from  InteractsWithForms
string|null
getComponentFileAttachmentUrl(string $statePath)

No description

from  InteractsWithForms
array
getSelectOptionLabels(string $statePath)

No description

from  InteractsWithForms
string|null
getSelectOptionLabel(string $statePath)

No description

from  InteractsWithForms
array
getSelectOptions(string $statePath)

No description

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

No description

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

No description

from  InteractsWithForms
array|null
getUploadedFileUrls(string $statePath)

No description

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

No description

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

No description

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

No description

from  InteractsWithForms
void
onValidationError(ValidationException $exception)

No description

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

No description

from  InteractsWithForms
string|null
getActiveFormLocale()

No description

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

No description

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

No description

from  InteractsWithForms
array
cacheForms()

No description

from  InteractsWithForms
array
getUncachedForms()

No description

from  InteractsWithForms
array
getTraitForms()

No description

from  InteractsWithForms
bool
hasCachedForm($name)

No description

from  InteractsWithForms
ComponentContainer|null
getCachedForm($name)

No description

from  InteractsWithForms
array
getCachedForms()

No description

from  InteractsWithForms
Model|string|null
getFormModel()

No description

from  InteractsWithForms
array
getFormSchema()

No description

from  InteractsWithForms
array
getForms()

No description

from  InteractsWithForms
string|null
getFormContext()

No description

from  InteractsWithForms
string|null
getFormStatePath()

No description

from  InteractsWithForms
array
getRules()

No description

from  InteractsWithForms
array
getValidationAttributes()

No description

from  InteractsWithForms
ComponentContainer
makeForm()

No description

from  InteractsWithForms

Details

in HasFormComponentActions at line 25
protected bool hasMountedFormComponentAction()

No description

Return Value

bool

in HasFormComponentActions at line 30
protected ComponentContainer|null getMountedFormComponentActionForm()

No description

Return Value

ComponentContainer|null

in HasFormComponentActions at line 49
callMountedFormComponentAction(string|null $arguments = null)

No description

Parameters

string|null $arguments

in HasFormComponentActions at line 107
Action|Closure|null getMountedFormComponentAction()

No description

Return Value

Action|Closure|null

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

No description

Parameters

string $component
string $name
array $arguments

in HasFormComponentActions at line 180
Component|null getMountedFormComponentActionComponent()

No description

Return Value

Component|null

in HasFormComponentActions at line 199
protected array getFormComponentActions()

No description

Return Value

array

in InteractsWithForms at line 29
__get($property)

No description

Parameters

$property

in InteractsWithForms at line 46
protected View|null getModalViewOnce()

No description

Return Value

View|null

in InteractsWithForms at line 59
void dispatchFormEvent(...$args)

No description

Parameters

...$args

Return Value

void

in InteractsWithForms at line 66
TemporaryUploadedFile|null getComponentFileAttachment(string $statePath)

No description

Parameters

string $statePath

Return Value

TemporaryUploadedFile|null

in InteractsWithForms at line 71
string|null getComponentFileAttachmentUrl(string $statePath)

No description

Parameters

string $statePath

Return Value

string|null

in InteractsWithForms at line 84
array getSelectOptionLabels(string $statePath)

No description

Parameters

string $statePath

Return Value

array

in InteractsWithForms at line 97
string|null getSelectOptionLabel(string $statePath)

No description

Parameters

string $statePath

Return Value

string|null

in InteractsWithForms at line 110
array getSelectOptions(string $statePath)

No description

Parameters

string $statePath

Return Value

array

in InteractsWithForms at line 123
array getSelectSearchResults(string $statePath, string $search)

No description

Parameters

string $statePath
string $search

Return Value

array

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

No description

Parameters

string $statePath
string $fileKey

Return Value

void

in InteractsWithForms at line 143
array|null getUploadedFileUrls(string $statePath)

No description

Parameters

string $statePath

Return Value

array|null

in InteractsWithForms at line 156
void removeUploadedFile(string $statePath, string $fileKey)

No description

Parameters

string $statePath
string $fileKey

Return Value

void

in InteractsWithForms at line 163
void reorderUploadedFiles(string $statePath, array $fileKeys)

No description

Parameters

string $statePath
array $fileKeys

Return Value

void

in InteractsWithForms at line 170
validate($rules = null, $messages = [], $attributes = [])

No description

Parameters

$rules
$messages
$attributes

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

No description

Parameters

ValidationException $exception

Return Value

void

in InteractsWithForms at line 187
validateOnly($field, $rules = null, $messages = [], $attributes = [])

No description

Parameters

$field
$rules
$messages
$attributes

in InteractsWithForms at line 200
string|null getActiveFormLocale()

No description

Return Value

string|null

in InteractsWithForms at line 205
protected void callBeforeAndAfterSyncHooks($name, $value, $callback)

No description

Parameters

$name
$value
$callback

Return Value

void

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

No description

Parameters

string $name
ComponentContainer|Closure|null $form

Return Value

ComponentContainer|null

in InteractsWithForms at line 229
protected array cacheForms()

No description

Return Value

array

in InteractsWithForms at line 247
protected array getUncachedForms()

No description

Return Value

array

in InteractsWithForms at line 252
protected array getTraitForms()

No description

Return Value

array

in InteractsWithForms at line 265
protected bool hasCachedForm($name)

No description

Parameters

$name

Return Value

bool

in InteractsWithForms at line 270
protected ComponentContainer|null getCachedForm($name)

No description

Parameters

$name

Return Value

ComponentContainer|null

in InteractsWithForms at line 275
protected array getCachedForms()

No description

Return Value

array

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

No description

Return Value

Model|string|null

in InteractsWithForms at line 289
protected array getFormSchema()

No description

Return Value

array

in InteractsWithForms at line 294
protected array getForms()

No description

Return Value

array

in InteractsWithForms at line 305
protected string|null getFormContext()

No description

Return Value

string|null

in InteractsWithForms at line 310
protected string|null getFormStatePath()

No description

Return Value

string|null

in InteractsWithForms at line 315
protected array getRules()

No description

Return Value

array

in InteractsWithForms at line 326
protected array getValidationAttributes()

No description

Return Value

array

in InteractsWithForms at line 337
protected ComponentContainer makeForm()

No description

Return Value

ComponentContainer