escolalms/mattermost

Escola LMS Mattermost 集成。

0.1.5 2023-02-21 12:18 UTC

This package is auto-updated.

Last update: 2024-09-19 07:04:31 UTC


README

swagger codecov phpunit downloads downloads downloads Maintainability Test Coverage

它做什么

此包用于 Mattermost 集成。

它监听事件,然后为 Mattermost 和特定频道添加/移除用户,无论是标准用户还是管理员。

安装

  • composer require escolalms/mattermost

示例

您可以使用 Facade 配置此包

Config::set('mattermost.package_status', PackageStatusEnum::ENABLED);
Config::set('mattermost.servers.default.host', 'localhost');
Config::set('mattermost.servers.default.login', 'login');
Config::set('mattermost.servers.default.password', 'password');

/api/admin/config 端点

$this->actingAs($this->user, 'api')->json(
    'POST',
    '/api/admin/config',
    [
        'config' => [
            [
                'key' => 'mattermost.package_status',
                'value' => PackageStatusEnum::ENABLED,
            ],
            [
                'key' => 'mattermost.servers.default.host',
                'value' => 'localhost',
            ],
            [
                'key' => 'mattermost.servers.default.login',
                'value' => 'login',
            ],
            [
                'key' => 'mattermost.servers.default.password',
                'value' => 'password',
            ],
        ]
    ]
);

端点

所有端点均定义在 swagger

测试

运行 ./vendor/bin/phpunit 以运行测试。查看测试文件夹,因为它是一个很好的文档附录起点。测试详情 codecov phpunit

监听器

处理事件

  • EscolaLms\Auth\Events\AccountConfirmed => 将用户添加到 Mattermost
  • EscolaLms\Auth\Events\AccountDeleted => 从 Mattermost 中移除用户
  • EscolaLms\Auth\Events\AccountBlocked => 锁定用户账户
  • EscolaLms\Courses\Events\CourseAssigned => 将用户添加到课程频道并分配成员角色
  • EscolaLms\Courses\Events\CourseUnassigned => 从课程频道中移除用户
  • EscolaLms\Courses\Events\CourseTutorAssigned => 将用户添加到课程频道并分配频道管理员角色
  • EscolaLms\Courses\Events\CourseTutorUnassigned => 从课程频道中移除用户
  • EscolaLms\Webinar\Events\WebinarUserAssigned => 将用户添加到网络研讨会频道并分配成员角色
  • EscolaLms\Webinar\Events\WebinarUserUnassigned => 从网络研讨会频道中移除用户
  • EscolaLms\Webinar\Events\WebinarTrainerAssigned => 将用户添加到网络研讨会频道并分配频道管理员角色
  • EscolaLms\Webinar\Events\WebinarTrainerUnassigned => 从网络研讨会频道中移除用户