KMP PHP API Reference

BackupsController extends AppController
in package

Application

uses ManagedBackupDownloadTrait

Tenant self-service view of platform-managed backups.

Tenant admins can list backups, request an on-demand backup, download an archive plus its one-time recovery key, and see backup status. Scheduling, retention, and restores are owned by Platform Admin.

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

$isCsvRequest : bool
$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.
create() : Response|null: Request an on-demand managed backup.
download() : Response|null: Download a managed encrypted backup archive.
downloadRecoveryKey() : Response|null: Export a managed backup's recovery key. One export per backup.
index() : void: List managed backups, backup status, and read-only legacy archives.
initialize() : void: Set up authorization for this controller.
isCsvRequest() : bool: Check if current request is for CSV export.
legacyDownload() : Response: Download a legacy self-service .kmpbackup file (read-only surface).
switchView() : Response: Switch between mobile and desktop view modes.
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.
assertUsableBackup() : void: Validate completed encrypted backup metadata before a guarded action.
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.
exportTenantBackupRecoveryKey() : array{filename: string, content: string}: Export a tenant backup recovery-key package.
getPageContextUrl() : string|null: Posted page context URL (path + query), validated.
isGridOriginRequest() : bool: Whether POST originated from a grid index (stay on list).
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.
recoveryKeyDownloadResponse() : Response: Return a recovery-key attachment that browsers and intermediary caches must not retain.
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.
stageBackupDownload() : array{path: string, filename: string}: Stage and verify a backup for a streaming file response.
wantsTurboStreamRequest() : bool: Whether the client expects a turbo-stream response.
withPageContextQuery() : T: Run a callback with query params from the posted page context URL.
actorId() : string|null: The acting member's identifier, if authenticated.
selfService() : TenantSelfServiceBackupService: Build the tenant self-service backup service on the platform connection.

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

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

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

create()

Request an on-demand managed backup.


    public
                    create() : Response|null

Return values

Response|null

download()

Download a managed encrypted backup archive.


    public
                    download(string $backupId) : Response|null

Parameters

$backupId : string

Return values

Response|null

downloadRecoveryKey()

Export a managed backup's recovery key. One export per backup.


    public
                    downloadRecoveryKey(string $backupId) : Response|null

Parameters

$backupId : string

Return values

Response|null

index()

List managed backups, backup status, and read-only legacy archives.


    public
                    index() : void

initialize()

Set up authorization for this controller.


    public
                    initialize() : void

isCsvRequest()

Check if current request is for CSV export.


    public
                    isCsvRequest() : bool

Return values

bool

legacyDownload()

Download a legacy self-service .kmpbackup file (read-only surface).


    public
                    legacyDownload(int $id) : Response

Parameters

$id : int

Return values

Response

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

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

assertUsableBackup()

Validate completed encrypted backup metadata before a guarded action.


    protected
                    assertUsableBackup(array<string, mixed> $backup[, array<int, string> $allowedTypes = [TenantBackupService::BACKUP_TYPE, 'pg_dump'] ]) : void

Parameters

$backup : array<string, mixed>
$allowedTypes : array<int, string> = [TenantBackupService::BACKUP_TYPE, 'pg_dump']

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

exportTenantBackupRecoveryKey()

Export a tenant backup recovery-key package.


    protected
                    exportTenantBackupRecoveryKey(array<string, mixed> $backup, array<string, mixed> $tenant) : array{filename: string, content: string}

Parameters

$backup : array<string, mixed>: Backup metadata row
$tenant : array<string, mixed>: Tenant metadata row

Return values

array{filename: string, content: string}

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

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

recoveryKeyDownloadResponse()

Return a recovery-key attachment that browsers and intermediary caches must not retain.


    protected
                    recoveryKeyDownloadResponse(array{filename: string, content: string} $export) : Response

Parameters

$export : array{filename: string, content: string}: Recovery-key export

Return values

Response

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

stageBackupDownload()

Stage and verify a backup for a streaming file response.


    protected
                    stageBackupDownload(array<string, mixed> $backup, BackupArchiveStorageInterface $storage, string $filenamePrefix) : array{path: string, filename: string}

Parameters

$backup : array<string, mixed>
$storage : BackupArchiveStorageInterface
$filenamePrefix : string

Return values

array{path: string, filename: string}

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

Return values

actorId()

The acting member's identifier, if authenticated.


    private
                    actorId() : string|null

Return values

string|null

selfService()

Build the tenant self-service backup service on the platform connection.


    private
                    selfService() : TenantSelfServiceBackupService

Return values

TenantSelfServiceBackupService

BackupsController extends AppController in package Application uses ManagedBackupDownloadTrait

Table of Contents

Constants

Properties

Methods

Constants

MOBILE_QUEUE_DEFAULT_PER_PAGE

MOBILE_QUEUE_MAX_PER_PAGE

VIEW_DATA_EVENT

VIEW_PLUGIN_EVENT

Properties

$isCsvRequest

$pluginViewCells

$pluginViewCellsEnabledForFragment

Methods

beforeFilter()

Parameters

Return values

beforeRender()

Parameters

Return values

create()

Return values

download()

Parameters

Return values

downloadRecoveryKey()

Parameters

Return values

index()

initialize()

isCsvRequest()

Return values

legacyDownload()

Parameters

Return values

switchView()

Return values

appSettingImageDataUri()

Parameters

Return values

assertSafeContextUrl()

Parameters

Tags

Return values

assertUsableBackup()

Parameters

authorizeCurrentUrl()

Tags

buildGridDataUrlFromPageContext()

Parameters

Return values

consumeFlashForStream()

Return values

enablePluginViewCellsForFragment()

exportTenantBackupRecoveryKey()

Parameters

Return values

getPageContextUrl()

Return values

isGridOriginRequest()

Parameters

Return values

matchesGridIndexPath()

Parameters

Return values

mobileQueuePagination()

Parameters

Return values

mobileQueuePaginationPayload()

Parameters

Return values

organizeViewCells()

Parameters

Return values

recoveryKeyDownloadResponse()

Parameters

Return values

renderDataverseTableRowElement()

Parameters

BackupsController extends AppController
in package

Application

uses ManagedBackupDownloadTrait