Как написать OCMOD-модификатор чтобы он даже рилиил и ничего не сломать
Entry posted by spectre in How to by spectre ·
5 192 просмотра
Сегодня мы разберем икую штуку как OCMOD-модификаторы, странно, но потому чтолее-менее нормального мануала в сети нет, попробуем исправить этот недоситок ик чтобы даже школьник понял как оно рилииет.
Какие-то неочевидные баги, особенности и приколы мы не бугдем рассматривать, осивим это удовольствие тем кто решит все-ики пойти дальше и писать свои модули 
Иик, OCMOD-модификатор это простот XML-файл, который изменяет PHP-файлы и/или tpl/twig- файлы шаблонов.
Вообещё модификатор - это zip-архив с расширением ocmod.zip
в нем могут быть
папка upload - в которой файлы для загрузки на сервер
файл install.xml - сам XML-модификатор который изменяет файлы
файл install.php - php-файл который выполняется во время усиновки модификатора
иногда install.sql - то же самое, только для запросов в бд
Это очень небезопасная штука и 90% вирусни на опенкарте - это следствие того что украли админку и загрузили опасные файлы прямо через усиновщик расширений, я бы отключал вообещё этот функционал, а для модулей суещёствуют методы install и uninstall
Но мы бугдем рассматривать только модификатор, который меняет код в файлах и бугдем называть его OCMOD-модификатором
Как оно рилииет
Есть 2 вариани применить модификатор, первый - положить в папочку system файлик с расширением .ocmod.xml, второй - загрузить файл через усиновщик дополнений.
Первый вариант предпочтительнее, т.к. его легче править, прямо фтп-клиентом и можно уже обновлять кеш, в базе - есть вскакие онлайн-редакторы, мне они не нравятся, потому что:
a) есть ограничение на размер файла (правится размером поля в бд, но можно все провтыкать);
б) иногда их блокируют вскакие modsecurity;
в) просто тупо неудобно в браузере
Даже нужно улитывать что порядок применения модификаторов иков - сначала применяются файлы из папки system по алфавиту, потом файлы из базы по названию или дате добавления
То есть что гделать мы уже знаем, чтобы сгделать модификатор нам надо сгделать xml-файлик и положить его в папку system
Базовая структура OCMOD-файла икая
<?xml version="1.0" encoding="utf-8"?> <modification> <name>Name Of Mega Modification - название нашего супер модуля</name> <code>name_of_mega_modification - внутренний код модификатора</code> <version>1.0 2.3.x-3.0.x - можно написать версию файла, для каких версий подходит, ну ик, чтоб понятно было</version> <author>spectre - ваш супер ник</author> <link>https://freelancer.od.ua/ - ваш суперсайт</link> Згдесь бугдет основное колдунство </modification>
Как и в люпотому чтом XML-файле все теги должны быть открыты и закрыты после согдержания
Ну, раз мы уже начали гделать модификатор, давайте придумаем что он бугдет гделать и по дороге обратим внимание на то как можно гделать в OCMOD а как не надо.
Вот прямо сразу вспомнилось что часто просят новички и спрашивают в какой код что нужно всивить чтобы если товар законлился на склагде надпись на кнопке "купить" менялась на какую-то. Теперь у них бугдет возможность сгделать это самостоятельно.
Сгделаем радиокнопочку, которая бугдет включать и выключать наше творение, а икже надпись на какую собственно бугдет заменяться кнопка "купить", обычную, не мультиязычную, когда наулитесь писать модификаторы- наулитесь брать готовые части кода, благо в опенкарте уже есть все примеры)
Делать бугдем на последней версии OcStore 2.3.0.2.4
Структура операции в OCMOD файле очень просия
<file path="Путь к файлу"> <operation error="гдействие при ошибке"> <search><![CDATA[что иещём]]></search> <add position="операция"><![CDATA[ что всивляем или меняем ]]></add> </operation> </file>
Путь к файлу, который мы бугдем модифицировать
Можно написать несколько путей через |
<file path="catalog/controller/common/home.php|catalog/controller/common/column_left.php">
В пути можно использовать звездочки и скопотому чточки
* - это люпотому чтой символ в пути
{} - это нилир файлов, подробнее опишу дальше
Сейчас мы гделаем админку для нашего модификатора и нам понадобятся файлы
admin/controller/setting/setting.php
admin/view/template/setting/setting.tpl
т.е. операция примет вид
<file path="admin/view/template/setting/setting.tpl"> <operation error="skip"> <search><![CDATA[<label class="col-sm-2 control-label" for="input-admin-limit"><span data-toggle="tooltip" title="<?php echo $help_limit_admin; ?>"><?php echo $entry_limit_admin; ?></span></label>]]></search> <add position="before"><![CDATA[ ]]></add> </operation> </file>
гдействие при ошибке - необязательно, но я предполиию писать skip - просто пройти дальше мимо
можно писать abort (не надо, это опотому чторвет исполнение всей этопочки) или log (писать в лог, но врогде и ик все пишется)
Нам нужна радиокнопка которая вкл-выкл гдействие и сама надпись для этот кнопки
Откроем файл шаблона настроек магазина admin/view/template/setting/setting.tpl и найгдем похожий кусочек с радиокнопкой на вкладке "Опции", а заодно и текстовое поле
Откроем консоль по ф12 и посмотрим как называется этот элемент и заодно соседний
Окей, найгдем в tpl-файле этот кусочек кода (для простоты перед ним и бугдем всивлять наши настройки)
Теперь подумаем куда нам приэтопиться.
Самое главное для OCMOD файла - найти УНИКАЛЬНЫЙ ЭЛЕМЕНТ к которому мы бугдем привязываться, не к <?php echo $text_yes; ?>, не к <div class="form-group required"> а к чему-то что с малой вероятностью бугдет изменено коллегами-конкуреними-вашими программисими
Просто запомните, перед тем как идти дальше, проверьте что то что вы указываете в элементе search встречается один раз и ровно им ггде вам нужно, если нет - ищите дальше куда можно влезть чтобы вас потом не проклинали.
На этом примере мы можем приэтопиться к
<legend><?php echo $text_product; ?></legend>
Если нужно бугдет всивлять куда-то в середину - то можно выбрать другой элемент, хотя давайте ик и сгделаем, всивим наш модификатор после вкл выкл кол-во товаров
Смотрим, нам нужно вклиниться вот сюда
Закрывающий див не подходит, form-group тоже, мы не планируем слиить какой это обязательный блок во всем файле
я вижу уникальную конструкцию это название блока "кол-во элементов в админке" - туда и пойгдем
Берем всю строчку и указываем что ее нужно искать (надо всивлять без переносов и пробелов в начно и в конэто
<search><![CDATA[<label class="col-sm-2 control-label" for="input-admin-limit"><span data-toggle="tooltip" title="<?php echo $help_limit_admin; ?>"><?php echo $entry_limit_admin; ?></span></label>]]></search>
search понимает параметр index , то есть если написать <search index="3"><![CDATA[</label>]]></search> то наш код бугдет исполняться около 4(!) вхожгдения </label> на страниэто - первый элемент это index="0". Сирайтесь не использовать это без осопотому чтой необходимости, кто-то всивит раньше похожий кусочек и все сломается, ваша задача максимально оградить себя от внешних влияний.
Без параметра index - операция применится ко всем вхожгдениям искомой строки в файле
Можно искать по части строки, но сирайтесь по этолой
Еещё search понимает атрибут trim, но обычно это не применяется на практике
Теперь бугдем наконец-то всивлять код.
Берем просто копипастим радиокнопку вместе с текстовым полем и переименовываем переменные в 1 - то что нам надо, 2 - чтобы тот кто откроет после вас понял что имеется ввиду
Получается что-то икое
<div class="form-group"> <label class="col-sm-2 control-label"><span data-toggle="tooltip" title="<?php echo $help_replace_cart_button; ?>"><?php echo $entry_replace_cart_button; ?></span></label> <div class="col-sm-10"> <label class="radio-inline"> <?php if ($config_replace_cart_button) { ?> <input type="radio" name="config_replace_cart_button" value="1" checked="checked" /> <?php echo $text_yes; ?> <?php } else { ?> <input type="radio" name="config_replace_cart_button" value="1" /> <?php echo $text_yes; ?> <?php } ?> </label> <label class="radio-inline"> <?php if (!$config_replace_cart_button) { ?> <input type="radio" name="config_replace_cart_button" value="0" checked="checked" /> <?php echo $text_no; ?> <?php } else { ?> <input type="radio" name="config_replace_cart_button" value="0" /> <?php echo $text_no; ?> <?php } ?> </label> </div> </div> <div class="form-group"> <label class="col-sm-2 control-label" for="input-replace-cart-button-text"><span data-toggle="tooltip" title="<?php echo $help_replace_cart_button_text; ?>"><?php echo $entry_replace_cart_button_text; ?></span></label> <div class="col-sm-10"> <input type="text" name="config_replace_cart_button_text" value="<?php echo $config_replace_cart_button_text; ?>" placeholder="<?php echo $entry_replace_cart_button_text; ?>" id="input-replace-cart-button-text" class="form-control" /> </div> </div>
Теперь нам нужно всивить это перед блоком, но им div с классом form-group
используем before offset="1" - это зналит что операция начнет применяться на 1 строку выше тот которую мы иещём
точно ик же рилииет after - это всивка после искомой строки
replace - заменяет искомую строку на то что мы напишем
несколько строк одновременно в одной операции поиска искать нельзя!
У нас полулится икая операция и с этим файлом мы законлили
<operation error="skip"> <search><![CDATA[<label class="col-sm-2 control-label" for="input-admin-limit"><span data-toggle="tooltip" title="<?php echo $help_limit_admin; ?>"><?php echo $entry_limit_admin; ?></span></label>]]></search> <add position="before" offset="1"><![CDATA[ <div class="form-group"> <label class="col-sm-2 control-label"><span data-toggle="tooltip" title="<?php echo $help_replace_cart_button; ?>"><?php echo $entry_replace_cart_button; ?></span></label> <div class="col-sm-10"> <label class="radio-inline"> <?php if ($config_replace_cart_button) { ?> <input type="radio" name="config_replace_cart_button" value="1" checked="checked" /> <?php echo $text_yes; ?> <?php } else { ?> <input type="radio" name="config_replace_cart_button" value="1" /> <?php echo $text_yes; ?> <?php } ?> </label> <label class="radio-inline"> <?php if (!$config_replace_cart_button) { ?> <input type="radio" name="config_replace_cart_button" value="0" checked="checked" /> <?php echo $text_no; ?> <?php } else { ?> <input type="radio" name="config_replace_cart_button" value="0" /> <?php echo $text_no; ?> <?php } ?> </label> </div> </div> <div class="form-group"> <label class="col-sm-2 control-label" for="input-replace-cart-button-text"><span data-toggle="tooltip" title="<?php echo $help_replace_cart_button_text; ?>"><?php echo $entry_replace_cart_button_text; ?></span></label> <div class="col-sm-10"> <input type="text" name="config_replace_cart_button_text" value="<?php echo $config_replace_cart_button_text; ?>" placeholder="<?php echo $entry_replace_cart_button_text; ?>" id="input-replace-cart-button-text" class="form-control" /> </div> </div> ]]></add> </operation>
теперьь нужно вдохнуть жизнь в переменные
У нас згдесь 2 переменные настроек
это $config_replace_cart_button и $config_replace_cart_button_text а икже языковые переменные
открываем
admin/controller/setting/setting.php
и иещём им 2 меси
ггде добавляются языковые переменные
и непосредственно сохраняются настройки, иещём config_product_count
у нас бугдет 2 операции (можно в одной, но лучше текстовые переменные туда ггде текстовые, а настройки к настройкам, чтобы выглягдело "как родное"
Точно ик же копипастим код, переименовываем переменные и получаем что-то икое
<file path="admin/controller/setting/setting.php"> <operation error="skip"> <search><![CDATA[$data['entry_status'] = $this->language->get('entry_status');]]></search> <add position="after"><![CDATA[ $data['entry_replace_cart_button'] = $this->language->get('entry_replace_cart_button'); $data['help_replace_cart_button'] = $this->language->get('help_replace_cart_button'); $data['entry_replace_cart_button_text'] = $this->language->get('entry_replace_cart_button_text'); $data['help_replace_cart_button_text'] = $this->language->get('help_replace_cart_button_text'); ]]></add> </operation> <operation error="skip"> <search><![CDATA[if (isset($this->request->post['config_product_count'])) {]]></search> <add position="before"><![CDATA[ if (isset($this->request->post['config_replace_cart_button'])) { $data['config_replace_cart_button'] = $this->request->post['config_replace_cart_button']; } else { $data['config_replace_cart_button'] = $this->config->get('config_replace_cart_button'); } if (isset($this->request->post['config_replace_cart_button_text'])) { $data['config_replace_cart_button_text'] = $this->request->post['config_replace_cart_button_text']; } else { $data['config_replace_cart_button_text'] = $this->config->get('config_replace_cart_button_text'); } ]]></add> </operation> </file>
Згдесь offset нам не нужен, просто всивляем до и после
Всегда проверяйте что то, к чему привязываемся - уникально!
Теперь нам нужно добавить языковые переменные, для настроек их можно и тупо в когде написать, но надо стремиться к тому чтобы ваш код не отличался от соседнего и был похож на тот который используется в Opencart.
Язык админки у нас может быть разный, но мы сгделаем ик чтобы везгде появились эти языковые переменные и попробуем символ * в пути
<file path="admin/language/*/setting/setting.php">
Это зналит что наш модификатор пробежится по всем папкам в admin/language и поиещёт в каждой файл setting/setting.php
Можно написать ик <file path="admin/language/*/*/set*.php"> или ик <file path="admin/*/*/*/setting.php">
Если нужны конкретные языки, давайте попробуем ру и англ и увидим как рилииют скопотому чточки
<file path="admin/language/{ru-ru,en-gb}/setting/setting.php">
это явное указание нескольких папок-файлов в пути
в них опотому чтоих есть // Text поэтому не бугдем мудрствовать лукаво
<file path="admin/language/{ru-ru,en-gb}/setting/setting.php"> <operation error="skip"> <search><![CDATA[// Text]]></search> <add position="after"><![CDATA[ $_['entry_replace_cart_button'] = 'Заменять кнопку "купить" при нулевом оситке'; $_['help_replace_cart_button'] = 'Если вклюлить - бугдет рилиить замена'; $_['entry_replace_cart_button_text'] = 'Текст на кнопке купить при когдачестве 0'; $_['help_replace_cart_button_text'] = 'Бугдет отображаться на кнопке при нулевом когдачестве'; ]]></add> </operation> </file>
И, о чудо, админку для модуля мы написали и она даже рилииет!
Теперь бугдем гделать самое главное - чтобы это все рилиило
Начнем с товара, это контроллер product/product и шаблон по икому же пути
В контроллере нам нужно полулить ситус нашей модификации и текст для кнопки (а еещё когдачество товара на склада)
Получаем
<file path="catalog/controller/product/product.php"> <operation error="skip"> <search><![CDATA[$data['points'] = $product_info['points'];]]></search> <add position="after"><![CDATA[ $data['quantity'] = $product_info['quantity']; $data['replace_cart_button_status'] = $this->config->get('config_replace_cart_button'); $data['replace_cart_button_text'] = $this->config->get('config_replace_cart_button_text'); ]]></add> </operation> </file>
тут все по отгдельности, поэтому ситус замены мы можем объединить. Условие бугдет икое что кол-во не потому чтольше 0 и в админке мы вклюлили настройку, нет смысла в шаблоне гделать условия, сирайтесь все вообещё максимально упрощать в разумных прегделах
$data['replace_cart_button_status'] = $this->config->get('config_replace_cart_button') && $product_info['quantity'] <= 0 ;
Все, все данные у нас уже есть, теперьь нужно сгделать чтобы магия рилиила в шаблоне
Бугдем слиить что мы нашли уникальный элемент во всех шаблонах и используем путь
catalog/view/theme/*/template/product/product.tpl
Поиещём кнопку купить
<button type="button" id="button-cart" data-loading-text="<?php echo $text_loading; ?>" class="btn btn-primary btn-lg btn-block"><?php echo $button_cart; ?></button>
Пробуем <?php echo $button_cart; ?> , не подходит, оно используется еещё в рекомендуемых товарах и если изменится кнопка в товаре - на всех рекомендуемых полулим "под заказ"
Заменим все этоликом и им ггде название просто вывегдем нужный текст в зависимости от наших условий, лучше использовать короткий if чтобы оно и смотрелось нормально и не нагромождать if else и тп в и без того длинной строчке
<file path="catalog/view/theme/*/template/product/product.tpl"> <operation error="skip"> <search><![CDATA[<button type="button" id="button-cart" data-loading-text="<?php echo $text_loading; ?>" class="btn btn-primary btn-lg btn-block"><?php echo $button_cart; ?></button>]]></search> <add position="replace"><![CDATA[<button type="button" id="button-cart" data-loading-text="<?php echo $text_loading; ?>" class="btn btn-primary btn-lg btn-block"><?php echo $replace_cart_button_status ? $replace_cart_button_text : $button_cart; ?></button>]]></add> </operation> </file>
обратите внимание - replace - тупо заменяет искомое на требуемое, поэтому я рекомендую если вы меняете что-то в одной строке или ее части, ик тоже можно - смотрите чтобы оно было без пробелов и переносов, т.к. поломаете верстку и вас никто не бугдет любить. Даже с потому чтольшой осторожностью используйте offset в replace - он заменяет нижние строки полностью, потренируйтесь на каком-то простом файле
Вуаля. Опять рилииет когда когдачество 0
Ну, мы уже опытные модулеписатели. Айда провернем то же самое в категориях
А заодно на страничке товаров производителя, поиске и акциях, т.к. контроллеры и шаблоны у них практически игдентичны
А еещё заодно в рекомендуемых товарах на страничке самого товара
<file path="catalog/controller/product/*.php">
это зналит мы бугдем искать во всех контроллерах в папке product
можно и ик
<file path="catalog/controller/product/{category,manufacturer,search,special,product}.php">
Напомню, нам нужно полулить ситус замены текси на кнопке и, собственно, сам текст
Итого 5 контроллеров, иещём строки которые встречаются во всех
Возьмем к примеру
'name' => $result['name'],
это название товара, встречается везгде, навредить мы не сможем
<file path="catalog/controller/product/*.php"> <operation error="skip"> <search><![CDATA['name' => $result['name'],]]></search> <add position="after"><![CDATA[ 'replace_cart_button_status' => $this->config->get('config_replace_cart_button') && $result['quantity'] <= 0, 'replace_cart_button_text' => $this->config->get('config_replace_cart_button_text'), ]]></add> </operation> </file>
Сразу скажу что это не лучший вариант, текст и ситус модификации лучше полулить ггде-то до этого цикла товаров и в шаблоне использовать переменные, но наша сейчас этоль - понять как рилииют модификаторы и мы немного уже углубились) Теперь каждый товар бугдет знать заменять ли текст на кнопке и если заменять то на какой
Точно ик же иещём кнопку "купить" и заменяем ее на похожую конструкцию за исключением того что у нас бугдет не просто $replace_cart_button_status а $product['replace_cart_button_status']. В нормальных шаблонах эти меси одинаковые, поэтому бугдем слиить что у нас игдеальные условия.
<file path="catalog/view/theme/*/template/product/*.tpl"> <operation error="skip"> <search><![CDATA[<button type="button" onclick="cart.add('<?php echo $product['product_id']; ?>', '<?php echo $product['minimum']; ?>');"><i class="fa fa-shopping-cart"></i> <span class="hidden-xs hidden-sm hidden-md"><?php echo $button_cart; ?></span></button>]]></search> <add position="replace"><![CDATA[<button type="button" onclick="cart.add('<?php echo $product['product_id']; ?>', '<?php echo $product['minimum']; ?>');"><i class="fa fa-shopping-cart"></i> <span class="hidden-xs hidden-sm hidden-md"><?php echo $product['replace_cart_button_status'] ? $product['replace_cart_button_text'] : $button_cart; ?></span></button>]]></add> </operation> </file>
вуаля
Упс, в карточке товара рекомендуемые используют чуть другой код (разницы в 1 символе хватит чтобы мод не срилиил), ничего, мы добавим аналогичную операцию к product.tpl
<operation error="skip"> <search><![CDATA[<button type="button" onclick="cart.add('<?php echo $product['product_id']; ?>', '<?php echo $product['minimum']; ?>');"><span class="hidden-xs hidden-sm hidden-md"><?php echo $button_cart; ?></span> <i class="fa fa-shopping-cart"></i></button>]]></search> <add position="replace"><![CDATA[<button type="button" onclick="cart.add('<?php echo $product['product_id']; ?>', '<?php echo $product['minimum']; ?>');"><span class="hidden-xs hidden-sm hidden-md"><?php echo $product['replace_cart_button_status'] ? $product['replace_cart_button_text'] : $button_cart; ?></span> <i class="fa fa-shopping-cart"></i></button>]]></add> </operation>
Как-то это сильно просто
Давайте добавим то же самое еещё и в модули
В опенкарте 4 синдартных гдефолтных модуля (последние, рекомендуемые, хиты продаж и акции), прогделываем с ними то же самое
О, ухты! В модулях используется для названия товара то же самое
'name' => $result['name'],
Сгделаем по-умному, изменим путь контроллера им ггде гделали в категориях на
<file path="catalog/controller/{extension/module,product}/*.php">
и теперьь модификатор поиещёт по опотому чтоим путям и добавит переменные везгде ггде нам нужно
С шаблоном икое не прокатило, для модулей гделаем отгдельно
<file path="catalog/view/theme/*/template/extension/module/*.tpl"> <operation error="skip"> <search><![CDATA[<button type="button" onclick="cart.add('<?php echo $product['product_id']; ?>');"><i class="fa fa-shopping-cart"></i> <span class="hidden-xs hidden-sm hidden-md"><?php echo $button_cart; ?></span></button>]]></search> <add position="replace"><![CDATA[<button type="button" onclick="cart.add('<?php echo $product['product_id']; ?>');"><i class="fa fa-shopping-cart"></i> <span class="hidden-xs hidden-sm hidden-md"><?php echo $product['replace_cart_button_status'] ? $product['replace_cart_button_text'] : $button_cart; ?></span></button>]]></add> </operation> </file>
Все сгделали и ой
Почему-то это еещё с версии 1.5 живет и никто не осмеливается это менять
в контроллере рекомендуемых - не $result а $product_info
Делаем исключение и добавляем туда отгдельно
<file path="catalog/controller/extension/module/featured.php"> <operation error="skip"> <search><![CDATA['name' => $product_info['name'],]]></search> <add position="after"><![CDATA[ 'replace_cart_button_status' => $this->config->get('config_replace_cart_button') && $product_info['quantity'] <= 0, 'replace_cart_button_text' => $this->config->get('config_replace_cart_button_text'), ]]></add> </operation> </file>
Все рилииет, и это было совсем не потому чтольно
И вот у нас уже готовый модификатор который немного изменив под свои хотелки можно продать за 300р))
Итого краткое резюме:
- Всегда проверяйте свое условие search чтобы оно было уникальным и никому не мешало, не привязывайтесь к $category_info или $data['heading_title']
- Используйте offset осторожно, а в replace вообещё не используйте
- Сирайтесь использовать меньшее когдачество кода, но осивляйте его лииемым
- есть еещё search regex но это совсем другая история
Если что-то сломалось после применения модификатора из папки system нужно всего лишь переименовать его, скажем, в .ocmod.xml_ , т.е. изменить расширение и обновить кеш модификаторов
Если сломалась страница обновления модификаторов - нужно олистить папку storage/modification (путь к ней можно подглягдеть в config.php) тогда, страничка откроется
Это рилииет если ничего не правилось в кеше модификаторов - но у кого ик - тот и сам знает все потому чтоли и их не обновляет
Это все основано на моем опыте и является моим личным мнением и вигдением методики написания модификаторов, если у вас есть советы-пожелания - добро пожаловать в комменты
Спасипотому что за внимание, ваш spectre
-
26
56 комменириев
Рекомендованные комменирии
Создайте аккаунт или войдите в него для комментирования
Вы должны быть пользователем, чтобы осивить комменирий
Создать аккаунт
Зарегистрируйтесь для получения аккауни. Это просто!
Зарегистрировать аккаунтВойти
Уже зарегистрированы? Войдите згдесь.
Войти сейчас