Параметры

02 июля 2016, 11:54

Компонент предназначен для подготовки и вывода документов с информацией о заказах в формате pdf удобном для распечатки. Полезен, если нужно напечатать, к примеру счет-фактуру или наряд курьеру на доставку заказанной продукции. Компонент позволяет пользователю самостоятельно настроить шаблоны документов, указать необходимые данные, которые можно будет использовать во всех шаблонах (к прмеру название компании, ИНН или имя бухгалтера). Основной особенностью OrderPrint является то, что он умеет работать как с MiniShop2, так и с Shopkeeper. Переключить тип магазина можно в настройках системы (по умолчанию компонент настроен на MiniShop2, и при переключении стандартные шаблоны документов нужно будет немного изменить для правильного вывода документов).

Основные особенности:

  • возможность работать как с MiniShop2, так и с Shopkeeper
  • "из коробки" доступно 4 распространенных типа документов (счет-фактура, счет, заявка на склад и наряд курьеру настроенных под MiniShop2, для использования с ShopKeeper нужно будет заменить плейсхолдеры в шаблонах)
  • возможность добавлять не ограниченное количество документов
  • возможность добавлять свои параметры для вывода в документах (например название компании)
  • использование для шаблонизации документов обычные и привычные механизмы MODX - чанки
  • для каждого документа Вы можете назначить 2 чанка: шаблон всего документа и шаблон строки с информацией о товаре из заказа, кроме того можно указать ориентацию листа при печати (альбомная или книжная) и поля (отступы)
  • любой документ можно сделать доступным для пользователей сайта, и дать им возможность распечатывать такие документы прямо из личного кабинета (по большому счету хоть с главной, где вызовите сниппет, там и будут ссылки на печать)
  • позволяет печатать только свои заказы. Возможность полного доступа есть только у членов группы "Администраторы"
  • для формирования PDF используется библиотека TCPDF
  • "из коробки" доступны только основные шрифты, при необходимости использовать шрифт, который не включен в пакет, Вы можете скачать архив со всеми доступными шрифтами на сайте разработчика библиотеки TCPDF. Скачанный архив нужно распаковать и загрузить файлы из папки fonts в папку assets/components/orderprint/pdf/tcpdf/fonts/ вашего сайта.

Настройка для работы с компонентом магазина

По умолчанию OrderPrint настроен на работу с MiniShop2. Если на Вашем сайте используется Shopkeeper, для использования OrderPrint необходимо изменить системную настройку opr_type ("Магазин" в разделе "orderprint") на "shk". Кроме того многие плейсхолдеры станут недоступными а появятся другие, это сделано для максимально удобной работы с тем магазином к которому Вы привыкли, к примеру в шаблоне строки таблицы товаров для MS2 доступен плейсхолдер [[+thumb]], которого просто нет в SHK, зато для него можно использовать ТВ image значение которой попадет в плейсхолдер [[+tv_add.image]]. Это значит что в шаблонах нужно будет заменить теги спецефичные для MS2 тегами SHK.

Документы

  • название
  • описание
  • основной шаблон - имя чанка, который будет использоваться как шаблон всего документа
  • шаблон строки таблицы товаров - имя чанка, который будет использоваться для вывода отдельного товара в таблицу со списком покупок в заказе, если не указать то таблица формироваться не будет
  • доступен для пользователей - если установить ДА то пользователи получат доступ для того чтобы распечатать свои заказы в виде данного документа прямо из фронтэнда сайта.
  • альбомная ориентация - ДА/НЕТ
  • отступы - поля документа через запятую, начиная с верхнего.

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

Чтобы напечатать документ достаточно просто на вкладке "Заказы" кликнуть по интересующему Вас заказу правой кнопкой мыши и в выпадающем меню выбрать нужный документ.

Параметры

Помимо данных полученных из заказа и параметров системы в шаблонах документов Вы можете использовать также и дополнительные параметры OrderPrint-а. Это полезно если, к примеру, нужно выводить в документ данные, которых нет нигде в системе (ИНН, имя руководителя, имя курьера или название банка, всё что угодно).

Перейдя на вкладку "Параметры" Вы сможете управлять дополнительными параметрами, изменять, удалять, создавать сколько угодно новых. Каждый такой параметр имеет следующие поля:

  • ключ - ключ параметра, подобно ключам системных настроек. Если создан параметр с ключом mycustomkey, его значение можно будет выводить в шаблонах документов так[[+mycustomkey]]
  • значение
  • описание

Вывод ссылок для печати во фронтэнде

Для того чтобы вывести ссылки пользователям сайта в компонент включен сниппет orderPrint. Доступны следующие параметры:

Параметр По умолчанию Описание
tpl orderPrint.LinkTpl имя чанка в который будут выводится ссылки.
orderId id заказа
docs все доступные для фронтэнда перечисленные через запятую id документов.