Tasks extends Entity
Table of Contents
Methods
- __construct() : mixed
- getContext() : Context
- Returns the local or global context for the action.
- getCounter() : int
- getCounterInternal() : int
- getRestEntityName() : string
- Returns the name of the entity that will be used in the rest response
- getUrl() : string
- getUrlInternal() : string
- isAvailable() : bool
- 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.
- withContext() : static
- Provides local context for the action.
- withContextUser() : static
- Provides local context for the action.
Methods
__construct()
public
__construct(int $groupId) : mixed
Parameters
- $groupId : int
Tags
getContext()
Returns the local or global context for the action.
public
getContext() : Context
Return values
ContextgetCounter()
public
getCounter() : int
Return values
intgetCounterInternal()
public
getCounterInternal() : int
Return values
intgetRestEntityName()
Returns the name of the entity that will be used in the rest response
public
static getRestEntityName() : string
Return values
stringgetUrl()
public
getUrl() : string
Return values
stringgetUrlInternal()
public
getUrlInternal() : string
Return values
stringisAvailable()
public
static isAvailable() : bool
Return values
boolsetContext()
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>|nullwithContext()
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