php-mattermost-driver

The PHP Driver to interact with the Mattermost Web Service API.

Please read the api documentation for further information on using this application.

Installation

Composer

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

composer require gnello/php-mattermost-driver

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

Laravel

If you are going to install this library on laravel maybe you prefer to install the laravel-mattermost-driver.

V3

If you want to install the V3 Driver instead of the V4 one you should do:

composer require gnello/php-mattermost-driver:1.*

Usage

Authentication

Login id and password

 use \Gnello\Mattermost\Driver;
 
 $container = new \Pimple\Container([
     'driver' => [
         'url' => 'your_chat_url',
         'login_id' => 'your_login_id',
         'password' => 'your_password',
     ]
 ]);
 
 $driver = new Driver($container);
 $result = $driver->authenticate();

Token

 use \Gnello\Mattermost\Driver;
 
 $container = new \Pimple\Container([
     'driver' => [
         'url' => 'your_chat_url',
         'token' => 'your_token',
     ]
 ]);
 
 $driver = new Driver($container);
 $result = $driver->authenticate();

Options

Below a list of all the Driver available options, for the Guzzle options please refer to its official documentation.

Option	Default value	Description
scheme	"https"	The URI scheme.
basePath	"/api/v4"	The base path of the API endpoint.
url	"localhost"	The URL of the Mattermost server, without the scheme (es. "www.mydomain.com").
login_id	null	The account username to use with the API.
password	null	The account password to use with the API.
token	null	The account token to use with the API, if specified it override the login_id and password.

You can specify the options as shown in the following example:

 use \Gnello\Mattermost\Driver;
 
 $container = new \Pimple\Container([
     'driver' => [
         //put here any options for the driver
     ],
     'guzzle' => [
         //put here any options for Guzzle
     ]
 ]);
 
 $driver = new Driver($container);
 $result = $driver->authenticate();

Check results

This Driver follows the PSR-7 document therefore any response is a ResponseInterface type:

if ($result->getStatusCode() == 200) {
    echo "Everything is ok.";
    var_dump(json_decode($result->getBody()));
} else {
    echo "HTTP ERROR " . $result->getStatusCode();
}

Users endpoint

//Add a new user
$result = $driver->getUserModel()->createUser([
    'email'    => 'test@test.com', 
    'username' => 'test', 
    'password' => 'testpsw'
]);

//Get a user
$result = $driver->getUserModel()->getUserByUsername('username');

//Please read the UserModel class or refer to the api documentation for a complete list of available methods.

Channels endpoint

//Create a channel
$result = $driver->getChannelModel()->createChannel([
    'name'         => 'new_channel',
    'display_name' => 'New Channel',
    'type'         => 'O',
]);


//Get a channel
$result = $driver->getChannelModel()->getChannelByName('team_id_of_the_channel_to_return', 'new_channel');

//Search a channel
$result = $driver->getChannelModel()->searchChannels($teamId, [
    'term' => "full or partial name or display name of channels"
]);

//Please read the ChannelModel class or refer to the api documentation for a complete list of available methods.

Posts endpoint

//Create a post
$result = $driver->getPostModel()->createPost([
    'channel_id' => 'The channel ID to post in',
    'message' => 'The message contents, can be formatted with Markdown',
]);


//Get a post
$result = $driver->getPostModel()->getPost('post_id_of_the_post_to_return');

//Please read the PostModel class or refer to the api documentation for a complete list of available methods.

Files endpoint

//Upload a file
$result = $driver->getFileModel()->uploadFile([
    'channel_id' => 'The ID of the channel that this file will be uploaded to',
    'filename' => 'The name of the file to be uploaded',
    'files' => fopen('Path of the file to be uploaded', 'rb'),
]);

//Send a post with the file just uploaded
$result = $driver->getPostModel()->createPost([
    'channel_id' => 'The channel ID to post in',
    'message' => 'The message contents, can be formatted with Markdown',
    'file_ids' => 'A list of file IDs to associate with the post',
]);

//Please read the FileModel class or refer to the api documentation for a complete list of available methods.

Preferences endpoint

//Get a list of the user's preferences
$result = $driver->getPreferenceModel('user_id')->getUserPreference();

//Please read the PreferenceModel class or refer to the api documentation for a complete list of available methods.