1. class
  2. Filament
  3. \
  4. Tables
  5. \
  6. TableComponent

TableComponent

abstract class TableComponent extends Component implements HasForms, HasTable (View source)

Traits

InteractsWithTable
CanBeStriped
CanPaginateRecords
CanPollRecords
CanReorderRecords
CanSearchRecords
CanSelectRecords
CanSortRecords
CanToggleColumns
CanDeferLoading
HasActions
HasBulkActions
HasColumns
HasContent
HasEmptyState
HasFilters
HasHeader
HasRecords
HasRecordAction
HasRecordClasses
HasRecordUrl
InteractsWithForms
WithPagination
WithFileUploads
HasFormComponentActions

Properties

$tableRecordsPerPage from  CanPaginateRecords
protected int $defaultTableRecordsPerPageSelectOption from  CanPaginateRecords
bool $isTableReordering from  CanReorderRecords
$tableColumnSearchQueries from  CanSearchRecords
$tableSearchQuery from  CanSearchRecords
array $selectedTableRecords from  CanSelectRecords
protected bool $shouldSelectCurrentPageOnly from  CanSelectRecords
protected Collection $cachedSelectedTableRecords from  CanSelectRecords
$tableSortColumn from  CanSortRecords
$tableSortDirection from  CanSortRecords
array $toggledTableColumns from  CanToggleColumns
ComponentContainer $toggleTableColumnForm from  CanToggleColumns
bool $isTableLoaded from  CanDeferLoading
$mountedTableAction from  HasActions
$mountedTableActionData from  HasActions
$mountedTableActionRecord from  HasActions
protected array $cachedTableActions from  HasActions
protected array $cachedTableColumnActions from  HasActions
protected Model|null $cachedMountedTableActionRecord from  HasActions
protected $cachedMountedTableActionRecordKey from  HasActions
ComponentContainer $mountedTableActionForm from  HasActions
$mountedTableBulkAction from  HasBulkActions
$mountedTableBulkActionData from  HasBulkActions
protected array $cachedTableBulkActions from  HasBulkActions
ComponentContainer $mountedTableBulkActionForm from  HasBulkActions
protected array $cachedTableColumns from  HasColumns
protected array $cachedTableColumnsLayout from  HasColumns
protected Component|null $cachedTableCollapsibleColumnsLayout from  HasColumns
protected bool $hasTableColumnsLayout from  HasColumns
protected array $cachedTableEmptyStateActions from  HasEmptyState
protected array $cachedTableFilters from  HasFilters
$tableFilters from  HasFilters
ComponentContainer $tableFiltersForm from  HasFilters
protected array $cachedTableHeaderActions from  HasHeader
protected bool $allowsDuplicates from  HasRecords
protected Paginator|null $records from  HasRecords
$mountedFormComponentAction from  HasFormComponentActions
$mountedFormComponentActionArguments from  HasFormComponentActions
$mountedFormComponentActionData from  HasFormComponentActions
$mountedFormComponentActionComponent from  HasFormComponentActions
ComponentContainer $mountedFormComponentActionForm from  HasFormComponentActions
array $componentFileAttachments from  InteractsWithForms
protected array|null $cachedForms from  InteractsWithForms
protected bool $hasCachedForms from  InteractsWithForms
protected bool $isCachingForms from  InteractsWithForms
protected bool $hasModalViewRendered from  InteractsWithForms
protected bool $hasMounted from  InteractsWithTable
protected Table $table from  InteractsWithTable

Methods

bool
isTableStriped()

No description

from  CanBeStriped
void
updatedTableRecordsPerPage()

No description

from  CanPaginateRecords
Paginator
paginateTableQuery(Builder $query)

No description

from  CanPaginateRecords
int
getTableRecordsPerPage()

No description

from  CanPaginateRecords
array
getTableRecordsPerPageSelectOptions()

No description

from  CanPaginateRecords
int
getDefaultTableRecordsPerPageSelectOption()

No description

from  CanPaginateRecords
bool
isTablePaginationEnabled()

No description

from  CanPaginateRecords
string
getTablePaginationPageName()

No description

from  CanPaginateRecords
string
getTablePerPageSessionKey()

No description

from  CanPaginateRecords
void
resetPage(string|null $pageName = null)

No description

from  CanPaginateRecords
string|null
getTablePollingInterval()

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

No description

from  CanReorderRecords
bool
isTableReorderable()

No description

from  CanReorderRecords
string|null
getTableReorderColumn()

No description

from  CanReorderRecords
bool
isTableSearchable()

No description

from  CanSearchRecords
bool
isTableSearchableByColumn()

No description

from  CanSearchRecords
void
updatedTableSearchQuery()

No description

