PHP Sigfox Client

Site extends BaseSite

Generic information about a site

Table of Contents

INVERTER_INFO_AC_POWER_HOST  = 1
AC POWER HOST
INVERTER_INFO_AC_POWER_HOST_INVERTER  = 2
AC POWER HOST INVERTER
INVERTER_INFO_AC_POWER_SIGFOX_INVERTER  = 3
AC POWER SIGFOX INVERTER
INVERTER_INFO_DC_POWER_HOST_48V  = 4
DC POWER HOST 48V
INVERTER_INFO_DC_POWER_SOLAR  = 5
DC POWER SOLAR
INVERTER_INFO_NONE  = 0
NONE
STATION_INSTALLATION_INDOOR_WITH_CABINET  = 2
INDOOR WITH CABINET
STATION_INSTALLATION_INDOOR_WITHOUT_CABINET  = 0
INDOOR WITHOUT CABINET
STATION_INSTALLATION_OUTDOOR_WITH_CABINET  = 1
OUTDOOR WITH CABINET
STATION_INSTALLATION_OUTDOOR_WITHOUT_CABINET  = 3
OUTDOOR WITHOUT CABINET
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
$address  : string|null
The address of the site
$aerialWorkPlatformAccess  : bool|null
is the site access to the aerial work platform
$basestationCount  : int|null
the number of base station installed on this site
$candidateExternalId  : int|null
the external identifier of the site as a candidate
$comment  : string|null
Comment about the site. This field can be unset when updating.
$createdBy  : string|null
Identifier of the user who created this site
$creationTime  : int|null
Date of the creation of this site (in milliseconds)
$group  : MinGroup|null
$host  : MinHost|null
$id  : string|null
The site's identifier
$inverterInfo  : int|null
Inverter type:
$lastEditedBy  : string|null
Identifier of the user who last edited this site
$lastEditedTime  : int|null
Date of the last edition of this site (in milliseconds)
$lat  : float|null
the site's latitude
$lessorId  : string|null
The lessor identifier of the site. This field can be unset when updating.
$lng  : float|null
the site's longitutde
$location  : array<string|int, mixed>|null
ISO 3166-1 UN M.49 country code of the site location. The first code is the country (region and department available for some countries).
$maintenance  : MinMaintenance|null
$name  : string|null
The site's name
$primaryInternetSubscription  : InternetSubscription|null
$resources  : array<string|int, mixed>|null
$stationInstallation  : int|null
Station installation:
$status  : int|null
Site status:
$statusComment  : string|null
The comment of the status of the site. This field can be unset when updating.
from()  : static
Initializing a model from an array
getActions()  : array<string|int, string>
Getter for actions
getAddress()  : string
Getter for address
getAerialWorkPlatformAccess()  : bool
Getter for aerialWorkPlatformAccess
getBasestationCount()  : int
Getter for basestationCount
getCandidateExternalId()  : int
Getter for candidateExternalId
getComment()  : string
Getter for comment
getCreatedBy()  : string
Getter for createdBy
getCreationTime()  : int
Getter for creationTime
getGroup()  : MinGroup
Getter for group
getHost()  : MinHost
Getter for host
getId()  : string
Getter for id
getInverterInfo()  : int
Getter for inverterInfo
getLastEditedBy()  : string
Getter for lastEditedBy
getLastEditedTime()  : int
Getter for lastEditedTime
getLat()  : float
Getter for lat
getLessorId()  : string
Getter for lessorId
getLng()  : float
Getter for lng
getLocation()  : array<string|int, LocationItem>
Getter for location
getMaintenance()  : MinMaintenance
Getter for maintenance
getName()  : string
Getter for name
getPrimaryInternetSubscription()  : InternetSubscription
Getter for primaryInternetSubscription
getResources()  : array<string|int, string>
Getter for resources
getStationInstallation()  : int
Getter for stationInstallation
getStatus()  : int
Getter for status
getStatusComment()  : string
Getter for statusComment
jsonSerialize()  : array<string|int, mixed>
setActions()  : static
Setter for actions
setAddress()  : static
Setter for address
setAerialWorkPlatformAccess()  : static
Setter for aerialWorkPlatformAccess
setBasestationCount()  : static
Setter for basestationCount
setCandidateExternalId()  : static
Setter for candidateExternalId
setComment()  : static
Setter for comment
setCreatedBy()  : static
Setter for createdBy
setCreationTime()  : static
Setter for creationTime
setGroup()  : static
Setter for group
setHost()  : static
Setter for host
setId()  : static
Setter for id
setInverterInfo()  : static
Setter for inverterInfo
setLastEditedBy()  : static
Setter for lastEditedBy
setLastEditedTime()  : static
Setter for lastEditedTime
setLat()  : static
Setter for lat
setLessorId()  : static
Setter for lessorId
setLng()  : static
Setter for lng
setLocation()  : static
Setter for location
setMaintenance()  : static
Setter for maintenance
setName()  : static
Setter for name
setPrimaryInternetSubscription()  : static
Setter for primaryInternetSubscription
setResources()  : static
Setter for resources
setStationInstallation()  : static
Setter for stationInstallation
setStatus()  : static
Setter for status
setStatusComment()  : static
Setter for statusComment

