Stage extends Base
Table of Contents
Constants
- ERROR_REQUIRED_PARAMETER = 'MAIN_CONTROLLER_22001'
- ERROR_UNKNOWN_ACTION = 'MAIN_CONTROLLER_22002'
- EVENT_ON_AFTER_ACTION = 'onAfterAction'
- EVENT_ON_BEFORE_ACTION = 'onBeforeAction'
- EXCEPTION_UNKNOWN_ACTION = 22002
- SCOPE_AJAX = 'ajax'
- SCOPE_CLI = 'cli'
- SCOPE_REST = 'rest'
Methods
- __construct() : mixed
- Constructor Controller.
- addKanbanStageAction() : array<string|int, mixed>
- addPlannerStageAction() : array<string|int, mixed>
- className() : string
- Returns the fully qualified name of this class.
- configureActions() : array<string|int, mixed>
- convertKeysToCamelCase() : array<string|int, mixed>|mixed|string
- Converts keys of array to camel case notation.
- deleteKanbanStageAction() : array<string|int, mixed>
- deletePlannerStageAction() : array<string|int, mixed>
- finalizeResponse() : void
- Finalizes response.
- forward() : HttpResponse|mixed
- generateActionMethodName() : string
- getActionUri() : Uri
- Returns uri for ajax end point for the action name. It's a helper, which uses relative action name without controller name.
- getAutoWiredParameters() : array<string|int, Parameter>
- getConfigurationOfActions() : array<string|int, mixed>|null
- getCurrentUser() : CurrentUser
- getDeadlineStagesAction() : array<string|int, mixed>
- getDefaultAutoWiredParameters() : array<string|int, Parameter>
- getErrorByCode() : Error
- Getting once error with the necessary code.
- getErrors() : array<string|int, Error>
- Getting array of errors.
- getFullEventName() : string
- getKanbanStagesAction() : array<string|int, mixed>
- getModuleId() : string
- Returns module id.
- getPlannerStagesAction() : array<string|int, mixed>
- getPrimaryAutoWiredParameter() : Parameter|null
- getRequest() : HttpRequest
- getScope() : string
- getSourceParametersList() : array<string|int, mixed>
- getUnsignedParameters() : mixed
- isLocatedUnderPsr4() : bool
- listNameActions() : array<string|int, mixed>
- Returns list of all
- redirectTo() : Redirect
- Redirect to URL.
- run() : HttpResponse|mixed
- setCurrentUser() : void
- setScope() : Controller
- setSourceParametersList() : Controller
- updateKanbanStageAction() : mixed
- updateKanbanStagesOrderAction() : array<string|int, mixed>
- updatePlannerStageAction() : mixed
- updatePlannerStagesOrderAction() : array<string|int, mixed>
Constants
ERROR_REQUIRED_PARAMETER
public
mixed
ERROR_REQUIRED_PARAMETER
= 'MAIN_CONTROLLER_22001'
ERROR_UNKNOWN_ACTION
public
mixed
ERROR_UNKNOWN_ACTION
= 'MAIN_CONTROLLER_22002'
EVENT_ON_AFTER_ACTION
public
mixed
EVENT_ON_AFTER_ACTION
= 'onAfterAction'
EVENT_ON_BEFORE_ACTION
public
mixed
EVENT_ON_BEFORE_ACTION
= 'onBeforeAction'
EXCEPTION_UNKNOWN_ACTION
public
mixed
EXCEPTION_UNKNOWN_ACTION
= 22002
SCOPE_AJAX
public
mixed
SCOPE_AJAX
= 'ajax'
SCOPE_CLI
public
mixed
SCOPE_CLI
= 'cli'
SCOPE_REST
public
mixed
SCOPE_REST
= 'rest'
Methods
__construct()
Constructor Controller.
public
__construct([Request|null $request = null ]) : mixed
Parameters
- $request : Request|null = null
addKanbanStageAction()
public
addKanbanStageAction(string $name, string $color, int $projectId[, int|null $afterId = null ]) : array<string|int, mixed>
Parameters
- $name : string
- $color : string
- $projectId : int
- $afterId : int|null = null
Return values
array<string|int, mixed>addPlannerStageAction()
public
addPlannerStageAction(string $name, string $color[, int|null $afterId = null ]) : array<string|int, mixed>
Parameters
- $name : string
- $color : string
- $afterId : int|null = null
Return values
array<string|int, mixed>className()
Returns the fully qualified name of this class.
public
final static className() : string
Return values
stringconfigureActions()
public
configureActions() : array<string|int, mixed>
Return values
array<string|int, mixed>convertKeysToCamelCase()
Converts keys of array to camel case notation.
public
convertKeysToCamelCase(mixed $data) : array<string|int, mixed>|mixed|string
Parameters
- $data : mixed
-
Data.
Tags
Return values
array<string|int, mixed>|mixed|stringdeleteKanbanStageAction()
public
deleteKanbanStageAction(int $stageId, int $projectId) : array<string|int, mixed>
Parameters
- $stageId : int
- $projectId : int
Return values
array<string|int, mixed>deletePlannerStageAction()
public
deletePlannerStageAction(int $stageId) : array<string|int, mixed>
Parameters
- $stageId : int
Return values
array<string|int, mixed>finalizeResponse()
Finalizes response.
public
finalizeResponse(Response $response) : void
The method will be invoked when HttpApplication will be ready to send response to client. It's a final place where Controller can interact with response.
Parameters
- $response : Response
forward()
public
forward(Controller|string $controller, string $actionName[, array<string|int, mixed>|null $parameters = null ]) : HttpResponse|mixed
Parameters
- $controller : Controller|string
- $actionName : string
- $parameters : array<string|int, mixed>|null = null
Tags
Return values
HttpResponse|mixedgenerateActionMethodName()
public
final generateActionMethodName(mixed $action) : string
Parameters
- $action : mixed
Return values
stringgetActionUri()
Returns uri for ajax end point for the action name. It's a helper, which uses relative action name without controller name.
public
final getActionUri(string $actionName[, array<string|int, mixed> $params = [] ][, bool $absolute = false ]) : Uri
Parameters
- $actionName : string
-
Action name. It's a relative action name without controller name.
- $params : array<string|int, mixed> = []
-
Parameters for creating uri.
- $absolute : bool = false
Return values
UrigetAutoWiredParameters()
public
getAutoWiredParameters() : array<string|int, Parameter>
Return values
array<string|int, Parameter>getConfigurationOfActions()
public
final getConfigurationOfActions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetCurrentUser()
public
final getCurrentUser() : CurrentUser
Return values
CurrentUsergetDeadlineStagesAction()
public
getDeadlineStagesAction(TaskRequestFilter $searchParams[, int|null $projectId = null ][, array<string|int, mixed> $extra = [] ]) : array<string|int, mixed>
Parameters
- $searchParams : TaskRequestFilter
- $projectId : int|null = null
- $extra : array<string|int, mixed> = []
Return values
array<string|int, mixed>getDefaultAutoWiredParameters()
public
final getDefaultAutoWiredParameters() : array<string|int, Parameter>
Return values
array<string|int, Parameter>getErrorByCode()
Getting once error with the necessary code.
public
final getErrorByCode(string $code) : Error
Parameters
- $code : string
-
Code of error.
Return values
ErrorgetErrors()
Getting array of errors.
public
final getErrors() : array<string|int, Error>
Return values
array<string|int, Error>getFullEventName()
public
final static getFullEventName(mixed $eventName) : string
Parameters
- $eventName : mixed
Return values
stringgetKanbanStagesAction()
public
getKanbanStagesAction(TaskRequestFilter $searchParams, int $projectId[, array<string|int, mixed> $extra = [] ][, int|null $taskId = null ]) : array<string|int, mixed>
Parameters
- $searchParams : TaskRequestFilter
- $projectId : int
- $extra : array<string|int, mixed> = []
- $taskId : int|null = null
Return values
array<string|int, mixed>getModuleId()
Returns module id.
public
final getModuleId() : string
Tries to guess module id by file path and function @see getModuleId().
Return values
stringgetPlannerStagesAction()
public
getPlannerStagesAction(TaskRequestFilter $searchParams[, int|null $projectId = null ][, array<string|int, mixed> $extra = [] ]) : array<string|int, mixed>
Parameters
- $searchParams : TaskRequestFilter
- $projectId : int|null = null
- $extra : array<string|int, mixed> = []
Return values
array<string|int, mixed>getPrimaryAutoWiredParameter()
public
getPrimaryAutoWiredParameter() : Parameter|null
Return values
Parameter|nullgetRequest()
public
final getRequest() : HttpRequest
Return values
HttpRequestgetScope()
public
final getScope() : string
Return values
stringgetSourceParametersList()
public
final getSourceParametersList() : array<string|int, mixed>
Return values
array<string|int, mixed>getUnsignedParameters()
public
final getUnsignedParameters() : mixed
isLocatedUnderPsr4()
public
final isLocatedUnderPsr4() : bool
Return values
boollistNameActions()
Returns list of all
public
final listNameActions() : array<string|int, mixed>
Return values
array<string|int, mixed>redirectTo()
Redirect to URL.
public
redirectTo(string $url) : Redirect
Parameters
- $url : string
Return values
Redirectrun()
public
final run(mixed $actionName, array<string|int, mixed> $sourceParametersList) : HttpResponse|mixed
Parameters
- $actionName : mixed
- $sourceParametersList : array<string|int, mixed>
Tags
Return values
HttpResponse|mixedsetCurrentUser()
public
final setCurrentUser(CurrentUser $currentUser) : void
Parameters
- $currentUser : CurrentUser
setScope()
public
final setScope(string $scope) : Controller
Parameters
- $scope : string
Return values
ControllersetSourceParametersList()
public
final setSourceParametersList(array<string|int, mixed> $sourceParametersList) : Controller
Parameters
- $sourceParametersList : array<string|int, mixed>
Return values
ControllerupdateKanbanStageAction()
public
updateKanbanStageAction(int $projectId, int $stageId, string $name, string $color) : mixed
Parameters
- $projectId : int
- $stageId : int
- $name : string
- $color : string
updateKanbanStagesOrderAction()
public
updateKanbanStagesOrderAction(int $projectId[, array<string|int, mixed> $stagesOrder = [] ]) : array<string|int, mixed>
Parameters
- $projectId : int
- $stagesOrder : array<string|int, mixed> = []
Return values
array<string|int, mixed>updatePlannerStageAction()
public
updatePlannerStageAction(int $stageId, string $name, string $color) : mixed
Parameters
- $stageId : int
- $name : string
- $color : string
updatePlannerStagesOrderAction()
public
updatePlannerStagesOrderAction([array<string|int, mixed> $stagesOrder = [] ]) : array<string|int, mixed>
Parameters
- $stagesOrder : array<string|int, mixed> = []