from  CanSearchRecords
void
updatedTableColumnSearchQueries($value = null, $key = null)

No description

from  CanSearchRecords
Builder
applySearchToTableQuery(Builder $query)

No description

from  CanSearchRecords
Builder
applyColumnSearchToTableQuery(Builder $query)

No description

from  CanSearchRecords
Builder
applyGlobalSearchToTableQuery(Builder $query)

No description

from  CanSearchRecords
string
getTableSearchQuery()

No description

from  CanSearchRecords
array
castTableColumnSearchQueries(array $searchQueries)

No description

from  CanSearchRecords
array
getTableColumnSearchQueries()

No description

from  CanSearchRecords
bool
hasTableColumnSearches()

No description

from  CanSearchRecords
string
getTableSearchSessionKey()

No description

from  CanSearchRecords
bool
shouldPersistTableSearchInSession()

No description

from  CanSearchRecords
string
getTableColumnSearchSessionKey()

No description

from  CanSearchRecords
bool
shouldPersistTableColumnSearchInSession()

No description

from  CanSearchRecords
void
deselectAllTableRecords()

No description

from  CanSelectRecords
bool
shouldDeselectAllRecordsWhenTableFiltered()

No description

from  CanSelectRecords
array
getAllSelectableTableRecordKeys()

No description

from  CanSelectRecords
int
getAllSelectableTableRecordsCount()

No description

from  CanSelectRecords
int
getAllTableRecordsCount()

No description

from  CanSelectRecords
Collection
getSelectedTableRecords()

No description

from  CanSelectRecords
bool
isTableSelectionEnabled()

No description

from  CanSelectRecords
string
getTableRecordCheckboxPosition()

No description

from  CanSelectRecords
bool
shouldSelectCurrentPageOnly()

No description

from  CanSelectRecords
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
string|null
getDefaultTableSortColumn()

No description

from  CanSortRecords
string|null
getDefaultTableSortDirection()

No description

from  CanSortRecords
void
updatedTableSort()

No description

from  CanSortRecords
Builder
applySortingToTableQuery(Builder $query)

No description

from  CanSortRecords
Builder
applyDefaultSortingToTableQuery(Builder $query, string $sortColumn, string $sortDirection)

No description

from  CanSortRecords
string
getTableSortSessionKey()

No description

from  CanSortRecords
bool
shouldPersistTableSortInSession()

No description

from  CanSortRecords
array
getDefaultTableColumnToggleState()

No description

from  CanToggleColumns
void
updatedToggledTableColumns()

No description

from  CanToggleColumns
bool
hasToggleableTableColumns()

No description

from  CanToggleColumns
ComponentContainer
getTableColumnToggleForm()

No description

from  CanToggleColumns
array
getTableColumnToggleFormSchema()

No description

from  CanToggleColumns
int|array
getTableColumnToggleFormColumns()

No description

from  CanToggleColumns
string|null
getTableColumnToggleFormMaxHeight()

No description

from  CanToggleColumns
string|null
getTableColumnToggleFormWidth()

No description

from  CanToggleColumns
bool
isTableColumnToggledHidden(string $name)

No description

from  CanToggleColumns
string
getTableColumnToggleFormStateSessionKey()

No description

from  CanToggleColumns
bool
isTableLoadingDeferred()

No description

from  CanDeferLoading
void
loadTable()

No description

from  CanDeferLoading
bool
isTableLoaded()

No description

from  CanDeferLoading
void
cacheTableActions()

No description

from  HasActions
void
cacheTableColumnActions()

No description

from  HasActions
void
configureTableAction(Action $action)

No description

from  HasActions
callMountedTableAction(string|null $arguments = null)

No description

from  HasActions
void
mountedTableActionRecord($record)

No description

from  HasActions
mountTableAction(string $name, string|null $record = null)

No description

from  HasActions
array
getCachedTableActions()

No description

from  HasActions
array
getCachedTableColumnActions()

No description

from  HasActions
Action|null
getMountedTableAction()

No description

from  HasActions
ComponentContainer|null
getMountedTableActionForm()

No description

from  HasActions
getMountedTableActionRecordKey()

No description

from  HasActions
Model|null
getMountedTableActionRecord()

No description

from  HasActions
Action|null
getCachedTableAction(string $name)

No description

from  HasActions
Action|null
findTableAction(string $name)

No description

from  HasActions
array
getTableActions()

No description

from  HasActions
string|null
getTableActionsPosition()

No description

from  HasActions
string|null
getTableActionsColumnLabel()

No description

from  HasActions
void
cacheTableBulkActions()

No description

from  HasBulkActions
void
configureTableBulkAction(BulkAction $action)

No description

from  HasBulkActions
callMountedTableBulkAction(string|null $arguments = null)

