VirtueMart – интернет-магазин на Joomla. Часть 29. Расширение функциональных возможностей Virtuemart без хака ядра.

Всем известно, что Virtuemart далеко не совершенен. У него есть проблемы с быстродействием, удобством, кодом. Но к настоящему моменту ситуация такова, что идеальных движков для создания интернет-магазинов попросту нет. Будь то платные или бесплатные скрипты – они все имеют свои недостатки.

Несмотря на все недостатки, Virtuemart обладает одним важным достоинством – для него существует огромное количество готовых расширений и хаков, позволяющих добавить магазину практически любой функционал. Но здесь есть одна проблема. Использование хаков приводит к тому, что обновлять магазин становится крайне затруднительно, т.к. новые файлы заменяют старые, которые содержат хаки. В этой статье я расскажу про одну возможность Virtuemart, о которой крайне редко можно встретить упоминание в Рунете. Благодаря ей некоторые хаки можно использовать не беспокоясь о проблемах с обновлениями. Лучше даже сказать «легализовать», превратить в нормальный код.

Virtuemart user class

Начиная с версии 1.1.4., в Virtuemart встроена возможность расширения классов. Она основана, на особенности PHP, позволяющей переопределять и расширять классы. Что вообще такое «классы»?

Понятие класса относится к объектно-ориентированному программированию. Если говорить простым языком, класс, это контейнер, содержащий в себе набор функций, относящихся к объекту. Ну вот, простым языком не получилось. Наверное, проще пояснить на примере.

В Virtuemart есть объект «Товар». Единица, которую мы продаем в магазине. Над товаром могут совершаться различные действия. Мы можем добавлять товар, редактировать, удалять, изменять параметры, характеристики, можем сортировать товары, добавлять дочерние и многое другое. За каждое такое действие отвечает определенная функция (это сказано достаточно условно, но так проще понять, о чем идет речь). Набор таких функций объединяют в класс, отвечающий за товар. Так вот, к чему я вообще всё это рассказываю? Предположим, что вам потребовалась функция, которой нет в Virtuemart по умолчанию, например, вы хотите, чтобы при достижении определенной суммы покупок покупатель автоматически переводился в другую группу покупателей(и получал скидку). Сейчас в Virtuemart это возможно делать только вручную. Что для этого нужно сделать? Реально – написать всего пару десятков строк кода. Например, при смене статуса заказа на «Оплачен» из базы запрашиваются все заказы данного пользователя, далее суммируются, и если сумма превышает определенную величину, группа покупателей для этого пользователя изменяется. Сделать это несложно. Даже если вы не знаете PHP на фрилансе найдется много желающих помочь вам за небольшую плату. Проблема в другом. Для того, чтобы сделать это, придется править классы VM(опять же, может это и необязательно в данном конкретном случае, но для нас сейчас показательно).

Предположим, что в один из классов нужно дописать функцию смены группы в зависимости от суммы всех заказов. Также предположим, что мы(нам) ее написали прямо в этом классе. После этого обновлять Virtuemart становится страшно. А вдруг разработчики внесли изменения в этот класс? Тогда текущий файл будет заменен новым, в котором нет и намека на нашу функцию.  

Для того, чтобы проблемы, описанной выше, не произошло, разработчики Virtuemart предусмотрели возможность создавать в используемом шаблоне Virtuemart пользовательские классы, которые расширяют или частично изменяют стандартные классы Virtuemart. Как это работает?

1) Прежде всего нужно понять какой, собственно, класс мы будем расширять или изменять. Все классы Virtuemart находятся в папке: administrator\components\com_virtuemart\classes

Обычно это все файлы имеют префикс ps_ .

2) После того, как требуемый класс определен, мы переходим в папку components\com_virtuemart\themes\default  и создаем в ней подпапку user_class.

3) В созданной папке components\com_virtuemart\themes\default\user_class  создаем файл с названием, аналогичным названию класса, который мы собираемся расширять или изменять. Например, ps_product_attribute.php.

4) В файле, созданном в п.3, добавляем новую функцию или изменяем существующую(скопировав ее из стандартного класса, и внося изменения).

Конструкция этого файла должна выглядеть следующим образом:

