Stages extends RestrictedAction
FinalYes
Table of Contents
Methods
- __construct() : mixed
- add() : int|null
- Add new stage. Return new stage id.
- canExecute() : mixed
- canMoveTask() : bool
- Can move task.
- delete() : bool|null
- Delete stage.
- get() : array<string|int, mixed>
- Get stages from group / user.
- getComponentHTML() : mixed
- getErrorCollection() : mixed
- getErrors() : mixed
- getForbiddenMethods() : array<string|int, mixed>
- todo: replace this method with some phpdoc notation
- isVersionGT() : mixed
- moveTask() : bool|null
- Move task to the new stage.
- update() : bool|null
- Update stage.
Methods
__construct()
public
__construct() : mixed
add()
Add new stage. Return new stage id.
public
add(array<string|int, mixed> $fields[, bool $isAdmin = false ]) : int|null
Parameters
- $fields : array<string|int, mixed>
-
Data array.
- $isAdmin : bool = false
-
Make action as portal admin.
Return values
int|nullcanExecute()
public
canExecute() : mixed
canMoveTask()
Can move task.
public
canMoveTask(int $entityId, string $entityType) : bool
Parameters
- $entityId : int
-
Entity id.
- $entityType : string
-
Entity type.
Return values
booldelete()
Delete stage.
public
delete(int $id[, bool $isAdmin = false ]) : bool|null
Parameters
- $id : int
-
Stage id.
- $isAdmin : bool = false
-
Make action as portal admin.
Return values
bool|nullget()
Get stages from group / user.
public
get(int $entityId[, bool $numeric = false ][, bool $isAdmin = false ]) : array<string|int, mixed>
Parameters
- $entityId : int
-
Entity id.
- $numeric : bool = false
-
Numeric array.
- $isAdmin : bool = false
-
Make action as portal admin.
Return values
array<string|int, mixed>getComponentHTML()
public
static getComponentHTML(mixed $name[, mixed $template = '' ][, array<string|int, mixed> $callParameters = array() ][, array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
- $name : mixed
- $template : mixed = ''
- $callParameters : array<string|int, mixed> = array()
- $parameters : array<string|int, mixed> = array()
getErrorCollection()
public
getErrorCollection() : mixed
getErrors()
public
getErrors() : mixed
getForbiddenMethods()
todo: replace this method with some phpdoc notation
public
static getForbiddenMethods() : array<string|int, mixed>
Return values
array<string|int, mixed>isVersionGT()
public
isVersionGT() : mixed
moveTask()
Move task to the new stage.
public
moveTask(int $id, int $stageId[, int $before = 0 ][, int $after = 0 ]) : bool|null
Parameters
- $id : int
-
Task id.
- $stageId : int
-
Stage id.
- $before : int = 0
-
Set before task id.
- $after : int = 0
-
Set after task id.
Return values
bool|nullupdate()
Update stage.
public
update(int $id, array<string|int, mixed> $fields[, bool $isAdmin = false ]) : bool|null
Parameters
- $id : int
-
Stage id.
- $fields : array<string|int, mixed>
-
Data array.
- $isAdmin : bool = false
-
Make action as portal admin.