冷招数/csv_exporter

导出所有可搜索实体为CSV

v12.0 2024-06-28 06:42 UTC

README

Elgg 6.0 Lint Checks Latest Stable Version License

此插件允许您将所有可搜索实体导出为CSV。

如何使用

作为管理员,前往管理部分。在管理 -> 工具中,您可以找到CSV导出菜单项。

通过几个简单步骤,您可以选择CSV内容。

  1. 选择您想要导出的内容(用户、组、博客等)
  2. 选择您想要导出的内容后,您可以选择要包含的列
  3. 现在您可以点击预览来检查这是否是您想要导出的内容
    或者您可以点击下载CSV将所有内容导出到CSV文件

开发者

默认情况下,所有可搜索实体都是可导出的,但如果您想更改此列表,请使用事件

elgg_register_event_handler("allowed_type_subtypes", "csv_exporter", "your function");

并更改结果数组。

您可以通过注册事件将自定义值添加到可用列表中,如下所示

elgg_register_event_handler("get_exportable_values", "csv_exporter", "your function");

此事件获取以下参数

  • type: 为提供值的实体类型
  • subtype: 为提供值的实体子类型
  • readable: true|false,如果 true,则结果必须是一个格式为 array(label => value) 的关联数组,这用于向用户显示复选框。
    如果 false,则只需将值作为数组的一部分返回(例如,array(value))。

为了导出正确的值,您还必须注册一个事件

elgg_register_event_handler("export_value", "csv_exporter", "your function");

此事件获取以下参数

  • type: 为提供值的实体类型
  • subtype: 为提供值的实体子类型
  • entity: 要导出值的实体
  • exportable_value: 要导出的值

如果您返回的任何内容不是 null,则将使用此值,否则系统将尝试获取 exportable_value 作为元数据字段。

为了允许群组管理员导出基本信息,请使用以下事件添加配置

elgg_register_event_handler("get_exportable_values:group", "csv_exporter", "your function");

此事件获取以下参数

  • type: 为提供值的实体类型
  • subtype: 为提供值的实体子类型

返回一个数组,其中 [value]

  • value: 与 get_exportable_valuescsv_exporter 事件中的名称相同