PlannedChange
in package
FinalYes
One entry in a {@see ManagementPlan}: what would happen to one entity, and why.
Table of Contents
Properties
- $action : ChangeAction
- $entity : ManifestEntity
- $fields : array<string|int, mixed>
- $id : string|null
Methods
- __construct() : mixed
- describe() : string
- A one-line rendering, e.g. `create role:auditor`.
Properties
$action read-only
public
ChangeAction
$action
$entity read-only
public
ManifestEntity
$entity
$fields read-only
public
array<string|int, mixed>
$fields
= []
$id read-only
public
string|null
$id
= null
Methods
__construct()
public
__construct(ManifestEntity $entity, ChangeAction $action[, array<string, mixed> $fields = [] ][, string|null $id = null ]) : mixed
Parameters
- $entity : ManifestEntity
-
The declaration this change is for.
- $action : ChangeAction
-
What would be done.
- $fields : array<string, mixed> = []
-
For an update, ONLY the drifted fields — the sparse body §27.4 rule 5 asks for. Empty otherwise.
- $id : string|null = null
-
The server id, when the entity already exists.
describe()
A one-line rendering, e.g. `create role:auditor`.
public
describe() : string