collective.dexteritytextindexer 2.4.1

简介

collective.dexteritytextindexer 为dexterity内容类型提供了一个动态可搜索文本索引器。它使得将多个行为字段的索引作为可搜索文本成为可能。

用法

要启用索引器，只需将行为添加到您的内容类型的行为列表中。

在您的 profiles/default/types/YOURTYPE.xml 中添加行为

<?xml version="1.0"?>
<object name="example.conference.presenter" meta_type="Dexterity FTI"
   xmlns:i18n="http://xml.zope.org/namespaces/i18n"
   i18n:domain="example.conference">

 <!-- enabled behaviors -->
 <property name="behaviors">
     <element value="collective.dexteritytextindexer.behavior.IDexterityTextIndexer" />
 </property>

</object>

现在您需要标记您希望在 SearchableText 中出现的字段。这可以通过指令来完成

from collective import dexteritytextindexer
from plone.autoform.interfaces import IFormFieldProvider
from plone.supermodel.model import Schema
from zope import schema
from zope.interface import alsoProvides

class IMyBehavior(Schema):

    dexteritytextindexer.searchable('specialfield')
    specialfield = schema.Text(title=u'Special field')

alsoProvides(IMyBehavior, IFormFieldProvider)

如果您想标记现有第三方行为中的字段，可以使用此实用函数来完成

from plone.app.dexterity.behaviors.metadata import ICategorization
from collective.dexteritytextindexer.utils import searchable

searchable(ICategorization, 'categorization')

title 和 description 在 plone.app.dexterity 的 IBasic 行为上默认标记为可搜索。对于标记为不再可搜索，有一个实用函数

from plone.app.dexterity.behaviors.metadata import IBasic
from collective.dexteritytextindexer.utils import no_longer_searchable

no_longer_searchable(IBasic, 'title')

或者，如果您将模型指定为 plone.supermodel XML 模型，您可以通过这种方式标记字段可搜索

<model xmlns="http://namespaces.plone.org/supermodel/schema"
       xmlns:indexer="http://namespaces.plone.org/supermodel/indexer">
  <schema based-on="plone.supermodel.model.Schema">

      <field name="specialfield" type="zope.schema.TextLine"
             indexer:searchable="true">
        <title>Special field</title>
      </field>

  </schema>
</model>

您的 SearchableText 索引器现在包括您在行为中的自定义字段，一旦您在内容类型中启用它，其中 IDexterityTextIndexer 行为也启用了。

注册自定义字段转换器

默认情况下，字段通过以显示模式渲染小部件并将结果转换为 text/plain 来转换为可搜索文本。但是，如果您需要以不同的方式转换自定义字段，您只需提供更具体的转换多适配器。

转换多适配器规范

接口:

collective.dexteritytextindexer.IDexterityTextIndexFieldConverter

区分器:

context, field, widget

示例

from collective.dexteritytextindexer.converters import DefaultDexterityTextIndexFieldConverter
from collective.dexteritytextindexer.interfaces import IDexterityTextIndexFieldConverter
from my.package.interfaces import IMyFancyField
from plone.dexterity.interfaces import IDexterityContent
from z3c.form.interfaces import IWidget
from zope.component import adapts
from zope.interface import implementer

@implementer(IDexterityTextIndexFieldConverter)
class CustomFieldConverter(DefaultDexterityTextIndexFieldConverter):
    adapts(IDexterityContent, IMyFancyField, IWidget)

    def convert(self):
         # implement your custom converter
         # which returns a string at the end
         return ''

ZCML

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

    <adapter factory=".converters.CustomFieldConverter" />

</configure>

已经有一个适配器用于正确转换 NamedFiles。只有当 plone.namedfile 安装时才会注册。

扩展索引数据

有时您需要通过存储在字段之外的数据扩展 SearchableText。您可以通过注册一个提供额外数据的命名适配器来实现

from collective import dexteritytextindexer
from zope.component import adapts
from zope.interface import implementer

implementer(dexteritytextindexer.IDynamicTextIndexExtender)
class MySearchableTextExtender(object):
    adapts(IMyBehavior)

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

    def __call__(self):
        """Extend the searchable text with a custom string"""
        return 'some more searchable words'

ZCML

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

    <adapter factory=".indexer.MySearchableTextExtender"
             name="IMyBehavior"
             />

</configure>

这是一个 命名 适配器！这使得可以在不同的行为接口上为同一对象注册多个扩展器。适配器的名称无关紧要，但建议使用行为名称（这可能减少冲突）。

如果您的行为有一个定义的工厂（不是属性存储），则需要定义一个标记接口，并在该标记接口上注册适配器（dexterity对象不提供不使用属性存储的行为接口）。

贡献者

(按出现顺序)

• Jonas Baumann

• Philippe Gross

• Lukas Graf

• Izhar Firdaus

• Sune Broendum Woeller

• Nejc Zupan

变更日志