PHP Sigfox Client

SimpleSite extends MinSite

Minimal information about a site linked to a Base Station.

Table of Contents

STATUS_CANCELLED  = 6
CANCELLED
STATUS_CANDIDATE  = 5
CANDIDATE
STATUS_CLIENT  = 7
CLIENT
STATUS_INSTALLED  = 2
INSTALLED
STATUS_INSTALLED_CONNECTED_ONLY_PRIMARY  = 15
INSTALLED CONNECTED ONLY PRIMARY
STATUS_INSTALLED_CONNECTED_ONLY_SECONDARY  = 14
INSTALLED CONNECTED ONLY SECONDARY
STATUS_LABO  = 9
LABO
STATUS_NOT_PLANNED  = 3
NOT PLANNED
STATUS_PRE_PROD  = 4
PRE PROD
STATUS_PROD  = 0
PROD
STATUS_RD  = 8
RD
STATUS_REFUSED  = 1
REFUSED
$actions  : array<string|int, mixed>|null
$candidateExternalId  : int|null
external id of the site where the base station is installed
$host  : MinHost|null
$id  : string|null
The site's identifier
$lessorId  : string|null
id of the lessor of the site where the base station is installed
$name  : string|null
The site's name
$status  : int|null
Site status
from()  : static
Initializing a model from an array
getActions()  : array<string|int, string>
Getter for actions
getCandidateExternalId()  : int
Getter for candidateExternalId
getHost()  : MinHost
Getter for host
getId()  : string
Getter for id
getLessorId()  : string
Getter for lessorId
getName()  : string
Getter for name
getStatus()  : int
Getter for status
jsonSerialize()  : array<string|int, mixed>
setActions()  : static
Setter for actions
setCandidateExternalId()  : static
Setter for candidateExternalId
setHost()  : static
Setter for host
setId()  : static
Setter for id
setLessorId()  : static
Setter for lessorId
setName()  : static
Setter for name
setStatus()  : static
Setter for status

Constants

STATUS_CANCELLED

CANCELLED

public mixed STATUS_CANCELLED = 6

STATUS_CANDIDATE

CANDIDATE

public mixed STATUS_CANDIDATE = 5

STATUS_CLIENT

CLIENT

public mixed STATUS_CLIENT = 7

STATUS_INSTALLED

INSTALLED

public mixed STATUS_INSTALLED = 2

STATUS_INSTALLED_CONNECTED_ONLY_PRIMARY

INSTALLED CONNECTED ONLY PRIMARY

public mixed STATUS_INSTALLED_CONNECTED_ONLY_PRIMARY = 15

STATUS_INSTALLED_CONNECTED_ONLY_SECONDARY

INSTALLED CONNECTED ONLY SECONDARY

public mixed STATUS_INSTALLED_CONNECTED_ONLY_SECONDARY = 14

STATUS_NOT_PLANNED

NOT PLANNED

public mixed STATUS_NOT_PLANNED = 3

STATUS_PRE_PROD

PRE PROD

public mixed STATUS_PRE_PROD = 4

STATUS_REFUSED

REFUSED

public mixed STATUS_REFUSED = 1

Properties

$actions

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

$candidateExternalId

external id of the site where the base station is installed

protected int|null $candidateExternalId = null

$id

The site's identifier

protected string|null $id = null

$lessorId

id of the lessor of the site where the base station is installed

protected string|null $lessorId = null

$name

The site's name

protected string|null $name = 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>

getCandidateExternalId()

Getter for candidateExternalId

public getCandidateExternalId() : int
Return values
int

external id of the site where the base station is installed

getId()

Getter for id

public getId() : string
Return values
string

The site's identifier

getLessorId()

Getter for lessorId

public getLessorId() : string
Return values
string

id of the lessor of the site where the base station is installed

getName()

Getter for name

public getName() : string
Return values
string

The site's name

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

setCandidateExternalId()

Setter for candidateExternalId

public setCandidateExternalId(int $candidateExternalId) : static
Parameters
$candidateExternalId : int

external id of the site where the base station is installed

Return values
static

To use in method chains

setHost()

Setter for host

public setHost(MinHost $host) : static
Parameters
$host : MinHost
Return values
static

To use in method chains

setId()

Setter for id

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

The site's identifier

Return values
static

To use in method chains

setLessorId()

Setter for lessorId

public setLessorId(string $lessorId) : static
Parameters
$lessorId : string

id of the lessor of the site where the base station is installed

Return values
static

To use in method chains

setName()

Setter for name

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

The site's name

Return values
static

To use in method chains

setStatus()

Setter for status

public setStatus(int $status) : static
Parameters
$status : int

Site status

Return values
static

To use in method chains

Search results