AXIAM PHP SDK

Scope
in package
implements JsonSerializable

FinalYes

The `Scope` schema from the server's OpenAPI document.

Table of Contents

Interfaces

JsonSerializable

Properties

$createdAt  : string
$description  : string
$id  : string
$name  : string
$resourceId  : string
$tenantId  : string
$updatedAt  : string

Methods

__construct()  : mixed
Constructs a Scope.
fromArray()  : self
Rebuilds a Scope 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

$createdAt read-only

public string $createdAt

$description read-only

public string $description

$id read-only

public string $id

$name read-only

public string $name

$resourceId read-only

public string $resourceId

$tenantId read-only

public string $tenantId

$updatedAt read-only

public string $updatedAt

Methods

__construct()

Constructs a Scope.

public __construct(string $createdAt, string $description, string $id, string $name, string $resourceId, string $tenantId, string $updatedAt) : mixed
Parameters
$createdAt : string

the server's created_at field

$description : string

the server's description field

$id : string

the server's id field

$name : string

the server's name field

$resourceId : string

The resource this scope belongs to.

$tenantId : string

the server's tenant_id field

$updatedAt : string

the server's updated_at field

fromArray()

Rebuilds a Scope from one decoded JSON object.

public static fromArray(array<string, mixed> $data) : self
Parameters
$data : array<string, mixed>

The raw wire object.

Return values
self

jsonSerialize()

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.

Return values
array<string, mixed>
On this page

Search results