README

👁 Latest Stable Version
👁 Scrutinizer Code Quality
👁 Total Downloads

A Laravel integration for the package php-mattermost-driver.

Please referer to the php-mattermost-driver package for further information on using this application.

Installation

Composer

The best way to install php-mattermost-driver is to use Composer:

composer require gnello/laravel-mattermost-driver

Read more about how to install and use Composer on your local machine here.

Laravel

After installation launch the command:

 php artisan vendor:publish

to publish the configuration file. You'll find it at config/mattermost.php

If you're on Laravel 5.5 or higher you can wipe the sweat on your forehead: you're done here!

Laravel 5.4 or lower

Otherwise don't give up, you're almost there! Do this:
Add the Gnello\Mattermost\Laravel\MattermostServiceProvider provider to the providers array in config/app.php:

'providers' => [
 //..
 Gnello\Mattermost\Laravel\MattermostServiceProvider::class,
],

Then add the facade to your aliases array:

'aliases' => [
 //..
 'Mattermost' => Gnello\Mattermost\Laravel\Facades\Mattermost::class,
],

You did it! Now consider updating your version of Laravel!

Configuration

Edit the file config/mattermost.php as you prefer.

Usage

 use \Gnello\Mattermost\Laravel\Facades\Mattermost;
 
 //Retrieve the driver
 $driver = Mattermost::server('default');
 
 //Retrieve the User Model
 $userModel = $driver->getUserModel();
 
 //Retrieve the User Model directly (on the default server)
 $userModel = Mattermost::getUserModel();