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

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

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

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

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

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

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

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

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

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

Ka Extensions и события OpenCart: скорость и удобство

В OpenCart 3 есть несколько способов изменить поведение магазина без правки ядра. В этой статье сравниваются два из них:

  • События OpenCart. Это встроенный механизм. Модуль регистрирует обработчик для маршрута, например admin/model/catalog/product/addProduct/before, и OpenCart вызывает его до или после этого метода.
  • Наследование с Ka Extensions (kamod). Модуль добавляет класс, который расширяет исходный класс OpenCart и переопределяет нужный метод. Kamod строит из этих классов цепочку наследования, а к исходному коду можно обратиться через parent::.
OCMOD мы сознательно не включаем в сравнение. OCMOD - хороший инструмент, но он патчит текст файлов ядра поиском и заменой. В крупных магазинах с множеством модулей такие патчи становится трудно сопровождать, поэтому в больших проектах OCMOD лучше избегать.

Оба механизма сравниваются на одном и том же коде - сначала по удобству, затем по скорости. Все замеры приводятся как изменение в процентах относительно чистого OpenCart, абсолютные значения - в скобках. Красные числа означают дополнительные затраты, зелёные - их отсутствие.

Итоги

Что сравнивается События OpenCart Ka Extensions
Как подключается модуль контроллер-обработчик получает массив $args по ссылке обычный PHP-метод с теми же параметрами, что и у оригинала
Параметры позиционные: $args[0], $args[1]… Чтобы понять, что лежит под каждым индексом, нужно смотреть ядро именованные: $data, $product_id
10 модулей, страница товара +17% (+4,1 мс) + 1%
50 модулей (прогноз), страница товара +83…96% (+20…24 мс) на тестовой странице + 3%
Минимальный набор файлов модуля контроллер-установщик с обработчиками плюс записи в таблице oc_event kamod.ini, active.kamod и класс, переопределяющий метод
Порядок модулей событие sort_order install_before / install_after в kamod.ini
Несколько модулей на одном методе да да, цепочкой через parent::

Пример: изменение поля товара при сохранении

Задача: при сохранении товара в админ-панели переводить его поле model в верхний регистр. Перехватывать нужно и addProduct(), и editProduct().

С событиями OpenCart 3

Файл admin/controller/extension/module/upper_model.php, содержащий и установщик, и обработчики:

PHP

class ControllerExtensionModuleUpperModel extends Controller {

    public function install() {
        $this->load->model('setting/event');

        // The trigger is a plain string. A typo here gives no error:
        // the handler is simply never called.
        $this->model_setting_event->addEvent('upper_model',
            'admin/model/catalog/product/addProduct/before',
            'extension/module/upper_model/beforeAddProduct'
        );
        $this->model_setting_event->addEvent('upper_model',
            'admin/model/catalog/product/editProduct/before',
            'extension/module/upper_model/beforeEditProduct'
        );
    }

    public function uninstall() {
        $this->load->model('setting/event');
        $this->model_setting_event->deleteEventByCode('upper_model');
    }

    // addProduct($data): $args[0] is $data.
    // Both parameters must be references, otherwise changes are lost silently.
    public function beforeAddProduct(&$route, &$args) {
        if (isset($args[0]['model'])) {
            $args[0]['model'] = strtoupper($args[0]['model']);
        }
        // Return nothing: in OpenCart 3 a non-null value returned from a
        // "before" handler replaces the result, the original addProduct()
        // is not called and the remaining handlers are skipped.
    }

    // editProduct($product_id, $data): here $args[0] is $product_id
    // and $args[1] is $data.
    public function beforeEditProduct(&$route, &$args) {
        if (isset($args[1]['model'])) {
            $args[1]['model'] = strtoupper($args[1]['model']);
        }
    }
}

На что здесь приходится обращать внимание:

  • Обработчик не знает, что получает. $args - это просто аргументы метода по порядку. Чтобы узнать, что $args[0] в одном случае - данные товара, а в другом - ID товара, нужно открыть admin/model/catalog/product.php и прочитать сигнатуры. Ни IDE, ни PHP тут не помогут.
  • Одно изменение требует двух обработчиков с разными индексами.
  • Модель перехватывается из контроллера. В OpenCart 3 обработчик события - всегда метод контроллера, даже если он изменяет метод модели. Если обработчику нужны данные из базы, приходится либо писать SQL-запросы в контроллере, хотя OpenCart держит SQL в моделях, либо создавать ещё одну модель специально для обработчика и загружать её из контроллера. В любом случае логика модели разрывается между контроллером и моделью, и код выглядит неуклюже.
  • Ошибки остаются незамеченными. Опечатка в маршруте, пропущенный & или лишний return не дают ни предупреждения, ни записи в журнале ошибок. Модуль просто перестаёт работать или ломает обработчики других модулей.
  • Связь маршрута с обработчиком хранится в таблице oc_event. Её нужно регистрировать при установке и удалять при удалении модуля.

