KMP PHP API Reference

AwardsController extends AppController
in package

Awards

Controller

uses DataverseGridTrait

Awards Controller - Award Management and Hierarchical Organization

Provides CRUD operations for award configuration within the Domain/Level/Branch hierarchy. Includes API endpoints for award discovery and recommendation integration.

Uses DataverseGridTrait for table-based data display.

Constants

VIEW_DATA_EVENT = 'KMP.plugins.callForViewData'
VIEW_PLUGIN_EVENT = 'KMP.plugins.callForViewCells'

Properties

$Awards : AwardsTable
$isCsvRequest : bool
$pluginViewCells : array<string|int, mixed>

Methods

add() : Response|null|void: Award Add - Create new award.
addActivity() : Response|null: Associate a gathering activity with an award.
addActivityToGatheringActivity() : Response|null: Attach an award to a gathering activity from the GatheringActivity context.
awardsByDomain() : Response: Provide a JSON list of awards filtered by a domain, including domain, level, and branch context ordered by level progression and award name.
beforeFilter() : Response|null|void: Pre-action filter for application-wide processing.
delete() : Response|null: Award Delete - Soft deletion with referential integrity check.
edit() : Response|null|void: Award Edit - Modify existing award with specialty JSON handling.
gridData() : Response|null|void: Provide grid data for Awards listing.
index() : Response|null|void: Award Index - Administrative award listing.
initialize() : void: Initialize Awards Controller.
isCsvRequest() : bool: Check if current request is for CSV export.
removeActivity() : Response|null: Dissociate a gathering activity from an award.
switchView() : Response: Switch between mobile and desktop view modes.
view() : Response|null|void: Display a single award with its domain, level, branch, and related gathering activities and prepare form data for the management view.
_buildTurboStreamResponse() : string: Builds a Turbo Stream payload that replaces the flash messages frame and, if present, replaces the provided turbo-frame with the given content.
applyCustomFilterHandlers() : SelectQuery: Apply custom filter handlers for columns with complex filtering logic
authorizeCurrentUrl() : void: Authorize the current URL/action via Authorization component.
buildDataverseGridState() : array<string|int, mixed>: Build complete grid state object (single source of truth)
buildExportDataFromEntities() : array<string|int, mixed>: Build export data from pre-processed entities (Data Mode)
buildExportDataFromQuery() : array<string|int, mixed>: Build export data from database query (Query Mode)
extractExportValue() : string: Extract export value from entity using column metadata
extractFilterFromExpression() : mixed: Recursively extract a filter value from an expression tree
extractFilterFromSystemView() : mixed: Extract a specific filter value from a system view configuration
extractFilterFromViewConfig() : mixed: Extract a specific filter value from a saved user view's config
extractFilterGrouping() : array<string|int, mixed>: Extract filter grouping information from expression tree
extractSystemViewDefaults() : array{filters: array, dateRange: array, search: ?string, skipFilterColumns: array}: Extract default filters/search metadata for a system view configuration
formatExportValue() : string: Format value for CSV export
handleCsvExport() : Response: Handle CSV export from grid result
isCsvExportRequest() : bool: Check if the current request is for CSV export
loadFilterOptions() : array<string|int, mixed>: Load filter options from a data source
organizeViewCells() : array<string|int, mixed>: Organize view cells by type and display order.
processDataverseGrid() : array<string|int, mixed>: Process dataverse grid request with unified logic
resolveNestedValue() : mixed: Resolve nested value from entity using dot notation path

VIEW_DATA_EVENT


    public
        string
    VIEW_DATA_EVENT
    = 'KMP.plugins.callForViewData'

Event for plugin view data enhancement

VIEW_PLUGIN_EVENT


    public
        string
    VIEW_PLUGIN_EVENT
    = 'KMP.plugins.callForViewCells'

Event for plugin view cell registration

$Awards


        public
            AwardsTable
    $Awards

$isCsvRequest


        protected
            bool
    $isCsvRequest
     = false

Whether current request is for CSV export (.csv extension)

$pluginViewCells


        protected
            array<string|int, mixed>
    $pluginViewCells
     = []

View cells from plugins for current request

add()

Award Add - Create new award.


    public
                    add() : Response|null|void

