Shopkeeper 1.3 Корзина товаров

Основные параметры

&lang=`english`

&style=`0`

&cartType=`small`

&currency=``

&priceTV=`value`

&orderFormPage=`10`

&noJQuery=`1`

&noConflict=`1`

&noCounter=`1`

&linkAllow=`0`

&stuffCont=``

&debug=`1`

&flyToCart=`image`

&noLoader=`1`

&excepDigitGroup=`0`

&changePrice=`1`

&counterField=`1`

&noJavaScript=`1`

&hideOn=`1`

Шаблоны

&tplPath=``

&cartTpl=`shopCart`

&cartRowTpl=`shopCartRow`

&cartHelperTpl=`cartHelperTpl`

&additDataTpl=`additDataTpl`

&orderDataTpl=`orderDataTpl`

&report=``

Примеры вызова

[!Shopkeeper? &priceTV=`price` &orderFormPage=`10`!]

[!Shopkeeper? &cartType=`small` &priceTV=`price` &orderFormPage=`10` &changePrice=`1` &counterField=`1` &flyToCart=`nofly`!]

Необходимые CSS-классы, Id и имена полей

CSS-классы (и id) используются в JS-функциях. Их можно использовать как дополнительные. Пример:

<div class="shop-stuff shk-item">

Оформление заказа

Форма заказа делается при помощи сниппета eForm. При вызове этого сниппета обзательно указать параметры:

&eFormOnBeforeMailSent=`populateOrderData` - функция для заполнения данных о выбранных товарах.

Для того чтобы заказы отправлялись в модуль Shopkeeper, в вызов сниппета eForm добавить параметр &eFormOnMailSent=`sendOrderToManager`.

Пример вызова eForm:

[!eForm? &formid=`shopOrderForm`&tpl=`shopOrderForm`&report=`shopOrderReport`&vericode=`1`&ccsender=`1`&gotoid=`11`&subject=`Новый заказ`&eFormOnBeforeMailSent=`populateOrderData`&eFormOnMailSent=`sendOrderToManager`!]

Подключение системы оплаты

Для подключения системы оплаты (выписки квитанций и т.п.) можно сделать дополнительный сниппет, который может использовать переменные сессии, создаваемые после отправки заказа:

$_SESSION['shk_order_id'] - ID заказа в БД;
$_SESSION['shk_payment_method'] - выбранный способ оплаты (список с name="payment" в форме);
$_SESSION['shk_order_price'] - общая цена;
$_SESSION['shk_currency'] - валюта;
$_SESSION['shk_order_user_id'] - ID пользователя (если не зарегистрирован = 0);
$_SESSION['shk_order_user_email'] - адрес электронной почты плательщика (если не зарегистрирован).

События для создания плагинов

• OnSHKFrontendInit - инициализация сниппета Shopkeeper во внешней части.
• OnSHKChangeStatus - изменение статуса заказа.
• OnSHKOrderDescRender - вывод подробной информации о заказе в модуле.
• OnSHKMailApprovedForPayment - отправление письма при статусе "Принят к оплате". Плагин может добавлять в письмо доп. информацию ().
• OnSHKcartLoad - загрузка корзины (вывод информации в чанке &cartTpl - ).
• OnSHKstatusSendMail - отправка письма о смене статуса.
• OnSHKmodRenderTopLinks - вывод ссылок вверху в модуле Shopkeeper.
• OnSHKmodPagePrint - вывод страницы модуля. Можно использовать для создания своей страницы (см. пример OnSHKmodPagePrint_plugin_example.txt).
• OnSHKbeforeSendOrder - перед отправкой заказа. Можно использовать для изменения полей ($fields).
• OnSHKsaveOrder - сохранение заказа.
• OnSHKcalcTotalPrice - расчет общей стоимости.

В папке shopkeeper/docs/ есть примеры плагинов.

"Сallback-функции" на JavaScript

setCartActionsCallback - перезагрузка корзины,
fillCartCallback - добавление товара в корзину,
emptyCartCallback - очищение корзины.

Просто создайте функции с такими именами и они будут вызываться при соответствующих действиях.

Две и более цены для одного товара

Для этого нужно создать две или более формы (<form>) и в поле name="shk-id" после ID написать имя TV с ценой.

Пример:

<input type="hidden" name="shk-id" value="[+id+]__price2" />

При submit формы в корзину добавится цена из TV-параметра с именем "price2".

Добавление в корзину данных, не создавая TV-параметры

Пример:

<input type="text" name="test__[*id*]__add" value="дополнительные данные" />

В корзину добавится параметр, который можно выводить в месте вставки плейсхолдера (выведется "дополнительные данные").

Товары в каталоге Shopkeeper

Можно сохранять товары в отдельльную таблицу БД (не документы). При хранении товаров в отдельной таблице можно забыть про ограничение на число документов MODx. При этом остается возможность использовать стандартные TV-параметры для товаров и плагины. Для создания и редактирования товаров используется стандартный интерфейс (можно настраивать с помощью плагина ManagerManager). Для вывода товаров на сайте используется сниппет catalogView (см. snippets/catalogView/readme.txt).

