abstract class BasePage extends Component implements HasActions, HasForms, HasInfolists (View source)

Traits

Properties

string[] $mountedActions from  InteractsWithActions
array<string,array<string,mixed>> $mountedActionsArguments from  InteractsWithActions
array<string,array<string,mixed>> $mountedActionsData from  InteractsWithActions
mixed $defaultAction from  InteractsWithActions
mixed $defaultActionArguments from  InteractsWithActions
protected Action> $cachedActions from  InteractsWithActions
protected bool $hasActionsModalRendered from  InteractsWithActions
Form $mountedActionForm from  InteractsWithActions
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
protected bool $hasInfolistsModalRendered from  InteractsWithInfolists
protected Infolist> $cachedInfolists from  InteractsWithInfolists
string[] $mountedInfolistActions from  InteractsWithInfolists
array<string,array<string,mixed>> $mountedInfolistActionsData from  InteractsWithInfolists
string|null $mountedInfolistActionsComponent from  InteractsWithInfolists
string|null $mountedInfolistActionsInfolist from  InteractsWithInfolists
static protected string $layout
static protected string|null $title
protected string|null $heading
protected string|null $subheading
static protected string $view
static Closure|null $reportValidationErrorUsing
protected string|null $maxContentWidth
protected array $extraBodyAttributes
static Alignment $formActionsAlignment
static bool $formActionsAreSticky
static bool $hasInlineLabels

Methods

mixed
callMountedAction(array $arguments = [])

No description

void
afterActionCalled()

No description

mixed
mountAction(string $name, array $arguments = [])

No description

void
replaceMountedAction(string $name, array $arguments = [])

No description

bool
mountedActionShouldOpenModal(Action|null $mountedAction = null)

No description

bool
mountedActionHasForm(Action|null $mountedAction = null)

No description

cacheAction(Action $action)

No description

void
mergeCachedActions(array $actions)

No description

void
configureAction(Action $action)

No description

Action|null
getMountedAction()

No description

Form|null
getMountedActionForm(Action|null $mountedAction = null)

No description

Model|string|null
getMountedActionFormModel()

No description

Action|null
getAction(string|array $name)

No description

Action|null
getMountableModalActionFromAction(Action $action, array $modalActionNames)

No description

string|null
popMountedAction()

No description

void
unmountAction(bool $shouldCancelParentActions = true, bool $shouldCloseModal = true)

No description

void
cacheMountedActionForm(Action|null $mountedAction = null)

No description

void
closeActionModal()

No description

void
openActionModal()

No description

string|null
getActiveActionsLocale()

No description

mixed
callMountedFormComponentAction(array $arguments = [])

No description

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

No description

void
cacheMountedFormComponentActionForm(Action|null $mountedAction = null)

No description

bool
mountedFormComponentActionShouldOpenModal(Action|null $mountedAction = null)

No description

bool
mountedFormComponentActionHasForm(Action|null $mountedAction = null)

No description

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

No description

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

No description

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

No description

string|null
void
unmountFormComponentAction(bool $shouldCancelParentActions = true, bool $shouldCloseModal = true)

No description

void
closeFormComponentActionModal(bool $shouldCloseModal = true)

No description

mixed
__get(string $property)

No description

void
dispatchFormEvent(mixed ...$args)

No description

void
fillFormDataForTesting(array $state = [])

No description

void
unsetMissingNumericArrayKeys(array $target, array $state)

No description

TemporaryUploadedFile|null
getFormComponentFileAttachment(string $statePath)

No description

string|null
getFormComponentFileAttachmentUrl(string $statePath)

No description

array
getFormSelectOptionLabels(string $statePath)

No description

string|null
getFormSelectOptionLabel(string $statePath)

No description

array
getFormSelectOptions(string $statePath)

No description

array
getFormSelectSearchResults(string $statePath, string $search)

No description

void
deleteUploadedFile(string $statePath, string $fileKey)

No description

array|null
getFormUploadedFiles(string $statePath)

No description

void
removeFormUploadedFile(string $statePath, string $fileKey)

No description

void
reorderFormUploadedFiles(string $statePath, array $fileKeys)

