BaseGridColumns
in package
implements
SystemViewsProviderInterface
Base class for grid column metadata definitions.
Provides common helper methods for querying column metadata. Grid-specific classes extend this and implement getColumns().
Tags
Table of Contents
Interfaces
- SystemViewsProviderInterface
- Contract for GridColumns classes that provide dv_grid system views.
Methods
- 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
- 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.
- validateColumnKeys() : array<string|int, string>
- Validate that column keys exist
Methods
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
abstract static getColumns() : array<string, array<string, mixed>>
Must be implemented by child classes to return column metadata
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
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>>
Override in child classes to provide system-defined dv_grid views.
Parameters
- $options : array<string, mixed> = []
-
Runtime context (timezone, scope, etc.)
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