Return values

Response|null|void —

Redirects on success, renders form otherwise

addActivity()

Associate a gathering activity with an award.


    public
                    addActivity([string|null $id = null ]) : Response|null

Creates a join record linking the specified award to the provided gathering activity and redirects back to the award's view page.

Parameters

$id : string|null = null: The award identifier.

Return values

Response|null —

Redirect response to the award view.

addActivityToGatheringActivity()

Attach an award to a gathering activity from the GatheringActivity context.


    public
                    addActivityToGatheringActivity([string|null $activityId = null ]) : Response|null

Creates an AwardGatheringActivity association and returns either a turbo-stream response updating the activity's awards cell (for Turbo/AJAX requests) or a redirect to the gathering activity view for standard form submissions.

Parameters

$activityId : string|null = null: The gathering activity identifier.

Return values

Response|null —

A Response containing turbo-stream HTML when the request expects turbo streams; otherwise a redirect Response to the gathering activity view.

awardsByDomain()

Provide a JSON list of awards filtered by a domain, including domain, level, and branch context ordered by level progression and award name.


    public
                    awardsByDomain([string|null $domainId = null ]) : Response

Parameters

$domainId : string|null = null: Domain identifier to filter awards; pass null to select awards with no domain.

Return values

Response —

JSON response containing an array of awards with their associated Domains, Levels, and Branches.

beforeFilter()

Pre-action filter for application-wide processing.


    public
                    beforeFilter(EventInterface $event) : Response|null|void

Handles: CSV detection, plugin validation, navigation history, view cell loading, and Turbo Frame detection.

Parameters

$event : EventInterface: The beforeFilter event

Return values

Response|null|void

delete()

Award Delete - Soft deletion with referential integrity check.


    public
                    delete([string|null $id = null ]) : Response|null

Prevents deletion if recommendations exist. Prefixes name with "Deleted:".

Parameters

$id : string|null = null: Award identifier

Return values

Response|null —

Redirects to index or view based on outcome

edit()

Award Edit - Modify existing award with specialty JSON handling.


    public
                    edit([string|null $id = null ]) : Response|null|void

Parameters

$id : string|null = null: Award identifier

Return values

Response|null|void —

Redirects to award view after processing

gridData()

Provide grid data for Awards listing.


    public
                    gridData(CsvExportService $csvExportService) : Response|null|void

This method serves data for the Dataverse grid component via Turbo Frame requests. Handles filtering, sorting, pagination, and CSV export.

Parameters

$csvExportService : CsvExportService: Injected CSV export service

Return values

Response|null|void —

Renders view or returns CSV response

index()

Award Index - Administrative award listing.


    public
                    index() : Response|null|void

Return values

Response|null|void

initialize()

Initialize Awards Controller.


    public
                    initialize() : void

Configures authorization for index/add/gridData and allows unauthenticated access to awardsByDomain endpoint.

isCsvRequest()

Check if current request is for CSV export.


    public
                    isCsvRequest() : bool

Return values

bool

removeActivity()

Dissociate a gathering activity from an award.


    public
                    removeActivity([string|null $awardId = null ][, string|null $activityId = null ]) : Response|null

Deletes the association between the specified award and gathering activity and sets an appropriate flash message.

Parameters

$awardId : string|null = null: Award identifier.
$activityId : string|null = null: Gathering activity identifier.

Return values

Response|null —

Redirects to the award view or returns Turbo Stream content when requested.

switchView()

Switch between mobile and desktop view modes.


    public
                    switchView() : Response

Stores preference in session and redirects to appropriate interface. Mobile redirects to viewMobileCard, desktop to profile.

Return values

Response —

Redirect response

view()

Display a single award with its domain, level, branch, and related gathering activities and prepare form data for the management view.


    public
                    view([string|null $id = null ]) : Response|null|void

Loads the award and its related Domains, Levels, Branches, and GatheringActivities, enforces entity authorization, and provides lists for domains, levels (ordered by progression), branch tree, and gathering activities not yet associated with the award for use in the view.

Parameters

$id : string|null = null: Award identifier to retrieve.

Return values

Response|null|void —

A Response when the action issues a redirect or other response, otherwise no value.

_buildTurboStreamResponse()

