KMP PHP API Reference

AuthorizationApprovalsGridColumns extends BaseGridColumns
in package

Grid column definitions for Authorization Approvals listing.

Used for the authorization approval queue views (myQueue and view actions).

Table of Contents

Methods

getApprovedViewColumns()  : array<string|int, string>
Get columns for the "approved" queue 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>>
Get all available columns for the authorization approvals grid
getDefaultVisibleColumns()  : array<string, array<string, mixed>>
Get only columns that are visible by default
getDeniedViewColumns()  : array<string|int, string>
Get columns for the "denied" queue view
getDropdownFilterColumns()  : array<string, array<string, mixed>>
Get columns with dropdown filters
getFilterableColumns()  : array<string|int, string>
Get all filterable columns
getPendingViewColumns()  : array<string|int, string>
Get columns for the "pending" queue view
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 system views for authorization approval queues
validateColumnKeys()  : array<string|int, string>
Validate that column keys exist

Methods

getApprovedViewColumns()

Get columns for the "approved" queue view

public static getApprovedViewColumns() : array<string|int, string>
Return values
array<string|int, string>

getColumn()

Get column by key

public static getColumn(string $key) : array<string, mixed>|null
Parameters
$key : string

Column key

Return values
array<string, mixed>|null

getColumnKeys()

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 authorization approvals 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>>

getDeniedViewColumns()

Get columns for the "denied" queue view

public static getDeniedViewColumns() : array<string|int, string>
Return values
array<string|int, string>

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

getPendingViewColumns()

Get columns for the "pending" queue view

public static getPendingViewColumns() : array<string|int, string>
Return values
array<string|int, string>

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 system views for authorization approval queues

public static getSystemViews([array<string|int, mixed> $options = [] ]) : array<string, array<string, mixed>>

Matches controller query logic in getQueueSystemViewCounts():

  • Pending: responded_on IS NULL
  • Approved: responded_on IS NOT NULL AND approved = true
  • Denied: responded_on IS NOT NULL AND approved = false
Parameters
$options : array<string|int, 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


        
On this page

Search results