archetypes.schemaextender 3.0.2

简介

此包允许您使用简单适配器修改 Archetypes 架构。这可以用来添加新字段、重新排序字段和字段集，或者进行其他更改。

架构扩展的最常见用途是允许附加产品增强标准 Plone 内容类型，例如添加一个可以设置以切换特殊行为的选项。

schemaextender 通过为 BaseContent 和 BaseFolder 注册 ISchema 适配器，挂载到 Archetypes 框架中，使其负责为所有从这些类派生的类型提供架构。这包括所有标准 Plone 内容类型。由于只有一个 ISchema 适配器可以激活，schemaextender 提供了使用命名适配器修改架构的自身机制。命名适配器允许为每个适配的接口注册多个 schemaextender。

有以下三种类型的适配器可用

• ISchemaExtender：使用此适配器可以向架构添加新字段。

• IOrderableSchemaExtender：此适配器既可以使您添加新字段，也可以重新排序字段。这比仅仅添加新字段代价更高。

• IBrowserLayerAwareExtender：此适配器利用 plone.browserlayer，因此扩展器仅在注册了特定层时才可用。

• ISchemaModifier：这是一个低级钩子，允许直接操作架构。这可能非常危险，如果不清楚自己在做什么，则永远不应使用！

适配器类型在 archetypes.schemaextender 的 'interfaces.py' 文件中有文档。

简单示例

例如，我们将向标准 Plone 文档类型添加一个简单的布尔字段。首先我们需要创建一个字段类

from Products.Archetypes.public import BooleanField
from archetypes.schemaextender.field import ExtensionField

class MyBooleanField(ExtensionField, BooleanField):
    """A trivial field."""

由于标准 Archetypes 字段依赖于生成访问器和修改器方法的类生成逻辑，schemaextender 不能直接使用它们。通过使用 ExtensionField 混入类，我们仍然可以使用它们。确保 ExtensionField 混入类排在第一位，以便正确覆盖标准方法。

接下来，我们需要创建一个适配器，用于添加此字段

from zope.component import adapts
from zope.interface import implements
from archetypes.schemaextender.interfaces import ISchemaExtender
from Products.Archetypes.public import BooleanWidget
from Products.ATContentTypes.interfaces import IATDocument

class PageExtender(object):
    adapts(IATDocument)
    implements(ISchemaExtender)


    fields = [
        MyBooleanField("super_power",
        widget = BooleanWidget(
            label="This page has super powers")),
            ]

    def __init__(self, context):
        self.context = context

    def getFields(self):
        return self.fields

尝试在类中存储字段，这样它们就不会在每次调用 getFields 方法时创建。通常，您应该确保 getFields 执行尽可能少的工作，因为它会被频繁调用。

最后一步是将此适配器注册到 Zope 组件架构中。由于我们已声明我们提供的接口和要适配的对象类型，因此可以在 configure.zcml 中非常快速地完成此操作（假设您将上述代码放在一个名为 extender.py 的文件中）

<configure xmlns="http://namespaces.zope.org/zope"
           xmlns:five="http://namespaces.zope.org/five">

    <include package="archetypes.schemaextender" />
    <adapter factory=".extender.PageExtender" />
</configure>

自定义字段

如果您想，也可以创建更复杂的字段类型。唯一的要求是您的字段类型需要以 ExtensionField 作为第一个父类。以下是一个在对象上切换标记接口的字段示例。

from zope.interface import Interface
from zope.interface import alsoProvides
from zope.interface import noLongerProvides
from Products.Archetypes.public import BooleanField
from archetypes.schemaextender.field import ExtensionField

def addMarkerInterface(obj, *ifaces):
    for iface in ifaces:
        if not iface.providedBy(obj):
            alsoProvides(obj, iface)


def removeMarkerInterface(obj, *ifaces):
    for iface in ifaces:
        if iface.providedBy(obj):
            noLongerProvides(obj, iface)


class ISuperPower(Interface):
    """Marker interface for classes that can do amazing things."""


class InterfaceMarkerField(ExtensionField, BooleanField):
    def get(self, instance, **kwargs):
        return ISuperPower.providedBy(instance)

    def getRaw(self, instance, **kwargs):
        return ISuperPower.providedBy(instance)

    def set(self, instance, value, **kwargs):
        if value:
            addMarkerInterface(instance, ISuperPower)
        else:
            removeMarkerInterface(instance, ISuperPower)

层感知示例

通过使用 archetypes.schemaextender.IBrowserLayerAwareExtender，扩展器仅在站点安装了特定浏览器层时才应用。

以下是一个示例 extender.py，它将新字段添加到 日期 编辑标签页上

"""

    Retrofit re-review dates to Archetypes schema.

"""

__docformat__ = "epytext"

from zope.component import adapts
from zope.interface import implements

from Products.Archetypes.public import BooleanWidget
from Products.ATContentTypes.interfaces import IATDocument
from Products.Archetypes import public as atapi
from Products.Archetypes.interfaces import IBaseContent

from archetypes.schemaextender.field import ExtensionField
from archetypes.schemaextender.interfaces import (
  ISchemaExtender, IOrderableSchemaExtender, IBrowserLayerAwareExtender)

# Your add-on browserlayer
from your.package.interfaces import IAddOnInstalled

class ExtensionDateField(ExtensionField, atapi.DateTimeField):
    """ Retrofitted date field """


class RevisitExtender(object):
    """ Include revisit date on all objects.

    An example extended which will create a new field on Dates
    tab between effective date and expiration date.
    """

    # This extender will apply to all Archetypes based content
    adapts(IBaseContent)

    # We use both orderable and browser layer aware sensitive properties
    implements(IOrderableSchemaExtender, IBrowserLayerAwareExtender)

    # Don't do schema extending unless our add-on product is installed on Plone site
    layer = IAddOnInstalled

    fields = [
        ExtensionDateField("revisitDate",
            schemata="dates",
            widget = atapi.CalendarWidget(
                label="Review Date",
                description=(u"When this date is reached, the content "
                             u"will be visible in the review task list"),
                show_hm=False,
            ),
        )
    ]

    def __init__(self, context):
        self.context = context

    def getOrder(self, schematas):
        """ Manipulate the order in which fields appear.

        @param schematas: Dictonary of schemata name -> field lists

        @return: Dictionary of reordered field lists per schemata.
        """
        schematas["dates"] = ['effectiveDate', 'revisitDate', 'expirationDate',
                              'creation_date', 'modification_date']

        return schematas

    def getFields(self):
        """
        @return: List of new fields we contribute to content.
        """
        return self.fields

注意：由于上述示例在其 implements 行中有两个接口，您的 Zope 实例启动时将会出错

TypeError: Missing 'provides' attribute

这意味着我们需要在我们的 zcml 配置中更加明确，并指定我们的适配器提供了哪两个接口之一

<adapter factory=".extender.RevisitExtender"
    provides="archetypes.schemaextender.interfaces.ISchemaExtender" />

变更日志