1. class
  2. Filament
  3. \
  4. Resources
  5. \
  6. RelationManagers
  7. \
  8. RelationManager

RelationManager

class RelationManager extends Component implements HasActions, HasForms, HasInfolists, HasTable (View source)

Traits

InteractsWithActions
CanBeLazy
InteractsWithForms
InteractsWithInfolists
InteractsWithRelationshipTable
HasFormComponentActions
ResolvesDynamicLivewireProperties
WithFileUploads
HasTabs
InteractsWithTable
CanBeStriped deprecated
CanDeferLoading
CanGroupRecords
CanPaginateRecords
CanPollRecords deprecated
CanReorderRecords
CanSearchRecords
CanSortRecords
CanSummarizeRecords
CanToggleColumns
HasActions
HasBulkActions
HasColumns
HasContent deprecated
HasEmptyState deprecated
HasFilters
HasHeader deprecated
HasRecordAction deprecated
HasRecordClasses deprecated
HasRecords
HasRecordUrl deprecated
WithPagination

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
static protected bool $isLazy from  CanBeLazy
protected string|null $placeholderHeight from  CanBeLazy
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
string|null $activeTab from  HasTabs
protected array $cachedTabs from  HasTabs
bool $isTableLoaded from  CanDeferLoading
string|null $tableGrouping from  CanGroupRecords
string|null $tableGroupingDirection from  CanGroupRecords
int $tableRecordsPerPage from  CanPaginateRecords
protected int|string|null $defaultTableRecordsPerPageSelectOption from  CanPaginateRecords
bool $isTableReordering from  CanReorderRecords
array $tableColumnSearches from  CanSearchRecords
?string $tableSearch from  CanSearchRecords
string|null $tableSortColumn from  CanSortRecords
string|null $tableSortDirection from  CanSortRecords
array $toggledTableColumns from  CanToggleColumns
Form $toggleTableColumnForm from  CanToggleColumns
string[] $mountedTableActions from  HasActions
array<string,array<string,mixed>> $mountedTableActionsData from  HasActions
array<string,array<string,mixed>> $mountedTableActionsArguments from  HasActions
int $mountedTableActionRecord from  HasActions
protected Model|null $cachedMountedTableActionRecord from  HasActions
protected int|string|null $cachedMountedTableActionRecordKey from  HasActions
mixed $defaultTableAction from  HasActions
mixed $defaultTableActionArguments from  HasActions
mixed $defaultTableActionRecord from  HasActions
Form $mountedTableActionForm from  HasActions
array $selectedTableRecords from  HasBulkActions
string|null $mountedTableBulkAction from  HasBulkActions
array<string,mixed> $mountedTableBulkActionData from  HasBulkActions
protected Collection $cachedSelectedTableRecords from  HasBulkActions
Form $mountedTableBulkActionForm from  HasBulkActions
array<string,mixed> $tableFilters from  HasFilters
array<string,mixed> $tableDeferredFilters from  HasFilters
Form $tableFiltersForm from  HasFilters
protected bool deprecated $allowsDuplicates from  HasRecords
protected CursorPaginator|null $cachedTableRecords from  HasRecords
protected Table $table from  InteractsWithTable
protected bool $hasTableModalRendered from  InteractsWithTable
protected bool $shouldMountInteractsWithTable from  InteractsWithTable
static protected string $relationship from  InteractsWithRelationshipTable
static protected bool $shouldCheckPolicyExistence from  InteractsWithRelationshipTable
static protected bool $shouldSkipAuthorization from  InteractsWithRelationshipTable
static protected string $view
Model $ownerRecord
string|null $pageClass
static protected string|null deprecated $recordTitleAttribute
static protected string|null deprecated $inverseRelationship
static protected string|null deprecated $label
static protected string|null deprecated $pluralLabel
static protected string|null deprecated $modelLabel
static protected string|null deprecated $pluralModelLabel
static protected string|null $title
static protected string|null $icon
static protected IconPosition $iconPosition
static protected string|null $badge
static protected string|null $badgeColor
static protected string|null $badgeTooltip

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
static bool
isLazy()

No description

from  CanBeLazy
View
placeholder()

No description

from  CanBeLazy
array
getPlaceholderData()

No description

from  CanBeLazy
string|null
getPlaceholderHeight()

No description

from  CanBeLazy
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

Form
form(Form $form)

No description

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
void
loadDefaultActiveTab()

No description

from  HasTabs
array
getTabs()

No description

from  HasTabs
array
getCachedTabs()

No description

from  HasTabs
string|int|null
getDefaultActiveTab()

No description

from  HasTabs
void
updatedActiveTab()

No description

from  HasTabs
string
generateTabLabel(string $key)

No description

from  HasTabs
Builder
modifyQueryWithActiveTab(Builder $query)

No description

from  HasTabs
bool
isTableStriped() deprecated

No description

from  CanBeStriped
bool
isTableLoadingDeferred() deprecated

No description

from  CanDeferLoading
void
loadTable()

No description

from  CanDeferLoading
bool
isTableLoaded()

No description

from  CanDeferLoading
Group|null
getTableGrouping()

No description

from  CanGroupRecords
void
updatedTableGroupColumn()

No description

from  CanGroupRecords
string|null
getTableGroupingDirection()

No description

from  CanGroupRecords
Builder
applyGroupingToTableQuery(Builder $query)

No description

from  CanGroupRecords
void
updatedTableRecordsPerPage()

No description

from  CanPaginateRecords
CursorPaginator
paginateTableQuery(Builder $query)

No description

from  CanPaginateRecords
int|string|null
getTableRecordsPerPage()

No description

from  CanPaginateRecords
int
getTablePage()

No description

from  CanPaginateRecords
int|string
getDefaultTableRecordsPerPageSelectOption()

No description

from  CanPaginateRecords
string
getTablePaginationPageName()

No description

from  CanPaginateRecords
string
getTablePerPageSessionKey()

No description

from  CanPaginateRecords
array|null
getTableRecordsPerPageSelectOptions() deprecated

