KMP PHP API Reference

ErrorController extends AppController
in package

Error Handling Controller

Controller used by ExceptionRenderer to render error responses.

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

afterFilter()  : Response|null|void
afterFilter callback.
beforeFilter()  : Response|null|void
beforeFilter callback.
beforeRender()  : Response|null|void
beforeRender callback.
initialize()  : void
Initialization hook method.
isCsvRequest()  : bool
Check if current request is for CSV export.
switchView()  : Response
Switch between mobile and desktop view modes.
authorizeCurrentUrl()  : void
Authorize the current URL/action via Authorization component.
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

afterFilter()

afterFilter callback.

public afterFilter(EventInterface<string|int, Controller$event) : Response|null|void
Parameters
$event : EventInterface<string|int, Controller>

Event.

Return values
Response|null|void

beforeFilter()

beforeFilter callback.

public beforeFilter(EventInterface<string|int, Controller$event) : Response|null|void
Parameters
$event : EventInterface<string|int, Controller>

Event.

Return values
Response|null|void

beforeRender()

beforeRender callback.

public beforeRender(EventInterface<string|int, Controller$event) : Response|null|void
Parameters
$event : EventInterface<string|int, Controller>

Event.

Return values
Response|null|void

isCsvRequest()

Check if current request is for CSV export.

public isCsvRequest() : bool
Return values
bool

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

authorizeCurrentUrl()

Authorize the current URL/action via Authorization component.

protected authorizeCurrentUrl() : void
Tags
throws
ForbiddenException

When authorization fails

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


        
On this page

Search results