Builds a Turbo Stream payload that replaces the flash messages frame and, if present, replaces the provided turbo-frame with the given content.


    protected
                    _buildTurboStreamResponse(string $frameContent[, array<string|int, mixed>|null $flashMessages = null ]) : string

Flash messages (if provided) are rendered as Bootstrap alert markup. The supplied $frameContent should include a element; when an id is found that frame will be replaced in the returned payload.

Parameters

$frameContent : string: HTML containing a turbo-frame to be inserted/replaced
$flashMessages : array<string|int, mixed>|null = null: Flash messages grouped by key; each message is an array with a 'message' string and an optional 'element' (e.g. 'flash/success') used to determine the alert type

Return values

string —

The combined turbo-stream HTML payload

applyCustomFilterHandlers()

Apply custom filter handlers for columns with complex filtering logic


    protected
                    applyCustomFilterHandlers(SelectQuery $query, array<string|int, mixed> $customFilterColumns, string $tableName, bool $canFilter, array<string|int, mixed> $currentFilters, mixed $currentView, array<string|int, mixed>|null $selectedSystemView, bool $dirtyFilters) : SelectQuery

Columns can define a customFilterHandler in their metadata to specify a static method that handles their filtering. This allows complex filter logic (like querying multiple tables) to be defined alongside the column definition rather than requiring special controller knowledge.

Filter values are extracted from:

Query string parameters (user-applied filters)
Saved user view configuration (when loading a saved view)
System view configuration (when loading a system view)

Parameters

$query : SelectQuery: The query to filter
$customFilterColumns : array<string|int, mixed>: Columns with customFilterHandler defined
$tableName : string: The main table name
$canFilter : bool: Whether user filtering is enabled
$currentFilters : array<string|int, mixed>: Current filter values from query params
$currentView : mixed: Current saved user view (or null)
$selectedSystemView : array<string|int, mixed>|null: Current system view config (or null)
$dirtyFilters : bool: Whether user explicitly modified filters

Return values

SelectQuery —

The filtered query

authorizeCurrentUrl()

Authorize the current URL/action via Authorization component.


    protected
                    authorizeCurrentUrl() : void

buildDataverseGridState()

Build complete grid state object (single source of truth)


    protected
                    buildDataverseGridState(mixed $currentView, array<string|int, mixed>|null $selectedSystemView, array<string|int, mixed>|null $systemViews, iterable<string|int, mixed> $availableViews, Member|null $currentMember, string|int|null $preferredViewId, string $search, array<string|int, mixed> $filters, array<string|int, mixed> $filterOptions, array<string|int, mixed> $dropdownFilterColumns, array<string|int, mixed> $dateRangeFilterColumns, array<string|int, mixed> $sort, array<string|int, mixed> $visibleColumns, array<string|int, mixed> $allColumns, string $gridKey, int $pageSize, bool $showAllTab, bool $canAddViews, bool $canFilter, bool $hasSearch, bool $hasDropdownFilters, bool $hasDateRangeFilters, array<string|int, mixed> $skipFilterColumns, bool $canExportCsv, bool $showFilterPills, bool $showViewTabs, bool $enableColumnPicker[, array<string|int, mixed> $lockedFilters = [] ][, bool $enableBulkSelection = false ][, array<string|int, mixed> $bulkActions = [] ]) : array<string|int, mixed>

Parameters