No description

from  CanPaginateRecords
bool
isTablePaginationEnabled() deprecated

No description

from  CanPaginateRecords
string|null
getTablePollingInterval() deprecated

No description

from  CanPollRecords
void
reorderTable(array $order)

No description

from  CanReorderRecords
void
toggleTableReordering()

No description

from  CanReorderRecords
bool
isTableReordering()

No description

from  CanReorderRecords
bool
isTablePaginationEnabledWhileReordering() deprecated

No description

from  CanReorderRecords
string|null
getTableReorderColumn() deprecated

No description

from  CanReorderRecords
void
updatedTableSearch()

No description

from  CanSearchRecords
void
updatedTableColumnSearches($value = null, string|null $key = null)

No description

from  CanSearchRecords
Builder
applySearchToTableQuery(Builder $query)

No description

from  CanSearchRecords
Builder
applyColumnSearchesToTableQuery(Builder $query)

No description

from  CanSearchRecords
array
extractTableSearchWords(string $search)

No description

from  CanSearchRecords
Builder
applyGlobalSearchToTableQuery(Builder $query)

No description

from  CanSearchRecords
string|null
getTableSearch()

No description

from  CanSearchRecords
bool
hasTableSearch()

No description

from  CanSearchRecords
void
resetTableSearch()

No description

from  CanSearchRecords
void
resetTableColumnSearch(string $column)

No description

from  CanSearchRecords
void
resetTableColumnSearches()

No description

from  CanSearchRecords
Indicator
getTableSearchIndicator()

No description

from  CanSearchRecords
array
getTableColumnSearchIndicators()

No description

from  CanSearchRecords
array
castTableColumnSearches(array $searches)

No description

from  CanSearchRecords
array
getTableColumnSearches()

No description

from  CanSearchRecords
string
getTableSearchSessionKey()

No description

from  CanSearchRecords
string
getTableColumnSearchesSessionKey()

No description

from  CanSearchRecords
bool
shouldPersistTableSearchInSession() deprecated

No description

from  CanSearchRecords
bool
shouldPersistTableColumnSearchInSession() deprecated

No description

from  CanSearchRecords
void
sortTable(string|null $column = null, string|null $direction = null)

No description

from  CanSortRecords
string|null
getTableSortColumn()

No description

from  CanSortRecords
string|null
getTableSortDirection()

No description

from  CanSortRecords
void
updatedTableSortColumn()

No description

from  CanSortRecords
void
updatedTableSortDirection()

No description

from  CanSortRecords
Builder
applySortingToTableQuery(Builder $query)

No description

from  CanSortRecords
Builder
applyDefaultSortingToTableQuery(Builder $query)

No description

from  CanSortRecords
string|null
getDefaultTableSortColumn() deprecated

No description

from  CanSortRecords
string|null
getDefaultTableSortDirection() deprecated

No description

from  CanSortRecords
string
getTableSortSessionKey()

No description

from  CanSortRecords
bool
shouldPersistTableSortInSession() deprecated

No description

from  CanSortRecords
Builder
getAllTableSummaryQuery()

No description

from  CanSummarizeRecords
Builder
getPageTableSummaryQuery()

No description

from  CanSummarizeRecords
array
getTableSummarySelectedState(Builder $query, Closure|null $modifyQueryUsing = null)

No description

from  CanSummarizeRecords
array
getDefaultTableColumnToggleState()

No description

from  CanToggleColumns
void
updatedToggledTableColumns()

No description

from  CanToggleColumns
Form
getTableColumnToggleForm()

No description

from  CanToggleColumns
array
getTableColumnToggleFormSchema()

No description

from  CanToggleColumns
bool
isTableColumnToggledHidden(string $name)

No description

from  CanToggleColumns
string
getTableColumnToggleFormStateSessionKey()

No description

from  CanToggleColumns
int|array
getTableColumnToggleFormColumns() deprecated

No description

from  CanToggleColumns
string|null
getTableColumnToggleFormWidth() deprecated

No description

from  CanToggleColumns
string|null
getTableColumnToggleFormMaxHeight() deprecated

No description

from  CanToggleColumns
void
configureTableAction(Action $action)

No description

mixed
callMountedTableAction(array $arguments = [])

No description

from  HasActions
void
mountedTableActionRecord(int|string|null $record)

No description

from  HasActions
mixed
mountTableAction(string $name, string|null $record = null, array $arguments = [])

No description

from  HasActions
void
replaceMountedTableAction(string $name, string|null $record = null, array $arguments = [])

No description

from  HasActions
bool
mountedTableActionShouldOpenModal(Action|null $mountedAction = null)

No description

from  HasActions
bool
mountedTableActionHasForm(Action|null $mountedAction = null)

No description

from  HasActions
Action|null
getMountedTableAction()

No description

from  HasActions
Form|null
getMountedTableActionForm(Action|null $mountedAction = null)

No description

from  HasActions
int|string|null
getMountedTableActionRecordKey()

No description

from  HasActions
Model|null
getMountedTableActionRecord()

No description

from  HasActions
string|null
popMountedTableAction()

No description

from  HasActions
void
resetMountedTableActionProperties()

No description

from  HasActions
void
unmountTableAction(bool $shouldCancelParentActions = true, bool $shouldCloseModal = true)

No description

from  HasActions
void
cacheMountedTableActionForm(Action|null $mountedAction = null)

No description

from  HasActions
void
closeTableActionModal()

No description

from  HasActions
void
openTableActionModal()

No description

from  HasActions
array
getTableActions() deprecated

No description

from  HasActions
string|null
getTableActionsColumnLabel() deprecated

No description

from  HasActions
Infolist
mountedTableActionInfolist()

No description

from  HasActions
void
configureTableBulkAction(BulkAction $action)

No description

mixed
callMountedTableBulkAction(array $arguments = [])

No description

from  HasBulkActions
mixed
mountTableBulkAction(string $name, array|null $selectedRecords = null)

No description