No description

from  HasBulkActions
mountTableBulkAction(string $name, array $selectedRecords)

No description

from  HasBulkActions
array
getCachedTableBulkActions()

No description

from  HasBulkActions
BulkAction|null
getMountedTableBulkAction()

No description

from  HasBulkActions
ComponentContainer|null
getMountedTableBulkActionForm()

No description

from  HasBulkActions
BulkAction|null
getCachedTableBulkAction(string $name)

No description

from  HasBulkActions
array
getTableBulkActions()

No description

from  HasBulkActions
Closure|null
isTableRecordSelectable()

No description

from  HasBulkActions
void
cacheTableColumns()

No description

from  HasColumns
callTableColumnAction(string $name, string $recordKey)

No description

from  HasColumns
array
getCachedTableColumns()

No description

from  HasColumns
array
getCachedTableColumnsLayout()

No description

from  HasColumns
Component|null
getCachedCollapsibleTableColumnsLayout()

No description

from  HasColumns
bool
hasTableColumnsLayout()

No description

from  HasColumns
Column|null
getCachedTableColumn(string $name)

No description

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

No description

from  HasColumns
array
getTableColumns()

No description

from  HasColumns
View|null
getTableContent()

No description

from  HasContent
array|null
getTableContentGrid()

No description

from  HasContent
View|null
getTableContentFooter()

No description

from  HasContent
void
cacheTableEmptyStateActions()

No description

from  HasEmptyState
array
getCachedTableEmptyStateActions()

No description

from  HasEmptyState
Action|null
getCachedTableEmptyStateAction(string $name)

No description

from  HasEmptyState
View|null
getTableEmptyState()

No description

from  HasEmptyState
array
getTableEmptyStateActions()

No description

from  HasEmptyState
string|null
getTableEmptyStateDescription()

No description

from  HasEmptyState
string|null
getTableEmptyStateHeading()

No description

from  HasEmptyState
string|null
getTableEmptyStateIcon()

No description

from  HasEmptyState
void
cacheTableFilters()

No description

from  HasFilters
array
getCachedTableFilters()

No description

from  HasFilters
BaseFilter|null
getCachedTableFilter(string $name)

No description

from  HasFilters
ComponentContainer
getTableFiltersForm()

No description

from  HasFilters
bool
isTableFilterable()

No description

from  HasFilters
void
updatedTableFilters()

No description

from  HasFilters
void
removeTableFilter(string $filter, string|null $field = null)

No description

from  HasFilters
void
removeTableFilters()

No description

from  HasFilters
void
resetTableFiltersForm()

No description

from  HasFilters
Builder
applyFiltersToTableQuery(Builder $query)

No description

from  HasFilters
array
getTableFilters()

No description

from  HasFilters
array|null
getTableFilterState(string $name)

No description

from  HasFilters
string
parseFilterName(string $name)

No description

from  HasFilters
int|array
getTableFiltersFormColumns()

No description

from  HasFilters
string|null
getTableFiltersFormMaxHeight()

No description

from  HasFilters
array
getTableFiltersFormSchema()

No description

from  HasFilters
string|null
getTableFiltersFormWidth()

No description

from  HasFilters
string|null
getTableFiltersLayout()

No description

from  HasFilters
string
getTableFiltersSessionKey()

No description

from  HasFilters
bool
shouldPersistTableFiltersInSession()

No description

from  HasFilters
void
cacheTableHeaderActions()

No description

from  HasHeader
array
getCachedTableHeaderActions()

No description

from  HasHeader
Action|null
getCachedTableHeaderAction(string $name)

No description

from  HasHeader
Htmlable|null
getTableDescription()

No description

from  HasHeader
Htmlable|null
getTableHeader()

No description

from  HasHeader
array
getTableHeaderActions()

No description

from  HasHeader
Htmlable|Closure|null
getTableHeading()

No description

from  HasHeader
bool
allowsDuplicates()

No description

from  HasRecords
Builder
getFilteredTableQuery()

No description

from  HasRecords
Paginator
hydratePivotRelationForTableRecords(Paginator $records)

No description

from  HasRecords
Paginator
getTableRecords()

No description

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

No description

from  HasRecords
string
getTableModel()

No description

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

No description

from  HasRecords
string
getTableRecordKey(Model $record)

No description

from  HasRecords
string
getTableRecordTitle(Model $record)

No description

from  HasRecords
string
getTableModelLabel()

No description

from  HasRecords
string
getTablePluralModelLabel()

No description

from  HasRecords
Closure|null
getTableRecordActionUsing()

No description

from  HasRecordAction
string|null
getTableRecordAction() deprecated

No description

from  HasRecordAction
Closure|null
getTableRecordClassesUsing()

No description

