KMP PHP API Reference

TenantsController extends PlatformAdminAppController

in package

• Application

Base controller for the isolated platform admin portal.

Table of Contents

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'

MAX_LEGACY_IMPORT_BYTES  : mixed = 512 * 1024 * 1024

Upper bound for synchronous legacy .kmpbackup imports.

Properties

$isCsvRequest  : bool

$platformAdmin  : array<string, mixed>|null

$pluginViewCells  : array<string|int, mixed>

$pluginViewCellsEnabledForFragment  : bool

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

Methods

add()  : Response|null|void

Create a tenant registry row and safe platform-managed configuration.

archive()  : mixed

Archive a suspended or incomplete tenant after operator step-up verification.

backups()  : void

Show tenant-scoped platform-admin backup controls.

beforeFilter()  : Response|null|void

Enforce fail-closed portal feature flag and platform-admin session auth.

beforeRender()  : Response|null|void

Finalize view-only data after the action has run.

config()  : Response|null|void

View and edit safe tenant-scoped platform configuration.

createBackup()  : Response|null

Queue an encrypted tenant JSON logical archive from Platform Admin.

deleteBackup()  : Response|null

Delete an encrypted tenant backup object after audit and operator step-up.

downloadBackup()  : Response|null

Download an encrypted tenant .kmpbackup archive after audit and step-up.

downloadBackupRecoveryKey()  : Response|null

Download a backup-scoped recovery key after audit and operator step-up.

edit()  : Response|null|void

Edit safe tenant registry fields and platform-managed configuration.

importLegacyBackup()  : Response|null

Import a legacy passphrase-encrypted .kmpbackup archive as a managed backup.

index()  : void

List platform tenants without database or secret metadata.

initialize()  : void

Load shared components: Authentication, Authorization, Flash.

isCsvRequest()  : bool

Check if current request is for CSV export.

reactivate()  : mixed

Reactivate a suspended tenant after operator step-up verification.

restoreBackup()  : Response|null

Queue a guarded tenant restore request.

suspend()  : mixed

Suspend an active tenant after operator step-up verification.

switchView()  : Response

Switch between mobile and desktop view modes.

view()  : void

Show safe tenant registry details and recent operational status.

appSettingImageDataUri()  : string|null

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

assertDeletableBackup()  : void

Validate that a managed archive can be removed without interrupting active work.

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.

backupPolicyRetentionDays()  : int

Retention days from the global backup policy, with a safe fallback.

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.

exportPlatformBackupRecoveryKey()  : array{filename: string, content: string}

Export a platform database backup recovery-key package.

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).

isLocked()  : bool

Check whether a platform user lockout timestamp is still active.

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.

platform()  : Connection

Return the platform metadata connection.

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.

statusIsAllowed()  : bool

Check whether a platform user status is allowed for authenticated access.

validateStepUpAction()  : string

Validate typed confirmation, reason, and TOTP step-up for sensitive admin actions.

wantsTurboStreamRequest()  : bool

Whether the client expects a turbo-stream response.

withPageContextQuery()  : T

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

assertValidIdentifier()  : void

Validate a PostgreSQL identifier used for tenant database resources.

assertValidSlug()  : void

Validate platform tenant slug format.

auditOptions()  : array<string, mixed>

auditService()  : PlatformAuditService

Create the platform audit service.

auditTenantConfigChange()  : void

auditTenantRegistryChange()  : void

configFormData()  : array<string, mixed>

createTenant()  : array<string, mixed>

defaultTenantForm()  : array<string, string>

encodeConfig()  : string

enqueueTenantProvisioningJob()  : array<string, mixed>

Queue out-of-band full tenant provisioning.

ensureTenantSecrets()  : void

Ensure runtime tenant routing can resolve the DB password secret after create.

generateDatabasePassword()  : string

Generate a random URL-safe tenant database password.

initialSuperUserEmailFromRequest()  : string|null

Validate and normalize the initial tenant super-user email.

jobEnqueuer()  : PlatformAdminJobEnqueuer

Create the audited Platform Admin job enqueue service.

jobEvents()  : array<int, array<string, mixed>>

latestTenantJob()  : array<string, mixed>|null

saveTenantConfig()  : void

tenantBackupById()  : array<string, mixed>

tenantBackups()  : array<int, array<string, mixed>>

tenantBackupService()  : TenantBackupService

Build the managed tenant backup service (same wiring as TenantBackupCommand).

tenantBySlug()  : array<string, mixed>|null

tenantDataFromRequest()  : array<string, mixed>

tenantFormFromRow()  : array<string, string>

tenantHosts()  : array<int, array<string, mixed>>

tenantJobs()  : array<int, array<string, mixed>>

tenantMetricHours()  : array<int, array<string, mixed>>

tenantMetricRoutes()  : array<int, array<string, mixed>>

tenantMetrics()  : array<string, int|float|bool>

transitionLifecycle()  : Response|null

Apply a guarded tenant lifecycle transition.

updateTenant()  : void

upsertPrimaryHost()  : void

Create or update the active primary host row for a tenant.