from  HasBulkActions
void
cacheMountedTableBulkActionForm(BulkAction|null $mountedBulkAction = null)

No description

from  HasBulkActions
void
replaceMountedTableBulkAction(string $name, array|null $selectedRecords = null)

No description

from  HasBulkActions
void
resetMountedTableBulkActionProperties()

No description

from  HasBulkActions
bool
mountedTableBulkActionShouldOpenModal(BulkAction|null $mountedBulkAction = null)

No description

from  HasBulkActions
void
unmountTableBulkAction(bool $shouldCloseModal = true)

No description

from  HasBulkActions
bool
mountedTableBulkActionHasForm(BulkAction|null $mountedBulkAction = null)

No description

from  HasBulkActions
void
deselectAllTableRecords()

No description

from  HasBulkActions
array
getAllSelectableTableRecordKeys()

No description

from  HasBulkActions
array
getGroupedSelectableTableRecordKeys(string $group)

No description

from  HasBulkActions
int
getAllSelectableTableRecordsCount()

No description

from  HasBulkActions
Collection
getSelectedTableRecords(bool $shouldFetchSelectedRecords = true)

No description

from  HasBulkActions
void
closeTableBulkActionModal()

No description

from  HasBulkActions
void
openTableBulkActionModal()

No description

from  HasBulkActions
bool
shouldSelectCurrentPageOnly() deprecated

No description

from  HasBulkActions
bool
shouldDeselectAllRecordsWhenTableFiltered() deprecated

No description

from  HasBulkActions
BulkAction|null
getMountedTableBulkAction()

No description

from  HasBulkActions
Form|null
getMountedTableBulkActionForm(BulkAction|null $mountedBulkAction = null)

No description

from  HasBulkActions
array
getTableBulkActions() deprecated

No description

from  HasBulkActions
Closure|null
isTableRecordSelectable() deprecated

No description

from  HasBulkActions
Infolist
mountedTableBulkActionInfolist()

No description

from  HasBulkActions
mixed
callTableColumnAction(string $name, string $recordKey)

No description

from  HasColumns
mixed
updateTableColumnState(string $column, string $record, mixed $input)

No description

from  HasColumns
array
getTableColumns() deprecated

No description

from  HasColumns
View|null
getTableContent() deprecated

No description

from  HasContent
array|null
getTableContentGrid() deprecated

No description

from  HasContent
View|null
getTableContentFooter() deprecated

No description

from  HasContent
View|null
getTableEmptyState() deprecated

No description

from  HasEmptyState
array
getTableEmptyStateActions() deprecated

No description

from  HasEmptyState
string|null
getTableEmptyStateDescription() deprecated

No description

from  HasEmptyState
string|null
getTableEmptyStateHeading() deprecated

No description

from  HasEmptyState
string|null
getTableEmptyStateIcon() deprecated

No description

from  HasEmptyState
Form
getTableFiltersForm()

No description

from  HasFilters
void
updatedTableFilters()

No description

from  HasFilters
void
handleTableFilterUpdates()

No description

from  HasFilters
void
removeTableFilter(string $filterName, string|null $field = null, bool $isRemovingAllFilters = false)

No description

from  HasFilters
void
removeTableFilters()

No description

from  HasFilters
void
resetTableFiltersForm()

No description

from  HasFilters
void
applyTableFilters()

No description

from  HasFilters
Builder
applyFiltersToTableQuery(Builder $query)

No description

from  HasFilters
array|null
getTableFilterState(string $name)

No description

from  HasFilters
string
parseTableFilterName(string $name)

No description

from  HasFilters
string
getTableFiltersSessionKey()

No description

from  HasFilters
array
getTableFilters() deprecated

No description

from  HasFilters
string|null
getTableFiltersFormWidth() deprecated

No description

from  HasFilters
string|null
getTableFiltersFormMaxHeight() deprecated

No description

from  HasFilters
bool
shouldPersistTableFiltersInSession() deprecated

No description

from  HasFilters
Htmlable|null
getTableDescription() deprecated

No description

from  HasHeader
Htmlable|null
getTableHeader() deprecated

No description

from  HasHeader
array
getTableHeaderActions() deprecated

No description

from  HasHeader
Htmlable|null
getTableHeading() deprecated

No description

from  HasHeader
Closure|null
getTableRecordActionUsing() deprecated

No description

from  HasRecordAction
string|null
getTableRecordAction() deprecated

No description

from  HasRecordAction
Closure|null
getTableRecordClassesUsing() deprecated

No description

from  HasRecordClasses
Builder
getFilteredTableQuery()

No description

from  HasRecords
Builder
filterTableQuery(Builder $query)

No description

from  HasRecords
Builder
getFilteredSortedTableQuery()

No description

from  HasRecords
Builder
getTableQueryForExport()

No description

from  HasRecords
CursorPaginator
hydratePivotRelationForTableRecords(CursorPaginator $records)

No description

from  HasRecords
CursorPaginator
getTableRecords()

No description

from  HasRecords
Model|null
resolveTableRecord(string|null $key)

No description

from  HasRecords
Model|null
getTableRecord(string|null $key)

No description

from  HasRecords
string
getTableRecordKey(Model $record)

No description

from  HasRecords
int
getAllTableRecordsCount()

No description

from  HasRecords
void
flushCachedTableRecords()

No description

from  HasRecords
bool
allowsDuplicates() deprecated

No description

from  HasRecords
string|null
getTableRecordTitle(Model $record) deprecated

No description

from  HasRecords
string|null
getTableModelLabel() deprecated

No description

from  HasRecords
string|null
getTablePluralModelLabel() deprecated

No description

from  HasRecords
Closure|null
getTableRecordUrlUsing() deprecated

No description

from  HasRecordUrl
void
bootedInteractsWithTable()

No description

from  InteractsWithTable
void
mountInteractsWithTable()

No description

from  InteractsWithTable
Table
table(Table $table)

No description

from  InteractsWithTable
Table
getTable()

No description

