brookinsconsulting/ezpcontenttreereport

eZ Publish 旧版扩展，提供灵活的解决方案，可以快速简单地以 CSV 格式报告内容树内容对象的内容。非常适合管理报告！

维护者

详细信息

github.com/brookinsconsulting/ezpcontenttreereport

主页

源代码

问题

安装: 6

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 3

分支: 1

开放问题: 0

类型:ezpublish-legacy-extension

dev-master 2015-07-09 04:11 UTC

Requires

GPL-2.0+ ad2091f66da7f9a2fe1cebdeb3abc66ee3263fbd

reportez publishcontent treecontent trees

This package is auto-updated.

Last update: 2024-09-29 04:54:59 UTC

README

本扩展提供灵活的解决方案，可以快速简单地以 CSV 格式报告内容树内容对象的内容。

版本

  • eZp 内容树报告的当前版本是 0.1.4

  • 上次主要更新：2015年6月6日

版权

  • eZp 内容树报告版权所有 © 1999 - 2016 Brookins Consulting 和 2013 - 2016 Think Creative

  • 更多信息请参阅：COPYRIGHT.md

许可证

eZp 内容树报告遵循 GNU 通用公共许可证。

完整的许可证协议包含在 LICENSE 文件中。

eZp 内容树报告是自由软件：您可以自由地重新分发和/或修改它，前提是您遵守自由软件基金会发布的 GNU 通用公共许可证的条款，无论是许可证的第2版还是您选择的任何后续版本。

eZp 内容树报告的重新分发希望它是有用的，但没有任何保证；甚至没有关于其适销性或特定用途适用性的暗示保证。有关详细信息，请参阅 GNU 通用公共许可证。

GNU GPL 在某些条件下赋予您使用、修改和重新分发 eZp 内容树报告的权利。GNU GPL 许可证与软件一起分发，请参阅文件 doc/LICENSE。

它也可在 https://gnu.ac.cn/licenses/gpl.txt 上找到。

您应该已经收到了与 eZp 内容树报告一起分发的 GNU 通用公共许可证副本，位于 doc/LICENSE 中。如果没有，请参阅 https://gnu.ac.cn/licenses/。

根据 GNU GPL 许可使用 eZp 内容树报告是免费的（即自由）。

如需更多信息或提问，请联系： license@brookinsconsulting.com

需求

使用 eZp 内容树报告扩展需要以下需求

eZ Publish 版本

  • 确保您使用 eZ Publish 版本 5.x（必需）或更高版本。

  • 与 eZ Publish 平台 5.4 设计和测试

PHP 版本

  • 确保您有 PHP 5.x 或更高版本。

功能

本解决方案提供以下功能

  • 命令行脚本

  • Cronjob

  • 模块视图

依赖关系

本解决方案仅依赖于 eZ Publish 旧版

安装

通过 Composer 进行捆绑安装

从您的项目根目录运行以下命令以安装捆绑包

bash$ composer require brookinsconsulting/ezpcontenttreereport dev-master;

扩展激活

通过将以下内容添加到您的 settings/override/site.ini.append.php 来激活此扩展

[ExtensionSettings]
# <snip existing active extensions list />
ActiveExtensions[]=ezpcontenttreereport

清除缓存

清除 eZ Publish 平台/ eZ Publish 旧版缓存（必需）。

php ./bin/php/ezcache.php --clear-all;

设置自定义

本扩展提供了一些设置，这些设置会影响报告生成过程。

首先创建一个文件 ezpcontenttreereport.ini.append.php 的设置覆盖（全局、站点访问或扩展）。

然后根据需要自定义设置。

必需设置

此解决方案只需自定义一个设置，即 AdminUserSiteAccessName。

您需要在 AdminUserSiteAccessName 设置变量中设置您的管理员站点访问名称。

这是必需的，因为解决方案使用此内容在管理员站点访问范围内运行报表生成，而这对于整个解决方案正确运行也是必需的。

可选设置

您可以通过配置 ContentTreeNodeIDs[] 设置数组内容来自定义要包含在报表中的内容树节点。

您可以通过配置 ExcludedParentNodeIDs[] 设置数组内容来排除内容树子树。

您可以通过配置 ClassFilterType 设置变量和 ClassFilterArray[] 设置数组内容来包含或排除内容类。

您可以通过配置 ExcludeHiddenNodes 设置变量来排除隐藏节点。

您可以通过配置 ContentObjectAttributes[] 设置数组内容来自定义生成的报表以包含额外的自定义配置的内容对象属性内容。

以下是期望/必需用于 ContentObjectAttributes[] 设置数组内容的格式示例

ContentObjectAttributes[]=class_identifier;class_attribute_identifier;datatype_attribute_identifier;CSV Header Text Description

以下是 ContentObjectAttributes[] 设置数组内容的几个示例用法

ContentObjectAttributes[]=folder;forward;content;Forward to Legacy / DocStudio
ContentObjectAttributes[]=folder;forwarding_path;content;DocStudio Forwarding Path
ContentObjectAttributes[]=file;file;original_filename;File Filename
ContentObjectAttributes[]=image;image;original_filename;Image Filename

注意：内容类、内容类属性和数据类型属性标识符必须是小写，但 CSV 标题文本描述可以是混合大小写（可能应该这样，因为其他 CSV 标题字段也使用了首字母大写和混合大小写的文本字符串）。

ContentObjectAttributes[] 属性使用参考文档

您可以使用此设置中可能使用的任何属性/数据类型。

以下是有关在内容对象和数据类型（关于标识符）中使用的上述设置值的文档。

使用方法

该解决方案默认配置为虚拟安装后即可工作。

使用方法 - 命令行脚本

注意：此脚本必须仅使用管理员站点访问运行！

切换到 eZ Publish 网站文档根目录

cd path/to/ezpublish/ezpublish_legacy/;

运行脚本以生成报表

php ./extension/ezpcontenttreereport/bin/php/ezpcontenttreereport.php -s site_admin;

在 LibreOffice 中作为电子表格查看生成的报表

less var/site/cache/ezpcontenttreereport_-_2015_06_06_-_09_02_43.csv;

使用方法 - Cronjob

切换到 eZ Publish 网站文档根目录

cd path/to/ezpublish/ezpublish_legacy/;

手动运行 cronjob 以生成报表

php ./runcronjobs.php ezpcontenttreereportgenerate;

在 LibreOffice 中作为电子表格查看生成的报表

less var/site/cache/ezpcontenttreereport_-_2015_06_06_-_09_02_43.csv;

使用方法 - 模块

模块视图是可选的，但通常是内容编辑管理员使用此解决方案的默认方式

可以使用模块视图进行简单的报表再生和报表下载

使用以下 URI 访问模块视图

http://admin.example.com/contenttreereport/report

故障排除

阅读常见问题解答

某些问题比其他问题更常见。最常见的问题列在 doc/FAQ.md 中

支持

如果您发现此文档或常见问题解答未处理的问题，您可以通过支持系统联系 Brookins Consulting：http://brookinsconsulting.com/contact