$currentView : mixed: Current saved view entity (null for system views or "All")
$selectedSystemView : array<string|int, mixed>|null: Currently selected system view
$systemViews : array<string|int, mixed>|null: All available system views
$availableViews : iterable<string|int, mixed>: Collection of saved views
$currentMember : Member|null: Authenticated member
$preferredViewId : string|int|null: Preferred view ID from user preferences
$search : string: Current search term
$filters : array<string|int, mixed>: Active filters by column key
$filterOptions : array<string|int, mixed>: Available filter options by column key
$dropdownFilterColumns : array<string|int, mixed>: Metadata for filterable columns
$dateRangeFilterColumns : array<string|int, mixed>
$sort : array<string|int, mixed>: Current sort configuration
$visibleColumns : array<string|int, mixed>: Array of visible column keys
$allColumns : array<string|int, mixed>: Complete column metadata
$gridKey : string: Unique grid identifier
$pageSize : int: Number of rows per page
$showAllTab : bool: Whether to show "All" tab
$canAddViews : bool: Whether users can create custom views
$canFilter : bool: Whether filtering is enabled
$hasSearch : bool
$hasDropdownFilters : bool
$hasDateRangeFilters : bool
$skipFilterColumns : array<string|int, mixed>: Columns with filter UI but not query application
$canExportCsv : bool: Whether CSV export button is shown
$showFilterPills : bool: Whether active filter pills/badges are displayed
$showViewTabs : bool: Whether view tabs are displayed
$enableColumnPicker : bool: Whether column picker is available
$lockedFilters : array<string|int, mixed> = []: Filter column keys that cannot be removed by users
$enableBulkSelection : bool = false
$bulkActions : array<string|int, mixed> = []

Return values

array<string|int, mixed> —

Complete grid state

buildExportDataFromEntities()

Build export data from pre-processed entities (Data Mode)


    protected
                    buildExportDataFromEntities(iterable<string|int, mixed> $data, array<string|int, mixed> $visibleColumns, array<string|int, mixed> $columnsMetadata) : array<string|int, mixed>

Extracts values from entities using column metadata configuration. Supports virtual properties, nested relations via renderField, and custom exportValue callbacks.

Parameters

$data : iterable<string|int, mixed>: Pre-processed entities or arrays
$visibleColumns : array<string|int, mixed>: List of visible column keys
$columnsMetadata : array<string|int, mixed>: Column configuration metadata

Return values

array<string|int, mixed> —

Transformed data ready for CSV export

buildExportDataFromQuery()

Build export data from database query (Query Mode)


    protected
                    buildExportDataFromQuery(Query $query, array<string|int, mixed> $visibleColumns, array<string|int, mixed> $columnsMetadata, string $tableName) : array<string|int, mixed>

Builds SQL SELECT statements and executes query for simple database fields. Best for exports that don't require computed fields.

Parameters

$query : Query: Database query to execute
$visibleColumns : array<string|int, mixed>: List of visible column keys
$columnsMetadata : array<string|int, mixed>: Column configuration metadata
$tableName : string: Full table name for model alias extraction

Return values

array<string|int, mixed> —

Transformed data ready for CSV export

extractExportValue()

Extract export value from entity using column metadata


    protected
                    extractExportValue(mixed $entity, string $columnKey, array<string|int, mixed> $columnMeta) : string

Resolution order:

exportValue callback if defined in column metadata
renderField path for nested entity access (e.g., 'member.name_for_herald')
Direct property access using column key

Parameters

$entity : mixed: Entity or array to extract value from
$columnKey : string: Column key identifier
$columnMeta : array<string|int, mixed>: Column metadata configuration

Return values

string —

Extracted and formatted value

extractFilterFromExpression()

Recursively extract a filter value from an expression tree


    protected
                    extractFilterFromExpression(array<string|int, mixed> $expression, string $columnKey) : mixed

Parameters

$expression : array<string|int, mixed>: The expression node to search
$columnKey : string: The column key to find

Return values

mixed —

The filter value or null if not found

extractFilterFromSystemView()

Extract a specific filter value from a system view configuration


    protected
                    extractFilterFromSystemView(array<string|int, mixed> $systemView, string $columnKey) : mixed

Parameters

$systemView : array<string|int, mixed>: The system view configuration
$columnKey : string: The column key to find

Return values

mixed —

The filter value or null if not found

extractFilterFromViewConfig()

Extract a specific filter value from a saved user view's config


    protected
                    extractFilterFromViewConfig(mixed $view, string $columnKey) : mixed

Parameters

$view : mixed: The GridView entity
$columnKey : string: The column key to find

Return values

mixed —

The filter value or null if not found

extractFilterGrouping()

Extract filter grouping information from expression tree


    protected
                    extractFilterGrouping(array<string|int, mixed>|null $selectedSystemView, array<string|int, mixed> $skipFilterColumns) : array<string|int, mixed>

Analyzes the expression tree to determine OR relationships between filters. Returns metadata that the frontend can use to display visual OR indicators.

Parameters

