1. class
  2. Filament
  3. \
  4. Resources
  5. \
  6. Pages
  7. \
  8. Page

Page

abstract class Page extends Page (View source)

Traits

CanAuthorizeResourceAccess
CanAuthorizeAccess
HasRoutes
HasSubNavigation
InteractsWithHeaderActions
InteractsWithActions
InteractsWithForms
InteractsWithInfolists
HasFormComponentActions
ResolvesDynamicLivewireProperties
WithFileUploads

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 from  Page
static protected string|null $title from  BasePage
protected string|null $heading from  BasePage
protected string|null $subheading from  BasePage
static protected string $view from  BasePage
static Closure|null $reportValidationErrorUsing from  BasePage
protected string|null $maxContentWidth from  BasePage
protected array $extraBodyAttributes from  BasePage
static Alignment $formActionsAlignment from  BasePage
static bool $formActionsAreSticky from  BasePage
static bool $hasInlineLabels from  BasePage
static protected string|null $slug from  HasRoutes
static protected string $routeMiddleware from  HasRoutes
static protected string $withoutRouteMiddleware from  HasRoutes
protected NavigationGroup[] $cachedSubNavigation from  HasSubNavigation
static protected SubNavigationPosition $subNavigationPosition from  HasSubNavigation
protected array $cachedHeaderActions from  InteractsWithHeaderActions
static protected Cluster> $cluster from  Page
static protected bool $isDiscovered
static protected string|null $navigationGroup from  Page
static protected string|null $navigationBadgeTooltip from  Page
static protected string|null $navigationParentItem from  Page
static protected string|null $navigationIcon from  Page
static protected string|null $activeNavigationIcon from  Page
static protected string|null $navigationLabel from  Page
static protected int|null $navigationSort from  Page
static protected bool $shouldRegisterNavigation from  Page
static protected string|null $breadcrumb
static protected string $resource

Methods

mixed
callMountedAction(array $arguments = [])

No description

from  InteractsWithActions
void
afterActionCalled()

No description

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

No description

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

No description

from  InteractsWithActions
bool
mountedActionShouldOpenModal(Action|null $mountedAction = null)

No description

from  InteractsWithActions
bool
mountedActionHasForm(Action|null $mountedAction = null)

No description

from  InteractsWithActions
Action
cacheAction(Action $action)

No description

from  InteractsWithActions
void
mergeCachedActions(array $actions)

No description

from  InteractsWithActions
void
configureAction(Action $action)

No description

from  InteractsWithActions
Action|null
getMountedAction()

No description

from  InteractsWithActions
array
getInteractsWithActionsForms()

No description

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

No description

from  InteractsWithActions
Model|string|null
getMountedActionFormModel()

No description

from  InteractsWithActions
Action|null
getAction(string|array $name)

No description

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

No description

from  InteractsWithActions
string|null
popMountedAction()

No description

from  InteractsWithActions
void
resetMountedActionProperties()

No description

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

No description

from  InteractsWithActions
void
cacheMountedActionForm(Action|null $mountedAction = null)

No description

from  InteractsWithActions
void
closeActionModal()

No description

from  InteractsWithActions
void
openActionModal()

No description

from  InteractsWithActions
string|null
getActiveActionsLocale()

No description

from  InteractsWithActions
Infolist
mountedActionInfolist()

No description

from  InteractsWithActions
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
Infolist|null
getInfolist(string $name)

No description

from  InteractsWithInfolists
Infolist
cacheInfolist(string $name, Infolist $infolist)

No description

from  InteractsWithInfolists
array
getCachedInfolists()

No description

from  InteractsWithInfolists
bool
hasCachedInfolist(string $name)

No description

from  InteractsWithInfolists
mixed
callMountedInfolistAction(array $arguments = [])

No description

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

No description

from  InteractsWithInfolists
void
openInfolistActionModal()

No description