С Ka Extensions: минимальный набор файлов

Ka Extensions не требует ни установщика модуля, ни языкового файла. Достаточно трёх файлов (вендор mycompany, модуль upper_model):

Файлы
admin/controller/extension/mycompany/upper_model/kamod.ini              manifest
admin/controller/extension/mycompany/upper_model/active.kamod           "module is enabled" marker, may be empty
admin/model/extension/mycompany/upper_model/model/catalog/product.php   override

Переопределение модели, admin/model/extension/mycompany/upper_model/model/catalog/product.php. Поскольку это модель, SQL-запросы через $this->db при необходимости можно писать прямо здесь:

PHP

namespace extension\mycompany\upper_model;

class ModelCatalogProduct extends \ModelCatalogProduct {

    public function addProduct($data) {
        $data = $this->normalizeModel($data);
        return parent::addProduct($data);
    }

    public function editProduct($product_id, $data) {
        $data = $this->normalizeModel($data);
        parent::editProduct($product_id, $data);
    }

    protected function normalizeModel($data) {
        if (isset($data['model'])) {
            $data['model'] = strtoupper($data['model']);
        }
        return $data;
    }
}

Манифест kamod.ini. Достаточно одной строки; остальные поля, например install_after, необязательны:

INI
name = "Upper case product model"

Файл active.kamod сообщает kamod, что модуль включён. Важно только его наличие, поэтому он может быть пустым. После загрузки файлов обновите кэш kamod: Расширения → Модификации → Обновить или на странице Ka Extensions. Во время разработки константа KAMOD_DEBUG пересоздаёт кэш при каждом запросе.

Такой модуль нигде не виден в интерфейсе админ-панели, но работает. Чтобы отключить его, удалите active.kamod и снова обновите кэш.

Что вы получаете:

  • Параметры называются так же, как в ядре: $data, $product_id. Видно, что изменяется и что передаётся дальше.
  • Результат - обычный return. Если нужен ID нового товара, он тут же: $product_id = parent::addProduct($data);.
  • Общая логика выносится в метод protected, например normalizeModel(), а не дублируется в двух обработчиках.
  • Модель изменяется моделью. Работа с базой данных остаётся там, где её держит OpenCart.
  • Ошибки легче заметить. Если сигнатура метода не совпадает с родительской, PHP сообщит об этом, а IDE покажет методы и параметры родителя.
  • Никаких записей в базе данных. Модуль включается файлом active.kamod.
Справедливости ради, ошибиться можно и с Ka. Если забыть вызвать parent::addProduct(), товар не сохранится, а цепочка других модулей на этом методе прервётся. Последствия так же плохи, как у лишнего return в событии, но это видно при чтении кода.

Необязательно: установщик и языковой файл

Если вы хотите, чтобы модуль появился на странице Ka Extensions, где его можно установить и удалить, добавьте установщик и языковой файл. Тогда active.kamod не нужно загружать самостоятельно: страница Ka Extensions создаёт его при установке модуля и удаляет при удалении.

Файлы
admin/controller/extension/mycompany/upper_model.php                    installer
admin/controller/extension/mycompany/upper_model/kamod.ini              manifest
admin/language/en-gb/extension/mycompany/upper_model.php                language
admin/model/extension/mycompany/upper_model/model/catalog/product.php   override

Установщик, admin/controller/extension/mycompany/upper_model.php. Он только объявляет версии; ничего регистрировать не нужно:

PHP

namespace extension\mycompany;

class ControllerUpperModel extends \extension\ka_extensions\ControllerSettings {

    protected $ext_code = 'upper_model';

    protected $extension_version = '1.0.0.0';
    protected $min_store_version = '3.0.0.0';
    protected $max_store_version = '3.0.9.9';
    protected $min_ka_extensions_version = '4.1.1.11';
    protected $max_ka_extensions_version = '4.1.1.99';
}

class_alias(__NAMESPACE__ . '\ControllerUpperModel', 'ControllerExtensionMycompanyUpperModel');

Несколько модулей на одном методе