No description

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

No description

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

void
onValidationError(ValidationException $exception)

No description

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

No description

string|null
TranslatableContentDriver|null
string|null
getActiveFormsLocale()

No description

void
updatingInteractsWithForms(string $statePath)

No description

mixed
getOldFormState(string $statePath)

No description

void
updatedInteractsWithForms(string $statePath)

No description

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

No description

array
cacheForms()

No description

array
getTraitForms()

No description

bool
hasCachedForm(string $name)

No description

Form|null
getForm(string $name)

No description

array
getCachedForms()

No description

array
getForms()

No description

form(Form $form)

No description

Model|string|null
getFormModel() deprecated

No description

array
getFormSchema() deprecated

No description

string|null
getFormContext() deprecated

No description

string|null
getFormStatePath() deprecated

No description

array
getRules()

No description

array
getValidationAttributes()

No description

makeForm()

No description

bool
isCachingForms()

No description

Infolist|null
getInfolist(string $name)

No description

cacheInfolist(string $name, Infolist $infolist)

No description

array
getCachedInfolists()

No description

bool
hasCachedInfolist(string $name)

No description

mixed
callMountedInfolistAction(array $arguments = [])

No description

mixed
mountInfolistAction(string $name, string|null $component = null, string|null $infolist = null)

No description

void
openInfolistActionModal()

No description

bool
mountedInfolistActionShouldOpenModal(Action|null $mountedAction = null)

No description

bool
mountedInfolistActionHasForm(Action|null $mountedAction = null)

No description

Action|null
getMountedInfolistAction()

No description

Component|null
Form|null
getMountedInfolistActionForm(Action|null $mountedAction = null)

No description

void
unmountInfolistAction(bool $shouldCancelParentActions = true, bool $shouldCloseModal = true)

No description

View
render()

No description

string
getView()

No description

string
getLayout()

No description

Htmlable
getHeading()

No description

Htmlable|null
getSubheading()

No description

Htmlable
getTitle()

No description

MaxWidth|string|null
getMaxContentWidth()

No description

array
getExtraBodyAttributes()

No description

array
getLayoutData()

No description

array
getViewData()

No description

void
halt()

No description

void
callHook(string $hook)

No description

static void
stickyFormActions(bool $condition = true)

No description

static void
alignFormActionsStart()

No description

static void
alignFormActionsCenter()

No description

static void
alignFormActionsEnd()

No description

static void
alignFormActionsLeft() deprecated

No description

static void
alignFormActionsRight() deprecated

No description

Alignment
getFormActionsAlignment()

No description

bool
areFormActionsSticky()

No description

bool
hasInlineLabels()

No description

static void
formActionsAlignment(Alignment $alignment)

No description

static void
inlineLabels(bool $condition = true)

No description

array
getRenderHookScopes()

No description

Details

mixed callMountedAction(array $arguments = [])

No description

Parameters

array $arguments

Return Value

mixed

protected void afterActionCalled()

No description

Return Value

void

mixed mountAction(string $name, array $arguments = [])

No description

Parameters

string $name
array $arguments

Return Value

mixed

void replaceMountedAction(string $name, array $arguments = [])

No description

Parameters

string $name
array $arguments

Return Value

void

