KMP PHP API Reference

PlatformAdminJobEnqueuer
in package

Enqueues platform-admin initiated operations with idempotency and audit.

Table of Contents

Properties

$auditService  : PlatformAuditService
$connection  : Connection

Methods

__construct()  : mixed
Constructor.
enqueue()  : array<string, mixed>
assertBackupAvailableForRestore()  : void
Recheck backup availability while holding the tenant operation lock.
assertNoActiveConflict()  : void
encodeParameters()  : string
findByIdempotencyKey()  : array<string, mixed>|null
isExclusiveOperation()  : bool
Whether the job requires exclusive lifecycle scope.
lockOperationScope()  : void

Properties

Methods

enqueue()

public enqueue(string $jobType, string|null $tenantId, string|null $platformUserId, array<string, mixed> $parameters, string $idempotencyKey, string $reason[, array<string, mixed> $auditOptions = [] ]) : array<string, mixed>
Parameters
$jobType : string
$tenantId : string|null
$platformUserId : string|null
$parameters : array<string, mixed>
$idempotencyKey : string
$reason : string
$auditOptions : array<string, mixed> = []
Return values
array<string, mixed>

platform_jobs row

assertBackupAvailableForRestore()

Recheck backup availability while holding the tenant operation lock.

private assertBackupAvailableForRestore(string $jobType, string|null $tenantId, array<string, mixed> $parameters) : void
Parameters
$jobType : string
$tenantId : string|null
$parameters : array<string, mixed>

assertNoActiveConflict()

private assertNoActiveConflict(string $jobType, string|null $tenantId, array<string, mixed> $parameters) : void
Parameters
$jobType : string
$tenantId : string|null
$parameters : array<string, mixed>

encodeParameters()

private encodeParameters(array<string, mixed> $parameters) : string
Parameters
$parameters : array<string, mixed>
Return values
string

findByIdempotencyKey()

private findByIdempotencyKey(string $idempotencyKey) : array<string, mixed>|null
Parameters
$idempotencyKey : string
Return values
array<string, mixed>|null

isExclusiveOperation()

Whether the job requires exclusive lifecycle scope.

private isExclusiveOperation(string $jobType) : bool
Parameters
$jobType : string
Return values
bool

lockOperationScope()

private lockOperationScope(string $jobType, string|null $tenantId, array<string, mixed> $parameters) : void
Parameters
$jobType : string
$tenantId : string|null
$parameters : array<string, mixed>
On this page

Search results