KMP PHP API Reference

OfficesController extends AppController
in package

Application

API controller for read-only office listing and detail.

Constants

MOBILE_QUEUE_DEFAULT_PER_PAGE : int = 25
MOBILE_QUEUE_MAX_PER_PAGE : int = 50
VIEW_DATA_EVENT : string = 'KMP.plugins.callForViewData'
VIEW_PLUGIN_EVENT : string = 'KMP.plugins.callForViewCells'

Properties

$Offices : Table
$isCsvRequest : bool
$pluginViewCells : array<string|int, mixed>
$pluginViewCellsEnabledForFragment : bool: Whether an intentionally fragment-style response still needs plugin view cells.

Methods

beforeFilter() : Response|null: Before filter - runs before each action.
beforeRender() : Response|null|void: Finalize view-only data after the action has run.
index() : void: List offices 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 office by ID.
apiError() : void: Standard error response envelope.
apiSuccess() : void: Standard success response envelope.
appSettingImageDataUri() : string|null: Resolve shared tenant branding for the online and cached mobile templates.
assertSafeContextUrl() : string: Ensure URL is same-origin relative path + query only.
authorizeCurrentUrl() : void: Authorize the current URL/action via Authorization component.
buildGridDataUrlFromPageContext() : string: Build grid-data URL preserving query string from page context.
consumeFlashForStream() : array<string, mixed>: Read flash from session and clear it for stream rendering.
enablePluginViewCellsForFragment() : void: Include route-matched plugin cells in an AJAX or other fragment response.
getKmpIdentity() : KmpIdentityInterface: Return the authenticated KMP identity for authorization checks.
getPageContextUrl() : string|null: Posted page context URL (path + query), validated.
getPaginationMeta() : array<string|int, mixed>: Build pagination metadata.
getServicePrincipal() : ServicePrincipal: Get the authenticated service principal.
isGridOriginRequest() : bool: Whether POST originated from a grid index (stay on list).
isServicePrincipal() : bool: Check if current identity is a service principal.
matchesGridIndexPath() : bool: Whether page context path matches a grid index route pattern.
mobileQueuePagination() : array<string, int|bool>: Build shared pagination values for mobile actionable queues.
mobileQueuePaginationPayload() : array<string, int|bool>: Remove internal pagination values before sending the mobile JSON payload.
organizeViewCells() : array<string|int, mixed>: Organize view cells by type and display order.
renderDataverseTableRowElement() : string: Render a single Dataverse grid row element (Turbo Stream replace target HTML).
renderTurboCloseModal() : Response: Render turbo-stream: flash + replace table frame with lazy reload src.
renderTurboFlashOnly() : Response: Render turbo-stream flash messages without forcing a grid or frame reload.
renderTurboReloadFrame() : Response: Stream that reloads an edit turbo-frame (validation errors).
renderTurboRemoveGridRow() : Response: Render turbo-stream: flash + remove a grid row (no longer matches current filters).
renderTurboReplaceGridRow() : Response: Render turbo-stream: flash + replace a single grid row by DOM id.
wantsTurboStreamRequest() : bool: Whether the client expects a turbo-stream response.
withPageContextQuery() : T: Run a callback with query params from the posted page context URL.

MOBILE_QUEUE_DEFAULT_PER_PAGE


    public
        int
    MOBILE_QUEUE_DEFAULT_PER_PAGE
    = 25

Shared default page size for mobile actionable queues.

MOBILE_QUEUE_MAX_PER_PAGE


    public
        int
    MOBILE_QUEUE_MAX_PER_PAGE
    = 50

Shared maximum page size for mobile actionable queues.

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

$Offices


        public
            Table
    $Offices

$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

$pluginViewCellsEnabledForFragment

Whether an intentionally fragment-style response still needs plugin view cells.


        protected
            bool
    $pluginViewCellsEnabledForFragment
     = false

beforeFilter()

