KMP PHP API Reference

QueuedJobsController extends AppController
in package

Application

uses LoadHelperTrait

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

$QueuedJobs : QueuedJobsTable
$Search : SearchComponent
$isCsvRequest : bool
$paginate : array<string, mixed>
$pluginViewCells : array<string|int, mixed>
$pluginViewCellsEnabledForFragment : bool: Whether an intentionally fragment-style response still needs plugin view cells.

Methods

beforeFilter() : Response|null|void: Pre-action filter for application-wide processing.
beforeRender() : Response|null|void: Finalize view-only data after the action has run.
data() : Response|null|void
delete() : Response|null|void: Delete method
edit() : Response|null|void: Edit method
execute() : Response|null|void
import() : Response|null|void
index() : Response|null|void: Index method
initialize() : void: Load shared components: Authentication, Authorization, Flash.
isCsvRequest() : bool: Check if current request is for CSV export.
migrate() : Response|null|void
paginate() : ResultSetInterface<string|int, QueuedJob>
stats() : void: Index method
switchView() : Response: Switch between mobile and desktop view modes.
test() : Response|null|void
view() : Response|null|void: View method
viewClasses() : array<string|int, string>
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.
enableSearch() : void
getPageContextUrl() : string|null: Posted page context URL (path + query), validated.
isGridOriginRequest() : bool: Whether POST originated from a grid index (stay on list).
loadHelpers() : void
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

$QueuedJobs


        public
            QueuedJobsTable
    $QueuedJobs

$Search


        public
            SearchComponent
    $Search

$isCsvRequest


        protected
            bool
    $isCsvRequest
     = false

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

$paginate


        protected
            array<string, mixed>
    $paginate
     = ['order' => ['created' => 'DESC']]

$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()

Pre-action filter for application-wide processing.


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

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

Parameters

$event : EventInterface: The beforeFilter event

Return values

Response|null|void

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

data()


    public
                    data([int|null $id = null ]) : Response|null|void

Parameters

$id : int|null = null: Queued Job id.

Return values

Response|null|void —

Redirects on successful edit, renders view otherwise.

delete()

Delete method


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

Parameters

$id : int|null = null: Queued Job id.

Return values

Response|null|void —

Redirects to index.

edit()

Edit method


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

Parameters

$id : int|null = null: Queued Job id.

Return values

Response|null|void —

Redirects on successful edit, renders view otherwise.

execute()


    public
                    execute() : Response|null|void

Return values

Response|null|void

import()


    public
                    import() : Response|null|void

Return values

Response|null|void

index()

Index method


    public
                    index() : Response|null|void

Return values

Response|null|void

initialize()

Load shared components: Authentication, Authorization, Flash.


    public
                    initialize() : void

isCsvRequest()

Check if current request is for CSV export.


    public
                    isCsvRequest() : bool

Return values

bool

migrate()


    public
                    migrate() : Response|null|void

Return values

Response|null|void

paginate()


    public
                    paginate([mixed $object =  = 'null' ][, array<string|int, mixed> $settings =  = '[]' ]) : ResultSetInterface<string|int, QueuedJob>

Parameters

$object : mixed = = 'null'
$settings : array<string|int, mixed> = = '[]'

Return values

ResultSetInterface<string|int, QueuedJob>

stats()

Index method


    public
                    stats([string|null $jobType = null ]) : void

Parameters

$jobType : string|null = null

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

test()


    public
                    test() : Response|null|void

Return values

Response|null|void

view()

View method


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

Parameters

$id : int|null = null: Queued Job id.

Return values

Response|null|void

viewClasses()


    public
                    viewClasses() : array<string|int, string>

Return values

array<string|int, string>

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

enableSearch()


    protected
                    enableSearch() : void

getPageContextUrl()

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


    protected
                    getPageContextUrl() : string|null

Return values

string|null

isGridOriginRequest()

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


    protected
                    isGridOriginRequest(string|null $pageContextUrl) : bool

Parameters

$pageContextUrl : string|null

Return values

bool

loadHelpers()


    protected
                    loadHelpers() : void

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

QueuedJobsController extends AppController in package Application uses LoadHelperTrait

Table of Contents

Constants

Properties

Methods

Constants

MOBILE_QUEUE_DEFAULT_PER_PAGE

MOBILE_QUEUE_MAX_PER_PAGE

VIEW_DATA_EVENT

VIEW_PLUGIN_EVENT

Properties

$QueuedJobs

$Search

$isCsvRequest

$paginate

$pluginViewCells

$pluginViewCellsEnabledForFragment

Methods

beforeFilter()

Parameters

Return values

beforeRender()

Parameters

Return values

data()

Parameters

Return values

delete()

Parameters

Return values

edit()

Parameters

Return values

execute()

Tags

Return values

import()

Tags

Return values

index()

Return values

initialize()

isCsvRequest()

Return values

migrate()

Return values

paginate()

Parameters

Return values

stats()

Parameters

Tags

switchView()

Return values

test()

Return values

view()

Parameters

Return values

viewClasses()

Return values

appSettingImageDataUri()

Parameters

Return values

assertSafeContextUrl()

Parameters

Tags

Return values

authorizeCurrentUrl()

Tags

buildGridDataUrlFromPageContext()

Parameters

Return values

consumeFlashForStream()

Return values

enablePluginViewCellsForFragment()

enableSearch()

getPageContextUrl()

Return values

isGridOriginRequest()

QueuedJobsController extends AppController
in package

Application

uses LoadHelperTrait