rhincodon/gitter-api

PHP package for interaction with Gitter REST API.

PHP Gitter API

PHP package for interaction with Gitter REST API., _(*1)

, _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require rhincodon/gitter-api, <sub>(*4)</sub>

## Usage

``` php
// Get new gitter instance
$gitter = new GitterApi($token);

// You can change token
$gitter->setToken($token);

// List of rooms for current user
$rooms = $gitter->rooms();

// Get room or join
$room = $gitter->room($roomId|$roomUrl);

// List of room users
$roomUsers = $room->users();

// List of room channels
$roomChannels = $room->channels();

// List of room messages
$roomMessages = $room->messages()->skip(10)->take(5)->before($messageId|$message)->after($messageId|$message)->get();

// Send message to the room
$message = $room->sendMessage($text);

// Update sent message
$message->update($text);

// Get message author
$messageAuthor = $message->author();

// Get message mentioned users
$messageMentions = $message->mentions();

// Get current user
$currentUser = $gitter->currentUser();

// Current user resources
$userRooms = $currentUser->rooms();
$userOrgs = $currentUser->organizations();
$userRepos = $currentUser->repositories();
$userChannels = $currentUser->channels();

Contributing

Please see CONTRIBUTING for details., <sub>(*5)</sub>

Testing

Set up gitter token in .env file and run:, <sub>(*6)</sub>

bash $ composer test, <sub>(*7)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*8)</sub>