Before filter - runs before each action.


    public
                    beforeFilter(EventInterface $event) : Response|null

Parameters

$event : EventInterface: Event

Return values

Response|null

beforeRender()

Finalize view-only data after the action has run.


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

Deferring view cells prevents redirect-only requests from executing badge callbacks.

Parameters

$event : EventInterface<string|int, Controller>: Event.

Return values

Response|null|void

index()

List offices with optional filters and pagination.


    public
                    index(ReadOnlyOfficeServiceInterface $service) : void

Parameters

$service : ReadOnlyOfficeServiceInterface

initialize()

Initialization hook.


    public
                    initialize() : 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

view()

View a single office by ID.


    public
                    view(int $id, ReadOnlyOfficeServiceInterface $service) : void

Parameters

$id : int: Office ID
$service : ReadOnlyOfficeServiceInterface

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

appSettingImageDataUri()

Resolve shared tenant branding for the online and cached mobile templates.


    protected
                    appSettingImageDataUri(string $settingName) : string|null

Parameters

$settingName : string

Return values

string|null

assertSafeContextUrl()

Ensure URL is same-origin relative path + query only.


    protected
                    assertSafeContextUrl(string $url) : string

Parameters

$url : string

Return values

string

authorizeCurrentUrl()

Authorize the current URL/action via Authorization component.


    protected
                    authorizeCurrentUrl() : void

buildGridDataUrlFromPageContext()

Build grid-data URL preserving query string from page context.


    protected
                    buildGridDataUrlFromPageContext(string|null $pageContextUrl, array<string, mixed> $gridDataRoute) : string

Parameters

$pageContextUrl : string|null
$gridDataRoute : array<string, mixed>: Cake URL array for gridData action

Return values

string

consumeFlashForStream()

Read flash from session and clear it for stream rendering.


    protected
                    consumeFlashForStream() : array<string, mixed>

Return values

array<string, mixed>

enablePluginViewCellsForFragment()

Include route-matched plugin cells in an AJAX or other fragment response.


    protected
                    enablePluginViewCellsForFragment() : void

getKmpIdentity()

Return the authenticated KMP identity for authorization checks.


    protected
                    getKmpIdentity() : KmpIdentityInterface

Return values

KmpIdentityInterface

getPageContextUrl()

Posted page context URL (path + query), validated.


    protected
                    getPageContextUrl() : string|null

Return values

string|null

getPaginationMeta()

Build pagination metadata.


    protected
                    getPaginationMeta() : array<string|int, mixed>

Return values

array<string|int, mixed>

getServicePrincipal()

Get the authenticated service principal.


    protected
                    getServicePrincipal() : ServicePrincipal

Return values

ServicePrincipal

isGridOriginRequest()

Whether POST originated from a grid index (stay on list).


    protected
                    isGridOriginRequest(string|null $pageContextUrl) : bool

Parameters

$pageContextUrl : string|null

Return values

bool

isServicePrincipal()

Check if current identity is a service principal.


    protected
                    isServicePrincipal() : bool

Return values

bool

matchesGridIndexPath()

Whether page context path matches a grid index route pattern.


    protected
                    matchesGridIndexPath(string|null $pageContextUrl, string $pathRegex) : bool

Parameters

$pageContextUrl : string|null
$pathRegex : string

Return values

bool

mobileQueuePagination()

Build shared pagination values for mobile actionable queues.


    protected
                    mobileQueuePagination(int $total) : array<string, int|bool>

Parameters

$total : int: Total actionable records

Return values

array<string, int|bool>

mobileQueuePaginationPayload()

Remove internal pagination values before sending the mobile JSON payload.


    protected
                    mobileQueuePaginationPayload(array<string, int|bool> $pagination) : array<string, int|bool>

Parameters

$pagination : array<string, int|bool>: Pagination data

Return values

array<string, int|bool>

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

renderDataverseTableRowElement()

Render a single Dataverse grid row element (Turbo Stream replace target HTML).


    protected
                    renderDataverseTableRowElement(array<string, mixed> $vars) : string

