https://github.com/escolalms/mattermost
Mattermost integration
https://github.com/escolalms/mattermost
Last synced: 2 months ago
JSON representation
Mattermost integration
- Host: GitHub
- URL: https://github.com/escolalms/mattermost
- Owner: EscolaLMS
- License: mit
- Created: 2022-01-13T16:32:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-19T06:39:38.000Z (12 months ago)
- Last Synced: 2025-04-17T18:27:01.611Z (3 months ago)
- Language: PHP
- Size: 17.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mattermost
[](https://escolalms.github.io/Mattermost/)
[](https://codecov.io/gh/EscolaLMS/Mattermost)
[](https://github.com/EscolaLMS/Mattermost/actions/workflows/test.yml)
[](https://packagist.org/packages/escolalms/mattermost)
[](https://packagist.org/packages/escolalms/mattermost)
[](https://packagist.org/packages/escolalms/mattermost)
[](https://codeclimate.com/github/EscolaLMS/Mattermost/maintainability)
[](https://codeclimate.com/github/EscolaLMS/Mattermost/test_coverage)
## What does it do
This package is used for [Mattermost](https://mattermost.com/) integration.
It listens for Events then add/remove user for mattermost and particular channels either as standard user or admin.
## Installing
- `composer require escolalms/mattermost`
## Example
You can configure the package using 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');
```
or `/api/admin/config` endpoint
```php
$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',
],
]
]
);
```
## Endpoints
All the endpoints are defined in [](https://escolalms.github.io/Mattermost/)
## Test
Run `./vendor/bin/phpunit` to run tests. See tests folder as it's quite good staring point as documentation appendix.
Test details
[](https://codecov.io/gh/EscolaLMS/Mattermost)
[](https://github.com/EscolaLMS/Mattermost/actions/workflows/test.yml)
## Listeners
Handling events
- `EscolaLms\Auth\Events\AccountConfirmed` => add user to Mattermost
- `EscolaLms\Auth\Events\AccountDeleted` => remove user from Mattermost
- `EscolaLms\Auth\Events\AccountBlocked` => block user account
- `EscolaLms\Courses\Events\CourseAssigned` => add user to course channel with member role
- `EscolaLms\Courses\Events\CourseUnassigned` => remove user from course channel
- `EscolaLms\Courses\Events\CourseTutorAssigned` => add user to course channel with channel_admin role
- `EscolaLms\Courses\Events\CourseTutorUnassigned` => remove user from course channel
- `EscolaLms\Webinar\Events\WebinarUserAssigned` => add user to webinar channel with member role
- `EscolaLms\Webinar\Events\WebinarUserUnassigned` => remove user from webinar channel
- `EscolaLms\Webinar\Events\WebinarTrainerAssigned` => add user to webinar channel with channel_admin role
- `EscolaLms\Webinar\Events\WebinarTrainerUnassigned` => remove user from webinar channel