DataProbe
extends BasicProbe
in package
Class CircleProbe
Table of Contents
- BASED_ON = \OCA\Circles\Db\CoreQueryBuilder::BASED_ON
- CONFIG = \OCA\Circles\Db\CoreQueryBuilder::CONFIG
- DETAILS_ALL = 127
- DETAILS_NONE = 0
- DETAILS_POPULATION = 32
- INHERITED_BY = \OCA\Circles\Db\CoreQueryBuilder::INHERITED_BY
- INITIATOR = \OCA\Circles\Db\CoreQueryBuilder::INITIATOR
- MEMBER = \OCA\Circles\Db\CoreQueryBuilder::MEMBER
- MEMBERSHIPS = \OCA\Circles\Db\CoreQueryBuilder::MEMBERSHIPS
- OWNER = \OCA\Circles\Db\CoreQueryBuilder::OWNER
- $details : int
- $filterCircle : Circle
- $filterMember : Member
- $filterRemoteInstance : RemoteInstance
- $itemsLimit : int
- $itemsOffset : int
- $options : array<string|int, mixed>
- $path : array<string|int, mixed>
- __construct() : mixed
- add() : $this
- addDetail() : $this
- addOption() : $this
- addOptionBool() : $this
- addOptionInt() : $this
- getAsOptions() : array<string|int, mixed>
- Return an array with includes as options
- getDetails() : int
- getFilterCircle() : Circle
- getFilterMember() : Member
- getFilterRemoteInstance() : RemoteInstance
- getItemsLimit() : int
- getItemsOffset() : int
- getPath() : array<string|int, mixed>
- has() : bool
- hasFilterCircle() : bool
- hasFilterMember() : bool
- hasFilterRemoteInstance() : bool
- JsonSerialize() : array<string|int, mixed>
- Return a JSON object with includes as options
- setDetails() : $this
- setFilterCircle() : CircleProbe
- setFilterMember() : CircleProbe
- setFilterRemoteInstance() : CircleProbe
- setItemsLimit() : BasicProbe
- setItemsOffset() : BasicProbe
- showDetail() : bool
Constants
BASED_ON
public
mixed
BASED_ON
= \OCA\Circles\Db\CoreQueryBuilder::BASED_ON
CONFIG
public
mixed
CONFIG
= \OCA\Circles\Db\CoreQueryBuilder::CONFIG
DETAILS_ALL
public
mixed
DETAILS_ALL
= 127
DETAILS_NONE
public
mixed
DETAILS_NONE
= 0
DETAILS_POPULATION
public
mixed
DETAILS_POPULATION
= 32
INHERITED_BY
public
mixed
INHERITED_BY
= \OCA\Circles\Db\CoreQueryBuilder::INHERITED_BY
INITIATOR
public
mixed
INITIATOR
= \OCA\Circles\Db\CoreQueryBuilder::INITIATOR
MEMBER
public
mixed
MEMBER
= \OCA\Circles\Db\CoreQueryBuilder::MEMBER
MEMBERSHIPS
public
mixed
MEMBERSHIPS
= \OCA\Circles\Db\CoreQueryBuilder::MEMBERSHIPS
OWNER
public
mixed
OWNER
= \OCA\Circles\Db\CoreQueryBuilder::OWNER
Properties
$details
private
int
$details
= 0
$filterCircle
private
Circle
$filterCircle
$filterMember
private
Member
$filterMember
$filterRemoteInstance
private
RemoteInstance
$filterRemoteInstance
$itemsLimit
private
int
$itemsLimit
= -1
$itemsOffset
private
int
$itemsOffset
= 0
$options
private
array<string|int, mixed>
$options
= []
$path
private
array<string|int, mixed>
$path
= []
Methods
__construct()
public
__construct() : mixed
Return values
mixed —add()
public
add(string $key[, array<string|int, mixed> $path = [] ]) : $this
Parameters
- $key : string
- $path : array<string|int, mixed> = []
Return values
$this —addDetail()
public
addDetail(int $detail) : $this
Parameters
- $detail : int
Return values
$this —addOption()
public
addOption(string $key, string $value) : $this
Parameters
- $key : string
- $value : string
Return values
$this —addOptionBool()
public
addOptionBool(string $key, bool $value) : $this
Parameters
- $key : string
- $value : bool
Return values
$this —addOptionInt()
public
addOptionInt(string $key, int $value) : $this
Parameters
- $key : string
- $value : int
Return values
$this —getAsOptions()
Return an array with includes as options
public
getAsOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDetails()
public
getDetails() : int
Return values
int —getFilterCircle()
public
getFilterCircle() : Circle
Return values
Circle —getFilterMember()
public
getFilterMember() : Member
Return values
Member —getFilterRemoteInstance()
public
getFilterRemoteInstance() : RemoteInstance
Return values
RemoteInstance —getItemsLimit()
public
getItemsLimit() : int
Return values
int —getItemsOffset()
public
getItemsOffset() : int
Return values
int —getPath()
public
getPath() : array<string|int, mixed>
Return values
array<string|int, mixed> —has()
public
has(string $key) : bool
Parameters
- $key : string
Return values
bool —hasFilterCircle()
public
hasFilterCircle() : bool
Return values
bool —hasFilterMember()
public
hasFilterMember() : bool
Return values
bool —hasFilterRemoteInstance()
public
hasFilterRemoteInstance() : bool
Return values
bool —JsonSerialize()
Return a JSON object with includes as options
public
JsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —setDetails()
public
setDetails(int $details) : $this
Parameters
- $details : int
Return values
$this —setFilterCircle()
public
setFilterCircle(Circle $filterCircle) : CircleProbe
Parameters
- $filterCircle : Circle
Return values
CircleProbe —setFilterMember()
public
setFilterMember(Member $filterMember) : CircleProbe
Parameters
- $filterMember : Member
Return values
CircleProbe —setFilterRemoteInstance()
public
setFilterRemoteInstance(RemoteInstance $filterRemoteInstance) : CircleProbe
Parameters
- $filterRemoteInstance : RemoteInstance
Return values
CircleProbe —setItemsLimit()
public
setItemsLimit(int $itemsLimit) : BasicProbe
Parameters
- $itemsLimit : int
Return values
BasicProbe —setItemsOffset()
public
setItemsOffset(int $itemsOffset) : BasicProbe
Parameters
- $itemsOffset : int
Return values
BasicProbe —showDetail()
public
showDetail(int $detail) : bool
Parameters
- $detail : int