Товары можно "вложить" в любой документ (категорию), выбрав в дереве документов. Т.е. категории каталога (структура) создается как и раньше документами MODx, но сами товары будут храниться в отдельной таблице БД.

Если товар из каталога Shopkeeeper, в чанк товара (сниппет catalogView) нужно вставить скрытое поле:

<input type="hidden" name="shk-catalog" value="1" />

Чтобы в модуле Shopkeeper (в админке) появилась ссылка "Каталог", нужно в конфигурации указать ID категории каталога (документ MODx) по умолчанию.
Также необходимо настроить конфигурацию плагина SaveToSHK — указать ID шаблона товаров и ID TV-параметра цены.

Важно!

• На странице формирования заказа сниппет Shopkeeper должен вызываться раньше eForm.
• В чанке формы заказа обязательно добавить скрытое поле
  <input type="hidden" name="reportTpl" value="shopOrderReport" />
  где shopOrderReport - это название чанка с шаблоном отчета (параметр &report сниппета eForm).
• Сниппет можно вызывать на странице несколько раз, но корзина выводится только в месте первого вызова. Второй и последующие вызовы игнорируются. Если у Вас корзина на страницах каталога товаров находится в правой колонке шаблона, а на странице оформления заказа вызов сниппета вставлен в контент страницы, то на этой странице корзина будет выведена только в ценральной колонке (в правой вызов сниппета можно не убирать).
• Рекомендуется использовать ЧПУ (семантические URL). В шаблонах сайта рекомендуется использовать <base href="http://i--gu.ru/" /> (внутри <head>) и относительные пути.
• Если чанки хранятся в файлах (используется команда @FILE:), проверьте кодировку этих файлов. Она должна быть такая же как у вашего сайта.
• Рекомендуется установить плагин PHx (http://modxcms.com/extras/package/?package=342).
  В чанке chunk_shopOrderFormWebUser.tpl для примера он используется для заполнения скрытых полей данными авторизованного пользователя.
• Для вывода корзины (сниппета) в разных местах рекомендуется создавать разные шаблоны для страниц или использовать плагин PHx.
• Если используется умножение цены товара на цену доп.параметра, в шаблоне информации о товаре (chunk_shopStuff.tpl и chunk_shopToCart.tpl) поле с ID товара (<input type="hidden" name="shk-id" value="1653" />) должно быть выше допюпараметров по HTML-коду.
• Рекомендуется имена TV-параметров и чанков писать на латинице.
• Рекомендованная кодировка - UTF-8.
• Для работы необходим PHP версии не позднее 5.0. На PHP 5.3 пока не тестировалось.

Все примеры прилагаются (папка shopkeeper/chunks/).

Примеры чанков в папке install/examples/

• chunk_shopCart.tpl - чанк корзины. Может быть использован как значение параметра &cartTpl при вызове Shopkeeper. Чанк содержит сразу 3 шаблона - для пустой, заполненной расширенной и простой корзины.
• chunk_shopCartRow.tpl - чанк шаблона строки с информацией товара в расширенной корзине.
• chunk_shopCartRow2.tpl - -//- пример с картинкой (TV - image) и условием PHx.
• chunk_shopStuff.tpl - чанк краткой информации о товаре. Может быть использован как значение параметра &tpl при вызове Ditto.
• chunk_shopStuff_2.tpl - -//- пример с двумя ценами для одного товара (продажа и прокат).
• chunk_shopToCart.tpl - может быть использован в шаблоне страницы подробного описания товара или можно вставлять вызов чанка в визуальный редактор.
• chunk_shopCartHelper.tpl - чанк шаблона "хелпера" - блока, который появляется для подтверждения действий.
• chunk_additDataTpl.tpl - шаблон для доп. параметров товаров в корзине.
• chunk_shopOrderForm.tpl - чанк форма оформление заказа. Может быть использован как значение параметра &tpl при вызове eForm.
• chunk_shopOrderFormWebUser.tpl - чанк форма оформление заказа для зарегистрированных пользователей.
• chunk_shopOrderReport.tpl - чанк письма с информацией о заказе. Может быть использован как значение параметра &report при вызове eForm.
• chunk_shopOrderReportWebUser.tpl - чанк письма с информацией о заказе для зарегистрированных пользователей.
• chunk_FormSignup.tpl - пример чанка с шаблоном формы регистрации для сниппета WebSignup.
• chunk_weblogin.tpl - пример чанка с шаблоном формы авторизации сниппета WebLogin.
• chunk_orderDataTpl.tpl - шаблон списка товаров в отчете о заказе ()

Виджеты для параметров товаров

Для создания виджетов (выпадающий список, радиокнопка, чекбокс) используется модификатор PHx - shk_widget.

Предупреждение

Т.к. сниппет производит действия с базой данных (запись, чтение), это может быть опасно. Автор попытался защититься от наиболее распространенных методов взлома системы, но всё может быть... Вы используете этот код на свой страх и риск. Автор не несет ответственности за последствия.