ReactorEventDescriptor
in package
implements
JsonSerializable
One hookable event, as the registry describes it.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $defaultFailurePolicy : FailurePolicy
- $description : string
- $interceptable : bool
- $mutable : bool
- $mutableFields : array<string|int, mixed>
- $name : string
Methods
- __construct() : mixed
- Constructs a ReactorEventDescriptor.
- fromArray() : self
- Rebuilds a ReactorEventDescriptor from one decoded JSON object.
- jsonSerialize() : array<string, mixed>
- Renders this object for `json_encode()`.
- toArray() : array<string, mixed>
- Renders this object back to its wire form.
Properties
$defaultFailurePolicy read-only
public
FailurePolicy
$defaultFailurePolicy
$description read-only
public
string
$description
$interceptable read-only
public
bool
$interceptable
$mutable read-only
public
bool
$mutable
$mutableFields read-only
public
array<string|int, mixed>
$mutableFields
$name read-only
public
string
$name
Methods
__construct()
Constructs a ReactorEventDescriptor.
public
__construct(FailurePolicy $defaultFailurePolicy, string $description, bool $interceptable, bool $mutable, array<int, string> $mutableFields, string $name) : mixed
Parameters
- $defaultFailurePolicy : FailurePolicy
-
the server's
default_failure_policyfield - $description : string
-
the server's
descriptionfield - $interceptable : bool
-
the server's
interceptablefield - $mutable : bool
-
the server's
mutablefield - $mutableFields : array<int, string>
-
Exact field names, or a namespace prefix ending in
.—ext.admitsext.departmentand nothing outside the namespace. - $name : string
-
the server's
namefield
fromArray()
Rebuilds a ReactorEventDescriptor from one decoded JSON object.
public
static fromArray(array<string, mixed> $data) : self
Parameters
- $data : array<string, mixed>
-
The raw wire object.
Return values
selfjsonSerialize()
Renders this object for `json_encode()`.
public
jsonSerialize() : array<string, mixed>
Any Sensitive it carries stays WRAPPED here, so a log line or a
json_encode($model) in application code prints [SENSITIVE]. The one place a secret
is revealed is ManagementTransport, on the way to the wire
and nowhere else (§27.5).
Return values
array<string, mixed>toArray()
Renders this object back to its wire form.
public
toArray() : array<string, mixed>
§27.4 rule 5: a null property is OMITTED, not emitted as null. On a sparse update those two say opposite things — "leave this alone" versus "set this to nothing" — and only omission means the first.