$selectedSystemView : array<string|int, mixed>|null: Currently active system view
$skipFilterColumns : array<string|int, mixed>: Columns that show as pills but don't query

Return values

array<string|int, mixed> —

Grouping metadata with 'orGroups' array

extractSystemViewDefaults()

Extract default filters/search metadata for a system view configuration


    protected
                    extractSystemViewDefaults(array<string, mixed> $systemViewConfig) : array{filters: array, dateRange: array, search: ?string, skipFilterColumns: array}

Parameters

$systemViewConfig : array<string, mixed>: Raw system view config

Return values

array{filters: array, dateRange: array, search: ?string, skipFilterColumns: array}

formatExportValue()

Format value for CSV export


    protected
                    formatExportValue(mixed $value) : string

Handles various data types and converts to string representation.

Parameters

$value : mixed: Value to format

Return values

string —

Formatted string value

handleCsvExport()

Handle CSV export from grid result


    protected
                    handleCsvExport(array<string|int, mixed> $result, CsvExportService $csvExportService, string $entityName[, string|null $tableName = null ][, iterable<string|int, mixed>|null $data = null ]) : Response

Generates a CSV export response from the grid processing result. Supports two modes:

Query Mode (default): Uses the query from result to build SQL SELECT statements. Best for simple fields that map directly to database columns.
Data Mode: Pass pre-processed data with computed/virtual fields already populated. Best for exports that include calculated fields, virtual properties, or complex transformations that can't be done in SQL.

Column Value Resolution (in order of precedence):

exportValue callback in column metadata - custom formatting function
renderField path (e.g., 'member.name_for_herald') - for nested entity access
queryField for relation columns in query mode
Direct column key access on entity/array

Parameters

$result : array<string|int, mixed>: Result from processDataverseGrid() with isCsvExport flag
$csvExportService : CsvExportService: CSV export service instance
$entityName : string: Base name for the export file (e.g., 'members', 'warrants')
$tableName : string|null = null: Optional table name for fetchTable (e.g., 'Awards.Recommendations' for plugin tables) If not provided, uses ucfirst($entityName)
$data : iterable<string|int, mixed>|null = null: Optional pre-processed data. If provided, uses data mode instead of query mode. Data should be an iterable of entities or arrays with all computed fields populated.

Return values

Response —

CSV download response

isCsvExportRequest()

Check if the current request is for CSV export


    protected
                    isCsvExportRequest() : bool

Return values

bool —

True if CSV export is requested

loadFilterOptions()

Load filter options from a data source


    protected
                    loadFilterOptions(array<string|int, mixed>|string $source) : array<string|int, mixed>

Supports multiple formats for filterOptionsSource:

Simple string (table name): Uses 'id' for value, 'name' for label
```
'filterOptionsSource' => 'Branches'
```

Array with table: Database table with full control

'filterOptionsSource' => [
    'table' => 'Waivers.WaiverTypes',  // Required: table name for fetchTable()
    'valueField' => 'id',              // Optional: field for option value (default: 'id')
    'labelField' => 'name',            // Optional: field for option label (default: 'name')
    'conditions' => ['is_active' => true],  // Optional: filter conditions
    'order' => ['name' => 'ASC'],      // Optional: sort order (default: labelField ASC)
]

Array with appSetting: Load from app settings (YAML array)
```
'filterOptionsSource' => [
    'appSetting' => 'Branches.Types',  // Required: app setting key
]
```
The app setting should contain a YAML array like: ['Kingdom', 'Principality', 'Barony'] Both value and label will be set to the array item value.

Array with method: Call a static method on a class to get options

'filterOptionsSource' => [
    'method' => 'getGatheringsFilterOptions',  // Required: static method name
    'class' => 'Awards\\KMP\\GridColumns\\RecommendationsGridColumns',  // Required: fully qualified class name
]

The method should return array of ['value' => string, 'label' => string].

Parameters

$source : array<string|int, mixed>|string: Source identifier string (table name) or configuration array

Return values

array<string|int, mixed> —

Filter options as array of ['value' => string, 'label' => string]

organizeViewCells()

Organize view cells by type and display order.


    protected
                    organizeViewCells(array<string|int, mixed> $viewCells) : array<string|int, mixed>