Parameters

$vars : array<string, mixed>: Element variables

Return values

string

renderTurboCloseModal()

Render turbo-stream: flash + replace table frame with lazy reload src.


    protected
                    renderTurboCloseModal(string $refreshFrame, array<string, mixed> $gridDataRoute[, string|null $pageContextUrl = null ][, array<string|int, mixed>|null $flashMessages = null ]) : Response

Parameters

$refreshFrame : string
$gridDataRoute : array<string, mixed>
$pageContextUrl : string|null = null
$flashMessages : array<string|int, mixed>|null = null

Return values

Response

renderTurboFlashOnly()

Render turbo-stream flash messages without forcing a grid or frame reload.


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

Parameters

$flashMessages : array<string|int, mixed>|null = null

Return values

Response

renderTurboReloadFrame()

Stream that reloads an edit turbo-frame (validation errors).


    protected
                    renderTurboReloadFrame(string $frameId, string $frameSrc[, array<string|int, mixed>|null $flashMessages = null ]) : Response

Parameters

$frameId : string
$frameSrc : string
$flashMessages : array<string|int, mixed>|null = null

Return values

Response

renderTurboRemoveGridRow()

Render turbo-stream: flash + remove a grid row (no longer matches current filters).


    protected
                    renderTurboRemoveGridRow(string $rowDomId[, array<string|int, mixed>|null $flashMessages = null ]) : Response

Parameters

$rowDomId : string
$flashMessages : array<string|int, mixed>|null = null

Return values

Response

renderTurboReplaceGridRow()

Render turbo-stream: flash + replace a single grid row by DOM id.


    protected
                    renderTurboReplaceGridRow(string $rowDomId, string $rowHtml[, array<string|int, mixed>|null $flashMessages = null ]) : Response

Parameters

$rowDomId : string
$rowHtml : string
$flashMessages : array<string|int, mixed>|null = null

Return values

Response

wantsTurboStreamRequest()

Whether the client expects a turbo-stream response.


    protected
                    wantsTurboStreamRequest() : bool

Return values

bool

withPageContextQuery()

Run a callback with query params from the posted page context URL.


    protected
                    withPageContextQuery(string|null $pageContextUrl, callable(): T $callback) : T

Parameters

$pageContextUrl : string|null
$callback : callable(): T

OfficesController extends AppController in package Application

Table of Contents

Constants

Properties

Methods

Constants

MOBILE_QUEUE_DEFAULT_PER_PAGE

MOBILE_QUEUE_MAX_PER_PAGE

VIEW_DATA_EVENT

VIEW_PLUGIN_EVENT

Properties

$Offices

$isCsvRequest

$pluginViewCells

$pluginViewCellsEnabledForFragment

Methods

beforeFilter()

Parameters

Return values

beforeRender()

Parameters

Return values

index()

Parameters

initialize()

isCsvRequest()

Return values

switchView()

Return values

view()

Parameters

apiError()

Parameters

apiSuccess()

Parameters

appSettingImageDataUri()

Parameters

Return values

assertSafeContextUrl()

Parameters

Tags

Return values

authorizeCurrentUrl()

Tags

buildGridDataUrlFromPageContext()

Parameters

Return values

consumeFlashForStream()

Return values

enablePluginViewCellsForFragment()

getKmpIdentity()

Return values

getPageContextUrl()

Return values

getPaginationMeta()

Return values

getServicePrincipal()

Tags

Return values

isGridOriginRequest()

Parameters

Return values

isServicePrincipal()

Return values

matchesGridIndexPath()

Parameters

Return values

mobileQueuePagination()

Parameters

Return values

mobileQueuePaginationPayload()

Parameters

Return values

organizeViewCells()

Parameters

Return values

renderDataverseTableRowElement()

Parameters

Return values

renderTurboCloseModal()

OfficesController extends AppController
in package

Application