from  InteractsWithTable
Table
makeTable()

No description

string|null
getTableQueryStringIdentifier()

No description

from  InteractsWithTable
string
getIdentifiedTableQueryStringPropertyNameFor(string $property)

No description

from  InteractsWithTable
array
getInteractsWithTableForms()

No description

from  InteractsWithTable
string|null
getActiveTableLocale()

No description

from  InteractsWithTable
void
resetPage(?string $pageName = null)

No description

from  InteractsWithTable
Relation|null
getTableQuery() deprecated

No description

from  InteractsWithTable
void
normalizeTableFilterValuesFromQueryString(array $data)

No description

from  InteractsWithTable
void
resetTable()

No description

from  InteractsWithTable
static void
checkPolicyExistence(bool $condition = true)

No description

from  InteractsWithRelationshipTable
static void
skipAuthorization(bool $condition = true)

No description

from  InteractsWithRelationshipTable
static bool
shouldCheckPolicyExistence()

No description

from  InteractsWithRelationshipTable
static bool
shouldSkipAuthorization()

No description

from  InteractsWithRelationshipTable
Builder
getRelationship()

No description

from  InteractsWithRelationshipTable
static string
getRelationshipName()

No description

from  InteractsWithRelationshipTable
void
mount()

No description

static RelationManagerConfiguration
make(array $properties = [])

No description

array
getRenderHookScopes()

No description

View
render()

No description

array
getViewData()

No description

static string|null
getIcon(Model $ownerRecord, string $pageClass)

No description

static IconPosition
getIconPosition(Model $ownerRecord, string $pageClass)

No description

static string|null
getBadge(Model $ownerRecord, string $pageClass)

No description

static string|null
getBadgeColor(Model $ownerRecord, string $pageClass)

No description

static string|null
getBadgeTooltip(Model $ownerRecord, string $pageClass)

No description

static string
getTitle(Model $ownerRecord, string $pageClass)

No description

string
getPageClass()

No description

Model
getOwnerRecord()

No description

void
configureAssociateAction(AssociateAction $action)

No description

void
configureAttachAction(AttachAction $action)

No description

void
configureCreateAction(CreateAction $action)

No description

void
configureDeleteAction(DeleteAction $action)

No description

void
configureDetachAction(DetachAction $action)

No description

void
configureDissociateAction(DissociateAction $action)

No description

void
configureEditAction(EditAction $action)

No description

void
configureForceDeleteAction(ForceDeleteAction $action)

No description

void
configureReplicateAction(ReplicateAction $action)

No description

void
configureRestoreAction(RestoreAction $action)

No description

void
configureViewAction(ViewAction $action)

No description

void
configureDeleteBulkAction(DeleteBulkAction $action)

No description

void
configureDetachBulkAction(DetachBulkAction $action)

No description

void
configureDissociateBulkAction(DissociateBulkAction $action)

No description

void
configureForceDeleteBulkAction(ForceDeleteBulkAction $action)

No description

void
configureRestoreBulkAction(RestoreBulkAction $action)

No description

bool
can(string $action, Model|null $record = null)

No description

Infolist
infolist(Infolist $infolist)

No description

bool
isReadOnly()

No description

bool
canAssociate()

No description

bool
canAttach()

No description

bool
canCreate()

No description

bool
canDelete(Model $record)

No description

bool
canDeleteAny()

No description

bool
canDetach(Model $record)

No description

bool
canDetachAny()

No description

bool
canDissociate(Model $record)

No description

bool
canDissociateAny()

No description

bool
canEdit(Model $record)

No description

bool
canForceDelete(Model $record)

No description

bool
canForceDeleteAny()

No description

bool
canReorder()

No description

bool
canReplicate(Model $record)

No description

bool
canRestore(Model $record)

No description

bool
canRestoreAny()

No description

bool
canView(Model $record)

No description

static string|null
getRecordTitleAttribute() deprecated

No description

static string|null
getRecordLabel() deprecated

No description

static string|null
getModelLabel() deprecated

No description

static string|null
getPluralRecordLabel() deprecated

No description

static string|null
getPluralModelLabel() deprecated

No description

string|null
getInverseRelationshipName() deprecated

No description

static bool
canViewForRecord(Model $ownerRecord, string $pageClass)

No description

static array
getDefaultProperties()

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 CanBeLazy at line 13
static bool isLazy()

No description

Return Value

bool

in CanBeLazy at line 18
View placeholder()

No description

Return Value

View

in CanBeLazy at line 32
array getPlaceholderData()

No description

Return Value

array

in CanBeLazy at line 39
string|null getPlaceholderHeight()

No description

Return Value

string|null

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

at line 99
protected array getForms()

No description

Return Value

array

at line 327
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 HasTabs at line 17
protected void loadDefaultActiveTab()

No description

Return Value

void

in HasTabs at line 29
array getTabs()

No description

Return Value

array

in HasTabs at line 37
array getCachedTabs()

No description

Return Value

array

in HasTabs at line 42
string|int|null getDefaultActiveTab()

No description

Return Value

string|int|null

in HasTabs at line 47
void updatedActiveTab()

No description

Return Value

void

in HasTabs at line 52
string generateTabLabel(string $key)

No description

Parameters

string $key

Return Value

string