Unused - view cells organized in ViewCellRegistry

Parameters

$viewCells : array<string|int, mixed>: Flat array of view cell configurations

Return values

array<string|int, mixed> —

Organized array grouped by type and sorted by order

processDataverseGrid()

Process dataverse grid request with unified logic


    protected
                    processDataverseGrid(array<string|int, mixed> $config) : array<string|int, mixed>

This method handles all aspects of grid processing including view management, filtering, searching, sorting, and pagination. It supports both saved user views and system-defined views.

Parameters

$config : array<string|int, mixed>

Grid configuration with the following keys:

gridKey (string): Unique identifier for the grid
gridColumnsClass (string): Fully qualified class name for grid columns metadata
baseQuery (Query): Base query object to start with
tableName (string): Primary table name for field qualification
defaultSort (array): Default sort configuration ['field' => 'direction']
defaultPageSize (int): Default number of records per page (default: 25)
systemViews (array|null): Optional array of system views (for Warrants-style grids)
defaultSystemView (string|null): Default system view key (required if systemViews provided)
queryCallback (callable|null): Optional callback to modify query per system view
showAllTab (bool): Whether to show "All" tab (default: true for saved views, false for system views)
canAddViews (bool): Whether users can create custom views (default: true)
canFilter (bool): Whether user filtering is enabled (default: true). When false, users cannot add/remove filters via the UI or query parameters. However, filters defined by system views are ALWAYS applied regardless of this setting.
canExportCsv (bool): Whether CSV export button is shown (default: true)
showFilterPills (bool): Whether active filter pills/badges are displayed (default: true)
showViewTabs (bool): Whether view tabs are displayed (default: true)
enableColumnPicker (bool): Whether column picker is available (default: true)
lockedFilters (array): Array of filter column keys that cannot be removed by users. Locked filters will not show remove (×) buttons and their values cannot be cleared via query string parameters. Useful for embedded grids where context filters (e.g., member_id) must always be applied.
enableBulkSelection (bool): Whether row selection checkboxes are shown (default: false)
bulkActions (array): Array of bulk action button configurations when enableBulkSelection is true. Each action is an array with keys: label, icon, modalTarget, permission.

NOTE: Authorization scope must be applied to baseQuery BEFORE calling this method. Use $baseQuery = $this->Authorization->applyScope($baseQuery, 'index'); in your controller before passing the query to processDataverseGrid().

Return values

array<string|int, mixed> —

Result array with keys: data, gridState, columnsMetadata, etc.

resolveNestedValue()

Resolve nested value from entity using dot notation path


    protected
                    resolveNestedValue(mixed $entity, string $path) : mixed

Parameters

$entity : mixed: Entity to traverse
$path : string: Dot-notation path (e.g., 'member.name_for_herald')

Return values

mixed —

Resolved value or null if path doesn't exist

AwardsController extends AppController in package Awards Controller uses DataverseGridTrait

Table of Contents

Constants

Properties

Methods

Constants

VIEW_DATA_EVENT

VIEW_PLUGIN_EVENT

Properties

$Awards

$isCsvRequest

$pluginViewCells

Methods

add()

Return values

addActivity()

Parameters

Tags

Return values

addActivityToGatheringActivity()

Parameters

Tags

Return values

awardsByDomain()

Parameters

Return values

beforeFilter()

Parameters

Return values

delete()

Parameters

Tags

Return values

edit()

Parameters

Tags

Return values

gridData()

Parameters

Return values

index()

Return values

initialize()

isCsvRequest()

Return values

removeActivity()

Parameters

Tags

Return values

switchView()

Return values

view()

Parameters

Tags

Return values

_buildTurboStreamResponse()

Parameters

Return values

applyCustomFilterHandlers()

Parameters

Return values

authorizeCurrentUrl()

Tags

buildDataverseGridState()

Parameters

Return values

buildExportDataFromEntities()

Parameters

Return values

buildExportDataFromQuery()

Parameters

Return values

extractExportValue()

Parameters

Return values

extractFilterFromExpression()

Parameters

Return values

extractFilterFromSystemView()

Parameters

AwardsController extends AppController
in package

Awards

Controller

uses DataverseGridTrait