RecentCollab extends Recent
Table of Contents
Methods
- filter() : $this
- getAny() : T|null
- getCollabs() : self
- getContext() : Context
- Returns the local or global context for the action.
- getPopupData() : PopupData
- Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.
- getRestEntityName() : string
- Returns the name of the entity that will be used in the rest response
- merge() : static
- setContext() : self
- Sets new context for operations.
- setContextUser() : self
- toRestFormat() : array<string|int, mixed>|null
- Returns an array in JSON like format to return the entity as a rest response.
- unsetByKeys() : void
- withContext() : static
- Provides local context for the action.
- withContextUser() : static
- Provides local context for the action.
Methods
filter()
public
filter(callable $predicate) : $this
Parameters
- $predicate : callable
Return values
$thisgetAny()
public
getAny() : T|null
Return values
T|nullgetCollabs()
public
static getCollabs(int $limit[, DateTime|null $lastMessageDate = null ]) : self
Parameters
- $limit : int
- $lastMessageDate : DateTime|null = null
Return values
selfgetContext()
Returns the local or global context for the action.
public
getContext() : Context
Return values
ContextgetPopupData()
Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.
public
getPopupData([array<string|int, mixed> $excludedList = [] ]) : PopupData
Parameters
- $excludedList : array<string|int, mixed> = []
Return values
PopupDatagetRestEntityName()
Returns the name of the entity that will be used in the rest response
public
final static getRestEntityName() : string
Return values
stringmerge()
public
merge(Registry<string|int, T> $registry) : static
Parameters
- $registry : Registry<string|int, T>
Return values
staticsetContext()
Sets new context for operations.
public
setContext(Context|null $context) : self
Parameters
- $context : Context|null
Return values
selfsetContextUser()
public
setContextUser(mixed $user) : self
Parameters
- $user : mixed
Return values
selftoRestFormat()
Returns an array in JSON like format to return the entity as a rest response.
public
toRestFormat([array<string|int, mixed> $option = [] ]) : array<string|int, mixed>|null
Parameters
- $option : array<string|int, mixed> = []
Return values
array<string|int, mixed>|nullunsetByKeys()
public
unsetByKeys(array<string|int, mixed> $keys) : void
Parameters
- $keys : array<string|int, mixed>
withContext()
Provides local context for the action.
public
withContext(Context|null $context) : static
Parameters
- $context : Context|null
Return values
staticwithContextUser()
Provides local context for the action.
public
withContextUser(int|User|User $user) : static
Parameters
- $user : int|User|User