from  InteractsWithInfolists
bool
mountedInfolistActionShouldOpenModal(Action|null $mountedAction = null)

No description

from  InteractsWithInfolists
bool
mountedInfolistActionHasForm(Action|null $mountedAction = null)

No description

from  InteractsWithInfolists
Action|null
getMountedInfolistAction()

No description

from  InteractsWithInfolists
Component|null
getMountedInfolistActionComponent()

No description

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

No description

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

No description

from  InteractsWithInfolists
Infolist
makeInfolist()

No description

from  InteractsWithInfolists
array
getInteractsWithInfolistsForms()

No description

from  InteractsWithInfolists
View
render()

No description

from  BasePage
string
getView()

No description

from  BasePage
string
getLayout()

No description

from  Page
Htmlable
getHeading()

No description

from  BasePage
Htmlable|null
getSubheading()

No description

from  BasePage
Htmlable
getTitle()

No description

from  BasePage
MaxWidth|string|null
getMaxContentWidth()

No description

from  BasePage
array
getExtraBodyAttributes()

No description

from  BasePage
array
getLayoutData()

No description

from  BasePage
array
getViewData()

No description

from  BasePage
void
halt()

No description

from  BasePage
void
callHook(string $hook)

No description

from  BasePage
static void
stickyFormActions(bool $condition = true)

No description

from  BasePage
static void
alignFormActionsStart()

No description

from  BasePage
static void
alignFormActionsCenter()

No description

from  BasePage
static void
alignFormActionsEnd()

No description

from  BasePage
static void
alignFormActionsLeft() deprecated

No description

from  BasePage
static void
alignFormActionsRight() deprecated

No description

from  BasePage
Alignment
getFormActionsAlignment()

No description

from  BasePage
bool
areFormActionsSticky()

No description

from  BasePage
bool
hasInlineLabels()

No description

from  BasePage
static void
formActionsAlignment(Alignment $alignment)

No description

from  BasePage
static void
inlineLabels(bool $condition = true)

No description

from  BasePage
array
getRenderHookScopes()

No description

void
mountCanAuthorizeAccess()

No description

from  CanAuthorizeAccess
static bool
canAccess(array $parameters = [])

No description

static void
registerRoutes(Panel $panel)

No description

from  HasRoutes
static void
routes(Panel $panel)

No description

from  HasRoutes
static string
getRoutePath()

No description

from  HasRoutes
static string
getRelativeRouteName()

No description

from  HasRoutes
static string
getSlug()

No description

from  HasRoutes
static string|array
getRouteMiddleware(Panel $panel)

No description

from  HasRoutes
static string|array
getWithoutRouteMiddleware(Panel $panel)

No description

from  HasRoutes
static string
getEmailVerifiedMiddleware(Panel $panel)

No description

static bool
isEmailVerificationRequired(Panel $panel)

No description

static string
getTenantSubscribedMiddleware(Panel $panel)

No description

static bool
isTenantSubscriptionRequired(Panel $panel)

No description

array
getSubNavigation()

No description

SubNavigationPosition
getSubNavigationPosition()

No description

array
getCachedSubNavigation()

No description

from  HasSubNavigation
array
generateNavigationItems(array $components)

No description

from  HasSubNavigation
array
getSubNavigationParameters()

No description

from  HasSubNavigation
void
bootedInteractsWithHeaderActions()

No description

from  InteractsWithHeaderActions
void
cacheHeaderActions()

No description

from  InteractsWithHeaderActions
array
getCachedHeaderActions()

No description

from  InteractsWithHeaderActions
array
getHeaderActions()

No description

from  InteractsWithHeaderActions
array
getActions() deprecated

No description

from  InteractsWithHeaderActions
static string
getUrl(array $parameters = [], bool $isAbsolute = true, string|null $panel = null, Model|null $tenant = null)

No description

static void
registerNavigationItems()

No description

from  Page
static array
getNavigationItems(array $urlParameters = [])

