smart-freedom / yii2-slack
There is no license information available for the latest version (v1.0.2) of this package.
Yii2 slack client
v1.0.2
2020-03-23 11:54 UTC
Requires
- php: >=5.4.0
- yiisoft/yii2: >=2.0.0
- yiisoft/yii2-httpclient: ^2.0.0
README
Designed to send messages to slack messenger
Installation
php composer.phar require understeam/yii2-slack:~0.3 --prefer-dist
Also, you should configure incoming webhook inside your Slack team.
Usage
First of all, configure yiisoft/yii2-httpclient component:
... 'components' => [ 'httpclient' => [ 'class' => 'yii\httpclient\Client', ], ], ...
Also you can set it up only inside of slack client:
... 'components' => [ 'slack' => [ 'httpclient' => [ 'class' => 'yii\httpclient\Client', ], ... ], ], ...
Configure component:
... 'components' => [ 'slack' => [ 'class' => 'SmartFreedom\Slack\Client', 'url' => '<slack incoming webhook url here>', 'username' => 'My awesome application', ], ], ...
Now you can send messages right into slack channel via next command:
Yii::$app->slack->send('Hello', ':thumbs_up:', [ [ // attachment object 'text' => 'text of attachment', 'pretext' => 'pretext here', ], ]);
To learn more about attachments, read Slack documentation
Also you can use slack as a log target:
... 'components' => [ 'log' => [ 'traceLevel' => 3, 'targets' => [ [ 'class' => 'SmartFreedom\Slack\LogTarget', 'categories' => ['commandBus'], 'exportInterval' => 1, // Send logs on every message 'logVars' => [], ], ], ], ], ...