Constants

INVERTER_INFO_AC_POWER_HOST

AC POWER HOST

public mixed INVERTER_INFO_AC_POWER_HOST = 1

INVERTER_INFO_AC_POWER_HOST_INVERTER

AC POWER HOST INVERTER

public mixed INVERTER_INFO_AC_POWER_HOST_INVERTER = 2

INVERTER_INFO_AC_POWER_SIGFOX_INVERTER

AC POWER SIGFOX INVERTER

public mixed INVERTER_INFO_AC_POWER_SIGFOX_INVERTER = 3

INVERTER_INFO_DC_POWER_HOST_48V

DC POWER HOST 48V

public mixed INVERTER_INFO_DC_POWER_HOST_48V = 4

INVERTER_INFO_DC_POWER_SOLAR

DC POWER SOLAR

public mixed INVERTER_INFO_DC_POWER_SOLAR = 5

INVERTER_INFO_NONE

NONE

public mixed INVERTER_INFO_NONE = 0

STATION_INSTALLATION_INDOOR_WITH_CABINET

INDOOR WITH CABINET

public mixed STATION_INSTALLATION_INDOOR_WITH_CABINET = 2

STATION_INSTALLATION_INDOOR_WITHOUT_CABINET

INDOOR WITHOUT CABINET

public mixed STATION_INSTALLATION_INDOOR_WITHOUT_CABINET = 0

STATION_INSTALLATION_OUTDOOR_WITH_CABINET

OUTDOOR WITH CABINET

public mixed STATION_INSTALLATION_OUTDOOR_WITH_CABINET = 1

STATION_INSTALLATION_OUTDOOR_WITHOUT_CABINET

OUTDOOR WITHOUT CABINET

public mixed STATION_INSTALLATION_OUTDOOR_WITHOUT_CABINET = 3

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_LABO

LABO

public mixed STATUS_LABO = 9

STATUS_NOT_PLANNED

NOT PLANNED

public mixed STATUS_NOT_PLANNED = 3

STATUS_PRE_PROD

PRE PROD

public mixed STATUS_PRE_PROD = 4

STATUS_PROD

PROD

public mixed STATUS_PROD = 0

STATUS_REFUSED

REFUSED

public mixed STATUS_REFUSED = 1

Properties

$actions

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

$address

The address of the site

protected string|null $address = null

$aerialWorkPlatformAccess

is the site access to the aerial work platform

protected bool|null $aerialWorkPlatformAccess = null

$basestationCount

the number of base station installed on this site

protected int|null $basestationCount = null

$candidateExternalId

the external identifier of the site as a candidate

protected int|null $candidateExternalId = null

$comment

Comment about the site. This field can be unset when updating.

protected string|null $comment = null

$createdBy

Identifier of the user who created this site

protected string|null $createdBy = null

$creationTime

Date of the creation of this site (in milliseconds)

protected int|null $creationTime = null

$id

The site's identifier

protected string|null $id = null

$lastEditedBy

Identifier of the user who last edited this site

protected string|null $lastEditedBy = null

$lastEditedTime

Date of the last edition of this site (in milliseconds)

protected int|null $lastEditedTime = null

$lat

the site's latitude

protected float|null $lat = null

$lessorId

The lessor identifier of the site. This field can be unset when updating.

protected string|null $lessorId = null

$lng

the site's longitutde

protected float|null $lng = null

$location

ISO 3166-1 UN M.49 country code of the site location. The first code is the country (region and department available for some countries).

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

$name

The site's name

protected string|null $name = null

$resources

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

$statusComment

The comment of the status of the site. This field can be unset when updating.

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

getAddress()

Getter for address

public getAddress() : string
Return values
string —

The address of the site

getAerialWorkPlatformAccess()

Getter for aerialWorkPlatformAccess

public getAerialWorkPlatformAccess() : bool
Return values
bool —

is the site access to the aerial work platform

getBasestationCount()

Getter for basestationCount

public getBasestationCount() : int
Return values
int —

the number of base station installed on this site

getCandidateExternalId()

Getter for candidateExternalId

public getCandidateExternalId() : int
Return values
int —

the external identifier of the site as a candidate

getComment()

Getter for comment

public getComment() : string
Return values
string —

Comment about the site. This field can be unset when updating.

