Membership
extends ManagedModel
in package
implements
IDeserializable, IQueryRow, JsonSerializable
Uses
TArrayTools
Class Membership
Interfaces, Classes, Traits and Enums
- IDeserializable
- IQueryRow
- Interface IQueryRow
- JsonSerializable
Table of Contents
- ID_LENGTH = 31
- $TYPE_ARRAY : mixed
- $TYPE_BOOLEAN : mixed
- $TYPE_INTEGER : mixed
- $TYPE_NULL : mixed
- $TYPE_SERIALIZABLE : mixed
- $TYPE_STRING : mixed
- $circleConfig : int
- $circleId : string
- $inheritanceDepth : int
- $inheritanceDetails : array<string|int, mixed>
- $inheritanceFirst : string
- $inheritanceLast : string
- $inheritancePath : array<string|int, mixed>
- $level : int
- $modelManager : ModelManager
- $singleId : string
- __construct() : mixed
- Membership constructor.
- getCircleConfig() : int
- getCircleId() : string
- getInheritanceDepth() : int
- getInheritanceDetails() : array<string|int, mixed>
- getInheritanceFirst() : string
- getInheritanceLast() : string
- getInheritancePath() : array<string|int, mixed>
- getLevel() : int
- getSingleId() : string
- import() : IDeserializable
- importFromDatabase() : IQueryRow
- import data to feed the model.
- importFromIFederatedUser() : void
- jsonSerialize() : array<string|int, mixed>
- setCircleConfig() : Membership
- setCircleId() : Membership
- setInheritanceDepth() : Membership
- setInheritanceDetails() : Membership
- setInheritanceFirst() : Membership
- setInheritanceLast() : Membership
- setInheritancePath() : Membership
- setLevel() : Membership
- setSingleId() : self
- 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'
$circleConfig
private
int
$circleConfig
= 0
$circleId
private
string
$circleId
= ''
$inheritanceDepth
private
int
$inheritanceDepth
= 0
$inheritanceDetails
private
array<string|int, mixed>
$inheritanceDetails
= []
$inheritanceFirst
private
string
$inheritanceFirst
= ''
$inheritanceLast
private
string
$inheritanceLast
= ''
$inheritancePath
private
array<string|int, mixed>
$inheritancePath
= []
$level
private
int
$level
= 0
$modelManager
private
ModelManager
$modelManager
$singleId
private
string
$singleId
= ''
Methods
__construct()
Membership constructor.
public
__construct([string $singleId = '' ][, string $inheritanceLast = '' ][, Member|null $member = null ]) : mixed
Parameters
- $singleId : string = ''
- $inheritanceLast : string = ''
- $member : Member|null = null
Return values
mixed —getCircleConfig()
public
getCircleConfig() : int
Return values
int —getCircleId()
public
getCircleId() : string
Return values
string —getInheritanceDepth()
public
getInheritanceDepth() : int
Return values
int —getInheritanceDetails()
public
getInheritanceDetails() : array<string|int, mixed>
Return values
array<string|int, mixed> —getInheritanceFirst()
public
getInheritanceFirst() : string
Return values
string —getInheritanceLast()
public
getInheritanceLast() : string
Return values
string —getInheritancePath()
public
getInheritancePath() : array<string|int, mixed>
Return values
array<string|int, mixed> —getLevel()
public
getLevel() : int
Return values
int —getSingleId()
public
getSingleId() : string
Return values
string —import()
public
import(array<string|int, mixed> $data) : IDeserializable
Parameters
- $data : array<string|int, mixed>
Tags
Return values
IDeserializable —importFromDatabase()
import data to feed the model.
public
importFromDatabase(array<string|int, mixed> $data[, string $prefix = '' ]) : IQueryRow
Parameters
- $data : array<string|int, mixed>
- $prefix : string = ''
Tags
Return values
IQueryRow —importFromIFederatedUser()
public
importFromIFederatedUser(IFederatedUser $orig) : void
Parameters
- $orig : IFederatedUser
Tags
Return values
void —jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —setCircleConfig()
public
setCircleConfig(int $circleConfig) : Membership
Parameters
- $circleConfig : int
Return values
Membership —setCircleId()
public
setCircleId(string $circleId) : Membership
Parameters
- $circleId : string
Return values
Membership —setInheritanceDepth()
public
setInheritanceDepth(int $inheritanceDepth) : Membership
Parameters
- $inheritanceDepth : int
Return values
Membership —setInheritanceDetails()
public
setInheritanceDetails(array<string|int, mixed> $inheritanceDetails) : Membership
Parameters
- $inheritanceDetails : array<string|int, mixed>
Return values
Membership —setInheritanceFirst()
public
setInheritanceFirst(string $inheritanceFirst) : Membership
Parameters
- $inheritanceFirst : string
Return values
Membership —setInheritanceLast()
public
setInheritanceLast(string $inheritanceLast) : Membership
Parameters
- $inheritanceLast : string
Return values
Membership —setInheritancePath()
public
setInheritancePath(array<string|int, mixed> $inheritancePath) : Membership
Parameters
- $inheritancePath : array<string|int, mixed>
Return values
Membership —setLevel()
public
setLevel(int $level) : Membership
Parameters
- $level : int
Return values
Membership —setSingleId()
public
setSingleId(string $singleId) : self
Parameters
- $singleId : string
Return values
self —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>