bool mountedActionShouldOpenModal(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

bool mountedActionHasForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

Action cacheAction(Action $action)

No description

Parameters

Action $action

Return Value

Action

protected void mergeCachedActions(array $actions)

No description

Parameters

array $actions

Return Value

void

protected void configureAction(Action $action)

No description

Parameters

Action $action

Return Value

void

Action|null getMountedAction()

No description

Return Value

Action|null

protected array getInteractsWithActionsForms()

No description

Return Value

array

Form|null getMountedActionForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

Form|null

protected Model|string|null getMountedActionFormModel()

No description

Return Value

Model|string|null

Action|null getAction(string|array $name)

No description

Parameters

string|array $name

Return Value

Action|null

protected Action|null getMountableModalActionFromAction(Action $action, array $modalActionNames)

No description

Parameters

Action $action
array $modalActionNames

Return Value

Action|null

protected string|null popMountedAction()

No description

Return Value

string|null

protected void resetMountedActionProperties()

No description

Return Value

void

void unmountAction(bool $shouldCancelParentActions = true, bool $shouldCloseModal = true)

No description

Parameters

bool $shouldCancelParentActions
bool $shouldCloseModal

Return Value

void

protected void cacheMountedActionForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

void

protected void closeActionModal()

No description

Return Value

void

protected void openActionModal()

No description

Return Value

void

string|null getActiveActionsLocale()

No description

Return Value

string|null

Infolist mountedActionInfolist()

No description

Return Value

Infolist

mixed callMountedFormComponentAction(array $arguments = [])

No description

Parameters

array $arguments

Return Value

mixed

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

No description

Parameters

string $component
string $name
array $arguments

Return Value

mixed

protected void cacheMountedFormComponentActionForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

void

bool mountedFormComponentActionShouldOpenModal(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

bool mountedFormComponentActionHasForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

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

No description

Parameters

int|null $actionNestingIndex

Return Value

Action|null

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

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

No description

Parameters

int|null $actionNestingIndex

Return Value

Component|null

protected void resetMountedFormComponentActionProperties()

No description

Return Value

void

protected string|null popMountedFormComponentAction()

No description

Return Value

string|null

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

No description

Parameters

bool $shouldCancelParentActions
bool $shouldCloseModal

Return Value

void

protected void closeFormComponentActionModal(bool $shouldCloseModal = true)

No description

Parameters

bool $shouldCloseModal

Return Value

void

protected void openFormComponentActionModal()

No description

Return Value

void

mixed __get(string $property)

No description

Parameters

string $property

Return Value

mixed

Exceptions

PropertyNotFoundException

void dispatchFormEvent(mixed ...$args)

No description

Parameters

mixed ...$args

Return Value

void

void fillFormDataForTesting(array $state = [])

No description

Parameters

array $state

Return Value

void

protected void unsetMissingNumericArrayKeys(array $target, array $state)

No description

Parameters

array $target
array $state

Return Value

void

TemporaryUploadedFile|null getFormComponentFileAttachment(string $statePath)

No description

Parameters

string $statePath

Return Value

TemporaryUploadedFile|null

string|null getFormComponentFileAttachmentUrl(string $statePath)

No description

Parameters

string $statePath

Return Value

string|null

array getFormSelectOptionLabels(string $statePath)

No description

Parameters

string $statePath

Return Value

array

string|null getFormSelectOptionLabel(string $statePath)

No description

Parameters

string $statePath

Return Value

string|null

array getFormSelectOptions(string $statePath)

No description

Parameters

string $statePath

Return Value

array

array getFormSelectSearchResults(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 getFormUploadedFiles(string $statePath)

No description

Parameters

string $statePath

Return Value

array|null

void removeFormUploadedFile(string $statePath, string $fileKey)

No description

Parameters

string $statePath
string $fileKey

Return Value

void

void reorderFormUploadedFiles(string $statePath, array $fileKeys)

No description

Parameters

string $statePath
array $fileKeys

Return Value

void

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

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>

protected void onValidationError(ValidationException $exception)

No description

Parameters

ValidationException $exception

Return Value

void

protected array prepareForValidation(array<string,mixed> $attributes)

No description

Parameters

array<string,mixed> $attributes

Return Value

array

string|null getFilamentTranslatableContentDriver()

No description

Return Value

string|null

| null

TranslatableContentDriver|null makeFilamentTranslatableContentDriver()

No description

Return Value

TranslatableContentDriver|null

string|null getActiveFormsLocale()

No description

Return Value

string|null

void updatingInteractsWithForms(string $statePath)

No description

Parameters

string $statePath

Return Value

void

mixed getOldFormState(string $statePath)

No description

Parameters

string $statePath

Return Value

mixed

void updatedInteractsWithForms(string $statePath)

No description

Parameters

string $statePath

Return Value

void

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

No description

Parameters

string $name
Form|Closure|null $form

Return Value

Form|null

protected array cacheForms()

No description

Return Value

array

array getTraitForms()

No description

Return Value

array

protected bool hasCachedForm(string $name)

No description

Parameters

string $name

Return Value

bool

Form|null getForm(string $name)

No description

Parameters

string $name

Return Value

Form|null

array getCachedForms()

No description

Return Value

array

protected array getForms()

No description

Return Value

array

Form form(Form $form)

No description

Parameters

Form $form

Return Value

Form

protected Model|string|null getFormModel() deprecated

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

No description

Return Value

Model|string|null

protected array getFormSchema() deprecated

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

No description

Return Value

array

protected string|null getFormContext() deprecated

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

No description

Return Value

string|null

protected string|null getFormStatePath() deprecated

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

No description

Return Value

string|null

array getRules()

No description

Return Value

array

protected array getValidationAttributes()

No description

Return Value

array

protected Form makeForm()

No description

Return Value

Form

bool isCachingForms()

No description

Return Value

bool

Infolist mountedFormComponentActionInfolist()

No description

Return Value

Infolist

Infolist|null getInfolist(string $name)

No description

Parameters

string $name

Return Value

Infolist|null

Infolist cacheInfolist(string $name, Infolist $infolist)

No description

Parameters

string $name
Infolist $infolist

Return Value

Infolist

array getCachedInfolists()

No description

Return Value

array

protected bool hasCachedInfolist(string $name)

No description

Parameters

string $name

Return Value

bool

mixed callMountedInfolistAction(array $arguments = [])

No description

Parameters

array $arguments

Return Value

mixed

mixed mountInfolistAction(string $name, string|null $component = null, string|null $infolist = null)

No description

Parameters

string $name
string|null $component
string|null $infolist

Return Value

mixed

protected void openInfolistActionModal()

No description

Return Value

void

bool mountedInfolistActionShouldOpenModal(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

bool mountedInfolistActionHasForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

Action|null getMountedInfolistAction()

No description

Return Value

Action|null

Component|null getMountedInfolistActionComponent()

No description

Return Value

Component|null

Form|null getMountedInfolistActionForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

Form|null

void unmountInfolistAction(bool $shouldCancelParentActions = true, bool $shouldCloseModal = true)

No description

Parameters

bool $shouldCancelParentActions
bool $shouldCloseModal

Return Value

void

protected Infolist makeInfolist()

No description

Return Value

Infolist

protected array getInteractsWithInfolistsForms()

No description

Return Value

array

View render()

No description

Return Value

View

string getView()

No description

Return Value

string

string getLayout()

No description

Return Value

string

Htmlable getHeading()

No description

Return Value

Htmlable

Htmlable|null getSubheading()

No description

Return Value

Htmlable|null

Htmlable getTitle()

No description

Return Value

Htmlable

MaxWidth|string|null getMaxContentWidth()

No description

Return Value

MaxWidth|string|null

array getExtraBodyAttributes()

No description

Return Value

array

protected array getLayoutData()

No description

Return Value

array

protected array getViewData()

No description

Return Value

array

protected void halt()

No description

Return Value

void

protected void callHook(string $hook)

No description

Parameters

string $hook

Return Value

void

static void stickyFormActions(bool $condition = true)

No description

Parameters

bool $condition

Return Value

void

static void alignFormActionsStart()

No description

Return Value

void

static void alignFormActionsCenter()

No description

Return Value

void

static void alignFormActionsEnd()

No description

Return Value

void

static void alignFormActionsLeft() deprecated

deprecated Use `alignFormActionsStart()` instead

No description

Return Value

void

static void alignFormActionsRight() deprecated

deprecated Use `alignFormActionsEnd()` instead

No description

Return Value

void

Alignment getFormActionsAlignment()

No description

Return Value

Alignment

bool areFormActionsSticky()

No description

Return Value

bool

bool hasInlineLabels()

No description

Return Value

bool

static void formActionsAlignment(Alignment $alignment)

No description

Parameters

Alignment $alignment

Return Value

void

static void inlineLabels(bool $condition = true)

No description

Parameters

bool $condition

Return Value

void

array getRenderHookScopes()

No description

Return Value

array