getCreatedBy()

Getter for createdBy

public getCreatedBy() : string
Return values
string —

Identifier of the user who created this site

getCreationTime()

Getter for creationTime

public getCreationTime() : int
Return values
int —

Date of the creation of this site (in milliseconds)

getId()

Getter for id

public getId() : string
Return values
string —

The site's identifier

getLastEditedBy()

Getter for lastEditedBy

public getLastEditedBy() : string
Return values
string —

Identifier of the user who last edited this site

getLastEditedTime()

Getter for lastEditedTime

public getLastEditedTime() : int
Return values
int —

Date of the last edition of this site (in milliseconds)

getLat()

Getter for lat

public getLat() : float
Return values
float —

the site's latitude

getLessorId()

Getter for lessorId

public getLessorId() : string
Return values
string —

The lessor identifier of the site. This field can be unset when updating.

getLng()

Getter for lng

public getLng() : float
Return values
float —

the site's longitutde

getLocation()

Getter for location

public getLocation() : array<string|int, LocationItem>
Return values
array<string|int, LocationItem> —

ISO 3166-1 UN M.49 country code of the site location. The first code is the country (region and department available for some countries).

getName()

Getter for name

public getName() : string
Return values
string —

The site's name

getResources()

Getter for resources

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

getStatusComment()

Getter for statusComment

public getStatusComment() : string
Return values
string —

The comment of the status of the site. This field can be unset when updating.

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

setAddress()

Setter for address

public setAddress(string $address) : static
Parameters
$address : string

The address of the site

Return values
static —

To use in method chains

setAerialWorkPlatformAccess()

Setter for aerialWorkPlatformAccess

public setAerialWorkPlatformAccess(bool $aerialWorkPlatformAccess) : static
Parameters
$aerialWorkPlatformAccess : bool

is the site access to the aerial work platform

Return values
static —

To use in method chains

setBasestationCount()

Setter for basestationCount

public setBasestationCount(int $basestationCount) : static
Parameters
$basestationCount : int

the number of base station installed on this site

Return values
static —

To use in method chains

setCandidateExternalId()

Setter for candidateExternalId

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

the external identifier of the site as a candidate

Return values
static —

To use in method chains

setComment()

Setter for comment

public setComment(string $comment) : static
Parameters
$comment : string

Comment about the site. This field can be unset when updating.

Return values
static —

To use in method chains

setCreatedBy()

Setter for createdBy

public setCreatedBy(string $createdBy) : static
Parameters
$createdBy : string

Identifier of the user who created this site

Return values
static —

To use in method chains

setCreationTime()

Setter for creationTime

public setCreationTime(int $creationTime) : static
Parameters
$creationTime : int

Date of the creation of this site (in milliseconds)

Return values
static —

To use in method chains

setGroup()

Setter for group

public setGroup(MinGroup $group) : static
Parameters
$group : MinGroup
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

setLastEditedBy()

Setter for lastEditedBy

public setLastEditedBy(string $lastEditedBy) : static
Parameters
$lastEditedBy : string

Identifier of the user who last edited this site

Return values
static —

To use in method chains

setLastEditedTime()

Setter for lastEditedTime

public setLastEditedTime(int $lastEditedTime) : static
Parameters
$lastEditedTime : int

Date of the last edition of this site (in milliseconds)

Return values
static —

To use in method chains

setLat()

Setter for lat

public setLat(float $lat) : static
Parameters
$lat : float

the site's latitude

Return values
static —

To use in method chains

setLessorId()

Setter for lessorId

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

The lessor identifier of the site. This field can be unset when updating.

Return values
static —

To use in method chains

setLng()

Setter for lng

public setLng(float $lng) : static
Parameters
$lng : float

the site's longitutde

Return values
static —

To use in method chains

setLocation()

Setter for location

public setLocation(array<string|int, LocationItem> $location) : static
Parameters
$location : array<string|int, LocationItem>

ISO 3166-1 UN M.49 country code of the site location. The first code is the country (region and department available for some countries).

Return values
static —

To use in method chains

setMaintenance()

Setter for maintenance

public setMaintenance(MinMaintenance $maintenance) : static
Parameters
$maintenance : MinMaintenance
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

setPrimaryInternetSubscription()

Setter for primaryInternetSubscription

public setPrimaryInternetSubscription(InternetSubscription $primaryInternetSubscription) : static
Parameters
$primaryInternetSubscription : InternetSubscription
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

setStatus()

Setter for status

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

Site status:

Return values
static —

To use in method chains

setStatusComment()

Setter for statusComment

public setStatusComment(string $statusComment) : static
Parameters
$statusComment : string

The comment of the status of the site. This field can be unset when updating.

Return values
static —

To use in method chains

Search results