GSEvent
in package
implements
JsonSerializable
Uses
TArrayTools
Class GSEvent
Interfaces, Classes, Traits and Enums
- JsonSerializable
Table of Contents
- CIRCLE_CREATE = '\\OCA\\Circles\\GlobalScale\\CircleCreate'
- CIRCLE_STATUS = '\\OCA\\Circles\\GlobalScale\\CircleStatus'
- FILE_SHARE = '\\OCA\\Circles\\GlobalScale\\FileShare'
- FILE_UNSHARE = '\\OCA\\Circles\\GlobalScale\\FileUnshare'
- MEMBER_ADD = '\\OCA\\Circles\\GlobalScale\\MemberAdd'
- MEMBER_JOIN = '\\OCA\\Circles\\GlobalScale\\MemberJoin'
- MEMBER_LEAVE = '\\OCA\\Circles\\GlobalScale\\MemberLeave'
- MEMBER_LEVEL = '\\OCA\\Circles\\GlobalScale\\MemberLevel'
- MEMBER_REMOVE = '\\OCA\\Circles\\GlobalScale\\MemberRemove'
- MEMBER_UPDATE = '\\OCA\\Circles\\GlobalScale\\MemberUpdate'
- SEVERITY_HIGH = 3
- SEVERITY_LOW = 1
- TEST = '\\OCA\\Circles\\GlobalScale\\Test'
- USER_DELETED = '\\OCA\\Circles\\GlobalScale\\UserDeleted'
- $TYPE_ARRAY : mixed
- $TYPE_BOOLEAN : mixed
- $TYPE_INTEGER : mixed
- $TYPE_NULL : mixed
- $TYPE_SERIALIZABLE : mixed
- $TYPE_STRING : mixed
- $async : bool
- $checked : bool
- $circle : Circle
- $data : SimpleDataStore
- $deprecatedCircle : DeprecatedCircle
- $force : bool
- $key : string
- $local : bool
- $member : DeprecatedMember
- $result : SimpleDataStore
- $severity : int
- $source : string
- $type : string
- __construct() : mixed
- GSEvent constructor.
- getCircle() : Circle
- getData() : SimpleDataStore
- getDeprecatedCircle() : DeprecatedCircle
- getKey() : string
- getMember() : DeprecatedMember
- getResult() : SimpleDataStore
- getSeverity() : int
- getSource() : string
- getType() : string
- hasCircle() : bool
- hasMember() : bool
- import() : GSEvent
- importFromJson() : GSEvent
- isAsync() : bool
- isForced() : bool
- isLocal() : bool
- isValid() : bool
- jsonSerialize() : array<string|int, mixed>
- setAsync() : GSEvent
- setCircle() : GSEvent
- setData() : GSEvent
- setDeprecatedCircle() : GSEvent
- setForced() : GSEvent
- setKey() : GSEvent
- setLocal() : GSEvent
- setMember() : GSEvent
- setResult() : GSEvent
- setSeverity() : GSEvent
- setSource() : GSEvent
- setType() : GSEvent
- 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
CIRCLE_CREATE
public
mixed
CIRCLE_CREATE
= '\\OCA\\Circles\\GlobalScale\\CircleCreate'
CIRCLE_STATUS
public
mixed
CIRCLE_STATUS
= '\\OCA\\Circles\\GlobalScale\\CircleStatus'
FILE_SHARE
public
mixed
FILE_SHARE
= '\\OCA\\Circles\\GlobalScale\\FileShare'
FILE_UNSHARE
public
mixed
FILE_UNSHARE
= '\\OCA\\Circles\\GlobalScale\\FileUnshare'
MEMBER_ADD
public
mixed
MEMBER_ADD
= '\\OCA\\Circles\\GlobalScale\\MemberAdd'
MEMBER_JOIN
public
mixed
MEMBER_JOIN
= '\\OCA\\Circles\\GlobalScale\\MemberJoin'
MEMBER_LEAVE
public
mixed
MEMBER_LEAVE
= '\\OCA\\Circles\\GlobalScale\\MemberLeave'
MEMBER_LEVEL
public
mixed
MEMBER_LEVEL
= '\\OCA\\Circles\\GlobalScale\\MemberLevel'
MEMBER_REMOVE
public
mixed
MEMBER_REMOVE
= '\\OCA\\Circles\\GlobalScale\\MemberRemove'
MEMBER_UPDATE
public
mixed
MEMBER_UPDATE
= '\\OCA\\Circles\\GlobalScale\\MemberUpdate'
SEVERITY_HIGH
public
mixed
SEVERITY_HIGH
= 3
SEVERITY_LOW
public
mixed
SEVERITY_LOW
= 1
TEST
public
mixed
TEST
= '\\OCA\\Circles\\GlobalScale\\Test'
USER_DELETED
public
mixed
USER_DELETED
= '\\OCA\\Circles\\GlobalScale\\UserDeleted'
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
$checked
private
bool
$checked
= false
$circle
private
Circle
$circle
$data
private
SimpleDataStore
$data
$deprecatedCircle
private
DeprecatedCircle
$deprecatedCircle
$force
private
bool
$force
= false
$key
private
string
$key
= ''
$local
private
bool
$local
= false
$member
private
DeprecatedMember
$member
$result
private
SimpleDataStore
$result
$severity
private
int
$severity
= self::SEVERITY_LOW
$source
private
string
$source
= ''
$type
private
string
$type
= ''
Methods
__construct()
GSEvent constructor.
public
__construct([string $type = '' ][, bool $local = false ][, bool $force = false ]) : mixed
Parameters
- $type : string = ''
- $local : bool = false
- $force : bool = false
Return values
mixed —getCircle()
public
getCircle() : Circle
Return values
Circle —getData()
public
getData() : SimpleDataStore
Return values
SimpleDataStore —getDeprecatedCircle()
public
getDeprecatedCircle() : DeprecatedCircle
Tags
Return values
DeprecatedCircle —getKey()
public
getKey() : string
Return values
string —getMember()
public
getMember() : DeprecatedMember
Return values
DeprecatedMember —getResult()
public
getResult() : SimpleDataStore
Return values
SimpleDataStore —getSeverity()
public
getSeverity() : int
Return values
int —getSource()
public
getSource() : string
Return values
string —getType()
public
getType() : 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) : GSEvent
Parameters
- $data : array<string|int, mixed>
Tags
Return values
GSEvent —importFromJson()
public
importFromJson(string $json) : GSEvent
Parameters
- $json : string
Tags
Return values
GSEvent —isAsync()
public
isAsync() : bool
Return values
bool —isForced()
public
isForced() : bool
Return values
bool —isLocal()
public
isLocal() : bool
Return values
bool —isValid()
public
isValid() : bool
Return values
bool —jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —setAsync()
public
setAsync(bool $async) : GSEvent
Parameters
- $async : bool
Return values
GSEvent —setCircle()
public
setCircle(Circle $circle) : GSEvent
Parameters
- $circle : Circle
Return values
GSEvent —setData()
public
setData(SimpleDataStore $data) : GSEvent
Parameters
- $data : SimpleDataStore
Return values
GSEvent —setDeprecatedCircle()
public
setDeprecatedCircle(DeprecatedCircle $deprecatedCircle) : GSEvent
Parameters
- $deprecatedCircle : DeprecatedCircle
Tags
Return values
GSEvent —setForced()
public
setForced(bool $force) : GSEvent
Parameters
- $force : bool
Return values
GSEvent —setKey()
public
setKey(string $key) : GSEvent
Parameters
- $key : string
Return values
GSEvent —setLocal()
public
setLocal(bool $local) : GSEvent
Parameters
- $local : bool
Return values
GSEvent —setMember()
public
setMember(DeprecatedMember $member) : GSEvent
Parameters
- $member : DeprecatedMember
Return values
GSEvent —setResult()
public
setResult(SimpleDataStore $result) : GSEvent
Parameters
- $result : SimpleDataStore
Return values
GSEvent —setSeverity()
public
setSeverity(int $severity) : GSEvent
Parameters
- $severity : int
Return values
GSEvent —setSource()
public
setSource(string $source) : GSEvent
Parameters
- $source : string
Return values
GSEvent —setType()
public
setType(mixed $type) : GSEvent
Parameters
- $type : mixed
Return values
GSEvent —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>