BestowalsGridColumns
extends BaseGridColumns
in package
Grid column metadata for award bestowal Dataverse-style grids.
Used on the bestowals index and gathering-scoped bestowal tabs.
Table of Contents
Properties
- $includeCrownFields : bool
- $includeHeraldNotes : bool
Methods
- applyTodoRemainingFilter() : SelectQuery
- Custom filter handler narrowing bestowals by their open/remaining to-do checks.
- getColumn() : array<string, mixed>|null
- Get column by key
- getColumnKeys() : array<string|int, string>
- Get column keys as array
- getColumns() : array<string, array<string, mixed>>
- Get all available columns for the grid
- getDefaultVisibleColumns() : array<string, array<string, mixed>>
- Get only columns that are visible by default
- getDropdownFilterColumns() : array<string, array<string, mixed>>
- Get columns with dropdown filters
- getFilterableColumns() : array<string|int, string>
- Get all filterable columns
- getRequiredColumns() : array<string|int, string>
- Get required columns
- getRowActions() : array<string, array<string, mixed>>
- getSearchableColumns() : array<string|int, string>
- Get searchable columns
- getSortableColumns() : array<string|int, string>
- Get sortable columns
- getSystemViews() : array<string, array<string, mixed>>
- Return system views for a grid.
- getTodoRemainingFilterOptions() : array<int, array{value: string, label: string}>
- Dropdown filter options for the to-do summary column.
- setProtectedFieldVisibility() : array{heraldNotes: bool, crownFields: bool}
- Set protected-column visibility for the current request.
- validateColumnKeys() : array<string|int, string>
- Validate that column keys exist
Properties
$includeCrownFields
protected
static bool
$includeCrownFields
= false
$includeHeraldNotes
protected
static bool
$includeHeraldNotes
= false
Methods
applyTodoRemainingFilter()
Custom filter handler narrowing bestowals by their open/remaining to-do checks.
public
static applyTodoRemainingFilter(SelectQuery $query, array<string|int, mixed>|string $filterValue[, array<string, mixed> $context = [] ]) : SelectQuery
Supported values:
__remaining_any: bestowals with at least one open to-do (required or optional).__remaining: bestowals with at least one open gating (required) to-do.__complete: bestowals with no open to-do at all (every to-do done/cancelled).open:<item_key>: bestowals with that specific check still open.
Parameters
- $query : SelectQuery
-
The bestowals query to filter
- $filterValue : array<string|int, mixed>|string
-
Selected filter value
- $context : array<string, mixed> = []
-
Trait-supplied context (unused)
Return values
SelectQuery —The filtered query
getColumn()
Get column by key
public
static getColumn(string $key) : array<string, mixed>|null
Parameters
- $key : string
-
Column key
Return values
array<string, mixed>|nullgetColumnKeys()
Get column keys as array
public
static getColumnKeys() : array<string|int, string>
Return values
array<string|int, string>getColumns()
Get all available columns for the grid
public
static getColumns() : array<string, array<string, mixed>>
Return values
array<string, array<string, mixed>>getDefaultVisibleColumns()
Get only columns that are visible by default
public
static getDefaultVisibleColumns() : array<string, array<string, mixed>>
Return values
array<string, array<string, mixed>>getDropdownFilterColumns()
Get columns with dropdown filters
public
static getDropdownFilterColumns() : array<string, array<string, mixed>>
Returns array of column metadata for columns that have dropdown filter type or other UI-based filters (e.g., 'dropdown', 'is-populated')
Return values
array<string, array<string, mixed>> —Column metadata indexed by key
getFilterableColumns()
Get all filterable columns
public
static getFilterableColumns() : array<string|int, string>
Returns array of column keys that can be filtered
Return values
array<string|int, string> —Filterable column keys
getRequiredColumns()
Get required columns
public
static getRequiredColumns() : array<string|int, string>
Returns array of column keys that are required and cannot be hidden
Return values
array<string|int, string> —Required column keys
getRowActions()
public
static getRowActions() : array<string, array<string, mixed>>
Return values
array<string, array<string, mixed>>getSearchableColumns()
Get searchable columns
public
static getSearchableColumns() : array<string|int, string>
Returns array of column keys that should be included in text search
Return values
array<string|int, string> —Searchable column keys
getSortableColumns()
Get sortable columns
public
static getSortableColumns() : array<string|int, string>
Returns array of column keys that can be sorted
Return values
array<string|int, string> —Sortable column keys
getSystemViews()
Return system views for a grid.
public
static getSystemViews([array<string, mixed> $options = [] ]) : array<string, array<string, mixed>>
Parameters
- $options : array<string, mixed> = []
Return values
array<string, array<string, mixed>>getTodoRemainingFilterOptions()
Dropdown filter options for the to-do summary column.
public
static getTodoRemainingFilterOptions() : array<int, array{value: string, label: string}>
Because different awards can carry different to-do templates (e.g. kingdom vs baronial), the options combine path-agnostic states ("remaining" / "complete") with per-check options keyed on the shared template item key, so a single "Open: Scroll Ready" filter matches that check across every path that defines it.
Return values
array<int, array{value: string, label: string}>setProtectedFieldVisibility()
Set protected-column visibility for the current request.
public
static setProtectedFieldVisibility(bool $heraldNotes, bool $crownFields) : array{heraldNotes: bool, crownFields: bool}
Parameters
- $heraldNotes : bool
- $crownFields : bool
Return values
array{heraldNotes: bool, crownFields: bool} —Previous visibility.
validateColumnKeys()
Validate that column keys exist
public
static validateColumnKeys(array<string|int, string> $keys) : array<string|int, string>
Parameters
- $keys : array<string|int, string>
-
Column keys to validate
Return values
array<string|int, string> —Invalid keys