DataverseGridQueryContext
in package
Resolved column context for building Dataverse grid queries.
The grid-visible columns are used for UI state. Query-visible columns include hidden-but-active dependencies such as sort, filter, and search columns.
Table of Contents
Properties
- $columnsMetadata : array<string|int, mixed>
- $gridVisibleColumns : array<string|int, mixed>
- $queryVisibleColumns : array<string|int, mixed>|null
Methods
- __construct() : mixed
- columnsMetadata() : array<string, array<string, mixed>>
- Column metadata after request-specific filtering.
- gridVisibleColumns() : array<int, string>
- Columns that should be displayed in the grid UI.
- loadsAny() : bool
- Determine whether any of the given columns should be loaded.
- loadsColumn() : bool
- Determine whether a column's display data should be loaded.
- queryVisibleColumns() : array<int, string>|null
- Columns whose data dependencies should be loaded by query builders.
- requiredComputed() : array<int, string>
- Computed enrichment steps declared by active columns.
- requiredContains() : array<int, string>
- Associations declared by active columns as required display data.
- requiredFields() : array<int, string>
- Fields declared by active columns as required display data.
- requiresComputed() : bool
- Determine whether a computed enrichment step is required by active columns.
- requiresContain() : bool
- Determine whether an association is required by active columns.
- selectsAllDisplayData() : bool
- Determine whether export/all-display mode is active.
- activeColumnKeys() : array<int, string>
- metadataValuesForActiveColumns() : array<int, string>
Properties
$columnsMetadata read-only
private
array<string|int, mixed>
$columnsMetadata
$gridVisibleColumns read-only
private
array<string|int, mixed>
$gridVisibleColumns
$queryVisibleColumns read-only
private
array<string|int, mixed>|null
$queryVisibleColumns
Methods
__construct()
public
__construct(array<int, string> $gridVisibleColumns, array<int, string>|null $queryVisibleColumns, array<string, array<string, mixed>> $columnsMetadata) : mixed
Parameters
- $gridVisibleColumns : array<int, string>
- $queryVisibleColumns : array<int, string>|null
-
Null means load all display data.
- $columnsMetadata : array<string, array<string, mixed>>
columnsMetadata()
Column metadata after request-specific filtering.
public
columnsMetadata() : array<string, array<string, mixed>>
Return values
array<string, array<string, mixed>>gridVisibleColumns()
Columns that should be displayed in the grid UI.
public
gridVisibleColumns() : array<int, string>
Return values
array<int, string>loadsAny()
Determine whether any of the given columns should be loaded.
public
loadsAny(array<int, string> $columnKeys) : bool
Parameters
- $columnKeys : array<int, string>
Return values
boolloadsColumn()
Determine whether a column's display data should be loaded.
public
loadsColumn(string $columnKey) : bool
Parameters
- $columnKey : string
Return values
boolqueryVisibleColumns()
Columns whose data dependencies should be loaded by query builders.
public
queryVisibleColumns() : array<int, string>|null
Return values
array<int, string>|null —Null means load all display data.
requiredComputed()
Computed enrichment steps declared by active columns.
public
requiredComputed() : array<int, string>
Return values
array<int, string>requiredContains()
Associations declared by active columns as required display data.
public
requiredContains() : array<int, string>
Return values
array<int, string>requiredFields()
Fields declared by active columns as required display data.
public
requiredFields() : array<int, string>
Return values
array<int, string>requiresComputed()
Determine whether a computed enrichment step is required by active columns.
public
requiresComputed(string $computedKey) : bool
Parameters
- $computedKey : string
Return values
boolrequiresContain()
Determine whether an association is required by active columns.
public
requiresContain(string $association) : bool
Parameters
- $association : string
Return values
boolselectsAllDisplayData()
Determine whether export/all-display mode is active.
public
selectsAllDisplayData() : bool
Return values
boolactiveColumnKeys()
private
activeColumnKeys() : array<int, string>
Return values
array<int, string>metadataValuesForActiveColumns()
private
metadataValuesForActiveColumns(string $metadataKey) : array<int, string>
Parameters
- $metadataKey : string