No description

static string
getNavigationItemActiveRoutePattern()

No description

from  Page
static string
getRouteName(string|null $panel = null)

No description

array
getBreadcrumbs()

No description

static string|null
getNavigationGroup()

No description

from  Page
static string|null
getNavigationParentItem()

No description

from  Page
static Htmlable|null
getActiveNavigationIcon()

No description

from  Page
static Htmlable|null
getNavigationIcon()

No description

from  Page
static string
getNavigationLabel()

No description

from  Page
static string|null
getNavigationBadge()

No description

from  Page
static string|array|null
getNavigationBadgeColor()

No description

from  Page
static string|null
getNavigationBadgeTooltip()

No description

from  Page
static int|null
getNavigationSort()

No description

from  Page
static string
getNavigationUrl(array $parameters = [])

No description

View|null
getFooter()

No description

from  Page
View|null
getHeader()

No description

from  Page
array
getHeaderWidgets()

No description

from  Page
array
getVisibleHeaderWidgets()

No description

from  Page
int|string|array
getHeaderWidgetsColumns()

No description

from  Page
array
getFooterWidgets()

No description

from  Page
array
getVisibleFooterWidgets()

No description

from  Page
array
filterVisibleWidgets(array $widgets)

No description

from  Page
string
normalizeWidgetClass(WidgetConfiguration $widget)

No description

from  Page
int|string|array
getFooterWidgetsColumns()

No description

from  Page
array
getWidgetData()

No description

from  Page
static bool
shouldRegisterNavigation(array $parameters = [])

No description

static bool
isDiscovered()

No description

from  Page
static string|null
getCluster()

No description

static string
prependClusterSlug(string $slug)

No description

from  Page
static string
prependClusterRouteBaseName(string $name)

No description

from  Page
void
mountCanAuthorizeResourceAccess()

No description

from  CanAuthorizeResourceAccess
static void
authorizeResourceAccess()

No description

from  CanAuthorizeResourceAccess
static string
getResourcePageName()

No description

static PageRegistration
route(string $path)

No description

string|null
getBreadcrumb()

No description

string
getModel()

No description

static string
getResource()

No description

Details

in InteractsWithActions at line 61
mixed callMountedAction(array $arguments = [])

No description

Parameters

array $arguments

Return Value

mixed

in InteractsWithActions at line 154
protected void afterActionCalled()

No description

Return Value

void

in InteractsWithActions at line 159
mixed mountAction(string $name, array $arguments = [])

No description

Parameters

string $name
array $arguments

Return Value

mixed

in InteractsWithActions at line 217
void replaceMountedAction(string $name, array $arguments = [])

No description

Parameters

string $name
array $arguments

Return Value

void

