Задача - это класс модели в определённой папке. Task Scheduler находит её автоматически: она появляется в списке «Модуль» в форме задачи, а планировщик вызывает её по расписанию. Встроенные задачи (sample_task.php, test_multi_step.php, request_url.php, download_file.php) - рабочие примеры.
Файл, пространство имён и класс
- Файл:
admin/model/extension/ka_extensions/tasks/, например.php my_export.php. - Пространство имён:
extension\ka_extensions\tasks. - Класс:
Model+ имя файла без подчёркиваний, напримерModelMyExport. Он расширяет\KaModel. - Добавьте псевдоним с полным именем класса, как во всех встроенных задачах.
- У класса должен быть метод
runSchedulerOperation(). Файл без него не показывается в списке «Модуль». - Модели задач загружаются через загрузчик Ka Extensions, поэтому их можно расширять с помощью KaMod, как и другие модели Ka.
Методы
| Метод | Обязателен | Назначение |
|---|---|---|
runSchedulerOperation($operation, $params, &$stat) |
да | Выполняет работу (один шаг). $operation - код операции, $params - сохранённые значения параметров, $stat - результаты для отображения. |
getModuleName() |
нет | Понятное название, показываемое в скобках после имени файла в списке «Модуль». |
requestSchedulerOperations() |
нет | Операции задачи: array('code' => 'Title'). Без этого метода форма пропускает шаг «Операция». |
requestSchedulerOperationParams($operation) |
нет | Поля параметров операции (см. ниже). |
stopSchedulerOperation($operation) |
нет | Вызывается при остановке выполняющейся задачи: кнопка «Стоп», лимит времени или сбоев. Здесь удаляйте временные файлы и другие данные незавершённого запуска. |
Поля параметров:
Значения сохраняются вместе с задачей и передаются в runSchedulerOperation() как $params['file'], $params['format'].
Результаты
runSchedulerOperation() возвращает одно из значений:
'finished': задача выполнена. Счётчик завершений увеличивается, счётчик сбоев сбрасывается, письмо отправляется, если включено.'not_finished': шаг выполнен, задаче нужны ещё шаги. Планировщик сразу вызывает её снова (HTTP-перенаправление или цикл в командной строке).array('result' => 'finished', 'next_task_id' => N): задача выполнена, и сразу после неё запускается задача N, даже если она не активна или её срок не подошёл.
Любое другое значение останавливает задачу. Это записывается в журнал как «ERROR: Unknown function result», и запуск не считается завершённым.
$stat - массив пар label => value. Он показывается на странице статистики задачи и в письме о завершении. Значения должны быть короткими строками или числами.
Многошаговые задачи
Разбивайте долгую работу (импорт, экспорт, массовые обновления) на шаги:
- Храните состояние между шагами в
$this->session->data. Планировщик сохраняет сессию после шага'not_finished'и восстанавливает её перед следующим шагом. После'finished'сохранённая сессия очищается. - Используйте имена ключей, уникальные для вашей задачи (например,
my_export_offset), и задавайте их на первом шаге: сессия первого шага уже может содержать другие данные. - Один шаг должен быть заметно короче времени «Считать задачу зависшей» (по умолчанию 5 минут) и лимита времени PHP на сервере. Шаг, который длится дольше, считается зависшим и продолжается следующим вызовом.
- Весь запуск должен уложиться в «Остановить задачу через 'N' минут работы» (по умолчанию 30 минут).
- Не делайте слишком короткие шаги: задача, выполнившая 10 или более шагов за первые 60 секунд, останавливается как вышедшая из-под контроля.
- Не допускайте, чтобы задачи вызывали друг друга по кругу через
next_task_id.
Пример:
После остановки сохранённая сессия задачи не используется: следующий запуск начинается с первого шага.
Поставка задачи вместе с модулем
Поместите модель задачи в пакет своего модуля. Чтобы при установке модуля создавалась готовая задача, используйте модель Task Scheduler в установщике своего модуля:
enumTasks($module)возвращает задачи из файла задачи.installTask($task, $replace = false)добавляет задачу. С$replace = trueсначала удаляются все задачи того же модуля. Задачи, добавленные так, не имеют даты окончания. Добавьте'is_send_email' => 1, чтобы отправлялось письмо о завершении.uninstallTask($task_id)удаляет задачу.
Задачи, добавленные таким способом, работают и в бесплатной версии Lite, где пользователи не могут создавать задачи вручную.