OfficersController
extends AppController
in package
API controller for read-only officer roster listing and detail.
Authorizes against entity policy since OfficersTablePolicy uses SKIP_BASE.
Table of Contents
Constants
- VIEW_DATA_EVENT = 'KMP.plugins.callForViewData'
- VIEW_PLUGIN_EVENT = 'KMP.plugins.callForViewCells'
Properties
- $isCsvRequest : bool
- $pluginViewCells : array<string|int, mixed>
Methods
- beforeFilter() : Response|null
- Before filter - runs before each action.
- index() : void
- List officers with optional filters and pagination.
- initialize() : void
- Initialization hook.
- isCsvRequest() : bool
- Check if current request is for CSV export.
- switchView() : Response
- Switch between mobile and desktop view modes.
- view() : void
- View a single officer record by ID.
- apiError() : void
- Standard error response envelope.
- apiSuccess() : void
- Standard success response envelope.
- authorizeCurrentUrl() : void
- Authorize the current URL/action via Authorization component.
- getKmpIdentity() : KmpIdentityInterface
- Return the authenticated KMP identity for authorization checks.
- getPaginationMeta() : array<string|int, mixed>
- Build pagination metadata.
- getServicePrincipal() : ServicePrincipal
- Get the authenticated service principal.
- isServicePrincipal() : bool
- Check if current identity is a service principal.
- organizeViewCells() : array<string|int, mixed>
- Organize view cells by type and display order.
Constants
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
Properties
$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
Methods
beforeFilter()
Before filter - runs before each action.
public
beforeFilter(EventInterface $event) : Response|null
Parameters
- $event : EventInterface
-
Event
Return values
Response|nullindex()
List officers with optional filters and pagination.
public
index(ReadOnlyOfficerRosterServiceInterface $service) : void
Parameters
- $service : ReadOnlyOfficerRosterServiceInterface
initialize()
Initialization hook.
public
initialize() : void
isCsvRequest()
Check if current request is for CSV export.
public
isCsvRequest() : bool
Return values
boolswitchView()
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()
View a single officer record by ID.
public
view(int $id, ReadOnlyOfficerRosterServiceInterface $service) : void
Parameters
- $id : int
-
Officer ID
- $service : ReadOnlyOfficerRosterServiceInterface
apiError()
Standard error response envelope.
protected
apiError(string $code, string $message[, array<string|int, mixed> $details = [] ][, int $statusCode = 400 ]) : void
Parameters
- $code : string
-
Error code
- $message : string
-
Error message
- $details : array<string|int, mixed> = []
-
Additional error details
- $statusCode : int = 400
-
HTTP status code
apiSuccess()
Standard success response envelope.
protected
apiSuccess(mixed $data[, array<string|int, mixed> $meta = [] ]) : void
Parameters
- $data : mixed
-
Response data
- $meta : array<string|int, mixed> = []
-
Optional metadata
authorizeCurrentUrl()
Authorize the current URL/action via Authorization component.
protected
authorizeCurrentUrl() : void
Tags
getKmpIdentity()
Return the authenticated KMP identity for authorization checks.
protected
getKmpIdentity() : KmpIdentityInterface
Return values
KmpIdentityInterfacegetPaginationMeta()
Build pagination metadata.
protected
getPaginationMeta() : array<string|int, mixed>
Return values
array<string|int, mixed>getServicePrincipal()
Get the authenticated service principal.
protected
getServicePrincipal() : ServicePrincipal
Tags
Return values
ServicePrincipalisServicePrincipal()
Check if current identity is a service principal.
protected
isServicePrincipal() : bool
Return values
boolorganizeViewCells()
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