MembersGridColumns
extends BaseGridColumns
in package
Members Grid Column Metadata
Defines available columns for the Members data grid including rendering, sorting, filtering, and visibility settings.
Tags
Table of Contents
Properties
- $includePii : bool
- $queryPii : bool
Methods
- getColumn() : array<string, mixed>|null
- Get column by key
- getColumnKeys() : array<string|int, string>
- Get column keys as array
- getColumns() : array<string|int, mixed>
- Get columns.
- 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>>
- Get available system views for the Members grid.
- setIncludePii() : bool
- Control inclusion of PII columns for the current request.
- setQueryPii() : bool
- Restrict private-field queries when permission is scoped to individual records.
- validateColumnKeys() : array<string|int, string>
- Validate that column keys exist
- getPiiColumnKeys() : array<string|int, string>
- List of PII-related column keys.
Properties
$includePii
protected
static bool
$includePii
= true
Whether PII columns should be included
$queryPii
protected
static bool
$queryPii
= false
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 columns.
public
static getColumns() : array<string|int, mixed>
Return values
array<string|int, 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()
Get available system views for the Members grid.
public
static getSystemViews([array<string, mixed> $options = [] ]) : array<string, array<string, mixed>>
Parameters
- $options : array<string, mixed> = []
-
Optional context (unused)
Return values
array<string, array<string, mixed>>setIncludePii()
Control inclusion of PII columns for the current request.
public
static setIncludePii(bool $includePii) : bool
Parameters
- $includePii : bool
-
Include PII columns when true
Return values
bool —Previous include state
setQueryPii()
Restrict private-field queries when permission is scoped to individual records.
public
static setQueryPii(bool $allowed) : bool
Parameters
- $allowed : bool
Return values
boolvalidateColumnKeys()
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
getPiiColumnKeys()
List of PII-related column keys.
protected
static getPiiColumnKeys() : array<string|int, string>