MemberProbe
extends BasicProbe
in package
Class MemberProbe
Table of Contents
- DETAILS_ALL = 127
- DETAILS_NONE = 0
- DETAILS_POPULATION = 32
- $details : int
- $emulateVisitor : bool
- $filterCircle : Circle
- $filterMember : Member
- $filterRemoteInstance : RemoteInstance
- $initiatorDirectMember : bool
- $itemsLimit : int
- $itemsOffset : int
- $minimumLevel : int
- $options : array<string|int, mixed>
- $requestingMembership : bool
- 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
- getAsOptions() : array<string|int, mixed>
- getDetails() : int
- getFilterCircle() : Circle
- getFilterMember() : Member
- getFilterRemoteInstance() : RemoteInstance
- getItemsLimit() : int
- getItemsOffset() : int
- getMinimumLevel() : int
- hasFilterCircle() : bool
- hasFilterMember() : bool
- hasFilterRemoteInstance() : bool
- initiatorAsDirectMember() : $this
- isEmulatingVisitor() : bool
- isRequestingMembership() : bool
- JsonSerialize() : array<string|int, mixed>
- mustBeAdmin() : $this
- mustBeMember() : $this
- mustBeModerator() : $this
- mustBeOwner() : $this
- setDetails() : $this
- setFilterCircle() : CircleProbe
- setFilterMember() : CircleProbe
- setFilterRemoteInstance() : CircleProbe
- setItemsLimit() : BasicProbe
- setItemsOffset() : BasicProbe
- showDetail() : bool
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
$filterCircle
private
Circle
$filterCircle
$filterMember
private
Member
$filterMember
$filterRemoteInstance
private
RemoteInstance
$filterRemoteInstance
$initiatorDirectMember
private
bool
$initiatorDirectMember
= false
$itemsLimit
private
int
$itemsLimit
= -1
$itemsOffset
private
int
$itemsOffset
= 0
$minimumLevel
private
int
$minimumLevel
= \OCA\Circles\Model\Member::LEVEL_NONE
$options
private
array<string|int, mixed>
$options
= []
$requestingMembership
private
bool
$requestingMembership
= false
Methods
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 —getAsOptions()
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 —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 —initiatorAsDirectMember()
public
initiatorAsDirectMember([bool $include = true ]) : $this
Parameters
- $include : bool = true
Return values
$this —isEmulatingVisitor()
public
isEmulatingVisitor() : bool
Return values
bool —isRequestingMembership()
public
isRequestingMembership() : bool
Return values
bool —JsonSerialize()
public
JsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —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 —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