lispa/amos-report

此包最新版本(1.2.1)没有提供许可证信息。

AMOS 报告系统

1.2.1 2023-05-23 11:20 UTC

This package is auto-updated.

Last update: 2024-09-23 14:13:18 UTC


README

#Amos Report

用于新闻、讨论等内容发送报告的扩展...

安装

  1. 安装此扩展的首选方式是通过 composer

运行以下命令之一:

composer require open20/amos-report

或添加此行到您的 composer.json 文件的 require 部分中。

"open20/amos-report": "dev-master"

将模块添加到后端的主配置文件中

  1. 为了将报告通知发送给内容创建者和内容验证者,还需要安装 amos-workflow

    'modules' => [
        'comments' => [
            'class' => 'open20\amos\report\AmosReport',
            'modelsEnabled' => [
                /**
                 * Add here the classnames of the models for whose you want to enable reports
                 * (i.e. 'open20\amos\news\models\News')
                 */
            ]
        ],
    ],
  2. a. 将工作流添加到 composer

    b. 在 config/main 中检查 modules 数组中的 'workflow',如果存在

    "open20/amos-workflow": "dev-master"
    

    c. 修改以下条目

    'workflow' => [
        'class' => 'cornernote\workflow\manager\Module',
    ],

    d. 添加工作流条目(config/main 中的 modules 数组)

    'workflow-manager' => [
        'class' => 'cornernote\workflow\manager\Module',
    ],

    e. 将 'workflow' 条目添加到您的 bootstrap 中

    'workflow' => [
        'class' => 'open20\amos\workflow\AmosWorkflow',
    ],

    应用迁移

    'bootstrap' => [
        .
        .
        .
        'workflow',
        .
        .
        .
    ],
  3. a. amos-report 迁移

    或添加此行到您的控制台中的迁移配置

    php yii migrate/up --migrationPath=@vendor/open20/amos-report/src/migrations

    b. 如果已安装工作流模块(见步骤 3),也添加 amos-workflow 迁移

    return [
        .
        .
        .
        '@vendor/open20/amos-report/src/migrations',
        .
        .
        .
    ];

    小部件

    php yii migrate/up --migrationPath=@vendor/open20/amos-workflow/src/migrations

    b. 如果已安装工作流模块(见步骤 3),也添加 amos-workflow 迁移

    return [
        .
        .
        .
        '@vendor/open20/amos-workflow/src/migrations',
        .
        .
        .
    ];

Amos Report 提供了两个小部件

Amos Report 提供了两个小部件

  • ReportWidget open20\amos\report\widgets\ReportWidget
    绘制与模型相关的旗帜图标。点击旗帜时,系统在模态弹出窗口中打开表单以插入新的报告。

  • TabReportsWidget open20\amos\report\widgets\TabReportsWidget
    在一个模型视图/表单中绘制报告标签,包含特定内容的报告列表。
    如果模型已启用报告,标签将自动通过 AmosCore 小部件 'Tabs' 注入更新阶段(表单)。

电子邮件发送

在内容上创建新的报告后,会向以下位置发送电子邮件:

  • 内容创建者
  • 内容验证者(如果存在)
  • 拥有该内容类型的 REPORT_MONITOR 角色的用户(如果角色存在)
    角色名称必须遵循一般权限命名约定 _REPORT_MONITOR,例如创建和更新权限(MODELNAME_CREATE, MODELNAME_UPDATE)。