from  HasRecordClasses
Closure|null
getTableRecordUrlUsing()

No description

from  HasRecordUrl
bool
hasMountedFormComponentAction()

No description

from  HasFormComponentActions
ComponentContainer|null
getMountedFormComponentActionForm()

No description

from  HasFormComponentActions
callMountedFormComponentAction(string|null $arguments = null)

No description

from  HasFormComponentActions
Action|Closure|null
getMountedFormComponentAction()

No description

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

No description

from  HasFormComponentActions
Component|null
getMountedFormComponentActionComponent()

No description

from  HasFormComponentActions
array
getFormComponentActions()

No description

from  HasFormComponentActions
__get($property)

No description

from  InteractsWithForms
View|null
getModalViewOnce()

No description

from  InteractsWithForms
void
dispatchFormEvent(...$args)

No description

from  InteractsWithForms
TemporaryUploadedFile|null
getComponentFileAttachment(string $statePath)

No description

from  InteractsWithForms
string|null
getComponentFileAttachmentUrl(string $statePath)

No description

from  InteractsWithForms
array
getSelectOptionLabels(string $statePath)

No description

from  InteractsWithForms
string|null
getSelectOptionLabel(string $statePath)

No description

from  InteractsWithForms
array
getSelectOptions(string $statePath)

No description

from  InteractsWithForms
array
getSelectSearchResults(string $statePath, string $search)

No description

from  InteractsWithForms
void
deleteUploadedFile(string $statePath, string $fileKey)

No description

from  InteractsWithForms
array|null
getUploadedFileUrls(string $statePath)

No description

from  InteractsWithForms
void
removeUploadedFile(string $statePath, string $fileKey)

No description

from  InteractsWithForms
void
reorderUploadedFiles(string $statePath, array $fileKeys)

No description

from  InteractsWithForms
validate($rules = null, $messages = [], $attributes = [])

No description

from  InteractsWithForms
void
onValidationError(ValidationException $exception)

No description

from  InteractsWithForms
validateOnly($field, $rules = null, $messages = [], $attributes = [])

No description

from  InteractsWithForms
string|null
getActiveFormLocale()

No description

from  InteractsWithForms
void
callBeforeAndAfterSyncHooks($name, $value, $callback)

No description

from  InteractsWithForms
ComponentContainer|null
cacheForm(string $name, ComponentContainer|Closure|null $form)

No description

from  InteractsWithForms
array
cacheForms()

No description

from  InteractsWithForms
array
getUncachedForms()

No description

from  InteractsWithForms
array
getTraitForms()

No description

from  InteractsWithForms
bool
hasCachedForm($name)

No description

from  InteractsWithForms
ComponentContainer|null
getCachedForm($name)

No description

from  InteractsWithForms
array
getCachedForms()

No description

from  InteractsWithForms
Model|string|null
getFormModel()

No description

from  InteractsWithForms
array
getFormSchema()

No description

from  InteractsWithForms
array
getForms()

No description

from  InteractsWithForms
string|null
getFormContext()

No description

from  InteractsWithForms
string|null
getFormStatePath()

No description

from  InteractsWithForms
array
getRules()

No description

from  InteractsWithForms
array
getValidationAttributes()

No description

from  InteractsWithForms
ComponentContainer
makeForm()

No description

from  InteractsWithForms
void
bootedInteractsWithTable()

No description

from  InteractsWithTable
void
mountInteractsWithTable()

No description

from  InteractsWithTable
Table
getCachedTable()

No description

from  InteractsWithTable
Table
getTable()

No description

from  InteractsWithTable
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
array
getTableForms()

No description

from  InteractsWithTable
Relation
getTableQuery()

No description

from  InteractsWithTable
Relation
selectPivotDataInQuery(Relation $query)

No description

from  InteractsWithTable

Details

in CanBeStriped at line 7
protected bool isTableStriped()

No description

Return Value

bool

in CanPaginateRecords at line 20
void updatedTableRecordsPerPage()

No description

Return Value

void

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

No description

Parameters

Builder $query

Return Value

Paginator

in CanPaginateRecords at line 41
protected int getTableRecordsPerPage()

No description

Return Value

int

in CanPaginateRecords at line 46
protected array getTableRecordsPerPageSelectOptions()

No description

Return Value

array

in CanPaginateRecords at line 51
protected int getDefaultTableRecordsPerPageSelectOption()

No description

Return Value

int

in CanPaginateRecords at line 67
protected bool isTablePaginationEnabled()

No description

Return Value

bool

in CanPaginateRecords at line 72
protected string getTablePaginationPageName()

No description

Return Value

string

in CanPaginateRecords at line 77
string getTablePerPageSessionKey()

No description

Return Value

string

