RoleAssignment
in package
implements
JsonSerializable
A role together with its assignment context (the resource it is scoped to).
Table of Contents
Interfaces
- JsonSerializable
Properties
- $resourceId : string|null
- $role : Role
- $tenantScope : array<string|int, mixed>|null
Methods
- __construct() : mixed
- Constructs a RoleAssignment.
- fromArray() : self
- Rebuilds a RoleAssignment 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
$resourceId read-only
public
string|null
$resourceId
= null
$role read-only
public
Role
$role
$tenantScope read-only
public
array<string|int, mixed>|null
$tenantScope
= null
Methods
__construct()
Constructs a RoleAssignment.
public
__construct(Role $role[, string|null $resourceId = null ][, array<int, string>|null $tenantScope = null ]) : mixed
Parameters
- $role : Role
-
the server's
rolefield - $resourceId : string|null = null
-
Nonemeans the role was assigned globally (no resource scope). (optional) - $tenantScope : array<int, string>|null = null
-
The tenants this assignment reaches. See [
TenantScope]. (optional)
fromArray()
Rebuilds a RoleAssignment 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.