A Task scheduler for Neos Flow
This package provides a simple to use task scheduler for Neos Flow. Tasks are configured via settings, recurring tasks can be configured using cron syntax. Detailed options configure the first and last executions as well as options for the class handling the task.
Scheduling and running tasks are decoupled: The
Scheduler schedules tasks whcih the are executed by the
TaskRunner. This architecture allows receiving and displaying metrics of already executed tasks.
Most of the architectural ideas behind the package are taken from php-task, and reimplemented for Neos Flow.
composer require 'flowpack/task'
Flowpack: Task: tasks: 'a-unique-identifier': label: The label of this task description: Some detailed description of thsi task # A class, implementing the TaskHandlerInterface handlerClass: 'Vendor\Package\TaskHandler\TaskHandlerClass' cronExpression: '*/5 * * * *' # A workload, eg. some configuration, given to the taskHandler workload: interval: PT5M
lockStorage: Configuration string for the lock storage used for taskHandler implementing
LockingTaskHandlerInterface. See https://symfony.com/doc/current/components/lock.html#available-stores for more options
keepTaskExecutionHistory: Number of task executions to keep in the database. (default: 3)
A task handler contains the code executed for a specific task. Your command handler has to implement one of the following interfaces:
A basic task. The interface requires the method
handle(WorkloadInterface $workload): string to be implemented. The return value serves as information for successfully executed tasks.
getMaximumAttempts(): int to be implemented. Allowing the tasks to be retried on failure.
getLockIdentifier(WorkloadInterface $workload): string to be implemented. The return value specifies a lock to be acquired. When such a task is running, other tasks requiring the same lock will be skipped.
Schedule and run due tasks
Schedule and run a single task
./flow task:runSingle <taskIdentifier>
Show a list of all defined and scheduled tasks:
Show details about a specific task:
./flow task:show <taskIdentifier>