1. trait
  2. Filament
  3. \
  4. Forms
  5. \
  6. Components
  7. \
  8. Concerns
  9. \
  10. HasState

HasState

trait HasState (View source)

Properties

protected Closure|null $afterStateHydrated
protected Closure[] $afterStateUpdated
protected Closure|null $beforeStateDehydrated
protected mixed $defaultState
protected Closure|null $dehydrateStateUsing
protected Closure|null $mutateDehydratedStateUsing
protected Closure|null $mutateStateForValidationUsing
protected bool $hasDefaultState
protected bool|Closure $isDehydrated
protected bool|Closure $isDehydratedWhenHidden
protected string|null $statePath
protected string $cachedAbsoluteStatePath
protected string $stripCharacters
protected string[] $cachedStripCharacters

Methods

HasState
afterStateHydrated(Closure|null $callback)

No description

HasState
clearAfterStateUpdatedHooks()

No description

HasState
afterStateUpdated(Closure|null $callback)

No description

HasState
beforeStateDehydrated(Closure|null $callback)

No description

HasState
callAfterStateHydrated()

No description

HasState
callAfterStateUpdated()

No description

void
callAfterStateUpdatedHook(Closure $hook)

No description

HasState
callBeforeStateDehydrated()

No description

HasState
default(mixed $state)

No description

HasState
dehydrated(bool|Closure $condition = true)

No description

HasState
dehydratedWhenHidden(bool|Closure $condition = true)

No description

HasState
formatStateUsing(Closure|null $callback)

No description

array
getStateToDehydrate()

No description

void
dehydrateState(array $state, bool $isDehydrated = true)

No description

HasState
dehydrateStateUsing(Closure|null $callback)

No description

void
hydrateState(array|null $hydratedDefaultState, bool $andCallHydrationHooks = true)

No description

void
fill()

No description

void
hydrateDefaultState(array|null $hydratedDefaultState)

No description

void
fillStateWithNull()

No description

mixed
mutateDehydratedState(mixed $state)

No description

mixed
mutateStateForValidation(mixed $state)

No description

mixed
stripCharactersFromState(mixed $state)

No description

bool
mutatesDehydratedState()

No description

bool
mutatesStateForValidation()

No description

bool
hasStripCharacters()

No description

HasState
mutateDehydratedStateUsing(Closure|null $callback)

No description

HasState
mutateStateForValidationUsing(Closure|null $callback)

No description

HasState
state(mixed $state)

No description

HasState
statePath(string|null $path)

No description

mixed
getDefaultState()

No description

mixed
getState()

No description

mixed
getOldState()

No description

string
getStatePath(bool $isAbsolute = true)

No description

bool
hasStatePath()

No description

bool
hasDefaultState()

No description

bool
isDehydrated()

No description

bool
isDehydratedWhenHidden()

No description

bool
isHiddenAndNotDehydrated()

No description

Get
getGetCallback()

No description

Set
getSetCallback()

No description

string
generateRelativeStatePath(Component $path = '', bool $isAbsolute = false)

No description

void
flushCachedAbsoluteStatePath()

No description

HasState
stripCharacters(string|array|Closure|null $characters)

No description

array
getStripCharacters()

No description

Details

at line 55
HasState afterStateHydrated(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

at line 62
HasState clearAfterStateUpdatedHooks()

No description

Return Value

HasState

at line 69
HasState afterStateUpdated(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

at line 76
HasState beforeStateDehydrated(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

at line 83
HasState callAfterStateHydrated()

No description

Return Value

HasState

at line 92
HasState callAfterStateUpdated()

No description

Return Value

HasState

at line 109
protected void callAfterStateUpdatedHook(Closure $hook)

No description

Parameters

Closure $hook

Return Value

void

at line 116
HasState callBeforeStateDehydrated()

No description

Return Value

HasState

at line 125
HasState default(mixed $state)

No description

Parameters

mixed $state

Return Value

HasState

at line 133
HasState dehydrated(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasState

at line 140
HasState dehydratedWhenHidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasState

at line 147
HasState formatStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

at line 157
array getStateToDehydrate()

No description

Return Value

array

at line 169
void dehydrateState(array $state, bool $isDehydrated = true)

No description

Parameters

array $state
bool $isDehydrated

Return Value

void

at line 204
HasState dehydrateStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

at line 214
void hydrateState(array|null $hydratedDefaultState, bool $andCallHydrationHooks = true)

No description

Parameters

array|null $hydratedDefaultState
bool $andCallHydrationHooks

Return Value

void

at line 227
void fill()

No description

Return Value

void

at line 237
void hydrateDefaultState(array|null $hydratedDefaultState)

No description

Parameters

array|null $hydratedDefaultState

Return Value

void

at line 272
void fillStateWithNull()

No description

Return Value

void

at line 283
mixed mutateDehydratedState(mixed $state)

No description

Parameters

mixed $state

Return Value

mixed

at line 297
mixed mutateStateForValidation(mixed $state)

No description

Parameters

mixed $state

Return Value

mixed

at line 311
protected mixed stripCharactersFromState(mixed $state)

No description

Parameters

mixed $state

Return Value

mixed

at line 326
bool mutatesDehydratedState()

No description

Return Value

bool

at line 331
bool mutatesStateForValidation()

No description

Return Value

bool

at line 336
bool hasStripCharacters()

No description

Return Value

bool

at line 341
HasState mutateDehydratedStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

at line 348
HasState mutateStateForValidationUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

at line 355
HasState state(mixed $state)

No description

Parameters

mixed $state

Return Value

HasState

at line 364
HasState statePath(string|null $path)

No description

Parameters

string|null $path

Return Value

HasState

at line 371
mixed getDefaultState()

No description

Return Value

mixed

at line 376
mixed getState()

No description

Return Value

mixed

at line 391
mixed getOldState()

No description

Return Value

mixed

at line 406
string getStatePath(bool $isAbsolute = true)

No description

Parameters

bool $isAbsolute

Return Value

string

at line 429
bool hasStatePath()

No description

Return Value

bool

at line 434
protected bool hasDefaultState()

No description

Return Value

bool

at line 439
bool isDehydrated()

No description

Return Value

bool

at line 444
bool isDehydratedWhenHidden()

No description

Return Value

bool

at line 449
bool isHiddenAndNotDehydrated()

No description

Return Value

bool

at line 458
Get getGetCallback()

No description

Return Value

Get

at line 463
Set getSetCallback()

No description

Return Value

Set

at line 468
string generateRelativeStatePath(Component $path = '', bool $isAbsolute = false)

No description

Parameters

Component $path
bool $isAbsolute

Return Value

string

at line 495
protected void flushCachedAbsoluteStatePath()

No description

Return Value

void

at line 503
HasState stripCharacters(string|array|Closure|null $characters)

No description

Parameters

string|array|Closure|null $characters

Return Value

HasState

at line 513
array getStripCharacters()

No description

Return Value

array