Products.ExtendedPathIndex 4.0.1

简介

这是一个Zope目录索引，用于通过路径查询ZODB中的树状结构。它支持深度限制，并且具有构建可用于导航树和网站图的结构的 ability。实际的导航树实现不（也不应该）在这个包中。这仅是索引实现。

假设

EPI关于目录和索引与所有内容位于同一容器中做出了假设。这在Plone设置中非常有意义，但在其他场景中可能不会按预期工作。

像/plonesite/folder, level=0这样的查询在内部被转换为/folder, level=1。这避免了触摸包含指向您网站中所有内容引用的相当大的plonesite集合。

功能

• 可以使用单个目录查询构建网站图

• 可以使用单个目录查询构建导航树

配置

在GenericSetup配置文件中，提供以下片段以创建索引

<index
    meta_type="ExtendedPathIndex"
    name="my_path">
  <extra
      name="indexed_attrs"
      value="my_path"
  />
</index>

对于多值路径，提供一个额外的（关闭不必要的优化）

<index
    meta_type="ExtendedPathIndex"
    name="my_path">
  <extra
      name="indexed_attrs"
      value="my_path"
  />
  <extra
      name="multi_valued"
      value="True"
  />
</index>

具有每个路径元素多个值的索引示例：想象一下索引多语言内容。每个项目都被翻译，并且所有翻译的项目共享一个共同的唯一标识符（这就是plone.app.multilingual的工作方式）。现在创建一个返回此唯一标识符而不是项目ID作为路径元素的索引器。通过这种方式，可以一次查询文件夹中所有语言的所有元素（有关此模式的更高级用法，请参阅plone.app.multilingualindexes）。

用法

catalog(path='some/path')

在some/path下搜索所有对象（递归，相当于深度=-1）

catalog(path=dict(query='some/path', depth=0))

搜索给定路径的对象。对于多值路径，返回多个对象。

catalog(path=dict(query='some/path', depth=2))

搜索some/path下的所有对象，但只到深度2

catalog(path=dict(query='some/path', navtree=True))

搜索some/path下的所有对象以用于渲染导航树。这包括some/path下的所有对象，以及所有父对象，直到深度1。

catalog(path=dict(query='some/path', navtree=True, depth=0))

搜索some/path下的所有对象以用于渲染面包屑导航。这仅包括父对象本身。

catalog(path=dict(query='some/path', navtree=True, navtree_start=1))

搜索some/path下的所有对象以用于渲染部分导航树。这包括路径下的所有对象，但停止在根级别之上1级。给定的路径被包含在内，即使它在门户中的路径比级别参数允许的更短。

catalog(path=dict(query='some/path', navtree=True, depth=0, navtree_start=1))

在某个路径下搜索所有对象以渲染部分面包屑路径。这包括路径下的所有父级，但停止在根目录之上的一级。即使给定路径在门户中的级别低于起始参数允许的级别，也会将其包含在内。

catalog(path=dict(query='some/path', level=2))

搜索所有路径包含some/path且位于第2级的对象。这包括路径如/foo/bar/some/path和/spam/eggs/some/path，以及这些路径的所有子路径。

catalog(path=dict(query='some/path', level=-1, depth=0))

搜索所有路径包含some/path且位于任何级别的对象。这包括路径如/spam/some/path以及/foo/bar/baz/some/path，但由于深度设置为0，只有那些精确匹配的结果被包含在内。

catalog(path=dict(query=(('foo/bar', 2), ('bar/baz'), 1), depth=0))

搜索多个路径，每个路径位于不同的级别（foo/bar在第2级，bar/baz在第1级），并且只返回精确匹配的结果。

致谢

• 初始PathIndex代码由Zope Corporation提供

• 来自Jarn的Helge Tesdal和Martijn Pieters实现了ExtendedPathIndex

• Alec Mitchell对navtree和列表优化做出了贡献

许可证

本软件基于GPLv2许可证发布。

变更日志