r0dger / slack-api
Wrapper for Slack.com WEB API.
Requires
- php: >=7.2
- guzzlehttp/guzzle: ^6.0
- illuminate/cache: ^6.0
- illuminate/support: ^6.0
README
This package provides a simple way to use Slack API.
Instalation
composer require r0dger/slack-api
Instalation on Laravel 5
Add to config/app.php:
<?php [ 'providers' => [ Vluzrmos\SlackApi\SlackApiServiceProvider::class, ] ] ?>
The ::class notation is optional.
and add the Facades to your aliases, if you need it
<?php [ 'aliases' => [ 'SlackApi' => Vluzrmos\SlackApi\Facades\SlackApi::class, 'SlackChannel' => Vluzrmos\SlackApi\Facades\SlackChannel::class, 'SlackChat' => Vluzrmos\SlackApi\Facades\SlackChat::class, 'SlackGroup' => Vluzrmos\SlackApi\Facades\SlackGroup::class, 'SlackFile' => Vluzrmos\SlackApi\Facades\SlackFile::class, 'SlackSearch' => Vluzrmos\SlackApi\Facades\SlackSearch::class, 'SlackInstantMessage' => Vluzrmos\SlackApi\Facades\SlackInstantMessage::class, 'SlackUser' => Vluzrmos\SlackApi\Facades\SlackUser::class, 'SlackStar' => Vluzrmos\SlackApi\Facades\SlackStar::class, 'SlackUserAdmin' => Vluzrmos\SlackApi\Facades\SlackUserAdmin::class, 'SlackRealTimeMessage' => Vluzrmos\SlackApi\Facades\SlackRealTimeMessage::class, 'SlackTeam' => Vluzrmos\SlackApi\Facades\SlackTeam::class, ] ] ?>
The ::class notation is optional.
Instalation on Lumen
Add that line on bootstrap/app.php:
<?php // $app->register('App\Providers\AppServiceProvider'); (by default that comes commented) $app->register('Vluzrmos\SlackApi\SlackApiServiceProvider'); ?>
If you want to use facades, add this lines on bootstrap/app.php
<?php class_alias('Vluzrmos\SlackApi\Facades\SlackApi', 'SlackApi'); class_alias('Vluzrmos\SlackApi\Facades\SlackChannel', 'SlackChannel'); class_alias('Vluzrmos\SlackApi\Facades\SlackChat', 'SlackChat'); class_alias('Vluzrmos\SlackApi\Facades\SlackGroup', 'SlackGroup'); class_alias('Vluzrmos\SlackApi\Facades\SlackUser', 'SlackUser'); class_alias('Vluzrmos\SlackApi\Facades\SlackTeam', 'SlackTeam'); //... and others ?>
Otherwise, just use the singleton shortcuts:
<?php /** @var \Vluzrmos\SlackApi\Contracts\SlackApi $slackapi */ $slackapi = app('slack.api'); /** @var \Vluzrmos\SlackApi\Contracts\SlackChat $slackchat */ $slackchat = app('slack.chat'); /** @var \Vluzrmos\SlackApi\Contracts\SlackChannel $slackchannel */ $slackchannel = app('slack.channel'); //or /** @var \Vluzrmos\SlackApi\Contracts\SlackApi $slackapi */ $slackapi = slack(); /** @var \Vluzrmos\SlackApi\Contracts\SlackChat $slackchat */ $slackchat = slack('chat'); // or slack('slack.chat') //... //... ?>
Configuration
configure your slack team token in config/services.php
<?php [ //..., 'slack' => [ 'token' => 'your token here' ] ] ?>
Usage
<?php //Lists all users on your team SlackUser::lists(); //all() //Lists all channels on your team SlackChannel::lists(); //all() //List all groups SlackGroup::lists(); //all() //Invite a new member to your team SlackUserAdmin::invite("example@example.com", [ 'first_name' => 'John', 'last_name' => 'Doe' ]); //Send a message to someone or channel or group SlackChat::message('#general', 'Hello my friends!'); //Upload a file/snippet SlackFile::upload([ 'filename' => 'sometext.txt', 'title' => 'text', 'content' => 'Nice contents', 'channels' => 'C0440SZU6' //can be channel, users, or groups ID ]); // Search for files or messages SlackSearch::all('my message'); // Search for files SlackSearch::files('my file'); // Search for messages SlackSearch::messages('my message'); // or just use the helper //Autoload the api slack()->post('chat.postMessage', [...]); //Autoload a Slack Method slack('Chat')->message([...]); slack('Team')->info(); ?>
Using Dependency Injection
<?php namespace App\Http\Controllers; use Vluzrmos\SlackApi\Contracts\SlackUser; class YourController extends Controller{ /** @var SlackUser */ protected $slackUser; public function __construct(SlackUser as $slackUser){ $this->slackUser = $slackUser; } public function controllerMethod(){ $usersList = $this->slackUser->lists(); } } ?>
All Injectable Contracts:
Generic API
Vluzrmos\SlackApi\Contracts\SlackApi
Allows you to do generic requests to the api with the following http verbs:
get, post, put, patch, delete ... all allowed api methods you could see here: Slack Web API Methods.
And is also possible load a SlackMethod contract:
<?php /** @var SlackChannel $channel **/ $channel = $slack->load('Channel'); $channel->lists(); /** @var SlackChat $chat **/ $chat = $slack->load('Chat'); $chat->message('D98979F78', 'Hello my friend!'); /** @var SlackUserAdmin $chat **/ $admin = $slack('UserAdmin'); //Minimal syntax (invokable) $admin->invite('jhon.doe@example.com'); ?>
Channels API
Vluzrmos\SlackApi\Contracts\SlackChannel
Allows you to operate channels:
invite, archive, rename, join, kick, setPurpose ...
Chat API
Vluzrmos\SlackApi\Contracts\SlackChat
Allows you to send, update and delete messages with methods:
delete, message, update.
Files API
Vluzrmos\SlackApi\Contracts\SlackFile
Allows you to send, get info, delete, or just list files:
info, lists, upload, delete.
Groups API
Vluzrmos\SlackApi\Contracts\SlackGroup
Same methods of the SlackChannel, but that operates with groups and have adicional methods:
open, close, createChild
Instant Messages API (Direct Messages)
Vluzrmos\SlackApi\Contracts\SlackInstantMessage
Allows you to manage direct messages to your team members.
Real Time Messages API
Vluzrmos\SlackApi\Contracts\SlackRealTimeMessage
Allows you list all channels and user presence at the moment.
Search API
Vluzrmos\SlackApi\Contracts\SlackSearch
Find messages or files.
Stars API
Vluzrmos\SlackApi\Contracts\SlackStar
List all of starred itens.
Team API
Vluzrmos\SlackApi\Contracts\SlackTeam
Get information about your team.
Users API
Vluzrmos\SlackApi\Contracts\SlackUser
Get information about an user on your team or just check your presence ou status.
Users Admin API
Vluzrmos\SlackApi\Contracts\SlackUserAdmin
Invite new members to your team.