GSWrapper
in package
implements
JsonSerializable
Uses
TArrayTools
Class GSEvent
Interfaces, Classes, Traits and Enums
- JsonSerializable
Table of Contents
- STATUS_DONE = 8
- STATUS_FAILED = 1
- STATUS_INIT = 0
- STATUS_OVER = 9
- $TYPE_ARRAY : mixed
- $TYPE_BOOLEAN : mixed
- $TYPE_INTEGER : mixed
- $TYPE_NULL : mixed
- $TYPE_SERIALIZABLE : mixed
- $TYPE_STRING : mixed
- $creation : int
- $event : GSEvent
- $instance : string
- $severity : int
- $status : int
- $token : string
- __construct() : mixed
- getCreation() : int
- getEvent() : GSEvent
- getInstance() : string
- getSeverity() : int
- getStatus() : int
- getToken() : string
- hasEvent() : bool
- import() : GSWrapper
- jsonSerialize() : array<string|int, mixed>
- setCreation() : GSWrapper
- setEvent() : GSWrapper
- setInstance() : GSWrapper
- setSeverity() : GSWrapper
- setStatus() : GSWrapper
- setToken() : GSWrapper
- 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
STATUS_DONE
public
mixed
STATUS_DONE
= 8
STATUS_FAILED
public
mixed
STATUS_FAILED
= 1
STATUS_INIT
public
mixed
STATUS_INIT
= 0
STATUS_OVER
public
mixed
STATUS_OVER
= 9
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'
$creation
private
int
$creation
$event
private
GSEvent
$event
$instance
private
string
$instance
= ''
$severity
private
int
$severity
= \OCA\Circles\Model\GlobalScale\GSEvent::SEVERITY_LOW
$status
private
int
$status
= 0
$token
private
string
$token
= ''
Methods
__construct()
public
__construct() : mixed
Return values
mixed —getCreation()
public
getCreation() : int
Return values
int —getEvent()
public
getEvent() : GSEvent
Return values
GSEvent —getInstance()
public
getInstance() : string
Return values
string —getSeverity()
public
getSeverity() : int
Return values
int —getStatus()
public
getStatus() : int
Return values
int —getToken()
public
getToken() : string
Return values
string —hasEvent()
public
hasEvent() : bool
Return values
bool —import()
public
import(array<string|int, mixed> $data) : GSWrapper
Parameters
- $data : array<string|int, mixed>
Tags
Return values
GSWrapper —jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —setCreation()
public
setCreation(int $creation) : GSWrapper
Parameters
- $creation : int
Return values
GSWrapper —setEvent()
public
setEvent(GSEvent $event) : GSWrapper
Parameters
- $event : GSEvent
Return values
GSWrapper —setInstance()
public
setInstance(string $instance) : GSWrapper
Parameters
- $instance : string
Return values
GSWrapper —setSeverity()
public
setSeverity(int $severity) : GSWrapper
Parameters
- $severity : int
Return values
GSWrapper —setStatus()
public
setStatus(int $status) : GSWrapper
Parameters
- $status : int
Return values
GSWrapper —setToken()
public
setToken(string $token) : GSWrapper
Parameters
- $token : string
Return values
GSWrapper —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>