SchedulerModuleController
FinalYes
Scheduler backend module.
This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
Attributes
- #[AsController]
Table of Contents
Properties
- $context : Context
- $currentAction : SchedulerManagementAction
- $iconFactory : IconFactory
- $moduleTemplateFactory : ModuleTemplateFactory
- $pageRenderer : PageRenderer
- $scheduler : Scheduler
- $taskRepository : SchedulerTaskRepository
- $taskSerializer : TaskSerializer
- $taskService : TaskService
- $uriBuilder : UriBuilder
Methods
- __construct() : mixed
- getCurrentAction() : SchedulerManagementAction
- This is (unfortunately) used by additional field providers to distinct between "create new task" and "edit task".
- handleRequest() : ResponseInterface
- Entry dispatcher method.
- setCurrentAction() : void
- This is (unfortunately) needed so getCurrentAction() used by additional field providers - it is required to distinct between "create new task" and "edit task".
- addDocHeaderAddTaskButton() : void
- addDocHeaderReloadButton() : void
- addDocHeaderShortcutButton() : void
- addMessage() : void
- Add a flash message to the flash message queue of this module.
- deleteTask() : void
- Mark a task as deleted.
- executeTasks() : void
- Execute a list of tasks.
- getLanguageService() : LanguageService
- renderListTasksView() : ResponseInterface
- Assemble a listing of scheduled tasks
- scheduleCrons() : void
- Schedule selected tasks to be executed on next cron run
- stopTask() : void
- Clears the registered running executions from the task.
- toggleDisabledFlag() : void
- Toggle the disabled state of a task and register for next execution if a task is of type "single execution".
Properties
$context read-only
protected
Context
$context
$currentAction
protected
SchedulerManagementAction
$currentAction
$iconFactory read-only
protected
IconFactory
$iconFactory
$moduleTemplateFactory read-only
protected
ModuleTemplateFactory
$moduleTemplateFactory
$pageRenderer read-only
protected
PageRenderer
$pageRenderer
$scheduler read-only
protected
Scheduler
$scheduler
$taskRepository read-only
protected
SchedulerTaskRepository
$taskRepository
$taskSerializer read-only
protected
TaskSerializer
$taskSerializer
$taskService read-only
protected
TaskService
$taskService
$uriBuilder read-only
protected
UriBuilder
$uriBuilder
Methods
__construct()
public
__construct(Scheduler $scheduler, TaskSerializer $taskSerializer, SchedulerTaskRepository $taskRepository, IconFactory $iconFactory, UriBuilder $uriBuilder, ModuleTemplateFactory $moduleTemplateFactory, Context $context, TaskService $taskService, PageRenderer $pageRenderer) : mixed
Parameters
- $scheduler : Scheduler
- $taskSerializer : TaskSerializer
- $taskRepository : SchedulerTaskRepository
- $iconFactory : IconFactory
- $uriBuilder : UriBuilder
- $moduleTemplateFactory : ModuleTemplateFactory
- $context : Context
- $taskService : TaskService
- $pageRenderer : PageRenderer
getCurrentAction()
This is (unfortunately) used by additional field providers to distinct between "create new task" and "edit task".
public
getCurrentAction() : SchedulerManagementAction
Return values
SchedulerManagementActionhandleRequest()
Entry dispatcher method.
public
handleRequest(ServerRequestInterface $request) : ResponseInterface
Parameters
- $request : ServerRequestInterface
Return values
ResponseInterfacesetCurrentAction()
This is (unfortunately) needed so getCurrentAction() used by additional field providers - it is required to distinct between "create new task" and "edit task".
public
setCurrentAction(SchedulerManagementAction $currentAction) : void
Parameters
- $currentAction : SchedulerManagementAction
addDocHeaderAddTaskButton()
protected
addDocHeaderAddTaskButton(ModuleTemplate $moduleTemplate, ServerRequestInterface $request) : void
Parameters
- $moduleTemplate : ModuleTemplate
- $request : ServerRequestInterface
addDocHeaderReloadButton()
protected
addDocHeaderReloadButton(ModuleTemplate $moduleTemplate) : void
Parameters
- $moduleTemplate : ModuleTemplate
addDocHeaderShortcutButton()
protected
addDocHeaderShortcutButton(ModuleTemplate $moduleTemplate, string $name) : void
Parameters
- $moduleTemplate : ModuleTemplate
- $name : string
addMessage()
Add a flash message to the flash message queue of this module.
protected
addMessage(ModuleTemplate $moduleTemplate, string $message[, ContextualFeedbackSeverity $severity = ContextualFeedbackSeverity::OK ]) : void
Parameters
- $moduleTemplate : ModuleTemplate
- $message : string
- $severity : ContextualFeedbackSeverity = ContextualFeedbackSeverity::OK
deleteTask()
Mark a task as deleted.
protected
deleteTask(ModuleTemplate $view, int $taskUid) : void
Parameters
- $view : ModuleTemplate
- $taskUid : int
executeTasks()
Execute a list of tasks.
protected
executeTasks(ModuleTemplate $view, string $taskUids) : void
Parameters
- $view : ModuleTemplate
- $taskUids : string
getLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicerenderListTasksView()
Assemble a listing of scheduled tasks
protected
renderListTasksView(ModuleTemplate $view, ModuleData $moduleData, ServerRequestInterface $request) : ResponseInterface
Parameters
- $view : ModuleTemplate
- $moduleData : ModuleData
- $request : ServerRequestInterface
Return values
ResponseInterfacescheduleCrons()
Schedule selected tasks to be executed on next cron run
protected
scheduleCrons(ModuleTemplate $view, string $taskUids) : void
Parameters
- $view : ModuleTemplate
- $taskUids : string
stopTask()
Clears the registered running executions from the task.
protected
stopTask(ModuleTemplate $view, int $taskUid) : void
Note this doesn't actually stop the running script. It just unmarks execution.
Parameters
- $view : ModuleTemplate
- $taskUid : int
Tags
toggleDisabledFlag()
Toggle the disabled state of a task and register for next execution if a task is of type "single execution".
protected
toggleDisabledFlag(ModuleTemplate $view, int $taskUid) : void
Parameters
- $view : ModuleTemplate
- $taskUid : int