opb/laravel-hipchat

Laravel 4 的 HipChat 通知器

0.3.2 2015-02-04 08:59 UTC

This package is not auto-updated.

Last update: 2024-09-24 03:33:47 UTC


README

通过 Laravel 队列轻松地将消息发送到 HipChat 房间,默认为后台处理。使用 HipChat API v1,与验证密钥(与 OAuth 的 v2 相反)。

一些使用示例

$user = 'Taylor';

HipchatNotifier::message("A new account [{$user}] signed up!");

指定一些选项

$message = 'Warning, system is down!';
$options = [
	'notify' => true, 
	'color' => 'red',
	'from' => 'System Monitor',
	'room' => 'Emergency Notifications',
];

HipchatNotifier::message($message, $options);

安装

通过 composer 将其安装到您的 Laravel 应用中。

"opb/laravel-hipchat": "~0.2",

然后

composer update

app.php 中注册服务提供者

Opb\LaravelHipchat\HipchatNotifierServiceProvider

注意: HipchatNotifier 门面会自动注册,并且不需要添加到 app.php 中的 aliases 数组。

配置 - Laravel 4(包版本 0.2)

发布配置文件

php artisan config:publish opb/laravel-hipchat

您应该可以在 app/config/packages/opb/laravel-hipchat/config.php 中找到配置文件。编辑它以指定所需的设置(API 令牌和默认房间名称)以及附加的默认选项。

配置 - Laravel 5(包版本 0.3 及以上)

发布配置文件

php artisan vendor:publish

您应该可以在 config/hipchat.php 中找到配置文件。编辑它以指定所需的设置(API 令牌和默认房间名称)以及附加的默认选项。在适当的情况下使用 Laravel 的 .env 文件中的 env('VARIABLE_NAME') 功能。

选项

可以向该包提供几个选项(一些必须提供)。大多数选项可以在实例化时指定(通过配置文件),并在发送消息时可选地覆盖。

  • 颜色选项 - 黄色红色灰色绿色紫色随机
  • 消息格式 - 当设置为 html 格式时,HipChat 可以格式化基本的 html 结构(列表、段落、粗体、斜体等)。当使用 text 格式时,仅渲染表情符号。设置为 auto 时,将检查您的消息中的任何 html 标签,并自动决定使用哪个。

使用方法

使用 HipchatNotifier 门面允许您快速轻松地发送消息。最简单的是使用包内所有默认选项发送消息,或者使用配置文件中覆盖的选项

HipchatNotifier::message('Test message with all default options');

您可以在每条消息的基础上覆盖选项

$message = 'Warning, system is down!';
$options = [
	'notify' => true, 
	'color' => 'red',
	'from' => 'System Monitor',
	'room' => 'Emergency Notifications',
];

HipchatNotifier::message($message, $options);

如果您不打算使用门面,并直接从 IOC 容器解析,则密钥为 hipchat-notifier。例如

$notifier = App::make('hipchat-notifier');

待办事项

  • 支持 HipChat API v2