1
2
3
4
5
6
7
8

<?php if( !defined( '_VALID_MOS' ) && !defined( '_JEXEC' ) ) die( 'Direct Access to '.basename(__FILE__).' is not allowed.' );

 
      class ps_product_attribute extends vm_ ps_product_attribute {
            function myfunc($myparam) {
 
                //Тело функции 
 
            }

      }

 ?>

5) И самое главное. В Virtuemart вы должны включить «секретную опцию», разрешающую использование пользовательских классов. Почему «секретную»? Потому, что она появилась только в версии VM 1.1.4, как собственно и сама возможность пользовательских классов. Т.к. локализация VM была сделана раньше и особо не переделывалась, очень часто эта опция в русском языке никак не подписана.

Найти ее можно в настройках Virtuemart, вкладка «Безопасность». Что именно нужно включить, показано на рисунке ниже:

После этого заходите на сайт и тестируете. Возможны всего два варианта:

• О чудо! Это работает!
• Fatal Error: бла бла бла.

Если ваш вариант – второй. Внимательно смотрите что за ошибка появилась. Она ваша и никак иначе. Ищите.

От себя могу сказать, что user_class работает. Точно, на 100%. Проверенно лично и не раз :-).

Рабочий пример

Для большей наглядности приведу рабочий пример с одного из западных блогов.

Предположим, что мы хотим создать функцию, которая уведомляет по email администратора о добавлении в магазине нового товара.

1) Определяем какой класс будем расширять. Т.к. работает с товаром, то класс ps_product.

2) переходим в папку components\com_virtuemart\themes\default  и создаем в ней подпапку user_class.

3) В созданной папке components\com_virtuemart\themes\default\user_class создаем файл

ps_product.php

4) В созданном файле добавляем следующий код:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

<?php if( !defined( '_VALID_MOS' ) && !defined( '_JEXEC' ) ) die( 'Direct Access to '.basename(__FILE__).' is not allowed.' );


    class ps_product extends vm_ps_product { //Указываем, какой класс расширяется
       function add( &$d ) { //добавляем функцию добавления товара
          $retval=vm_ps_product::add(&$d);  //вызываем эту функцию из стандартного класса. Это сделано, чтобы не вставлять ее в пользовательский класс полностью
          if ($d['product_id']) { //если товар был добавлен
              $message='A new product has been added to your shop:

ID: '.$d['product_id'].'
SKU: '.$d['product_sku'].'
Name: '.$d['product_name']; //формируем сообщение 
              vmMail( "
 Адрес электронной почты защищен от спам-ботов. Для просмотра адреса в браузере должен быть включен Javascript.", "ShopAdmin", "
 Адрес электронной почты защищен от спам-ботов. Для просмотра адреса в браузере должен быть включен Javascript.", "New Product", $message, false, true);  //отправляем сообщение
          }

     
 }
     }
 ?>

5) Активируем опцию в настройках Virtuemart.

На этом всё. Теперь после добавления нового товара на указанный в функции email будет отправляться письмо с указанным содержимым.

Несколько дополнительных мыслей о user_class

1. Для тех, кто так и не понял смысла: user_class работает аналогично перенаправлениям в шаблонах Joomla(помните, когда мы создаем папку html и помещаем в нее макет, или модуль, который нужно исправить?)
2. Убедитесь, что функции, которые вы добавляете в класс, надежны. За их безопасность отвечаете вы, а не разработчики Virtuemart.
3. Файлы еще одной очень важной папки administrator\components\com_virtuemart\html не будут работать в user_class. Их можно редактировать только напрямую, создавая тем самым хаки. И хотя разработчики и утверждают, что файлы этой папки стабильны и с выпуском обновлений не будут подвергаться изменениям(а значит и не будут заменять текущие файлы с хаками), что-то я им не очень верю.
4. Если вы рядовой пользователь Virtuemart и ничего не поняли из этой статьи – не огорчайтесь. Эта информация предназначена в первую очередь для программистов и разработчиков. Возможно, когда-то, когда вам понадобится дополнительная функция, вы займетесь ее поиском, найдете, вернетесь к этой статье, прочитаете её еще несколько раз и поймете, как внедрить функцию без хаков ядра Virtuemart.