ConsentView
in package
implements
JsonSerializable
One consent record, as the subject sees it.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $acceptedAt : string
- $consentType : string
- $version : string
- $withdrawable : bool
Methods
- __construct() : mixed
- Constructs a ConsentView.
- fromArray() : self
- Rebuilds a ConsentView 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
$acceptedAt read-only
public
string
$acceptedAt
$consentType read-only
public
string
$consentType
$version read-only
public
string
$version
$withdrawable read-only
public
bool
$withdrawable
Methods
__construct()
Constructs a ConsentView.
public
__construct(string $acceptedAt, string $consentType, string $version, bool $withdrawable) : mixed
Parameters
- $acceptedAt : string
-
the server's
accepted_atfield - $consentType : string
-
What was consented to, e.g.
terms_of_serviceoroidc_scope_release:<client_id>. - $version : string
-
The document version or, for a scope release, the consented scopes.
- $withdrawable : bool
-
Whether this record can be withdrawn here.
falseforterms_of_service: withdrawing it is not a consent operation but an erasure, and it has its own endpoint with its own grace period. Reported rather than silently absent so the self-service page can show the record and explain it.
fromArray()
Rebuilds a ConsentView 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.