in CanPaginateRecords at line 84
void resetPage(string|null $pageName = null)

No description

Parameters

string|null $pageName

Return Value

void

in CanPollRecords at line 7
protected string|null getTablePollingInterval()

No description

Return Value

string|null

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

No description

Parameters

array $order

Return Value

void

in CanReorderRecords at line 51
void toggleTableReordering()

No description

Return Value

void

in CanReorderRecords at line 56
bool isTableReordering()

No description

Return Value

bool

in CanReorderRecords at line 61
protected bool isTablePaginationEnabledWhileReordering()

No description

Return Value

bool

in CanReorderRecords at line 66
protected bool isTableReorderable()

No description

Return Value

bool

in CanReorderRecords at line 71
protected string|null getTableReorderColumn()

No description

Return Value

string|null

in CanSearchRecords at line 15
bool isTableSearchable()

No description

Return Value

bool

in CanSearchRecords at line 28
bool isTableSearchableByColumn()

No description

Return Value

bool

in CanSearchRecords at line 41
void updatedTableSearchQuery()

No description

Return Value

void

in CanSearchRecords at line 57
void updatedTableColumnSearchQueries($value = null, $key = null)

No description

Parameters

$value
$key

Return Value

void

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

No description

Parameters

Builder $query

Return Value

Builder

