FederatedEvent
in package
implements
JsonSerializable
Uses
TArrayTools
Class FederatedEvent
Interfaces, Classes, Traits and Enums
- JsonSerializable
Table of Contents
- BYPASS_CIRCLE = 1
- BYPASS_INITIATORCHECK = 8
- BYPASS_INITIATORMEMBERSHIP = 16
- BYPASS_LOCALCIRCLECHECK = 2
- BYPASS_LOCALMEMBERCHECK = 4
- SEVERITY_HIGH = 3
- SEVERITY_LOW = 1
- $TYPE_ARRAY : mixed
- $TYPE_BOOLEAN : mixed
- $TYPE_INTEGER : mixed
- $TYPE_NULL : mixed
- $TYPE_SERIALIZABLE : mixed
- $TYPE_STRING : mixed
- $async : bool
- $bypass : int
- $circle : Circle
- $class : string
- $data : SimpleDataStore
- $dataRequestOnly : bool
- $internal : SimpleDataStore
- $itemId : string
- $itemSource : string
- $limitedToInstanceWithMember : bool
- $member : Member
- $members : array<string|int, Member>
- $origin : string
- $outcome : array<string|int, mixed>
- $params : SimpleDataStore
- $result : SimpleDataStore
- $sender : string
- $severity : int
- $wrapperToken : string
- __construct() : mixed
- FederatedEvent constructor.
- addResultEntry() : $this
- bypass() : FederatedEvent
- canBypass() : bool
- getCircle() : Circle
- getClass() : string
- getData() : SimpleDataStore
- getInternal() : SimpleDataStore
- getItemId() : string
- getItemSource() : string
- getMember() : Member
- getMembers() : array<string|int, Member>
- getOrigin() : string
- Origin of the event.
- getOutcome() : array<string|int, mixed>
- getParams() : SimpleDataStore
- getResult() : SimpleDataStore
- getSender() : string
- getSeverity() : int
- getWrapperToken() : string
- hasCircle() : bool
- hasMember() : bool
- import() : self
- isAsync() : bool
- isDataRequestOnly() : bool
- isLimitedToInstanceWithMember() : bool
- jsonSerialize() : array<string|int, mixed>
- resetData() : $this
- resetInternal() : $this
- resetResult() : $this
- setAsync() : self
- setCircle() : self
- setClass() : self
- setData() : self
- setDataRequestOnly() : self
- setInternal() : self
- setItemId() : self
- setItemSource() : self
- setLimitedToInstanceWithMember() : self
- setMember() : self
- setMembers() : self
- setOrigin() : self
- setOutcome() : $this
- setParams() : self
- setResult() : self
- setResultEntry() : $this
- setSender() : self
- Origin of the request
- setSeverity() : self
- setWrapperToken() : FederatedEvent
- typeOf() : string
- validKey() : bool
- cleanArray() : mixed
- extractArray() : mixed
- get() : string
- getArray() : array<string|int, mixed>
- getBool() : bool
- getFloat() : float
- getInt() : int
- getList() : array<string|int, mixed>
- getObj() : mixed
- mustContains() : mixed
Constants
BYPASS_CIRCLE
public
mixed
BYPASS_CIRCLE
= 1
BYPASS_INITIATORCHECK
public
mixed
BYPASS_INITIATORCHECK
= 8
BYPASS_INITIATORMEMBERSHIP
public
mixed
BYPASS_INITIATORMEMBERSHIP
= 16
BYPASS_LOCALCIRCLECHECK
public
mixed
BYPASS_LOCALCIRCLECHECK
= 2
BYPASS_LOCALMEMBERCHECK
public
mixed
BYPASS_LOCALMEMBERCHECK
= 4
SEVERITY_HIGH
public
mixed
SEVERITY_HIGH
= 3
SEVERITY_LOW
public
mixed
SEVERITY_LOW
= 1
Properties
$TYPE_ARRAY
public
static mixed
$TYPE_ARRAY
= 'Array'
$TYPE_BOOLEAN
public
static mixed
$TYPE_BOOLEAN
= 'Boolean'
$TYPE_INTEGER
public
static mixed
$TYPE_INTEGER
= 'Integer'
$TYPE_NULL
public
static mixed
$TYPE_NULL
= 'Null'
$TYPE_SERIALIZABLE
public
static mixed
$TYPE_SERIALIZABLE
= 'Serializable'
$TYPE_STRING
public
static mixed
$TYPE_STRING
= 'String'
$async
private
bool
$async
= false
$bypass
private
int
$bypass
= 0
$circle
private
Circle
$circle
$class
private
string
$class
$data
private
SimpleDataStore
$data
$dataRequestOnly
private
bool
$dataRequestOnly
= false
$internal
private
SimpleDataStore
$internal
$itemId
private
string
$itemId
= ''
$itemSource
private
string
$itemSource
= ''
$limitedToInstanceWithMember
private
bool
$limitedToInstanceWithMember
= false
$member
private
Member
$member
$members
private
array<string|int, Member>
$members
= []
$origin
private
string
$origin
= ''
$outcome
private
array<string|int, mixed>
$outcome
= []
$params
private
SimpleDataStore
$params
$result
private
SimpleDataStore
$result
$sender
private
string
$sender
= ''
$severity
private
int
$severity
= self::SEVERITY_LOW
$wrapperToken
private
string
$wrapperToken
= ''
Methods
__construct()
FederatedEvent constructor.
public
__construct([string $class = '' ]) : mixed
Parameters
- $class : string = ''
Return values
mixed —addResultEntry()
public
addResultEntry(string $key, array<string|int, mixed> $result) : $this
Parameters
- $key : string
- $result : array<string|int, mixed>
Return values
$this —bypass()
public
bypass(int $flag) : FederatedEvent
Parameters
- $flag : int
Return values
FederatedEvent —canBypass()
public
canBypass(int $flag) : bool
Parameters
- $flag : int
Return values
bool —getCircle()
public
getCircle() : Circle
Return values
Circle —getClass()
public
getClass() : string
Return values
string —getData()
public
getData() : SimpleDataStore
Return values
SimpleDataStore —getInternal()
public
getInternal() : SimpleDataStore
Return values
SimpleDataStore —getItemId()
public
getItemId() : string
Return values
string —getItemSource()
public
getItemSource() : string
Return values
string —getMember()
public
getMember() : Member
Return values
Member —getMembers()
public
getMembers() : array<string|int, Member>
Return values
array<string|int, Member> —getOrigin()
Origin of the event.
public
getOrigin() : string
Return values
string —getOutcome()
public
getOutcome() : array<string|int, mixed>
Return values
array<string|int, mixed> —getParams()
public
getParams() : SimpleDataStore
Return values
SimpleDataStore —getResult()
public
getResult() : SimpleDataStore
Return values
SimpleDataStore —getSender()
public
getSender() : string
Return values
string —getSeverity()
public
getSeverity() : int
Return values
int —getWrapperToken()
public
getWrapperToken() : string
Return values
string —hasCircle()
public
hasCircle() : bool
Return values
bool —hasMember()
public
hasMember() : bool
Return values
bool —import()
public
import(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Tags
Return values
self —isAsync()
public
isAsync() : bool
Return values
bool —isDataRequestOnly()
public
isDataRequestOnly() : bool
Return values
bool —isLimitedToInstanceWithMember()
public
isLimitedToInstanceWithMember() : bool
Return values
bool —jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —resetData()
public
resetData() : $this
Return values
$this —resetInternal()
public
resetInternal() : $this
Return values
$this —resetResult()
public
resetResult() : $this
Return values
$this —setAsync()
public
setAsync(bool $async) : self
Parameters
- $async : bool
Return values
self —setCircle()
public
setCircle(Circle $circle) : self
Parameters
- $circle : Circle
Return values
self —setClass()
public
setClass(mixed $class) : self
Parameters
- $class : mixed
Return values
self —setData()
public
setData(SimpleDataStore $data) : self
Parameters
- $data : SimpleDataStore
Return values
self —setDataRequestOnly()
public
setDataRequestOnly(bool $dataRequestOnly) : self
Parameters
- $dataRequestOnly : bool
Return values
self —setInternal()
public
setInternal(SimpleDataStore $internal) : self
Parameters
- $internal : SimpleDataStore
Return values
self —setItemId()
public
setItemId(string $itemId) : self
Parameters
- $itemId : string
Return values
self —setItemSource()
public
setItemSource(string $itemSource) : self
Parameters
- $itemSource : string
Return values
self —setLimitedToInstanceWithMember()
public
setLimitedToInstanceWithMember(bool $limitedToInstanceWithMember) : self
Parameters
- $limitedToInstanceWithMember : bool
Return values
self —setMember()
public
setMember(Member|null $member) : self
Parameters
- $member : Member|null
Return values
self —setMembers()
public
setMembers(array<string|int, Member> $members) : self
Parameters
- $members : array<string|int, Member>
Return values
self —setOrigin()
public
setOrigin(string $origin) : self
Parameters
- $origin : string
Return values
self —setOutcome()
public
setOutcome(array<string|int, mixed> $data) : $this
Parameters
- $data : array<string|int, mixed>
Return values
$this —setParams()
public
setParams(SimpleDataStore $params) : self
Parameters
- $params : SimpleDataStore
Return values
self —setResult()
public
setResult(SimpleDataStore $result) : self
Parameters
- $result : SimpleDataStore
Return values
self —setResultEntry()
public
setResultEntry(string $key, array<string|int, mixed> $result) : $this
Parameters
- $key : string
- $result : array<string|int, mixed>
Return values
$this —setSender()
Origin of the request
public
setSender(string $sender) : self
Parameters
- $sender : string
Return values
self —setSeverity()
public
setSeverity(int $severity) : self
Parameters
- $severity : int
Return values
self —setWrapperToken()
public
setWrapperToken(string $wrapperToken) : FederatedEvent
Parameters
- $wrapperToken : string
Return values
FederatedEvent —typeOf()
public
typeOf(string $key, array<string|int, mixed> $arr[, bool $root = true ]) : string
Parameters
- $key : string
- $arr : array<string|int, mixed>
- $root : bool = true
Tags
Return values
string —validKey()
public
validKey(string $k, array<string|int, mixed> $arr) : bool
Parameters
- $k : string
- $arr : array<string|int, mixed>
Return values
bool —cleanArray()
protected
cleanArray(array<string|int, mixed> &$arr) : mixed
Parameters
- $arr : array<string|int, mixed>
Return values
mixed —extractArray()
protected
extractArray(string $k, string $value, array<string|int, mixed> $list) : mixed
Parameters
- $k : string
- $value : string
- $list : array<string|int, mixed>
Tags
Return values
mixed —get()
protected
get(string $k, array<string|int, mixed> $arr[, string $default = '' ]) : string
Parameters
- $k : string
- $arr : array<string|int, mixed>
- $default : string = ''
Return values
string —getArray()
protected
getArray(string $k, array<string|int, mixed> $arr[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
- $k : string
- $arr : array<string|int, mixed>
- $default : array<string|int, mixed> = []
Return values
array<string|int, mixed> —getBool()
protected
getBool(string $k, array<string|int, mixed> $arr[, bool $default = false ]) : bool
Parameters
- $k : string
- $arr : array<string|int, mixed>
- $default : bool = false
Return values
bool —getFloat()
protected
getFloat(string $k, array<string|int, mixed> $arr, float $default) : float
Parameters
- $k : string
- $arr : array<string|int, mixed>
- $default : float
Return values
float —getInt()
protected
getInt(string $k, array<string|int, mixed> $arr, int $default) : int
Parameters
- $k : string
- $arr : array<string|int, mixed>
- $default : int
Return values
int —getList()
protected
getList(string $k, array<string|int, mixed> $arr, array<string|int, mixed> $import[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
- $k : string
- $arr : array<string|int, mixed>
- $import : array<string|int, mixed>
- $default : array<string|int, mixed> = []
Return values
array<string|int, mixed> —getObj()
protected
getObj(string $k, array<string|int, mixed> $arr[, JsonSerializable|null $default = null ]) : mixed
Parameters
- $k : string
- $arr : array<string|int, mixed>
- $default : JsonSerializable|null = null
Return values
mixed —mustContains()
protected
mustContains(array<string|int, mixed> $keys, array<string|int, mixed> $arr) : mixed
Parameters
- $keys : array<string|int, mixed>
- $arr : array<string|int, mixed>