AXIAM PHP SDK

ApplyReport
in package

FinalYes

What {@see ManifestApi::apply()} actually did — including, when it stopped early, what it had already done.

§27.7 is explicit that apply STOPS AT THE FIRST FAILURE and DOES NOT ROLL BACK. That is not a limitation to apologise for: a partial apply against a live IAM tenant is a state an operator must be able to inspect and resume from, and an automatic rollback would issue a second wave of writes at exactly the moment the server is already telling you something is wrong.

So this report is the recovery tool. $applied is what landed, in order; $failure is why it stopped; $remaining is what was never attempted.

Table of Contents

Properties

$applied  : array<string|int, mixed>
$failed  : PlannedChange|null
$failure  : Throwable|null
$remaining  : array<string|int, mixed>

Methods

__construct()  : mixed
describe()  : array<int, string>
A human-readable account of the run, suitable for a log line or a CI summary.
isComplete()  : bool
True when every planned change landed.

Properties

$applied read-only

public array<string|int, mixed> $applied

$failure read-only

public Throwable|null $failure = null

$remaining read-only

public array<string|int, mixed> $remaining = []

Methods

__construct()

public __construct(array<int, PlannedChange$applied[, PlannedChange|null $failed = null ][, Throwable|null $failure = null ][, array<int, PlannedChange$remaining = [] ]) : mixed
Parameters
$applied : array<int, PlannedChange>

Changes that succeeded, in the order they ran.

$failed : PlannedChange|null = null

The change that failed, or null if none did.

$failure : Throwable|null = null

Why it failed, or null.

$remaining : array<int, PlannedChange> = []

Changes never attempted because of the failure.

describe()

A human-readable account of the run, suitable for a log line or a CI summary.

public describe() : array<int, string>
Return values
array<int, string>

isComplete()

True when every planned change landed.

public isComplete() : bool
Return values
bool
On this page

Search results