in CanSearchRecords at line 85
protected Builder applyColumnSearchToTableQuery(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

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

No description

Parameters

Builder $query

Return Value

Builder

in CanSearchRecords at line 140
protected string getTableSearchQuery()

No description

Return Value

string

in CanSearchRecords at line 145
protected array castTableColumnSearchQueries(array $searchQueries)

No description

Parameters

array $searchQueries

Return Value

array

in CanSearchRecords at line 155
protected array getTableColumnSearchQueries()

No description

Return Value

array

in CanSearchRecords at line 197
bool hasTableColumnSearches()

No description

Return Value

bool

in CanSearchRecords at line 203
string getTableSearchSessionKey()

No description

Return Value

string

in CanSearchRecords at line 210
protected bool shouldPersistTableSearchInSession()

No description

Return Value

bool

in CanSearchRecords at line 215
string getTableColumnSearchSessionKey()

No description

Return Value

string

in CanSearchRecords at line 222
protected bool shouldPersistTableColumnSearchInSession()

No description

Return Value

bool

in CanSelectRecords at line 22
void deselectAllTableRecords()

No description

Return Value

void

in CanSelectRecords at line 27
bool shouldDeselectAllRecordsWhenTableFiltered()

No description

Return Value

bool

in CanSelectRecords at line 32
array getAllSelectableTableRecordKeys()

No description

Return Value

array

in CanSelectRecords at line 66
int getAllSelectableTableRecordsCount()

No description

Return Value

int

in CanSelectRecords at line 90
int getAllTableRecordsCount()

No description

Return Value

int

in CanSelectRecords at line 99
Collection getSelectedTableRecords()

No description

Return Value

Collection

in CanSelectRecords at line 136
bool isTableSelectionEnabled()

No description

Return Value

bool

in CanSelectRecords at line 144
string getTableRecordCheckboxPosition()

No description

Return Value

string

in CanSelectRecords at line 149
bool shouldSelectCurrentPageOnly()

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
protected string|null getDefaultTableSortColumn()

No description

Return Value

string|null

in CanSortRecords at line 46
protected string|null getDefaultTableSortDirection()

No description

Return Value

string|null

in CanSortRecords at line 51
void updatedTableSort()

No description

Return Value

void

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

No description

Parameters

Builder $query

Return Value

Builder

in CanSortRecords at line 94
protected Builder applyDefaultSortingToTableQuery(Builder $query, string $sortColumn, string $sortDirection)

No description

Parameters

Builder $query
string $sortColumn
string $sortDirection

Return Value

Builder

in CanSortRecords at line 103
string getTableSortSessionKey()

No description

Return Value

string

in CanSortRecords at line 110
protected bool shouldPersistTableSortInSession()

No description

Return Value

bool

in CanToggleColumns at line 16
protected array getDefaultTableColumnToggleState()

No description

Return Value

array

in CanToggleColumns at line 31
void updatedToggledTableColumns()

No description

Return Value

void

in CanToggleColumns at line 38
bool hasToggleableTableColumns()

No description

Return Value

bool

in CanToggleColumns at line 51
ComponentContainer getTableColumnToggleForm()

No description

Return Value

ComponentContainer

in CanToggleColumns at line 64
protected array getTableColumnToggleFormSchema()

No description

Return Value

array

in CanToggleColumns at line 80
protected int|array getTableColumnToggleFormColumns()

No description

Return Value

int|array

in CanToggleColumns at line 85
protected string|null getTableColumnToggleFormMaxHeight()

No description

Return Value

string|null

in CanToggleColumns at line 90
protected string|null getTableColumnToggleFormWidth()

No description

Return Value

string|null

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

No description

Parameters

string $name

Return Value

bool

in CanToggleColumns at line 105
string getTableColumnToggleFormStateSessionKey()

No description

Return Value

string

in CanDeferLoading at line 9
bool isTableLoadingDeferred()

No description

Return Value

bool

in CanDeferLoading at line 14
void loadTable()

No description

Return Value

void

in CanDeferLoading at line 19
bool isTableLoaded()

No description

Return Value

bool

in HasActions at line 32
void cacheTableActions()

No description

Return Value

void

in HasActions at line 58
void cacheTableColumnActions()

No description

Return Value

void

in HasActions at line 81
protected void configureTableAction(Action $action)

No description

Parameters

Action $action

Return Value

void

in HasActions at line 85
callMountedTableAction(string|null $arguments = null)

No description

Parameters

string|null $arguments

in HasActions at line 147
void mountedTableActionRecord($record)

No description

Parameters

$record

Return Value

void

in HasActions at line 152
mountTableAction(string $name, string|null $record = null)

No description

Parameters

string $name
string|null $record

in HasActions at line 208
array getCachedTableActions()

No description

Return Value

array

in HasActions at line 213
array getCachedTableColumnActions()

No description

Return Value

array

in HasActions at line 218
Action|null getMountedTableAction()

No description

Return Value

Action|null

in HasActions at line 227
ComponentContainer|null getMountedTableActionForm()

No description

Return Value

ComponentContainer|null

in HasActions at line 246
getMountedTableActionRecordKey()

No description

in HasActions at line 251
Model|null getMountedTableActionRecord()

No description

Return Value

Model|null

in HasActions at line 264
Action|null getCachedTableAction(string $name)

No description

Parameters

string $name

Return Value

Action|null

in HasActions at line 269
protected Action|null findTableAction(string $name)

No description

Parameters

string $name

Return Value

Action|null

in HasActions at line 304
protected array getTableActions()

No description

Return Value

array

in HasActions at line 309
protected string|null getTableActionsPosition()

No description

Return Value

string|null

in HasActions at line 314
protected string|null getTableActionsColumnLabel()

No description

Return Value

string|null

in HasBulkActions at line 22
void cacheTableBulkActions()

No description

Return Value

void

in HasBulkActions at line 38
protected void configureTableBulkAction(BulkAction $action)

No description

Parameters

BulkAction $action

Return Value

void

in HasBulkActions at line 42
callMountedTableBulkAction(string|null $arguments = null)

No description

Parameters

string|null $arguments

in HasBulkActions at line 98
mountTableBulkAction(string $name, array $selectedRecords)

No description

Parameters

string $name
array $selectedRecords

in HasBulkActions at line 150
array getCachedTableBulkActions()

No description

Return Value

array

in HasBulkActions at line 155
BulkAction|null getMountedTableBulkAction()

No description

Return Value

BulkAction|null

in HasBulkActions at line 164
ComponentContainer|null getMountedTableBulkActionForm()

No description

Return Value

ComponentContainer|null

in HasBulkActions at line 183
BulkAction|null getCachedTableBulkAction(string $name)

No description

Parameters

string $name

Return Value

BulkAction|null

in HasBulkActions at line 191
protected array getTableBulkActions()

No description

Return Value

array

in HasBulkActions at line 196
Closure|null isTableRecordSelectable()

No description

Return Value

Closure|null

in HasColumns at line 22
void cacheTableColumns()

No description

Return Value

void

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

No description

Parameters

string $name
string $recordKey

in HasColumns at line 79
array getCachedTableColumns()

No description

Return Value

array

in HasColumns at line 84
array getCachedTableColumnsLayout()

No description

Return Value

array

in HasColumns at line 89
Component|null getCachedCollapsibleTableColumnsLayout()

No description

Return Value

Component|null

in HasColumns at line 94
bool hasTableColumnsLayout()

No description

Return Value

bool

in HasColumns at line 99
Column|null getCachedTableColumn(string $name)

No description

Parameters

string $name

Return Value

Column|null

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

No description

Parameters

string $column
string $record
$input

Return Value

mixed

in HasColumns at line 135
protected array getTableColumns()

No description

Return Value

array

in HasContent at line 9
protected View|null getTableContent()

No description

Return Value

View|null

in HasContent at line 14
protected array|null getTableContentGrid()

No description

Return Value

array|null

in HasContent at line 19
protected View|null getTableContentFooter()

No description

Return Value

View|null

in HasEmptyState at line 13
void cacheTableEmptyStateActions()

No description

Return Value

void

in HasEmptyState at line 29
array getCachedTableEmptyStateActions()

No description

Return Value

array

in HasEmptyState at line 34
Action|null getCachedTableEmptyStateAction(string $name)

No description

Parameters

string $name

Return Value

Action|null

in HasEmptyState at line 39
protected View|null getTableEmptyState()

No description

Return Value

View|null

in HasEmptyState at line 44
protected array getTableEmptyStateActions()

No description

Return Value

array

in HasEmptyState at line 49
protected string|null getTableEmptyStateDescription()

No description

Return Value

string|null

in HasEmptyState at line 54
protected string|null getTableEmptyStateHeading()

No description

Return Value

string|null

in HasEmptyState at line 59
protected string|null getTableEmptyStateIcon()

No description

Return Value

string|null

in HasFilters at line 20
void cacheTableFilters()

No description

Return Value

void

in HasFilters at line 31
array getCachedTableFilters()

No description

Return Value

array

in HasFilters at line 39
BaseFilter|null getCachedTableFilter(string $name)

No description

Parameters

string $name

Return Value

BaseFilter|null

in HasFilters at line 44
ComponentContainer getTableFiltersForm()

No description

Return Value

ComponentContainer

in HasFilters at line 57
bool isTableFilterable()

No description

Return Value

bool

in HasFilters at line 62
void updatedTableFilters()

No description

Return Value

void

in HasFilters at line 78
void removeTableFilter(string $filter, string|null $field = null)

No description

Parameters

string $filter
string|null $field

Return Value

void

in HasFilters at line 100
void removeTableFilters()

No description

Return Value

void

in HasFilters at line 115
void resetTableFiltersForm()

No description

Return Value

void

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

No description

Parameters

Builder $query

Return Value

Builder

in HasFilters at line 143
protected array getTableFilters()

No description

Return Value

array

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

No description

Parameters

string $name

Return Value

array|null

in HasFilters at line 153
string parseFilterName(string $name)

No description

Parameters

string $name

Return Value

string

in HasFilters at line 166
protected int|array getTableFiltersFormColumns()

No description

Return Value

int|array

in HasFilters at line 179
protected string|null getTableFiltersFormMaxHeight()

No description

Return Value

string|null

in HasFilters at line 184
protected array getTableFiltersFormSchema()

No description

Return Value

array

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

No description

Return Value

string|null

in HasFilters at line 209
protected string|null getTableFiltersLayout()

No description

Return Value

string|null

in HasFilters at line 214
string getTableFiltersSessionKey()

No description

Return Value

string

in HasFilters at line 221
protected bool shouldPersistTableFiltersInSession()

No description

Return Value

bool

in HasHeader at line 15
void cacheTableHeaderActions()

No description

Return Value

void

in HasHeader at line 41
array getCachedTableHeaderActions()

No description

Return Value

array

in HasHeader at line 46
Action|null getCachedTableHeaderAction(string $name)

No description

Parameters

string $name

Return Value

Action|null

in HasHeader at line 73
protected Htmlable|null getTableDescription()

No description

Return Value

Htmlable|null

in HasHeader at line 78
protected Htmlable|null getTableHeader()

No description

Return Value

Htmlable|null

in HasHeader at line 83
protected array getTableHeaderActions()

No description

Return Value

array

in HasHeader at line 88
protected Htmlable|Closure|null getTableHeading()

No description

Return Value

Htmlable|Closure|null

in HasRecords at line 22
bool allowsDuplicates()

No description

Return Value

bool

in HasRecords at line 27
protected Builder getFilteredTableQuery()

No description

Return Value

Builder

in HasRecords at line 43
protected Paginator hydratePivotRelationForTableRecords(Paginator $records)

No description

Parameters

Paginator $records

Return Value

Paginator

in HasRecords at line 52
Paginator getTableRecords()

No description

Return Value

Paginator

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

No description

Parameters

string|null $key

Return Value

Model|null

in HasRecords at line 97
string getTableModel()

No description

Return Value

string

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

No description

Parameters

string|null $key

Return Value

Model|null

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

No description

Parameters

Model $record

Return Value

string

in HasRecords at line 122
string getTableRecordTitle(Model $record)

No description

Parameters

Model $record

Return Value

string

in HasRecords at line 127
string getTableModelLabel()

No description

Return Value

string

in HasRecords at line 132
string getTablePluralModelLabel()

No description

Return Value

string

in HasRecordAction at line 10
protected Closure|null getTableRecordActionUsing()

No description

Return Value

Closure|null

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

deprecated Use `getTableRecordActionUsing()` instead.

No description

Return Value

string|null

in HasRecordClasses at line 9
protected Closure|null getTableRecordClassesUsing()

No description

Return Value

Closure|null

in HasRecordUrl at line 9
protected Closure|null getTableRecordUrlUsing()

No description

Return Value

Closure|null

in HasFormComponentActions at line 25
protected bool hasMountedFormComponentAction()

No description

Return Value

bool

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

No description

Return Value

ComponentContainer|null

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

No description

Parameters

string|null $arguments

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

No description

Return Value

Action|Closure|null

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

No description

Parameters

string $component
string $name
array $arguments

in HasFormComponentActions at line 180
Component|null getMountedFormComponentActionComponent()

No description

Return Value

Component|null

in HasFormComponentActions at line 199
protected array getFormComponentActions()

No description

Return Value

array

in InteractsWithForms at line 29
__get($property)

No description

Parameters

$property

in InteractsWithForms at line 46
protected View|null getModalViewOnce()

No description

Return Value

View|null

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

No description

Parameters

...$args

Return Value

void

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

No description

Parameters

string $statePath

Return Value

TemporaryUploadedFile|null

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

No description

Parameters

string $statePath

Return Value

string|null

in InteractsWithForms at line 84
array getSelectOptionLabels(string $statePath)

No description

Parameters

string $statePath

Return Value

array

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

No description

Parameters

string $statePath

Return Value

string|null

in InteractsWithForms at line 110
array getSelectOptions(string $statePath)

No description

Parameters

string $statePath

Return Value

array

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

No description

Parameters

string $statePath
string $search

Return Value

array

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

No description

Parameters

string $statePath
string $fileKey

Return Value

void

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

No description

Parameters

string $statePath

Return Value

array|null

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

No description

Parameters

string $statePath
string $fileKey

Return Value

void

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

No description

Parameters

string $statePath
array $fileKeys

Return Value

void

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

No description

Parameters

$rules
$messages
$attributes

in InteractsWithForms at line 183
protected void onValidationError(ValidationException $exception)

No description

Parameters

ValidationException $exception

Return Value

void

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

No description

Parameters

$field
$rules
$messages
$attributes

in InteractsWithForms at line 200
string|null getActiveFormLocale()

No description

Return Value

string|null

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

No description

Parameters

$name
$value
$callback

Return Value

void

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

No description

Parameters

string $name
ComponentContainer|Closure|null $form

Return Value

ComponentContainer|null

in InteractsWithForms at line 229
protected array cacheForms()

No description

Return Value

array

in InteractsWithForms at line 247
protected array getUncachedForms()

No description

Return Value

array

in InteractsWithForms at line 252
protected array getTraitForms()

No description

Return Value

array

in InteractsWithForms at line 265
protected bool hasCachedForm($name)

No description

Parameters

$name

Return Value

bool

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

No description

Parameters

$name

Return Value

ComponentContainer|null

in InteractsWithForms at line 275
protected array getCachedForms()

No description

Return Value

array

in InteractsWithForms at line 284
protected Model|string|null getFormModel()

No description

Return Value

Model|string|null

in InteractsWithForms at line 289
protected array getFormSchema()

No description

Return Value

array

in InteractsWithForms at line 294
protected array getForms()

No description

Return Value

array

in InteractsWithForms at line 305
protected string|null getFormContext()

No description

Return Value

string|null

in InteractsWithForms at line 310
protected string|null getFormStatePath()

No description

Return Value

string|null

in InteractsWithForms at line 315
protected array getRules()

No description

Return Value

array

in InteractsWithForms at line 326
protected array getValidationAttributes()

No description

Return Value

array

in InteractsWithForms at line 337
protected ComponentContainer makeForm()

No description

Return Value

ComponentContainer

in InteractsWithTable at line 43
void bootedInteractsWithTable()

No description

Return Value

void

in InteractsWithTable at line 150
void mountInteractsWithTable()

No description

Return Value

void

in InteractsWithTable at line 157
protected Table getCachedTable()

No description

Return Value

Table

in InteractsWithTable at line 162
protected Table getTable()

No description

Return Value

Table

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

No description

Return Value

string|null

in InteractsWithTable at line 172
protected string getIdentifiedTableQueryStringPropertyNameFor(string $property)

No description

Parameters

string $property

Return Value

string

in InteractsWithTable at line 181
protected array getInteractsWithTableForms()

No description

Return Value

array

in InteractsWithTable at line 186
string|null getActiveTableLocale()

No description

Return Value

string|null

in InteractsWithTable at line 191
protected array getTableForms()

No description

Return Value

array

in InteractsWithTable at line 199
protected Relation getTableQuery()

No description

Return Value

Relation

in InteractsWithTable at line 233
protected Relation selectPivotDataInQuery(Relation $query)

No description

Parameters

Relation $query

Return Value

Relation