PHP Sigfox Client

CityArea extends Model

Define the city area's properties

Table of Contents

$actions  : array<string|int, mixed>|null
$deploymentKpiReport  : bool|null
true if the city area is included in the monthly deployement kpi report of the operator.
$groupId  : string|null
The city area operator's identifier
$id  : string|null
The city area's identifier
$name  : string|null
The city area's name
$readOnly  : bool|null
true if the city area is not editable by an operator user.
from()  : static
Initializing a model from an array
getActions()  : array<string|int, string>
Getter for actions
getDeploymentKpiReport()  : bool
Getter for deploymentKpiReport
getGroupId()  : string
Getter for groupId
getId()  : string
Getter for id
getName()  : string
Getter for name
getReadOnly()  : bool
Getter for readOnly
jsonSerialize()  : array<string|int, mixed>
setActions()  : static
Setter for actions
setDeploymentKpiReport()  : static
Setter for deploymentKpiReport
setGroupId()  : static
Setter for groupId
setId()  : static
Setter for id
setName()  : static
Setter for name
setReadOnly()  : static
Setter for readOnly

Properties

$actions

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

$deploymentKpiReport

true if the city area is included in the monthly deployement kpi report of the operator.

protected bool|null $deploymentKpiReport = null

$groupId

The city area operator's identifier

protected string|null $groupId = null

$id

The city area's identifier

protected string|null $id = null

$name

The city area's name

protected string|null $name = null

$readOnly

true if the city area is not editable by an operator user.

protected bool|null $readOnly = 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>

getDeploymentKpiReport()

Getter for deploymentKpiReport

public getDeploymentKpiReport() : bool
Return values
bool

true if the city area is included in the monthly deployement kpi report of the operator.

getGroupId()

Getter for groupId

public getGroupId() : string
Return values
string

The city area operator's identifier

getId()

Getter for id

public getId() : string
Return values
string

The city area's identifier

getName()

Getter for name

public getName() : string
Return values
string

The city area's name

getReadOnly()

Getter for readOnly

public getReadOnly() : bool
Return values
bool

true if the city area is not editable by an operator user.

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

setDeploymentKpiReport()

Setter for deploymentKpiReport

public setDeploymentKpiReport(bool $deploymentKpiReport) : static
Parameters
$deploymentKpiReport : bool

true if the city area is included in the monthly deployement kpi report of the operator.

Return values
static

To use in method chains

setGroupId()

Setter for groupId

public setGroupId(string $groupId) : static
Parameters
$groupId : string

The city area operator's identifier

Return values
static

To use in method chains

setId()

Setter for id

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

The city area's identifier

Return values
static

To use in method chains

setName()

Setter for name

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

The city area's name

Return values
static

To use in method chains

setReadOnly()

Setter for readOnly

public setReadOnly(bool $readOnly) : static
Parameters
$readOnly : bool

true if the city area is not editable by an operator user.

Return values
static

To use in method chains

Search results