PHP Sigfox Client

GlobalCoverageRequest extends Model

Defines the request to get Global Coverage

Table of Contents

$groupId  : string|null
The id of a group to include its operator in the global coverage, in case it is not a public operator.
$locations  : array<string|int, mixed>|null
An array of positions. Valid locations have two properties, lat and lng.
$radius  : int|null
The radius of the area in which the coverage results are averaged and returned for a selected location, in meters.
from()  : static
Initializing a model from an array
getGroupId()  : string
Getter for groupId
getLocations()  : array<string|int, LocationsItem>
Getter for locations
getRadius()  : int
Getter for radius
jsonSerialize()  : array<string|int, mixed>
setGroupId()  : static
Setter for groupId
setLocations()  : static
Setter for locations
setRadius()  : static
Setter for radius

Properties

$groupId

The id of a group to include its operator in the global coverage, in case it is not a public operator.

protected string|null $groupId = null

$locations

An array of positions. Valid locations have two properties, lat and lng.

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

$radius

The radius of the area in which the coverage results are averaged and returned for a selected location, in meters.

protected int|null $radius = 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

getGroupId()

Getter for groupId

public getGroupId() : string
Return values
string

The id of a group to include its operator in the global coverage, in case it is not a public operator.

getRadius()

Getter for radius

public getRadius() : int
Return values
int

The radius of the area in which the coverage results are averaged and returned for a selected location, in meters.

jsonSerialize()

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

setGroupId()

Setter for groupId

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

The id of a group to include its operator in the global coverage, in case it is not a public operator.

Return values
static

To use in method chains

setLocations()

Setter for locations

public setLocations(array<string|int, LocationsItem$locations) : static
Parameters
$locations : array<string|int, LocationsItem>

An array of positions. Valid locations have two properties, lat and lng.

Return values
static

To use in method chains

setRadius()

Setter for radius

public setRadius(int $radius) : static
Parameters
$radius : int

The radius of the area in which the coverage results are averaged and returned for a selected location, in meters.

Return values
static

To use in method chains

Search results