Filament\Forms\Concerns\InteractsWithForms

trait InteractsWithForms (View source)

Traits

WithFileUploads

Properties

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

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

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

ComponentContainer

makeForm()

No description

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

at line 29
`__get($property)`

No description

Parameters

$property

at line 46
`protected View|null getModalViewOnce()`

No description

Return Value

View|null

at line 59
`void dispatchFormEvent(...$args)`

No description

Parameters

...$args

Return Value

void

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

No description

Parameters

string

$statePath

Return Value

TemporaryUploadedFile|null

at line 71
`string|null getComponentFileAttachmentUrl(string $statePath)`

No description

Parameters

string

$statePath

Return Value

string|null

at line 84
`array getSelectOptionLabels(string $statePath)`

No description

Parameters

string

$statePath

Return Value

array

at line 97
`string|null getSelectOptionLabel(string $statePath)`

No description

Parameters

string

$statePath

Return Value

string|null

at line 110
`array getSelectOptions(string $statePath)`

No description

Parameters

string

$statePath

Return Value

array

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

No description

Parameters

string	$statePath
string	$search

Return Value

array

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

No description

Parameters

string	$statePath
string	$fileKey

Return Value

void

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

No description

Parameters

string

$statePath

Return Value

array|null

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

No description

Parameters

string	$statePath
string	$fileKey

Return Value

void

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

No description

Parameters

string	$statePath
array	$fileKeys

Return Value

void

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

No description

Parameters

	$rules
	$messages
	$attributes

at line 183
`protected void onValidationError(ValidationException $exception)`

No description

Parameters

ValidationException

$exception

Return Value

void

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

No description

Parameters

	$field
	$rules
	$messages
	$attributes

at line 200
`string|null getActiveFormLocale()`

No description

Return Value

string|null

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

No description

Parameters

	$name
	$value
	$callback

Return Value

void

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

at line 229
`protected array cacheForms()`

No description

Return Value

array

at line 247
`protected array getUncachedForms()`

No description

Return Value

array

at line 252
`protected array getTraitForms()`

No description

Return Value

array

at line 265
`protected bool hasCachedForm($name)`

No description

Parameters

$name

Return Value

bool

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

No description

Parameters

$name

Return Value

ComponentContainer|null

at line 275
`protected array getCachedForms()`

No description

Return Value

array

at line 284
`protected Model|string|null getFormModel()`

No description

Return Value

Model|string|null

at line 289
`protected array getFormSchema()`

No description

Return Value

array

at line 294
`protected array getForms()`

No description

Return Value

array

at line 305
`protected string|null getFormContext()`

No description

Return Value

string|null

at line 310
`protected string|null getFormStatePath()`

No description

Return Value

string|null

at line 315
`protected array getRules()`

No description

Return Value

array

at line 326
`protected array getValidationAttributes()`

No description

Return Value

array

at line 337
`protected ComponentContainer makeForm()`

No description

Return Value

ComponentContainer

InteractsWithForms

Traits

Properties

Methods

Details

in HasFormComponentActions at line 25 protected bool hasMountedFormComponentAction()

Return Value

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

Return Value

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

Parameters

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

Return Value

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

Parameters

in HasFormComponentActions at line 180 Component|null getMountedFormComponentActionComponent()

Return Value

in HasFormComponentActions at line 199 protected array getFormComponentActions()

Return Value

at line 29 __get($property)

Parameters

at line 46 protected View|null getModalViewOnce()

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

at line 84 array getSelectOptionLabels(string $statePath)

Parameters

Return Value

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

Parameters

Return Value

at line 110 array getSelectOptions(string $statePath)

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

at line 183 protected void onValidationError(ValidationException $exception)

Parameters

Return Value

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

Parameters

at line 200 string|null getActiveFormLocale()

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

at line 229 protected array cacheForms()

Return Value

at line 247 protected array getUncachedForms()

Return Value

at line 252 protected array getTraitForms()

Return Value

at line 265 protected bool hasCachedForm($name)

Parameters

Return Value

in HasFormComponentActions at line 25
`protected bool hasMountedFormComponentAction()`

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

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

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

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

in HasFormComponentActions at line 180
`Component|null getMountedFormComponentActionComponent()`

in HasFormComponentActions at line 199
`protected array getFormComponentActions()`

at line 29
`__get($property)`

at line 46
`protected View|null getModalViewOnce()`

at line 59
`void dispatchFormEvent(...$args)`

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

at line 71
`string|null getComponentFileAttachmentUrl(string $statePath)`

at line 84
`array getSelectOptionLabels(string $statePath)`

at line 97
`string|null getSelectOptionLabel(string $statePath)`

at line 110
`array getSelectOptions(string $statePath)`

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

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

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

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

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

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

at line 183
`protected void onValidationError(ValidationException $exception)`

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

at line 200
`string|null getActiveFormLocale()`

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

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

at line 229
`protected array cacheForms()`

at line 247
`protected array getUncachedForms()`

at line 252
`protected array getTraitForms()`

at line 265
`protected bool hasCachedForm($name)`

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

at line 275
`protected array getCachedForms()`

at line 284
`protected Model|string|null getFormModel()`

at line 289
`protected array getFormSchema()`

at line 294
`protected array getForms()`

at line 305
`protected string|null getFormContext()`

at line 310
`protected string|null getFormStatePath()`

at line 315
`protected array getRules()`

at line 326
`protected array getValidationAttributes()`

at line 337
`protected ComponentContainer makeForm()`