CircleProbe
extends MemberProbe
in package
Class CircleProbe
Table of Contents
- DETAILS_ALL = 127
- DETAILS_NONE = 0
- DETAILS_POPULATION = 32
- $details : int
- $emulateVisitor : bool
- $filter : int
- $filterCircle : Circle
- $filterMember : Member
- $filterRemoteInstance : RemoteInstance
- $include : int
- $includeNonVisible : bool
- $initiatorDirectMember : bool
- $itemsLimit : int
- $itemsOffset : int
- $limitConfig : int
- $minimumLevel : int
- $options : array<string|int, mixed>
- $requestingMembership : bool
- $visitSingleCircles : bool
- __construct() : mixed
- CircleProbe constructor.
- addDetail() : $this
- addOption() : $this
- addOptionBool() : $this
- addOptionInt() : $this
- canBeRequestingMembership() : $this
- allow the initiator as a requesting member
- directMemberInitiator() : bool
- emulateVisitor() : $this
- force the generation an initiator if visitor
- filterBackendCircles() : $this
- Configure whether backend circles are filtered in the probe
- filterConfig() : $this
- Add a config to the probe filter
- filtered() : int
- Return the filtered value
- filterHiddenCircles() : $this
- Configure whether hidden circles are filtered in the probe
- filterPersonalCircles() : $this
- Configure whether personal circles are filtered in the probe
- filterSingleCircles() : $this
- Configure whether single circles are filtered in the probe
- filterSystemCircles() : $this
- Configure whether system circles are filtered in the probe
- getAsOptions() : array<string|int, mixed>
- Return an array with includes as options
- getChecksum() : string
- getDetails() : int
- getFilterCircle() : Circle
- getFilterMember() : Member
- getFilterRemoteInstance() : RemoteInstance
- getItemsLimit() : int
- getItemsOffset() : int
- getLimitConfig() : int
- getMinimumLevel() : int
- hasFilterCircle() : bool
- hasFilterMember() : bool
- hasFilterRemoteInstance() : bool
- hasLimitConfig() : bool
- includeBackendCircles() : $this
- Configure whether backend circles are included in the probe
- included() : int
- Return the include value
- includeHiddenCircles() : $this
- Configure whether hidden circles are included in the probe
- includeNonVisibleCircles() : $this
- Configure whether non-visible circles are included in the probe
- includePersonalCircles() : $this
- Configure whether personal circles are included in the probe
- includeSingleCircles() : $this
- Configure whether single circles are included in the probe
- includeSystemCircles() : $this
- Configure whether system circles are included in the probe
- initiatorAsDirectMember() : $this
- isEmulatingVisitor() : bool
- isFiltered() : bool
- Return whether a config is filtered in the probe (bitwise comparison)
- isIncluded() : bool
- Return whether a config is included in the probe (bitwise comparison)
- isRequestingMembership() : bool
- JsonSerialize() : array<string|int, mixed>
- Return a JSON object with includes as options
- limitConfig() : $this
- limit to a specific config
- mustBeAdmin() : $this
- mustBeMember() : $this
- mustBeModerator() : $this
- mustBeOwner() : $this
- nonVisibleCirclesIncluded() : bool
- Return whether non-visible circles are included in the probe
- setDetails() : $this
- setFilterCircle() : CircleProbe
- setFilterMember() : CircleProbe
- setFilterRemoteInstance() : CircleProbe
- setItemsLimit() : BasicProbe
- setItemsOffset() : BasicProbe
- showDetail() : bool
- visitingSingleCircles() : bool
- Return whether single circles are visited in the probe
- visitSingleCircles() : $this
- Configure whether single circles are visited in the probe
Constants
DETAILS_ALL
public
mixed
DETAILS_ALL
= 127
DETAILS_NONE
public
mixed
DETAILS_NONE
= 0
DETAILS_POPULATION
public
mixed
DETAILS_POPULATION
= 32
Properties
$details
private
int
$details
= 0
$emulateVisitor
private
bool
$emulateVisitor
= false
$filter
private
int
$filter
= \OCA\Circles\Model\Circle::CFG_SINGLE
$filterCircle
private
Circle
$filterCircle
$filterMember
private
Member
$filterMember
$filterRemoteInstance
private
RemoteInstance
$filterRemoteInstance
$include
private
int
$include
= 0
$includeNonVisible
private
bool
$includeNonVisible
= false
$initiatorDirectMember
private
bool
$initiatorDirectMember
= false
$itemsLimit
private
int
$itemsLimit
= -1
$itemsOffset
private
int
$itemsOffset
= 0
$limitConfig
private
int
$limitConfig
= 0
$minimumLevel
private
int
$minimumLevel
= \OCA\Circles\Model\Member::LEVEL_NONE
$options
private
array<string|int, mixed>
$options
= []
$requestingMembership
private
bool
$requestingMembership
= false
$visitSingleCircles
private
bool
$visitSingleCircles
= false
Methods
__construct()
CircleProbe constructor.
public
__construct() : mixed
Return values
mixed —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 —canBeRequestingMembership()
allow the initiator as a requesting member
public
canBeRequestingMembership([bool $can = true ]) : $this
Parameters
- $can : bool = true
Return values
$this —directMemberInitiator()
public
directMemberInitiator() : bool
Return values
bool —emulateVisitor()
force the generation an initiator if visitor
public
emulateVisitor() : $this
Return values
$this —filterBackendCircles()
Configure whether backend circles are filtered in the probe
public
filterBackendCircles([bool $filter = true ]) : $this
Parameters
- $filter : bool = true
Return values
$this —filterConfig()
Add a config to the probe filter
public
filterConfig(int $config[, bool $filter = true ]) : $this
Parameters
- $config : int
- $filter : bool = true
Return values
$this —filtered()
Return the filtered value
public
filtered() : int
Return values
int —filterHiddenCircles()
Configure whether hidden circles are filtered in the probe
public
filterHiddenCircles([bool $filter = true ]) : $this
Parameters
- $filter : bool = true
Return values
$this —filterPersonalCircles()
Configure whether personal circles are filtered in the probe
public
filterPersonalCircles([bool $filter = true ]) : $this
Parameters
- $filter : bool = true
Return values
$this —filterSingleCircles()
Configure whether single circles are filtered in the probe
public
filterSingleCircles([bool $filter = true ]) : $this
Parameters
- $filter : bool = true
Return values
$this —filterSystemCircles()
Configure whether system circles are filtered in the probe
public
filterSystemCircles([bool $filter = true ]) : $this
Parameters
- $filter : bool = true
Return values
$this —getAsOptions()
Return an array with includes as options
public
getAsOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getChecksum()
public
getChecksum() : string
Return values
string —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 —getLimitConfig()
public
getLimitConfig() : int
Return values
int —getMinimumLevel()
public
getMinimumLevel() : int
Return values
int —hasFilterCircle()
public
hasFilterCircle() : bool
Return values
bool —hasFilterMember()
public
hasFilterMember() : bool
Return values
bool —hasFilterRemoteInstance()
public
hasFilterRemoteInstance() : bool
Return values
bool —hasLimitConfig()
public
hasLimitConfig() : bool
Return values
bool —includeBackendCircles()
Configure whether backend circles are included in the probe
public
includeBackendCircles([bool $include = true ]) : $this
Parameters
- $include : bool = true
Return values
$this —included()
Return the include value
public
included() : int
Return values
int —includeHiddenCircles()
Configure whether hidden circles are included in the probe
public
includeHiddenCircles([bool $include = true ]) : $this
Parameters
- $include : bool = true
Return values
$this —includeNonVisibleCircles()
Configure whether non-visible circles are included in the probe
public
includeNonVisibleCircles([bool $include = true ]) : $this
Parameters
- $include : bool = true
Return values
$this —includePersonalCircles()
Configure whether personal circles are included in the probe
public
includePersonalCircles([bool $include = true ]) : $this
Parameters
- $include : bool = true
Return values
$this —includeSingleCircles()
Configure whether single circles are included in the probe
public
includeSingleCircles([bool $include = true ]) : $this
Parameters
- $include : bool = true
Return values
$this —includeSystemCircles()
Configure whether system circles are included in the probe
public
includeSystemCircles([bool $include = true ]) : $this
Parameters
- $include : bool = true
Return values
$this —initiatorAsDirectMember()
public
initiatorAsDirectMember([bool $include = true ]) : $this
Parameters
- $include : bool = true
Return values
$this —isEmulatingVisitor()
public
isEmulatingVisitor() : bool
Return values
bool —isFiltered()
Return whether a config is filtered in the probe (bitwise comparison)
public
isFiltered(int $config) : bool
Parameters
- $config : int
Return values
bool —isIncluded()
Return whether a config is included in the probe (bitwise comparison)
public
isIncluded(int $config) : bool
Parameters
- $config : int
Return values
bool —isRequestingMembership()
public
isRequestingMembership() : 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> —limitConfig()
limit to a specific config
public
limitConfig(int $config) : $this
Parameters
- $config : int
Return values
$this —mustBeAdmin()
public
mustBeAdmin() : $this
Return values
$this —mustBeMember()
public
mustBeMember([bool $must = true ]) : $this
Parameters
- $must : bool = true
Return values
$this —mustBeModerator()
public
mustBeModerator() : $this
Return values
$this —mustBeOwner()
public
mustBeOwner() : $this
Return values
$this —nonVisibleCirclesIncluded()
Return whether non-visible circles are included in the probe
public
nonVisibleCirclesIncluded() : bool
Return values
bool —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
Return values
bool —visitingSingleCircles()
Return whether single circles are visited in the probe
public
visitingSingleCircles() : bool
Return values
bool —visitSingleCircles()
Configure whether single circles are visited in the probe
public
visitSingleCircles([bool $visit = true ]) : $this
Parameters
- $visit : bool = true