bda.plone.orders · PyPI · Python 包索引

bda.plone.shop的订单持久化和后台UI

这些详细信息尚未由PyPI验证

项目描述

https://img.shields.io/badge/code%20style-black-000000.svg

https://travis-ci.org/bluedynamics/bda.plone.orders.svg?branch=master

安装

此软件包是堆栈的一部分。请参阅https://github.com/bluedynamics/bda.plone.shop以获取安装说明。

集成说明

订单操作通过CSS中的背景图像完成，因此如果您有自己的非Sunburst主题，您将需要添加Sunburst的base.css中的“icons.on”部分。

定制订单

如果您已将自定义字段添加到结账（请参阅bda.plone.checkout），那么您很可能希望将它们添加到订单电子邮件、订单摘要或订单导出中。

请首先遵循bda.plone.shop Readme中的《定制商店》中的说明来设置补丁基础设施。

之后，您可以开始定制订单流程

def patchShop():
    patchMailTemplates()
    patchOrderExport()

邮件通知

订单相关的通知是通过发送包含文本和HTML版本的通告有效负载的多部分邮件完成的。

在自定义邮件通知时，需要自定义文本和HTML模板。

警告

自 bda.plone.orders 1.0a1 版本起，bda.plone.orders.MailNotify.send 函数的签名已更改。现在它接受 subject、receiver 和 text 作为位置参数，以及可选的 html 参数。

HTML 模板

默认的 HTML 模板位于 bda.plone.orders:mailtemplates。要自定义它们，将整个模板文件夹复制到您的集成包中，并像这样修补 bda.plone.orders.mailnotify.MAIL_TEMPLATES_DIRECTORY

from bda.plone.orders import mailnotify
import os

mailnotify.MAIL_TEMPLATES_DIRECTORY = os.path.join(
    os.path.dirname(__file__),
    'mailtemplates'
)

文本模板

将您需要定制的消息从 bda.plone.orders.mailtemplates 复制过来，并根据您的需求更改文本。有两个字典包含所有字符串，分别是 ORDER_TEMPLATES 和 RESERVATION_TEMPLATES。这是一个嵌套字典。第一层是语言代码，第二层是 subject、body 和 delivery_address。更改它们，例如如下所示

from bda.plone.orders.mailtemplates import ORDER_TEMPLATES
from bda.plone.orders.mailtemplates import RESERVATION_TEMPLATES

ORDER_TEMPLATES['en']['body'] = """
This is my heavily customized confirmation mail."""

RESERVATION_TEMPLATES['de']['body'] = "Ihre Reservierung ist da!"

当更新 bda.plone.order 到新版本时，请确保与原始模板保持同步，并检查所有库存变量（如 global_text 或在版本 0.4 中添加的 @@showorder 链接）是否都存在。

自定义通知机制

或者，您可以添加/替换通知方法，并实现自己非常定制的版本。为此，提供两个类似于 bda.plone.orders.mailnotify.notify_checkout_success 和 bda.plone.orders.mailnotify.notify_payment_success 的函数。然后

from bda.plone.orders.mailnotify import NOTIFICATIONS

# register as additional action
NOTIFICATIONS['checkout_success'].append(my_notify_checkout_success)
NOTIFICATIONS['payment_success'].append(my_notify_payment_success)

# OR
# register as replacement:
NOTIFICATIONS['checkout_success'] = [my_notify_checkout_success]
NOTIFICATIONS['payment_success'] = [my_notify_payment_success]

订单导出

要使新字段在导出中显示，只需将其添加到列表 ORDER_EXPORT_ATTRS 中。

在此示例中，我们在公司名称后添加了公司 uid，以便自定义 bda.plone.checkout

from bda.plone.orders.browser.export import ORDER_EXPORT_ATTRS

def patchOrderExport():
    idx = ORDER_EXPORT_ATTRS.index('personal_data.company')
    ORDER_EXPORT_ATTRS.insert(idx+1, 'personal_data.uid')

订单详情

要显示新字段的订单详情视图中的数据，请使用 z3c.jbot 或通过为您策略包的 browserlayer 或 themelayer 注册浏览器页面来自定义 bda/plone/orders/browser/templates/order.pt

<browser:page
  for="zope.component.interfaces.ISite"
  name="order"
  template="my-order.pt"
  class="bda.plone.orders.browser.order.OrderView"
  permission="bda.plone.orders.ViewOrders"
  layer="my.package.interfaces.IMyBrowserLayer"/>

警告

从 bda.plone.orders 1.0a1 版本开始，模板位置从浏览器包更改为浏览器包中的模板文件夹。请根据您在集成包中通过 z3c.jbot 自定义模板的位置进行调整。

发票视图

发票模板是 bda/plone/orders/browser/templates/invoice.pt。它可以通过 z3c.jbot 或通过为您策略包的 browserlayer 或 themelayer 注册浏览器页面来自定义。

<browser:page
  for="zope.component.interfaces.ISite"
  name="invoice"
  template="my-invoice.pt"
  class="bda.plone.orders.browser.invoice.InvoiceView"
  permission="bda.plone.orders.ViewOrders"
  layer="my.package.interfaces.IMyBrowserLayer" />

与 souper.plone 的限制

请确保您不要将订单或预订从门户网站根目录中移动出去。这会导致意外的行为和错误。

供应商支持

bda.plone.orders 支持供应商的概念。供应商能够管理自己的产品，并查看与这些产品相关的订单和预订。

供应商有一个自己的区域，这是门户网站中的某个位置的容器。要启用容器的供应商支持，导航到该容器，并对其应用“启用供应商区域”操作。然后导航到该容器的本地角色管理视图，并将 Vendor 角色授予所需用户。

被授予 Vendor 角色的用户现在能够在此容器的上下文中查看与订单相关的视图并执行与订单相关的操作。

权限

通常，定制商店部署可能根据其用例配置权限和角色设置。

权限 bda.plone.orders.ViewOrderDirectly 和 bda.plone.orders.ViewOwnOrders 被授予默认的 Plone 角色，而不是客户角色。客户角色应作为本地角色上下文相关地授予。《@@orders》、《@@showorder》和《@@showinvoice》视图应在 ISite 根上可调用。因此，可能的客户可能是网站根目录上的非客户。

以下为权限及其目的的列表

bda.plone.orders.ViewOrderDirectly

授予查看与单个订单数据相关的视图的访问权限，这些视图受 ordernumber 和相关电子邮件地址的保护。

目前订单详情和发票已作为此类视图实现。在成功结账后，这些视图的链接将通过订单确认邮件发送。

默认情况下，此权限设置为以下角色

管理员
网站管理员
已认证用户

为了默认情况下向所有访客公开这些视图，请通过您的集成包的通用设置的 rolemap.xml 添加匿名角色。

bda.plone.orders.ViewOwnOrders

授予查看当前认证用户制作的订单的权限。

默认情况下，此权限设置为以下角色

管理员
网站管理员
已认证用户