FederatedShare
extends ManagedModel
in package
implements
IFederatedModel, JsonSerializable, IQueryRow, IDeserializable
Uses
TArrayTools
Class FederatedShare
Interfaces, Classes, Traits and Enums
- IFederatedModel
- Interface IFederatedModel
- JsonSerializable
- IQueryRow
- Interface IQueryRow
- IDeserializable
Table of Contents
- ID_LENGTH = 31
- $TYPE_ARRAY : mixed
- $TYPE_BOOLEAN : mixed
- $TYPE_INTEGER : mixed
- $TYPE_NULL : mixed
- $TYPE_SERIALIZABLE : mixed
- $TYPE_STRING : mixed
- $circleId : string
- $data : SimpleDataStore
- $id : int
- $instance : string
- $itemId : string
- $lockStatus : string
- $modelManager : ModelManager
- __construct() : mixed
- FederatedShare constructor.
- getCircleId() : string
- getId() : int
- getInstance() : string
- getItemId() : string
- getLockStatus() : string
- import() : IDeserializable
- importFromDatabase() : IQueryRow
- import data to feed the model.
- importFromIFederatedUser() : void
- isLocal() : bool
- jsonSerialize() : array<string|int, mixed>
- setCircleId() : FederatedShare
- setId() : FederatedShare
- setInstance() : FederatedShare
- setItemId() : FederatedShare
- setLockStatus() : FederatedShare
- 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>
- getManager() : ModelManager
- getObj() : mixed
- mustContains() : mixed
Constants
ID_LENGTH
public
mixed
ID_LENGTH
= 31
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'
$circleId
private
string
$circleId
= ''
$data
private
SimpleDataStore
$data
$id
private
int
$id
= 0
$instance
private
string
$instance
= ''
$itemId
private
string
$itemId
= ''
$lockStatus
private
string
$lockStatus
= ''
$modelManager
private
ModelManager
$modelManager
Methods
__construct()
FederatedShare constructor.
public
__construct() : mixed
Return values
mixed —getCircleId()
public
getCircleId() : string
Return values
string —getId()
public
getId() : int
Return values
int —getInstance()
public
getInstance() : string
Return values
string —getItemId()
public
getItemId() : string
Return values
string —getLockStatus()
public
getLockStatus() : string
Return values
string —import()
public
import(array<string|int, mixed> $data) : IDeserializable
Parameters
- $data : array<string|int, mixed>
Return values
IDeserializable —importFromDatabase()
import data to feed the model.
public
importFromDatabase(array<string|int, mixed> $data) : IQueryRow
Parameters
- $data : array<string|int, mixed>
Return values
IQueryRow —importFromIFederatedUser()
public
importFromIFederatedUser(IFederatedUser $orig) : void
Parameters
- $orig : IFederatedUser
Tags
Return values
void —isLocal()
public
isLocal() : bool
Return values
bool —jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —setCircleId()
public
setCircleId(string $circleId) : FederatedShare
Parameters
- $circleId : string
Return values
FederatedShare —setId()
public
setId(int $id) : FederatedShare
Parameters
- $id : int
Return values
FederatedShare —setInstance()
public
setInstance(string $instance) : FederatedShare
Parameters
- $instance : string
Return values
FederatedShare —setItemId()
public
setItemId(string $itemId) : FederatedShare
Parameters
- $itemId : string
Return values
FederatedShare —setLockStatus()
public
setLockStatus(string $lockStatus) : FederatedShare
Parameters
- $lockStatus : string
Return values
FederatedShare —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> —getManager()
protected
getManager() : ModelManager
Return values
ModelManager —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>