PHP Sigfox Client

MinGroup extends Model

Defines a group entity

Table of Contents

TYPE_CHANNEL  = 9
Channel
TYPE_DIST  = 8
DIST
TYPE_NIP  = 7
NIP
TYPE_OTHER  = 2
Other
TYPE_PARTNER  = 11
Partner
TYPE_PARTNERS  = 6
Partners
TYPE_SO  = 0
SO
TYPE_STARTER  = 10
Starter
TYPE_SVNO  = 5
SVNO
$actions  : array<string|int, mixed>|null
$id  : string|null
The group identifier
$level  : int|null
The depth level of the group in hierarchy
$name  : string|null
The group name
$resources  : array<string|int, mixed>|null
$type  : int|null
Group's type
from()  : static
Initializing a model from an array
getActions()  : array<string|int, string>
Getter for actions
getId()  : string
Getter for id
getLevel()  : int
Getter for level
getName()  : string
Getter for name
getResources()  : array<string|int, string>
Getter for resources
getType()  : int
Getter for type
jsonSerialize()  : array<string|int, mixed>
setActions()  : static
Setter for actions
setId()  : static
Setter for id
setLevel()  : static
Setter for level
setName()  : static
Setter for name
setResources()  : static
Setter for resources
setType()  : static
Setter for type

Constants

TYPE_CHANNEL

Channel

public mixed TYPE_CHANNEL = 9

TYPE_DIST

DIST

public mixed TYPE_DIST = 8

TYPE_OTHER

Other

public mixed TYPE_OTHER = 2

TYPE_PARTNER

Partner

public mixed TYPE_PARTNER = 11

TYPE_PARTNERS

Partners

public mixed TYPE_PARTNERS = 6

TYPE_STARTER

Starter

public mixed TYPE_STARTER = 10

TYPE_SVNO

SVNO

public mixed TYPE_SVNO = 5

Properties

$actions

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

$id

The group identifier

protected string|null $id = null

$level

The depth level of the group in hierarchy

protected int|null $level = null

$name

The group name

protected string|null $name = null

$resources

protected array<string|int, mixed>|null $resources = 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

getActions()

Getter for actions

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

getId()

Getter for id

public getId() : string
Return values
string

The group identifier

getLevel()

Getter for level

public getLevel() : int
Return values
int

The depth level of the group in hierarchy

getName()

Getter for name

public getName() : string
Return values
string

The group name

getResources()

Getter for resources

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

jsonSerialize()

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

setActions()

Setter for actions

public setActions(array<string|int, string> $actions) : static
Parameters
$actions : array<string|int, string>
Return values
static

To use in method chains

setId()

Setter for id

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

The group identifier

Return values
static

To use in method chains

setLevel()

Setter for level

public setLevel(int $level) : static
Parameters
$level : int

The depth level of the group in hierarchy

Return values
static

To use in method chains

setName()

Setter for name

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

The group name

Return values
static

To use in method chains

setResources()

Setter for resources

public setResources(array<string|int, string> $resources) : static
Parameters
$resources : array<string|int, string>
Return values
static

To use in method chains

Search results