yiier/yii2-slack

Yii2 slack client based library

v1.1.0 2016-07-22 03:25 UTC

Requires

• yiisoft/yii2: *

Suggests

• php-curl-class/php-curl-class: ^4.8

GPL-3.0

• forecho

• extension
• yii2
• slack

README

Designed to send messages to slack messenger

Installation

php composer.phar require --prefer-dist yiier/yii2-slack "*"

Also, you should configure incoming webhook inside your Slack team.

Usage

Configure component:

...
    'components' => [
        'slack' => [
            'httpClient' => ['class' => 'Curl\Curl'],
            'class' => 'yiier\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' => 'yiier\slack\LogTarget',
                'categories' => ['commandBus'],
                'exportInterval' => 1, // Send logs on every message
                'logVars' => [],
            ],
        ],
    ],
],
...

or

...
'components' => [
    'log' => [
        'traceLevel' => 3,
        [
            'class' => 'yiier\slack\LogTarget',
            'levels' => ['error'],
            'enabled' => true,
            'emoji' => ':beetle:',
            'logMessage' => '错误信息',
            'categories' => [
                'yii\db\*',
                'yii\web\HttpException:*',
                'error',
            ],
            'except' => [
                'yii\web\HttpException:404', // 除了404错误
            ],
            'exportInterval' => 1, // Send logs on every message
            'logVars' => [],
        ],
    ],
],
...

Credits

Understeam/yii2-slack