in InteractsWithActions at line 223
bool mountedActionShouldOpenModal(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

in InteractsWithActions at line 230
bool mountedActionHasForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

in InteractsWithActions at line 235
Action cacheAction(Action $action)

No description

Parameters

Action $action

Return Value

Action

in InteractsWithActions at line 245
protected void mergeCachedActions(array $actions)

No description

Parameters

array $actions

Return Value

void

in InteractsWithActions at line 253
protected void configureAction(Action $action)

No description

Parameters

Action $action

Return Value

void

in InteractsWithActions at line 255
Action|null getMountedAction()

No description

Return Value

Action|null

in InteractsWithActions at line 267
protected array getInteractsWithActionsForms()

No description

Return Value

array

in InteractsWithActions at line 274
Form|null getMountedActionForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

Form|null

in InteractsWithActions at line 294
protected Model|string|null getMountedActionFormModel()

No description

Return Value

Model|string|null

in InteractsWithActions at line 302
Action|null getAction(string|array $name)

No description

Parameters

string|array $name

Return Value

Action|null

in InteractsWithActions at line 351
protected Action|null getMountableModalActionFromAction(Action $action, array $modalActionNames)

No description

Parameters

Action $action
array $modalActionNames

Return Value

Action|null

in InteractsWithActions at line 384
protected string|null popMountedAction()

No description

Return Value

string|null

in InteractsWithActions at line 394
protected void resetMountedActionProperties()

No description

Return Value

void

in InteractsWithActions at line 401
void unmountAction(bool $shouldCancelParentActions = true, bool $shouldCloseModal = true)

No description

Parameters

bool $shouldCancelParentActions
bool $shouldCloseModal

Return Value

void

in InteractsWithActions at line 446
protected void cacheMountedActionForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

void

in InteractsWithActions at line 454
protected void closeActionModal()

No description

Return Value

void

in InteractsWithActions at line 459
protected void openActionModal()

No description

Return Value

void

in InteractsWithActions at line 464
string|null getActiveActionsLocale()

No description

Return Value

string|null

in InteractsWithActions at line 469
Infolist mountedActionInfolist()

No description

Return Value

Infolist

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

in InteractsWithInfolists at line 44
Infolist|null getInfolist(string $name)

No description

Parameters

string $name

Return Value

Infolist|null

in InteractsWithInfolists at line 65
Infolist cacheInfolist(string $name, Infolist $infolist)

No description

Parameters

string $name
Infolist $infolist

Return Value

Infolist

in InteractsWithInfolists at line 75
array getCachedInfolists()

No description

Return Value

array

in InteractsWithInfolists at line 80
protected bool hasCachedInfolist(string $name)

No description

Parameters

string $name

Return Value

bool

in InteractsWithInfolists at line 88
mixed callMountedInfolistAction(array $arguments = [])

No description

Parameters

array $arguments

Return Value

mixed

in InteractsWithInfolists at line 169
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

in InteractsWithInfolists at line 234
protected void openInfolistActionModal()

No description

Return Value

void

in InteractsWithInfolists at line 248
bool mountedInfolistActionShouldOpenModal(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

in InteractsWithInfolists at line 255
bool mountedInfolistActionHasForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

in InteractsWithInfolists at line 260
Action|null getMountedInfolistAction()

No description

Return Value

Action|null

in InteractsWithInfolists at line 269
Component|null getMountedInfolistActionComponent()

No description

Return Value

Component|null

in InteractsWithInfolists at line 280
Form|null getMountedInfolistActionForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

Form|null

in InteractsWithInfolists at line 300
void unmountInfolistAction(bool $shouldCancelParentActions = true, bool $shouldCloseModal = true)

No description

Parameters

bool $shouldCancelParentActions
bool $shouldCloseModal

Return Value

void

in InteractsWithInfolists at line 347
protected Infolist makeInfolist()

No description

Return Value

Infolist

in InteractsWithInfolists at line 355
protected array getInteractsWithInfolistsForms()

No description

Return Value

array

in BasePage at line 51
View render()

No description

Return Value

View

in BasePage at line 61
string getView()

No description

Return Value

string

in Page at line 46
string getLayout()

No description

Return Value

string

in BasePage at line 71
Htmlable getHeading()

No description

Return Value

Htmlable

in BasePage at line 76
Htmlable|null getSubheading()

No description

Return Value

Htmlable|null

in BasePage at line 81
Htmlable getTitle()

No description

Return Value

Htmlable

in BasePage at line 89
MaxWidth|string|null getMaxContentWidth()

No description

Return Value

MaxWidth|string|null

in BasePage at line 97
array getExtraBodyAttributes()

No description

Return Value

array

in BasePage at line 105
protected array getLayoutData()

No description

Return Value

array

in BasePage at line 113
protected array getViewData()

No description

Return Value

array

in BasePage at line 127
protected void halt()

No description

Return Value

void

in BasePage at line 132
protected void callHook(string $hook)

No description

Parameters

string $hook

Return Value

void

in BasePage at line 141
static void stickyFormActions(bool $condition = true)

No description

Parameters

bool $condition

Return Value

void

in BasePage at line 146
static void alignFormActionsStart()

No description

Return Value

void

in BasePage at line 151
static void alignFormActionsCenter()

No description

Return Value

void

in BasePage at line 156
static void alignFormActionsEnd()

No description

Return Value

void

in BasePage at line 164
static void alignFormActionsLeft() deprecated

deprecated Use `alignFormActionsStart()` instead

No description

Return Value

void

in BasePage at line 172
static void alignFormActionsRight() deprecated

deprecated Use `alignFormActionsEnd()` instead

No description

Return Value

void

in BasePage at line 177
Alignment getFormActionsAlignment()

No description

Return Value

Alignment

in BasePage at line 182
bool areFormActionsSticky()

No description

Return Value

bool

in BasePage at line 187
bool hasInlineLabels()

No description

Return Value

bool

in BasePage at line 192
static void formActionsAlignment(Alignment $alignment)

No description

Parameters

Alignment $alignment

Return Value

void

in BasePage at line 197
static void inlineLabels(bool $condition = true)

No description

Parameters

bool $condition

Return Value

void

at line 169
array getRenderHookScopes()

No description

Return Value

array

in CanAuthorizeAccess at line 7
void mountCanAuthorizeAccess()

No description

Return Value

void

at line 145
static bool canAccess(array $parameters = [])

No description

Parameters

array $parameters

Return Value

bool

in HasRoutes at line 23
static void registerRoutes(Panel $panel)

No description

Parameters

Panel $panel

Return Value

void

in HasRoutes at line 28
static void routes(Panel $panel)

No description

Parameters

Panel $panel

Return Value

void

in HasRoutes at line 36
static string getRoutePath()

No description

Return Value

string

in HasRoutes at line 41
static string getRelativeRouteName()

No description

Return Value

string

in HasRoutes at line 46
static string getSlug()

No description

Return Value

string

in HasRoutes at line 60
static string|array getRouteMiddleware(Panel $panel)

No description

Parameters

Panel $panel

Return Value

string|array

| array

in HasRoutes at line 72
static string|array getWithoutRouteMiddleware(Panel $panel)

No description

Parameters

Panel $panel

Return Value

string|array

| array

at line 90
static string getEmailVerifiedMiddleware(Panel $panel)

No description

Parameters

Panel $panel

Return Value

string

at line 95
static bool isEmailVerificationRequired(Panel $panel)

No description

Parameters

Panel $panel

Return Value

bool

at line 100
static string getTenantSubscribedMiddleware(Panel $panel)

No description

Parameters

Panel $panel

Return Value

string

at line 105
static bool isTenantSubscriptionRequired(Panel $panel)

No description

Parameters

Panel $panel

Return Value

bool

at line 190
array getSubNavigation()

No description

Return Value

array

at line 177
SubNavigationPosition getSubNavigationPosition()

No description

Return Value

SubNavigationPosition

in HasSubNavigation at line 40
array getCachedSubNavigation()

No description

Return Value

array

in HasSubNavigation at line 109
array generateNavigationItems(array $components)

No description

Parameters

array $components

Return Value

array

in HasSubNavigation at line 150
array getSubNavigationParameters()

No description

Return Value

array

in InteractsWithHeaderActions at line 17
void bootedInteractsWithHeaderActions()

No description

Return Value

void

in InteractsWithHeaderActions at line 22
protected void cacheHeaderActions()

No description

Return Value

void

in InteractsWithHeaderActions at line 55
array getCachedHeaderActions()

No description

Return Value

array

in InteractsWithHeaderActions at line 63
protected array getHeaderActions()

No description

Return Value

array

in InteractsWithHeaderActions at line 73
protected array getActions() deprecated

deprecated Register header actions within the `getHeaderActions()` method instead.

No description

Return Value

array

at line 62
static string getUrl(array $parameters = [], bool $isAbsolute = true, string|null $panel = null, Model|null $tenant = null)

No description

Parameters

array $parameters
bool $isAbsolute
string|null $panel
Model|null $tenant

Return Value

string

in Page at line 76
static void registerNavigationItems()

No description

Return Value

void

at line 36
static array getNavigationItems(array $urlParameters = [])

No description

Parameters

array $urlParameters

Return Value

array

in Page at line 113
static string getNavigationItemActiveRoutePattern()

No description

Return Value

string

at line 26
static string getRouteName(string|null $panel = null)

No description

Parameters

string|null $panel

Return Value

string

at line 118
array getBreadcrumbs()

No description

Return Value

array

in Page at line 140
static string|null getNavigationGroup()

No description

Return Value

string|null

in Page at line 145
static string|null getNavigationParentItem()

No description

Return Value

string|null

in Page at line 150
static Htmlable|null getActiveNavigationIcon()

No description

Return Value

Htmlable|null

in Page at line 155
static Htmlable|null getNavigationIcon()

No description

Return Value

Htmlable|null

in Page at line 160
static string getNavigationLabel()

No description

Return Value

string

in Page at line 168
static string|null getNavigationBadge()

No description

Return Value

string|null

in Page at line 176
static string|array|null getNavigationBadgeColor()

No description

Return Value

string|array|null

| array{50: string, 100: string, 200: string, 300: string, 400: string, 500: string, 600: string, 700: string, 800: string, 900: string, 950: string} | null

in Page at line 181
static string|null getNavigationBadgeTooltip()

No description

Return Value

string|null

in Page at line 186
static int|null getNavigationSort()

No description

Return Value

int|null

at line 54
static string getNavigationUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string

in Page at line 196
View|null getFooter()

No description

Return Value

View|null

in Page at line 201
View|null getHeader()

No description

Return Value

View|null

in Page at line 209
protected array getHeaderWidgets()

No description

Return Value

array

in Page at line 217
array getVisibleHeaderWidgets()

No description

Return Value

array

in Page at line 225
int|string|array getHeaderWidgetsColumns()

No description

Return Value

int|string|array

| string | array<string, int | string | null>

in Page at line 233
protected array getFooterWidgets()

No description

Return Value

array

in Page at line 241
array getVisibleFooterWidgets()

No description

Return Value

array

in Page at line 250
protected array filterVisibleWidgets(array $widgets)

No description

Parameters

array $widgets

Return Value

array

in Page at line 259
protected string normalizeWidgetClass(WidgetConfiguration $widget)

No description

Parameters

WidgetConfiguration $widget

Return Value

string

in Page at line 271
int|string|array getFooterWidgetsColumns()

No description

Return Value

int|string|array

| string | array<string, int | string | null>

in Page at line 279
array getWidgetData()

No description

Return Value

array

at line 137
static bool shouldRegisterNavigation(array $parameters = [])

No description

Parameters

array $parameters

Return Value

bool

in Page at line 289
static bool isDiscovered()

No description

Return Value

bool

at line 185
static string|null getCluster()

No description

Return Value

string|null

| null

in Page at line 302
static string prependClusterSlug(string $slug)

No description

Parameters

string $slug

Return Value

string

in Page at line 311
static string prependClusterRouteBaseName(string $name)

No description

Parameters

string $name

Return Value

string

in CanAuthorizeResourceAccess at line 7
void mountCanAuthorizeResourceAccess()

No description

Return Value

void

in CanAuthorizeResourceAccess at line 12
static void authorizeResourceAccess()

No description

Return Value

void

at line 67
static string getResourcePageName()

No description

Return Value

string

at line 80
static PageRegistration route(string $path)

No description

Parameters

string $path

Return Value

PageRegistration

at line 110
string|null getBreadcrumb()

No description

Return Value

string|null

at line 153
string getModel()

No description

Return Value

string

at line 161
static string getResource()

No description

Return Value

string