PHP Sigfox Client

MinRole extends Model

Defines a role entity

Table of Contents

$id  : string|null
The role's identifier
$name  : string|null
The role's name
$path  : array<string|int, mixed>|null
The roles's path sorted by descending ancestor (direct parent to farest parent)
from()  : static
Initializing a model from an array
getId()  : string
Getter for id
getName()  : string
Getter for name
getPath()  : array<string|int, MinMetaRole>
Getter for path
jsonSerialize()  : array<string|int, mixed>
setId()  : static
Setter for id
setName()  : static
Setter for name
setPath()  : static
Setter for path

Properties

$id

The role's identifier

protected string|null $id = null

$name

The role's name

protected string|null $name = null

$path

The roles's path sorted by descending ancestor (direct parent to farest parent)

protected array<string|int, mixed>|null $path = null

Methods

from()

Initializing a model from an array

public static from(array<string|int, mixed> $params) : static
Parameters
$params : array<string|int, mixed>

Pass this parameter if you want to initial property value from an array. See API reference for all property names and types

Tags
throws
DeserializeException

If provided an invalid type to a property

Return values
static

getId()

Getter for id

public getId() : string
Return values
string

The role's identifier

getName()

Getter for name

public getName() : string
Return values
string

The role's name

getPath()

Getter for path

public getPath() : array<string|int, MinMetaRole>
Return values
array<string|int, MinMetaRole>

The roles's path sorted by descending ancestor (direct parent to farest parent)

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
inheritdoc
Return values
array<string|int, mixed>

setId()

Setter for id

public setId(string $id) : static
Parameters
$id : string

The role's identifier

Return values
static

To use in method chains

setName()

Setter for name

public setName(string $name) : static
Parameters
$name : string

The role's name

Return values
static

To use in method chains

setPath()

Setter for path

public setPath(array<string|int, MinMetaRole$path) : static
Parameters
$path : array<string|int, MinMetaRole>

The roles's path sorted by descending ancestor (direct parent to farest parent)

Return values
static

To use in method chains

Search results