EpicService implements Errorable
Table of Contents
Interfaces
- Errorable
Constants
- ERROR_COULD_NOT_ADD_EPIC = 'TASKS_EPS_01'
- ERROR_COULD_NOT_ADD_FILES = 'TASKS_EPS_07'
- ERROR_COULD_NOT_GET_EPIC = 'TASKS_EPS_02'
- ERROR_COULD_NOT_GET_EPICS = 'TASKS_EPS_06'
- ERROR_COULD_NOT_GET_LIST = 'TASKS_EPS_04'
- ERROR_COULD_NOT_GET_UF_FIELD = 'TASKS_EPS_08'
- ERROR_COULD_NOT_REMOVE_EPIC = 'TASKS_EPS_05'
- ERROR_COULD_NOT_REMOVE_FILES = 'TASKS_EPS_09'
- ERROR_COULD_NOT_UPDATE_EPIC = 'TASKS_EPS_03'
Methods
- __construct() : mixed
- attachFiles() : array<string|int, mixed>
- Attaches disk files to an epic.
- createEpic() : EpicForm
- deleteFiles() : bool
- Removes disk files from epic.
- getEpic() : EpicForm
- Gets an epic by identifier.
- getEpics() : array<string|int, mixed>
- The method returns a list of all epics for an entity.
- getErrorByCode() : mixed
- getErrors() : mixed
- getFilesUserField() : array<string|int, mixed>
- getList() : Result|null
- removeEpic() : bool
- updateEpic() : bool
- Updates an epic.
Constants
ERROR_COULD_NOT_ADD_EPIC
public
mixed
ERROR_COULD_NOT_ADD_EPIC
= 'TASKS_EPS_01'
ERROR_COULD_NOT_ADD_FILES
public
mixed
ERROR_COULD_NOT_ADD_FILES
= 'TASKS_EPS_07'
ERROR_COULD_NOT_GET_EPIC
public
mixed
ERROR_COULD_NOT_GET_EPIC
= 'TASKS_EPS_02'
ERROR_COULD_NOT_GET_EPICS
public
mixed
ERROR_COULD_NOT_GET_EPICS
= 'TASKS_EPS_06'
ERROR_COULD_NOT_GET_LIST
public
mixed
ERROR_COULD_NOT_GET_LIST
= 'TASKS_EPS_04'
ERROR_COULD_NOT_GET_UF_FIELD
public
mixed
ERROR_COULD_NOT_GET_UF_FIELD
= 'TASKS_EPS_08'
ERROR_COULD_NOT_REMOVE_EPIC
public
mixed
ERROR_COULD_NOT_REMOVE_EPIC
= 'TASKS_EPS_05'
ERROR_COULD_NOT_REMOVE_FILES
public
mixed
ERROR_COULD_NOT_REMOVE_FILES
= 'TASKS_EPS_09'
ERROR_COULD_NOT_UPDATE_EPIC
public
mixed
ERROR_COULD_NOT_UPDATE_EPIC
= 'TASKS_EPS_03'
Methods
__construct()
public
__construct([int $userId = 0 ]) : mixed
Parameters
- $userId : int = 0
attachFiles()
Attaches disk files to an epic.
public
attachFiles(CUserTypeManager $manager, int $epicId, array<string|int, mixed> $files) : array<string|int, mixed>
Parameters
- $manager : CUserTypeManager
- $epicId : int
-
Epic id.
- $files : array<string|int, mixed>
Return values
array<string|int, mixed>createEpic()
public
createEpic(EpicForm $epic[, PushService $pushService = null ]) : EpicForm
Parameters
- $epic : EpicForm
- $pushService : PushService = null
Return values
EpicFormdeleteFiles()
Removes disk files from epic.
public
deleteFiles(CUserTypeManager $manager, int $epicId) : bool
Parameters
- $manager : CUserTypeManager
- $epicId : int
-
Epic id.
Return values
boolgetEpic()
Gets an epic by identifier.
public
getEpic(int $epicId) : EpicForm
Parameters
- $epicId : int
Return values
EpicFormgetEpics()
The method returns a list of all epics for an entity.
public
getEpics(int $groupId) : array<string|int, mixed>
Parameters
- $groupId : int
-
Group id.
Return values
array<string|int, mixed>getErrorByCode()
public
getErrorByCode(mixed $code) : mixed
Parameters
- $code : mixed
getErrors()
public
getErrors() : mixed
getFilesUserField()
public
getFilesUserField(CUserTypeManager $manager[, int $valueId = 0 ]) : array<string|int, mixed>
Parameters
- $manager : CUserTypeManager
- $valueId : int = 0
Return values
array<string|int, mixed>getList()
public
getList([array<string|int, mixed> $select = [] ][, array<string|int, mixed> $filter = [] ][, array<string|int, mixed> $order = [] ][, PageNavigation|null $nav = null ]) : Result|null
Parameters
- $select : array<string|int, mixed> = []
- $filter : array<string|int, mixed> = []
- $order : array<string|int, mixed> = []
- $nav : PageNavigation|null = null
Return values
Result|nullremoveEpic()
public
removeEpic(EpicForm $epic[, PushService $pushService = null ]) : bool
Parameters
- $epic : EpicForm
- $pushService : PushService = null
Return values
boolupdateEpic()
Updates an epic.
public
updateEpic(int $epicId, EpicForm $epic[, PushService|null $pushService = null ]) : bool
Parameters
- $epicId : int
- $epic : EpicForm
- $pushService : PushService|null = null