FederatedLink
in package
implements
JsonSerializable
Interfaces, Classes, Traits and Enums
- JsonSerializable
Table of Contents
- SHORT_UNIQUE_ID_LENGTH = 12
- STATUS_ERROR = -1
- STATUS_LINK_DOWN = 1
- STATUS_LINK_REMOVE = 0
- STATUS_LINK_REQUESTED = 6
- STATUS_LINK_SETUP = 2
- STATUS_LINK_UP = 9
- STATUS_REQUEST_DECLINED = 4
- STATUS_REQUEST_SENT = 5
- $address : string
- $circleUniqueId : int
- $creation : int
- $fullJson : bool
- $id : int
- $localAddress : string
- $localCircleName : string
- $remoteCircleName : string
- $status : int
- $token : string
- $uniqueId : string
- __construct() : mixed
- fromArray() : mixed
- fromJSON() : mixed
- generateToken() : string
- getAddress() : string
- getCircleId() : string
- getCircleName() : string
- getCreation() : int
- getId() : int
- getJson() : mixed
- getLocalAddress() : string
- getRemoteCircleName() : string
- getStatus() : int
- getToken() : string
- getUniqueId() : string
- hasToBeValidStatusUpdate() : mixed
- jsonSerialize() : mixed
- setAddress() : FederatedLink
- setCircleId() : FederatedLink
- setCircleName() : FederatedLink
- setCreation() : FederatedLink
- setId() : FederatedLink
- setLocalAddress() : FederatedLink
- setRemoteCircleName() : FederatedLink
- setStatus() : FederatedLink
- setToken() : $this
- setUniqueId() : FederatedLink
- hasToBeValidStatusUpdateWhileLinkDown() : mixed
- hasToBeValidStatusUpdateWhileLinkRequested() : mixed
- hasToBeValidStatusUpdateWhileRequestDeclined() : mixed
- hasToBeValidStatusUpdateWhileRequestSent() : mixed
Constants
SHORT_UNIQUE_ID_LENGTH
public
mixed
SHORT_UNIQUE_ID_LENGTH
= 12
STATUS_ERROR
public
mixed
STATUS_ERROR
= -1
STATUS_LINK_DOWN
public
mixed
STATUS_LINK_DOWN
= 1
STATUS_LINK_REMOVE
public
mixed
STATUS_LINK_REMOVE
= 0
STATUS_LINK_REQUESTED
public
mixed
STATUS_LINK_REQUESTED
= 6
STATUS_LINK_SETUP
public
mixed
STATUS_LINK_SETUP
= 2
STATUS_LINK_UP
public
mixed
STATUS_LINK_UP
= 9
STATUS_REQUEST_DECLINED
public
mixed
STATUS_REQUEST_DECLINED
= 4
STATUS_REQUEST_SENT
public
mixed
STATUS_REQUEST_SENT
= 5
Properties
$address
private
string
$address
$circleUniqueId
private
int
$circleUniqueId
$creation
private
int
$creation
$fullJson
private
bool
$fullJson
= false
$id
private
int
$id
$localAddress
private
string
$localAddress
$localCircleName
private
string
$localCircleName
$remoteCircleName
private
string
$remoteCircleName
$status
private
int
$status
$token
private
string
$token
$uniqueId
private
string
$uniqueId
= ''
Methods
__construct()
public
__construct() : mixed
Return values
mixed —fromArray()
public
static fromArray(mixed $arr) : mixed
Parameters
- $arr : mixed
Return values
mixed —fromJSON()
public
static fromJSON(mixed $json) : mixed
Parameters
- $json : mixed
Return values
mixed —generateToken()
public
generateToken() : string
Return values
string —getAddress()
public
getAddress() : string
Return values
string —getCircleId()
public
getCircleId([bool $full = false ]) : string
Parameters
- $full : bool = false
Return values
string —getCircleName()
public
getCircleName() : string
Return values
string —getCreation()
public
getCreation() : int
Return values
int —getId()
public
getId() : int
Return values
int —getJson()
public
getJson([mixed $full = false ]) : mixed
Parameters
- $full : mixed = false
Return values
mixed —getLocalAddress()
public
getLocalAddress() : string
Return values
string —getRemoteCircleName()
public
getRemoteCircleName() : string
Return values
string —getStatus()
public
getStatus() : int
Return values
int —getToken()
public
getToken([bool $full = false ]) : string
Parameters
- $full : bool = false
Return values
string —getUniqueId()
public
getUniqueId([bool $full = false ]) : string
Parameters
- $full : bool = false
Return values
string —hasToBeValidStatusUpdate()
public
hasToBeValidStatusUpdate(mixed $status) : mixed
Parameters
- $status : mixed
Return values
mixed —jsonSerialize()
public
jsonSerialize() : mixed
Return values
mixed —setAddress()
public
setAddress(string $address) : FederatedLink
Parameters
- $address : string
Return values
FederatedLink —setCircleId()
public
setCircleId(string $circleUniqueId) : FederatedLink
Parameters
- $circleUniqueId : string
Return values
FederatedLink —setCircleName()
public
setCircleName(string $circleName) : FederatedLink
Parameters
- $circleName : string
Return values
FederatedLink —setCreation()
public
setCreation(int $creation) : FederatedLink
Parameters
- $creation : int
Return values
FederatedLink —setId()
public
setId(int $id) : FederatedLink
Parameters
- $id : int
Return values
FederatedLink —setLocalAddress()
public
setLocalAddress(string $address) : FederatedLink
Parameters
- $address : string
Return values
FederatedLink —setRemoteCircleName()
public
setRemoteCircleName(string $circleName) : FederatedLink
Parameters
- $circleName : string
Return values
FederatedLink —setStatus()
public
setStatus(int $status) : FederatedLink
Parameters
- $status : int
Return values
FederatedLink —setToken()
public
setToken( $token) : $this
Parameters
Return values
$this —setUniqueId()
public
setUniqueId(string $uniqueId) : FederatedLink
Parameters
- $uniqueId : string
Return values
FederatedLink —hasToBeValidStatusUpdateWhileLinkDown()
private
hasToBeValidStatusUpdateWhileLinkDown( $status) : mixed
Parameters
Tags
Return values
mixed —hasToBeValidStatusUpdateWhileLinkRequested()
private
hasToBeValidStatusUpdateWhileLinkRequested( $status) : mixed
Parameters
Tags
Return values
mixed —hasToBeValidStatusUpdateWhileRequestDeclined()
private
hasToBeValidStatusUpdateWhileRequestDeclined( $status) : mixed
Parameters
Tags
Return values
mixed —hasToBeValidStatusUpdateWhileRequestSent()
private
hasToBeValidStatusUpdateWhileRequestSent( $status) : mixed