Отличные расширения для Opencart с надёжной поддержкой

Созданы для эффективности, поставляются с уверенностью
Каталог расширений Смотреть
Получить поддержку Помогите мне
Факты, которые подтверждают наше внимание к качеству и поддержке

Более 10 лет опыта

Мы больше десяти лет создаём надёжные расширения для OpenCart и знаем, что нужно вашему магазину.

Открытый код, легко изменять

Чистый, понятный код. Все расширения поставляются с открытым исходным кодом и легко настраиваются.

Гарантия возврата денег и поддержка

Не устроило? Полный возврат средств в течение 30 дней. Поддержка отвечает в течение 72 часов.

Бесплатные обновления и помощь с совместимостью

Пожизненные обновления в пределах мажорной версии OpenCart. Бесплатная помощь, если возникнут проблемы интеграции.

Task Scheduler для разработчиков: создание собственной задачи

Задача - это класс модели в определённой папке. 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.
PHP
php
namespace extension\ka_extensions\tasks;

class ModelMyExport extends \KaModel {

    public function runSchedulerOperation($operation, $params, &$stat) {
        $stat = array('Exported products' => 10);
        return 'finished';
    }
}

class_alias(__NAMESPACE__ . '\ModelMyExport', 'ModelExtensionKaExtensionsTasksMyExport');

Методы

Метод Обязателен Назначение
runSchedulerOperation($operation, $params, &$stat) да Выполняет работу (один шаг). $operation - код операции, $params - сохранённые значения параметров, $stat - результаты для отображения.
getModuleName() нет Понятное название, показываемое в скобках после имени файла в списке «Модуль».
requestSchedulerOperations() нет Операции задачи: array('code' => 'Title'). Без этого метода форма пропускает шаг «Операция».
requestSchedulerOperationParams($operation) нет Поля параметров операции (см. ниже).
stopSchedulerOperation($operation) нет Вызывается при остановке выполняющейся задачи: кнопка «Стоп», лимит времени или сбоев. Здесь удаляйте временные файлы и другие данные незавершённого запуска.

Поля параметров:

PHP
public function requestSchedulerOperationParams($operation) {
    return array(
        'file' => array(
            'title'    => 'File name',
            'type'     => 'text',      // text, password or select
            'required' => true,
            'descr'    => 'Example: export/products.csv',  // tooltip, optional
        ),
        'format' => array(
            'title'    => 'Format',
            'type'     => 'select',
            'options'  => array('csv' => 'CSV', 'xml' => 'XML'),
            'required' => false,
        ),
    );
}

Значения сохраняются вместе с задачей и передаются в 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.

Пример:

PHP
public function runSchedulerOperation($operation, $params, &$stat) {

    if (!isset($this->session->data['my_export_offset'])) {   // first step
        $this->session->data['my_export_offset'] = 0;
    }
    $offset = $this->session->data['my_export_offset'];

    $done = $this->exportProducts($params, $offset, 500);    // your code, returns the number of exported rows
    $this->session->data['my_export_offset'] = $offset + $done;

    $stat = array('Exported products' => $offset + $done);

    if ($done == 500) {
        return 'not_finished';
    }

    unset($this->session->data['my_export_offset']);
    return 'finished';
}

public function stopSchedulerOperation($operation) {
    // remove temporary files, locks and other data of an unfinished run
}

После остановки сохранённая сессия задачи не используется: следующий запуск начинается с первого шага.

Поставка задачи вместе с модулем

Поместите модель задачи в пакет своего модуля. Чтобы при установке модуля создавалась готовая задача, используйте модель Task Scheduler в установщике своего модуля:

PHP
public function install() {
    if (!\extension\ka_extensions\KaGlobal::isKaInstalled('ka_scheduler', true)) {
        // Task Scheduler is not installed: show a message to the user
        return false;
    }
    if (!parent::install()) {
        return false;
    }

    $ka_tasks = $this->load->kamodel('extension/ka_extensions/ka_scheduler/ka_tasks');

    // add the task once, the user may have changed its schedule
    if (!$ka_tasks->enumTasks('my_export')) {
        $ka_tasks->installTask(array(
            'name'           => 'Export products',
            'module'         => 'my_export',        // task file name
            'operation'      => '',                 // operation code, if the task has operations
            'params'         => array(),
            'period_type'    => 'day',              // every_n_minutes, hour, day, week, month, year
            'period_at_hour' => 3,
            'period_at_min'  => 0,
            'start_at'       => date('Y-m-d 03:00:00'),
            'active'         => 'Y',
            'priority'       => 0,
        ));
    }
    return true;
}

public function uninstall() {
    if (\extension\ka_extensions\KaGlobal::isKaInstalled('ka_scheduler', true)) {
        $ka_tasks = $this->load->kamodel('extension/ka_extensions/ka_scheduler/ka_tasks');
        foreach ($ka_tasks->enumTasks('my_export') as $task) {
            $ka_tasks->uninstallTask($task['task_id']);
        }
    }
    return true;
}
  • enumTasks($module) возвращает задачи из файла задачи.
  • installTask($task, $replace = false) добавляет задачу. С $replace = true сначала удаляются все задачи того же модуля. Задачи, добавленные так, не имеют даты окончания. Добавьте 'is_send_email' => 1, чтобы отправлялось письмо о завершении.
  • uninstallTask($task_id) удаляет задачу.

Задачи, добавленные таким способом, работают и в бесплатной версии Lite, где пользователи не могут создавать задачи вручную.