Оба механизма это поддерживают.

  • С событиями обработчики на одном маршруте выполняются в sort_order.
  • С Ka Extensions каждый модуль становится звеном цепочки наследования. Первый модуль расширяет класс ядра, второй - первый и так далее, и каждый вызывает parent::. Порядок задаётся через install_before и install_after в kamod.ini.

Замеры

Как мы измеряли

  • Окружение: OpenCart 3.0.5.1, PHP 8.3.36, OPcache включён, JIT выключен, MariaDB 11.8, встроенный сервер PHP с одним обработчиком. Каталог крошечный, поэтому страницы быстрые: около 23–25 мс.
  • Чистый OpenCart: во всех сценариях установлены Ka Extensions и стандартные события OpenCart, всего 39 событий витрины. Стандартная страница товара или главная выполняет около 310 проверок событий (trigger): до и после каждого вызова модели, контроллера, шаблона и загрузки языка.
  • Один «модуль» выполняет одну и ту же работу обоими способами. Он добавляет ключ в результат getProduct(), добавляет переменную в шаблон product/product и перехватывает тестовую модель и контроллер. Версия на событиях использует 4 события; версия на Ka - 4 класса-переопределения.
  • Сценарии: чистый OpenCart; события с 10 модулями (40 событий); Ka с 10 модулями; 50 зарегистрированных событий, которые никогда не срабатывают. Мы также измерили по одному модулю каждого вида, но один модуль ни в том, ни в другом случае заметной разницы не даёт, поэтому эти данные не показаны.
  • Объём: каждая страница запрашивалась 2 000 раз в каждом сценарии, в 4 раунда с чередованием сценариев. Отдельные вызовы измерялись по 20 000 раз за прогон, 12 прогонов.
  • Типичное время. Для каждого сценария мы сортировали все времена и брали среднее по порядку: половина запросов была быстрее, половина - медленнее. В отличие от среднего арифметического, такое типичное время не искажается несколькими случайными медленными запросами.
  • Выбросы: два зависших запроса (480 с и 49 с, оба - события с 10 модулями) исключены. Это 2 запроса из 24 000, и на типичное время они не влияют.
  • Шум: типичное время отдельных раундов колебалось примерно на ±2 мс, около ±8%. Разница меньше 1,5 мс (около 6%) считается шумом.

Проценты рассчитываются как (сценарий − чистый OpenCart) / чистый OpenCart × 100%.

Сравнение с 10 модулями

Время страниц - в миллисекундах (мс). Отдельные вызовы - в микросекундах (мкс): 1 мкс - тысячная доля миллисекунды.

Что сравнивается Чистый OpenCart События OpenCart, 10 модулей Ka Extensions, 10 модулей
Страница товара, типичное время 0% (24,5 мс) +16,7% (28,6 мс) + 1% (24,8 мс)
Главная страница, типичное время 0% (22,6 мс) +18,3% (26,7 мс) + 1% (22,9 мс)
Страниц товара в секунду 0% (40,4 мс) +15% (44,3 мс) + 1% (41,8 мс)
  • Каждое зарегистрированное событие отнимает время при каждой проверке, даже если оно никогда не срабатывает. Event::trigger() перебирает все события и для каждого выполняет preg_quote и preg_match. Это ≈ 0,3 мкс на событие за проверку, а проверок около 310 на страницу. В итоге 50 событий, которые вообще ничего не делают, замедлили страницу товара на +24% (30,4 мс), а главную - на +26% (28,6 мс), то есть сильнее, чем 10 работающих модулей. Стоимость событий растёт с каждым установленным модулем, даже на страницах, где этот модуль не используется.

Прогноз для 50 модулей

Метод. Линейная экстраполяция. Её оправдывает устройство диспетчера: Event::trigger() проверяет каждое зарегистрированное событие при каждом вызове, поэтому затраты растут пропорционально количеству событий. Мы посчитали двумя способами:

  1. Наклон на модуль: (10 модулей − чистый OpenCart) / 10 = +0,41 мс на модуль, или +1,7% от страницы товара. Для 50 модулей: 50 × 0,41 ≈ +20,4 мс.
  2. Стоимость события: (50 холостых событий − чистый OpenCart) / 50 = +0,117 мс на событие. 50 модулей по 4 события дают 200 событий: 200 × 0,117 ≈ +23,5 мс.

Допущения: 4 события на модуль, как в тесте; около 310 проверок на страницу, как в тесте; обработчики почти ничего не делают, поэтому измеряются только собственные затраты механизма, а не полезная работа модуля. Эта полезная работа одинакова в обоих подходах и в сравнение не входит. Реальный магазин с 50 модулями обычно выполняет больше проверок на страницу, так что эта оценка, скорее всего, осторожная.

