ActionItemsGridColumns
extends BaseGridColumns
in package
Action Items Grid Column Metadata
Defines column configuration for the "My To-Dos" Dataverse grid. Mirrors the My Approvals grid: an "Open To-Dos" system view (items the member may act on) and a "Completed" system view (to-dos the member has completed), with a modal Complete / Reopen row action.
Table of Contents
Constants
- MEMBER_SCOPE_ACTIONABLE : mixed = 'actionable'
- MEMBER_SCOPE_COMPLETED_BY_ME : mixed = 'completed_by_me'
- NO_GATHERING_FILTER_VALUE : mixed = '__none__'
Methods
- applyGatheringFilter() : SelectQuery
- Filter to-dos by the gathering assigned to their polymorphic owner.
- applyMemberScopeFilter() : SelectQuery
- Apply the symbolic current-member scope stored with a To-Do view.
- 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>>
- Column definitions for the My To-Dos 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>>
- Row actions for the My To-Dos grid.
- getSearchableColumns() : array<string|int, string>
- Get searchable columns
- getSortableColumns() : array<string|int, string>
- Get sortable columns
- getSystemViews() : array<string, array<string, mixed>>
- System views for the My To-Dos grid.
- validateColumnKeys() : array<string|int, string>
- Validate that column keys exist
Constants
MEMBER_SCOPE_ACTIONABLE
public
mixed
MEMBER_SCOPE_ACTIONABLE
= 'actionable'
MEMBER_SCOPE_COMPLETED_BY_ME
public
mixed
MEMBER_SCOPE_COMPLETED_BY_ME
= 'completed_by_me'
NO_GATHERING_FILTER_VALUE
public
mixed
NO_GATHERING_FILTER_VALUE
= '__none__'
Methods
applyGatheringFilter()
Filter to-dos by the gathering assigned to their polymorphic owner.
public
static applyGatheringFilter(SelectQuery $query, array<string|int, mixed>|string $filterValue[, array<string, mixed> $context = [] ]) : SelectQuery
Only Awards bestowals currently support gathering ownership. "None" therefore includes generic owners, missing bestowals, and bestowals that do not resolve to an active gathering.
Parameters
- $query : SelectQuery
-
Action items query.
- $filterValue : array<string|int, mixed>|string
-
Selected gathering IDs or the none sentinel.
- $context : array<string, mixed> = []
-
Trait-supplied context (unused).
Return values
SelectQuery —Filtered query.
applyMemberScopeFilter()
Apply the symbolic current-member scope stored with a To-Do view.
public
static applyMemberScopeFilter(SelectQuery $query, mixed $filterValue[, array<string, mixed> $context = [] ]) : SelectQuery
Parameters
- $query : SelectQuery
-
Action items query.
- $filterValue : mixed
-
Saved symbolic filter value.
- $context : array<string, mixed> = []
-
Grid filter context.
Return values
SelectQuery —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()
Column definitions for the My To-Dos 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()
Row actions for the My To-Dos grid.
public
static getRowActions() : array<string, array<string, mixed>>
Complete is offered on open items; Reopen on completed items. Both open the shared completion modal, which reads the row's id/title/mode from the triggering button via Bootstrap's show.bs.modal event.
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()
System views for the My To-Dos grid.
public
static getSystemViews([array<string, mixed> $options = [] ]) : array<string, array<string, mixed>>
Parameters
- $options : array<string, mixed> = []
-
Runtime context (unused).
Return values
array<string, array<string, mixed>>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