PHP Sigfox Client

User extends CommonUser

Information about a User

Table of Contents

$actions  : array<string|int, mixed>|null
$creationTime  : int|null
The user's creation time (in millisecond since Unix Epoch)
$email  : string|null
The user's email
$firstName  : string|null
The user's first name
$id  : string|null
The user's identifier
$lastLoginTime  : int|null
The user's last login time
$lastName  : string|null
The user's last name
$locked  : bool|null
If the user account is locked or not
$resources  : array<string|int, mixed>|null
$timezone  : string|null
The user's timezone
$userRoles  : array<string|int, mixed>|null
from()  : static
Initializing a model from an array
getActions()  : array<string|int, string>
Getter for actions
getCreationTime()  : int
Getter for creationTime
getEmail()  : string
Getter for email
getFirstName()  : string
Getter for firstName
getId()  : string
Getter for id
getLastLoginTime()  : int
Getter for lastLoginTime
getLastName()  : string
Getter for lastName
getLocked()  : bool
Getter for locked
getResources()  : array<string|int, string>
Getter for resources
getTimezone()  : string
Getter for timezone
getUserRoles()  : array<string|int, UserRole>
Getter for userRoles
jsonSerialize()  : array<string|int, mixed>
setActions()  : static
Setter for actions
setCreationTime()  : static
Setter for creationTime
setEmail()  : static
Setter for email
setFirstName()  : static
Setter for firstName
setId()  : static
Setter for id
setLastLoginTime()  : static
Setter for lastLoginTime
setLastName()  : static
Setter for lastName
setLocked()  : static
Setter for locked
setResources()  : static
Setter for resources
setTimezone()  : static
Setter for timezone
setUserRoles()  : static
Setter for userRoles

Properties

$actions

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

$creationTime

The user's creation time (in millisecond since Unix Epoch)

protected int|null $creationTime = null

$email

The user's email

protected string|null $email = null

$firstName

The user's first name

protected string|null $firstName = null

$id

The user's identifier

protected string|null $id = null

$lastLoginTime

The user's last login time

protected int|null $lastLoginTime = null

$lastName

The user's last name

protected string|null $lastName = null

$locked

If the user account is locked or not

protected bool|null $locked = null

$resources

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

$timezone

The user's timezone

protected string|null $timezone = null

$userRoles

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

getCreationTime()

Getter for creationTime

public getCreationTime() : int
Return values
int —

The user's creation time (in millisecond since Unix Epoch)

getEmail()

Getter for email

public getEmail() : string
Return values
string —

The user's email

getFirstName()

Getter for firstName

public getFirstName() : string
Return values
string —

The user's first name

getId()

Getter for id

public getId() : string
Return values
string —

The user's identifier

getLastLoginTime()

Getter for lastLoginTime

public getLastLoginTime() : int
Return values
int —

The user's last login time

getLastName()

Getter for lastName

public getLastName() : string
Return values
string —

The user's last name

getLocked()

Getter for locked

public getLocked() : bool
Return values
bool —

If the user account is locked or not

getResources()

Getter for resources

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

getTimezone()

Getter for timezone

public getTimezone() : string
Return values
string —

The user's timezone

getUserRoles()

Getter for userRoles

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

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

setCreationTime()

Setter for creationTime

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

The user's creation time (in millisecond since Unix Epoch)

Return values
static —

To use in method chains

setEmail()

Setter for email

public setEmail(string $email) : static
Parameters
$email : string

The user's email

Return values
static —

To use in method chains

setFirstName()

Setter for firstName

public setFirstName(string $firstName) : static
Parameters
$firstName : string

The user's first name

Return values
static —

To use in method chains

setId()

Setter for id

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

The user's identifier

Return values
static —

To use in method chains

setLastLoginTime()

Setter for lastLoginTime

public setLastLoginTime(int $lastLoginTime) : static
Parameters
$lastLoginTime : int

The user's last login time

Return values
static —

To use in method chains

setLastName()

Setter for lastName

public setLastName(string $lastName) : static
Parameters
$lastName : string

The user's last name

Return values
static —

To use in method chains

setLocked()

Setter for locked

public setLocked(bool $locked) : static
Parameters
$locked : bool

If the user account is locked or not

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

setTimezone()

Setter for timezone

public setTimezone(string $timezone) : static
Parameters
$timezone : string

The user's timezone

Return values
static —

To use in method chains

setUserRoles()

Setter for userRoles

public setUserRoles(array<string|int, UserRole> $userRoles) : static
Parameters
$userRoles : array<string|int, UserRole>
Return values
static —

To use in method chains

Search results