Download the PHP package opb/laravel-hipchat without Composer
On this page you can find all versions of the php package opb/laravel-hipchat. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download opb/laravel-hipchat
More information about opb/laravel-hipchat
Files in opb/laravel-hipchat
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-hipchat
Hipchat Notifier for Laravel 4/5
Quickly and easily send messages to Hipchat rooms, backgrounding via the Laravel queue by default. Uses v1 of the Hipchat API, with auth keys (as opposed to v2 with OAuth).
A couple of usage examples:
Specifying some options:
Installation
Install into your Laravel app via composer.
and then
Register the service provider in app.php:
Note: The HipchatNotifier facade is registered automatically and does not need to be added to the aliases array in app.php.
Config - Laravel 4 (package version 0.2)
Publish the config file:
You should then find the config file at app/config/packages/opb/laravel-hipchat/config.php. Edit it to specify the required settings (API token and default room name) and additional default options.
Config - Laravel 5 (package version 0.3 and above)
Publish the config file:
You should then find the config file at config/hipchat.php. Edit it to specify the required settings (API token and default room name) and additional default options. Use the env('VARIABLE_NAME') functionality where appropriate when using Laravel's .env file.
Options
There are several options which can (and some which must) be provided to the package. Most options can be specified at instantiation (via the config file) and optionally overridden when a message is sent.
| Option | Required? | Default | Override with message? | Info |
|---|---|---|---|---|
| apiToken | Yes | none | No | |
| room | Yes | none | Yes | Name of the room, not ID |
| color | No | 'yellow' | Yes | See available options below |
| from | No | 'Notification' | Yes | The message sender name |
| notify | No | false | Yes | Make Hipchat app notify |
| queue | No | true | Yes | Background to Laravel queue |
| format | No | 'auto' | Yes | Message format - html, text or auto |
- Color options - yellow, red, gray, green, purple, random
- Message format - HipChat can format basic html structures (lists, paragraphs, bold, italic, etc) when set to html format. Emoticons are only rendered when text format is used. auto will check for any html tags in your message and decide automagically which to use.
Usage
Using the HipchatNotifier facade allows you to quickly and easily send messages. The simplest is to send a message using all the default options within the package, or using those that were overridden in the config file:
You can override options on a per-message basis:
If you're not going to use the facade, and resolve directly out of the IOC container, the key is hipchat-notifier. For example:
Todo
- Support HipChat API v2