Количество модулей События, страница товара События, главная страница Ka Extensions
10 (измерено) +17% (+4,1 мс) +18% (+4,1 мс) ≈ 0% (шум)
50 (прогноз) +83…96% (+20…24 мс) +91…105% (+21…24 мс) ≈ 0%, оценка < 1%

В тестовом магазине 50 модулей на событиях почти удвоили бы время страницы только за счёт диспетчера событий.

Оценка для Ka: одно звено цепочки стоит ≈ 0,025 мкс. Даже если бы все 50 модулей переопределяли один и тот же метод и он вызывался бы 100 раз на страницу, это составило бы 50 × 100 × 0,025 мкс ≈ 0,13 мс, около 0,5% страницы. На практике модули переопределяют разные методы, так что затраты ещё меньше.

А как в реальном магазине?

Реальные страницы тяжелее - 150–400 мс. Там те же абсолютные накладные расходы выглядят меньше:

Обычное время страницы магазина События, 10 модулей События, 50 модулей (прогноз) Ka Extensions
150 мс +2.7% +14…16% ≈ 0%
250 мс +1.6% +8…9% ≈ 0%
400 мс +1.0% +5…6% ≈ 0%
Мы не утверждаем, что события - главная причина медленной работы магазина. Обычно большая часть времени уходит на SQL, шаблоны и сеть. Но стоимость событий растёт с каждым модулем, а у Ka остаётся нулевой. Чем больше в магазине модулей, тем заметнее разница.

Сильные стороны каждого механизма

События OpenCart

Сильные стороны:

  • Это официальный механизм OpenCart. Он есть в каждом магазине и не требует сторонней библиотеки.
  • Нет сгенерированного кода и кэша классов: обработчик вызывается напрямую.
  • Отдельное событие можно отключить в админ-панели в разделе Расширения → События.
  • Хорошо подходят для небольших точечных перехватов, особенно вывода шаблонов.

Что нужно учитывать:

  • Обработчики - это контроллеры, даже для событий моделей, и получают параметры безымянным массивом.
  • Каждое зарегистрированное событие добавляет немного времени к каждой проверке событий на каждой странице.
  • События нужно регистрировать в базе данных при установке и удалять при удалении модуля.
Наше мнение: на практике отключать отдельное событие в админ-панели почти никогда не нужно. Модуль - это единое целое, и отключение его части скорее сломает его, чем поможет. С Ka модуль включается или отключается целиком.

Ka Extensions

Сильные стороны:

  • Обычное наследование PHP: дочерний класс, метод с теми же именованными параметрами, parent:: и return. Код проверяют IDE и сам PHP.
  • Модель изменяется моделью, а контроллер - контроллером, поэтому SQL остаётся в моделях.
  • Нулевые накладные расходы на модуль, сколько бы модулей ни было установлено.
  • Минимальный модуль - три файла без записей в базе данных: kamod.ini, active.kamod и класс-переопределение.
  • Модуль включается или отключается целиком - на странице Ka Extensions или файлом active.kamod.
  • Если что-то пошло не так, у администратора есть безопасный режим, который открывает админ-панель без кэша kamod.

Что нужно учитывать:

  • Нужно установить библиотеку Ka Extensions.
  • Kamod генерирует классы-переопределения и хранит их в кэше. При изменении файлов модуля кэш нужно обновлять. Во время разработки константа KAMOD_DEBUG пересоздаёт его при каждом запросе.
  • Каждое переопределение должно вызывать parent::, иначе цепочка других модулей на этом методе прервётся.

Вывод

  • Удобство. С Ka вы пишете обычный PHP: дочерний класс, метод с теми же параметрами, parent:: и return. Переопределение параметра функции - одна строка с понятным именем. С событиями приходится каждый раз распаковывать массив $args, помнить, что лежит под каждым индексом, держать в голове правила возврата и обрабатывать события моделей в контроллере.
  • Скорость. При 10 модулях события стоят +17…18% времени страницы, Ka - ≈ 0%. Для 50 модулей прогноз для событий - +83…105% в тестовом магазине и +5…16% в реальном, а Ka остаётся около нуля.
  • Порядок и цепочки есть в обоих механизмах. Здесь ни у одного нет преимущества.
Оба механизма работают, и для небольших изменений события по-прежнему хороший выбор. Но если в магазине много модулей или вам нужен понятный и легко проверяемый код, наследование с Ka Extensions экономит и время сервера, и время разработчика.

См. также: документация Ka Extensions для OpenCart 3 · документация Ka Extensions для OpenCart 4