GrantedScope
in package
implements
JsonSerializable
A scope named by a grant, resolved to something a human can read.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $id : string
- $name : string
- $resourceId : string
Methods
- __construct() : mixed
- Constructs a GrantedScope.
- fromArray() : self
- Rebuilds a GrantedScope 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
$id read-only
public
string
$id
$name read-only
public
string
$name
$resourceId read-only
public
string
$resourceId
Methods
__construct()
Constructs a GrantedScope.
public
__construct(string $id, string $name, string $resourceId) : mixed
Parameters
- $id : string
-
The scope's id, as it appears in the grant's
scope_ids. - $name : string
-
The scope's name, e.g.
invoices. - $resourceId : string
-
The resource the scope belongs to.
fromArray()
Rebuilds a GrantedScope 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.