in HasTabs at line 59
protected Builder modifyQueryWithActiveTab(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in CanBeStriped at line 13
protected bool isTableStriped() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

bool

in CanDeferLoading at line 12
bool isTableLoadingDeferred() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

bool

in CanDeferLoading at line 17
void loadTable()

No description

Return Value

void

in CanDeferLoading at line 22
bool isTableLoaded()

No description

Return Value

bool

in CanGroupRecords at line 14
Group|null getTableGrouping()

No description

Return Value

Group|null

in CanGroupRecords at line 34
void updatedTableGroupColumn()

No description

Return Value

void

in CanGroupRecords at line 39
string|null getTableGroupingDirection()

No description

Return Value

string|null

in CanGroupRecords at line 48
protected Builder applyGroupingToTableQuery(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in CanPaginateRecords at line 20
void updatedTableRecordsPerPage()

No description

Return Value

void

in CanPaginateRecords at line 29
protected CursorPaginator paginateTableQuery(Builder $query)

No description

Parameters

Builder $query

Return Value

CursorPaginator

in CanPaginateRecords at line 55
int|string|null getTableRecordsPerPage()

No description

Return Value

int|string|null

in CanPaginateRecords at line 60
int getTablePage()

No description

Return Value

int

in CanPaginateRecords at line 65
int|string getDefaultTableRecordsPerPageSelectOption()

No description

Return Value

int|string

in CanPaginateRecords at line 83
string getTablePaginationPageName()

No description

Return Value

string

in CanPaginateRecords at line 88
string getTablePerPageSessionKey()

No description

Return Value

string

in CanPaginateRecords at line 100
protected array|null getTableRecordsPerPageSelectOptions() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

array|null

in CanPaginateRecords at line 108
protected bool isTablePaginationEnabled() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

bool

in CanPollRecords at line 13
protected string|null getTablePollingInterval() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in CanReorderRecords at line 15
void reorderTable(array $order)

No description

Parameters

array $order

Return Value

void

in CanReorderRecords at line 53
void toggleTableReordering()

No description

Return Value

void

in CanReorderRecords at line 58
bool isTableReordering()

No description

Return Value

bool

in CanReorderRecords at line 66
protected bool isTablePaginationEnabledWhileReordering() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

bool

in CanReorderRecords at line 74
protected string|null getTableReorderColumn() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in CanSearchRecords at line 23
void updatedTableSearch()

No description

Return Value

void

in CanSearchRecords at line 42
void updatedTableColumnSearches($value = null, string|null $key = null)

No description

Parameters

$value
string|null $key

Return Value

void

in CanSearchRecords at line 62
protected Builder applySearchToTableQuery(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in CanSearchRecords at line 70
protected Builder applyColumnSearchesToTableQuery(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in CanSearchRecords at line 110
protected array extractTableSearchWords(string $search)

No description

Parameters

string $search

Return Value

array

in CanSearchRecords at line 118
protected Builder applyGlobalSearchToTableQuery(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in CanSearchRecords at line 151
string|null getTableSearch()

No description

Return Value

string|null

in CanSearchRecords at line 156
bool hasTableSearch()

No description

Return Value

bool

in CanSearchRecords at line 161
void resetTableSearch()

No description

Return Value

void

in CanSearchRecords at line 167
void resetTableColumnSearch(string $column)

No description

Parameters

string $column

Return Value

void

in CanSearchRecords at line 172
void resetTableColumnSearches()

No description

Return Value

void

in CanSearchRecords at line 178
Indicator getTableSearchIndicator()

No description

Return Value

Indicator

in CanSearchRecords at line 187
array getTableColumnSearchIndicators()

No description

Return Value

array

in CanSearchRecords at line 219
protected array castTableColumnSearches(array $searches)

No description

Parameters

array $searches

Return Value

array

in CanSearchRecords at line 232
array getTableColumnSearches()

No description

Return Value

array

in CanSearchRecords at line 274
string getTableSearchSessionKey()

No description

Return Value

string

in CanSearchRecords at line 281
string getTableColumnSearchesSessionKey()

No description

Return Value

string

in CanSearchRecords at line 291
protected bool shouldPersistTableSearchInSession() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

bool

in CanSearchRecords at line 299
protected bool shouldPersistTableColumnSearchInSession() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

bool

in CanSortRecords at line 13
void sortTable(string|null $column = null, string|null $direction = null)

No description

Parameters

string|null $column
string|null $direction

Return Value

void

in CanSortRecords at line 31
string|null getTableSortColumn()

No description

Return Value

string|null

in CanSortRecords at line 36
string|null getTableSortDirection()

No description

Return Value

string|null

in CanSortRecords at line 41
void updatedTableSortColumn()

No description

Return Value

void

in CanSortRecords at line 56
void updatedTableSortDirection()

No description

Return Value

void

in CanSortRecords at line 71
protected Builder applySortingToTableQuery(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in CanSortRecords at line 98
protected Builder applyDefaultSortingToTableQuery(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in CanSortRecords at line 130
protected string|null getDefaultTableSortColumn() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in CanSortRecords at line 138
protected string|null getDefaultTableSortDirection() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in CanSortRecords at line 143
string getTableSortSessionKey()

No description

Return Value

string

in CanSortRecords at line 153
protected bool shouldPersistTableSortInSession() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

bool

in CanSummarizeRecords at line 16
Builder getAllTableSummaryQuery()

No description

Return Value

Builder

in CanSummarizeRecords at line 21
Builder getPageTableSummaryQuery()

No description

Return Value

Builder

in CanSummarizeRecords at line 32
array getTableSummarySelectedState(Builder $query, Closure|null $modifyQueryUsing = null)

No description

Parameters

Builder $query
Closure|null $modifyQueryUsing

Return Value

array

in CanToggleColumns at line 22
protected array getDefaultTableColumnToggleState()

No description

Return Value

array

in CanToggleColumns at line 37
void updatedToggledTableColumns()

No description

Return Value

void

in CanToggleColumns at line 44
Form getTableColumnToggleForm()

No description

Return Value

Form

in CanToggleColumns at line 60
protected array getTableColumnToggleFormSchema()

No description

Return Value

array

in CanToggleColumns at line 76
bool isTableColumnToggledHidden(string $name)

No description

Parameters

string $name

Return Value

bool

in CanToggleColumns at line 81
string getTableColumnToggleFormStateSessionKey()

No description

Return Value

string

in CanToggleColumns at line 93
protected int|array getTableColumnToggleFormColumns() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

int|array

| array<string, int | null>

in CanToggleColumns at line 101
protected string|null getTableColumnToggleFormWidth() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in CanToggleColumns at line 109
protected string|null getTableColumnToggleFormMaxHeight() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

at line 182
protected void configureTableAction(Action $action)

No description

Parameters

Action $action

Return Value

void

in HasActions at line 70
mixed callMountedTableAction(array $arguments = [])

No description

Parameters

array $arguments

Return Value

mixed

in HasActions at line 163
void mountedTableActionRecord(int|string|null $record)

No description

Parameters

int|string|null $record

Return Value

void

in HasActions at line 171
mixed mountTableAction(string $name, string|null $record = null, array $arguments = [])

No description

Parameters

string $name
string|null $record
array $arguments

Return Value

mixed

in HasActions at line 239
void replaceMountedTableAction(string $name, string|null $record = null, array $arguments = [])

No description

Parameters

string $name
string|null $record
array $arguments

Return Value

void

in HasActions at line 245
bool mountedTableActionShouldOpenModal(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

in HasActions at line 252
bool mountedTableActionHasForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

bool

in HasActions at line 257
Action|null getMountedTableAction()

No description

Return Value

Action|null

in HasActions at line 266
Form|null getMountedTableActionForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

Form|null

in HasActions at line 286
int|string|null getMountedTableActionRecordKey()

No description

Return Value

int|string|null

in HasActions at line 291
Model|null getMountedTableActionRecord()

No description

Return Value

Model|null

in HasActions at line 304
protected string|null popMountedTableAction()

No description

Return Value

string|null

in HasActions at line 313
protected void resetMountedTableActionProperties()

No description

Return Value

void

in HasActions at line 320
void unmountTableAction(bool $shouldCancelParentActions = true, bool $shouldCloseModal = true)

No description

Parameters

bool $shouldCancelParentActions
bool $shouldCloseModal

Return Value

void

in HasActions at line 369
protected void cacheMountedTableActionForm(Action|null $mountedAction = null)

No description

Parameters

Action|null $mountedAction

Return Value

void

in HasActions at line 377
protected void closeTableActionModal()

No description

Return Value

void

in HasActions at line 382
protected void openTableActionModal()

No description

Return Value

void

in HasActions at line 392
protected array getTableActions() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

array

in HasActions at line 400
protected string|null getTableActionsColumnLabel() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in HasActions at line 405
Infolist mountedTableActionInfolist()

No description

Return Value

Infolist

at line 270
protected void configureTableBulkAction(BulkAction $action)

No description

Parameters

BulkAction $action

Return Value

void

in HasBulkActions at line 45
mixed callMountedTableBulkAction(array $arguments = [])

No description

Parameters

array $arguments

Return Value

mixed

in HasBulkActions at line 137
mixed mountTableBulkAction(string $name, array|null $selectedRecords = null)

No description

Parameters

string $name
array|null $selectedRecords

Return Value

mixed

in HasBulkActions at line 190
protected void cacheMountedTableBulkActionForm(BulkAction|null $mountedBulkAction = null)

No description

Parameters

BulkAction|null $mountedBulkAction

Return Value

void

in HasBulkActions at line 201
void replaceMountedTableBulkAction(string $name, array|null $selectedRecords = null)

No description

Parameters

string $name
array|null $selectedRecords

Return Value

void

in HasBulkActions at line 209
protected void resetMountedTableBulkActionProperties()

No description

Return Value

void

in HasBulkActions at line 215
bool mountedTableBulkActionShouldOpenModal(BulkAction|null $mountedBulkAction = null)

No description

Parameters

BulkAction|null $mountedBulkAction

Return Value

bool

in HasBulkActions at line 222
void unmountTableBulkAction(bool $shouldCloseModal = true)

No description

Parameters

bool $shouldCloseModal

Return Value

void

in HasBulkActions at line 231
bool mountedTableBulkActionHasForm(BulkAction|null $mountedBulkAction = null)

No description

Parameters

BulkAction|null $mountedBulkAction

Return Value

bool

in HasBulkActions at line 236
void deselectAllTableRecords()

No description

Return Value

void

in HasBulkActions at line 244
array getAllSelectableTableRecordKeys()

No description

Return Value

array

in HasBulkActions at line 279
array getGroupedSelectableTableRecordKeys(string $group)

No description

Parameters

string $group

Return Value

array

in HasBulkActions at line 320
int getAllSelectableTableRecordsCount()

No description

Return Value

int

in HasBulkActions at line 344
Collection getSelectedTableRecords(bool $shouldFetchSelectedRecords = true)

No description

Parameters

bool $shouldFetchSelectedRecords

Return Value

Collection

in HasBulkActions at line 393
protected void closeTableBulkActionModal()

No description

Return Value

void

in HasBulkActions at line 398
protected void openTableBulkActionModal()

No description

Return Value

void

in HasBulkActions at line 406
bool shouldSelectCurrentPageOnly() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

bool

in HasBulkActions at line 414
bool shouldDeselectAllRecordsWhenTableFiltered() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

bool

in HasBulkActions at line 419
BulkAction|null getMountedTableBulkAction()

No description

Return Value

BulkAction|null

in HasBulkActions at line 428
Form|null getMountedTableBulkActionForm(BulkAction|null $mountedBulkAction = null)

No description

Parameters

BulkAction|null $mountedBulkAction

Return Value

Form|null

in HasBulkActions at line 453
protected array getTableBulkActions() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

array

in HasBulkActions at line 461
Closure|null isTableRecordSelectable() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

Closure|null

in HasBulkActions at line 466
Infolist mountedTableBulkActionInfolist()

No description

Return Value

Infolist

in HasColumns at line 13
mixed callTableColumnAction(string $name, string $recordKey)

No description

Parameters

string $name
string $recordKey

Return Value

mixed

in HasColumns at line 40
mixed updateTableColumnState(string $column, string $record, mixed $input)

No description

Parameters

string $column
string $record
mixed $input

Return Value

mixed

in HasColumns at line 76
protected array getTableColumns() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

array

in HasContent at line 15
protected View|null getTableContent() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

View|null

in HasContent at line 25
protected array|null getTableContentGrid() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

array|null

in HasContent at line 33
protected View|null getTableContentFooter() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

View|null

in HasEmptyState at line 17
protected View|null getTableEmptyState() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

View|null

in HasEmptyState at line 27
protected array getTableEmptyStateActions() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

array

in HasEmptyState at line 35
protected string|null getTableEmptyStateDescription() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in HasEmptyState at line 43
protected string|null getTableEmptyStateHeading() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in HasEmptyState at line 51
protected string|null getTableEmptyStateIcon() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in HasFilters at line 25
Form getTableFiltersForm()

No description

Return Value

Form

in HasFilters at line 39
void updatedTableFilters()

No description

Return Value

void

in HasFilters at line 48
protected void handleTableFilterUpdates()

No description

Return Value

void

in HasFilters at line 64
void removeTableFilter(string $filterName, string|null $field = null, bool $isRemovingAllFilters = false)

No description

Parameters

string $filterName
string|null $field
bool $isRemovingAllFilters

Return Value

void

in HasFilters at line 99
void removeTableFilters()

No description

Return Value

void

in HasFilters at line 122
void resetTableFiltersForm()

No description

Return Value

void

in HasFilters at line 135
void applyTableFilters()

No description

Return Value

void

in HasFilters at line 142
protected Builder applyFiltersToTableQuery(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in HasFilters at line 161
array|null getTableFilterState(string $name)

No description

Parameters

string $name

Return Value

array|null

in HasFilters at line 166
string parseTableFilterName(string $name)

No description

Parameters

string $name

Return Value

string

in HasFilters at line 179
string getTableFiltersSessionKey()

No description

Return Value

string

in HasFilters at line 191
protected array getTableFilters() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

array

in HasFilters at line 199
protected string|null getTableFiltersFormWidth() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in HasFilters at line 207
protected string|null getTableFiltersFormMaxHeight() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in HasFilters at line 215
protected bool shouldPersistTableFiltersInSession() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

bool

in HasHeader at line 19
protected Htmlable|null getTableDescription() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

Htmlable|null

in HasHeader at line 27
protected Htmlable|null getTableHeader() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

Htmlable|null

in HasHeader at line 37
protected array getTableHeaderActions() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

array

in HasHeader at line 45
protected Htmlable|null getTableHeading() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

Htmlable|null

in HasRecordAction at line 16
protected Closure|null getTableRecordActionUsing() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

Closure|null

in HasRecordAction at line 26
protected string|null getTableRecordAction() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in HasRecordClasses at line 15
protected Closure|null getTableRecordClassesUsing() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

Closure|null

in HasRecords at line 24
Builder getFilteredTableQuery()

No description

Return Value

Builder

in HasRecords at line 29
Builder filterTableQuery(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

in HasRecords at line 52
Builder getFilteredSortedTableQuery()

No description

Return Value

Builder

in HasRecords at line 63
Builder getTableQueryForExport()

No description

Return Value

Builder

in HasRecords at line 74
protected CursorPaginator hydratePivotRelationForTableRecords(CursorPaginator $records)

No description

Parameters

CursorPaginator $records

Return Value

CursorPaginator

in HasRecords at line 86
CursorPaginator getTableRecords()

No description

Return Value

CursorPaginator

in HasRecords at line 114
protected Model|null resolveTableRecord(string|null $key)

No description

Parameters

string|null $key

Return Value

Model|null

in HasRecords at line 143
Model|null getTableRecord(string|null $key)

No description

Parameters

string|null $key

Return Value

Model|null

in HasRecords at line 154
string getTableRecordKey(Model $record)

No description

Parameters

Model $record

Return Value

string

in HasRecords at line 171
int getAllTableRecordsCount()

No description

Return Value

int

in HasRecords at line 180
void flushCachedTableRecords()

No description

Return Value

void

in HasRecords at line 188
bool allowsDuplicates() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

bool

in HasRecords at line 196
string|null getTableRecordTitle(Model $record) deprecated

deprecated Override the `table()` method to configure the table.

No description

Parameters

Model $record

Return Value

string|null

in HasRecords at line 204
string|null getTableModelLabel() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in HasRecords at line 212
string|null getTablePluralModelLabel() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

in HasRecordUrl at line 15
protected Closure|null getTableRecordUrlUsing() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

Closure|null

in InteractsWithTable at line 48
void bootedInteractsWithTable()

No description

Return Value

void

in InteractsWithTable at line 181
void mountInteractsWithTable()

No description

Return Value

void

in InteractsWithTable at line 186
Table table(Table $table)

No description

Parameters

Table $table

Return Value

Table

in InteractsWithTable at line 234
Table getTable()

No description

Return Value

Table

at line 504
protected Table makeTable()

No description

Return Value

Table

in InteractsWithTable at line 244
protected string|null getTableQueryStringIdentifier()

No description

Return Value

string|null

in InteractsWithTable at line 249
string getIdentifiedTableQueryStringPropertyNameFor(string $property)

No description

Parameters

string $property

Return Value

string

in InteractsWithTable at line 261
protected array getInteractsWithTableForms()

No description

Return Value

array

in InteractsWithTable at line 269
string|null getActiveTableLocale()

No description

Return Value

string|null

in InteractsWithTable at line 277
void resetPage(?string $pageName = null)

No description

Parameters

?string $pageName

Return Value

void

in InteractsWithTable at line 285
protected Relation|null getTableQuery() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

Relation|null

in InteractsWithTable at line 293
protected void normalizeTableFilterValuesFromQueryString(array $data)

No description

Parameters

array $data

Return Value

void

in InteractsWithTable at line 308
void resetTable()

No description

Return Value

void

in InteractsWithRelationshipTable at line 25
static void checkPolicyExistence(bool $condition = true)

No description

Parameters

bool $condition

Return Value

void

in InteractsWithRelationshipTable at line 30
static void skipAuthorization(bool $condition = true)

No description

Parameters

bool $condition

Return Value

void

in InteractsWithRelationshipTable at line 35
static bool shouldCheckPolicyExistence()

No description

Return Value

bool

in InteractsWithRelationshipTable at line 40
static bool shouldSkipAuthorization()

No description

Return Value

bool

in InteractsWithRelationshipTable at line 45
Builder getRelationship()

No description

Return Value

Builder

in InteractsWithRelationshipTable at line 50
static string getRelationshipName()

No description

Return Value

string

at line 91
void mount()

No description

Return Value

void

at line 107
static RelationManagerConfiguration make(array $properties = [])

No description

Parameters

array $properties

Return Value

RelationManagerConfiguration

at line 115
array getRenderHookScopes()

No description

Return Value

array

at line 123
View render()

No description

Return Value

View

at line 131
protected array getViewData()

No description

Return Value

array

at line 136
static string|null getIcon(Model $ownerRecord, string $pageClass)

No description

Parameters

Model $ownerRecord
string $pageClass

Return Value

string|null

at line 141
static IconPosition getIconPosition(Model $ownerRecord, string $pageClass)

No description

Parameters

Model $ownerRecord
string $pageClass

Return Value

IconPosition

at line 146
static string|null getBadge(Model $ownerRecord, string $pageClass)

No description

Parameters

Model $ownerRecord
string $pageClass

Return Value

string|null

at line 151
static string|null getBadgeColor(Model $ownerRecord, string $pageClass)

No description

Parameters

Model $ownerRecord
string $pageClass

Return Value

string|null

at line 156
static string|null getBadgeTooltip(Model $ownerRecord, string $pageClass)

No description

Parameters

Model $ownerRecord
string $pageClass

Return Value

string|null

at line 161
static string getTitle(Model $ownerRecord, string $pageClass)

No description

Parameters

Model $ownerRecord
string $pageClass

Return Value

string

at line 172
string getPageClass()

No description

Return Value

string

at line 177
Model getOwnerRecord()

No description

Return Value

Model

at line 200
protected void configureAssociateAction(AssociateAction $action)

No description

Parameters

AssociateAction $action

Return Value

void

at line 206
protected void configureAttachAction(AttachAction $action)

No description

Parameters

AttachAction $action

Return Value

void

at line 212
protected void configureCreateAction(CreateAction $action)

No description

Parameters

CreateAction $action

Return Value

void

at line 219
protected void configureDeleteAction(DeleteAction $action)

No description

Parameters

DeleteAction $action

Return Value

void

at line 225
protected void configureDetachAction(DetachAction $action)

No description

Parameters

DetachAction $action

Return Value

void

at line 231
protected void configureDissociateAction(DissociateAction $action)

No description

Parameters

DissociateAction $action

Return Value

void

at line 237
protected void configureEditAction(EditAction $action)

No description

Parameters

EditAction $action

Return Value

void

at line 244
protected void configureForceDeleteAction(ForceDeleteAction $action)

No description

Parameters

ForceDeleteAction $action

Return Value

void

at line 250
protected void configureReplicateAction(ReplicateAction $action)

No description

Parameters

ReplicateAction $action

Return Value

void

at line 256
protected void configureRestoreAction(RestoreAction $action)

No description

Parameters

RestoreAction $action

Return Value

void

at line 262
protected void configureViewAction(ViewAction $action)

No description

Parameters

ViewAction $action

Return Value

void

at line 282
protected void configureDeleteBulkAction(DeleteBulkAction $action)

No description

Parameters

DeleteBulkAction $action

Return Value

void

at line 288
protected void configureDetachBulkAction(DetachBulkAction $action)

No description

Parameters

DetachBulkAction $action

Return Value

void

at line 294
protected void configureDissociateBulkAction(DissociateBulkAction $action)

No description

Parameters

DissociateBulkAction $action

Return Value

void

at line 300
protected void configureForceDeleteBulkAction(ForceDeleteBulkAction $action)

No description

Parameters

ForceDeleteBulkAction $action

Return Value

void

at line 306
protected void configureRestoreBulkAction(RestoreBulkAction $action)

No description

Parameters

RestoreBulkAction $action

Return Value

void

at line 312
protected bool can(string $action, Model|null $record = null)

No description

Parameters

string $action
Model|null $record

Return Value

bool

at line 332
Infolist infolist(Infolist $infolist)

No description

Parameters

Infolist $infolist

Return Value

Infolist

at line 337
bool isReadOnly()

No description

Return Value

bool

at line 356
protected bool canAssociate()

No description

Return Value

bool

at line 361
protected bool canAttach()

No description

Return Value

bool

at line 366
protected bool canCreate()

No description

Return Value

bool

at line 371
protected bool canDelete(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 376
protected bool canDeleteAny()

No description

Return Value

bool

at line 381
protected bool canDetach(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 386
protected bool canDetachAny()

No description

Return Value

bool

at line 391
protected bool canDissociate(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 396
protected bool canDissociateAny()

No description

Return Value

bool

at line 401
protected bool canEdit(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 406
protected bool canForceDelete(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 411
protected bool canForceDeleteAny()

No description

Return Value

bool

at line 416
protected bool canReorder()

No description

Return Value

bool

at line 421
protected bool canReplicate(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 426
protected bool canRestore(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 431
protected bool canRestoreAny()

No description

Return Value

bool

at line 436
protected bool canView(Model $record)

No description

Parameters

Model $record

Return Value

bool

at line 444
static string|null getRecordTitleAttribute() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

at line 452
static protected string|null getRecordLabel() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

at line 460
static protected string|null getModelLabel() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

at line 468
static protected string|null getPluralRecordLabel() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

at line 476
static protected string|null getPluralModelLabel() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

at line 484
string|null getInverseRelationshipName() deprecated

deprecated Override the `table()` method to configure the table.

No description

Return Value

string|null

at line 489
static bool canViewForRecord(Model $ownerRecord, string $pageClass)

No description

Parameters

Model $ownerRecord
string $pageClass

Return Value

bool

at line 522
static array getDefaultProperties()

No description

Return Value

array