Движок Kamod

Что такое KaMod 

KaMod - это технология для магазинов на Opencart 3/4, позволяющая вносить изменения в php- и twig-файлы, не меняя их код. Она распространяется в составе бесплатной библиотеки Ka Extensions. Движок создаёт кэш (в папке storage) на основе файлов, размещённых в папке вашего расширения. Для Opencart 4 это папка extension/<ваше расширение>/kamod. Кэш подключается в самом начале загрузки Opencart, поэтому с помощью kamod можно доработать большинство стандартных файлов Opencart.

Kamod принципиально отличается от OCMod3/Events, но органично встроен в существующую среду Opencart, поэтому стандартные расширения ocmod с ним совместимы. KaMod нормально работает с системой событий Opencart и с официальным пакетом VQMod. Вероятно, он несовместим с движком Override (и похожими решениями, сильно изменяющими Opencart). Но проверить это мы пока не успели - возможно, после изучения удастся добиться совместимости. Если у вас возникнут проблемы с изменениями kamod, свяжитесь с нами.

Все модули команды karapuz для Opencart 4 основаны на kamod. Если вам нужно изменить наши модули, мы рекомендуем делать доработки с помощью файлов KaMod, но это не обязательно. Изменения VQMod применяются к коду как обычно.

Зачем мы создали KaMod

В целом он позволяет нам создавать надёжные доработки существующей функциональности. Разрабатывать собственные изменения с файлами kamod просто и естественно. Объём изменений Kamod в исходном файле не влияет на другие модификации, потому что их код находится в отдельном файле.

Kamod умеет и патчить файлы подобно изменениям vqmod/ocmod3, но эта функциональность очень ограничена, и мы стараемся использовать её как можно реже. Расширения, созданные с учётом технологии Kamod, должны легко дорабатываться другими расширениями без прямых патчей кода.

Как это устроено внутри

Менеджер Kamod создаёт кэш для php- и twig-файлов и использует его для автозагрузки изменённых классов. Кэш twig передаётся собственному загрузчику (ChainLoader заменяет стандартный загрузчик) с более высоким приоритетом, поэтому twig берёт файлы из кэша, если находит их там. Кэш создаётся при установке и удалении модулей, но для целей разработки можно принудительно пересоздавать его при каждой загрузке страницы.

php-файлы наследуют друг друга средствами родной поддержки классов php. В файле модуля вы указываете, какой класс хотите переопределить, и менеджер kamod строит кэш с учётом этой информации. 

twig-файлы используют extend/block для наследования от родителя к потомку.

KaMod создаёт новую папку 'cache.kamod' внутри папки storage. Дочерние классы одного родителя хранятся в одной папке, и их легко просматривать для изучения кода.

Можно ли использовать Kamod в своих проектах

Kamod - новая технология, и некоторые её части в будущем могут измениться. Но основа должна работать ещё довольно долго. Поэтому, если технология вам нравится, смело используйте её в своих проектах. Особенно мы рекомендуем вносить изменения в наши модули с помощью файлов kamod, потому что их легко сопровождать. Чтобы начать пользоваться KaMod, нужно установить библиотеку 'Ka Extensions'. Kamod - неотъемлемая часть этой библиотеки, и в ближайшем будущем мы не планируем её выделять.