snapshotpl / zf-snap-hip-chat
HipChat module (api and logger) for Zend Framework 2
Installs: 6 682
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 3
Forks: 1
Open Issues: 1
Requires
- php: >=5.3.3
- hipchat/hipchat-php: 1.*
- zendframework/zendframework: 2.*
This package is auto-updated.
Last update: 2024-10-29 04:36:20 UTC
README
HipChat module for Zend Framework 2
Module helps to use HipChat API and log messages to yours rooms!
The simplest usage
Add auth token (you can create it here - remember to set type admin
) to your config:
return array( 'zf_snap_hip_chat' => array( 'api' => array( 'auth_token' => 'yourauthtoken', ), ), );
And then get HipChat API object from Service Manager:
$hipChat = $this->getServiceLocator()->get('hipchat');
That's all! Module uses official HipChat library for PHP.
How to install?
Via composer.json
{ "require": { "snapshotpl/zf-snap-hip-chat": "1.*" } }
and add module ZfSnapHipChat
to application.config.php
.
Use HipChat as logger
To use HipChat as logger, you need to set room ID (IDs) or name (names) in config:
return array( 'zf_snap_hip_chat' => array( 'logger' => array( 'room_id' => array(100001, 'log room'), ), ), );
Now you have access to log writer from service manager:
$logger = new Zend\Log\Logger(); $hipChat = $this->getServiceLocator()->get('hipchat_log_writer'); $logger->addWriter($hipChat); $logger->debug('HipChat debug message!');
...or logger:
$logger = $this->getServiceLocator()->get('hipchat_logger'); $logger->debug('HipChat debug message!');
Options
You can customize logger using config:
return array( 'zf_snap_hip_chat' => array( 'api' => array( 'auth_token' => null, // Required auth token 'api_target' => HipChat::DEFAULT_TARGET, // Url address to HipChat API 'api_version' => HipChat::VERSION_1, // Api version ), 'logger' => array( 'room_id' => null, // string, int or array with IDs, required for logger 'from' => 'ZfSnapHipChat', // Author name for log messages in your rooms 'notify' => false, // Enables sounds notify in HipChat 'format' => HipChat::FORMAT_HTML, // Message format ), ), );
Console usage
You can manipulate HipChat API from application console. To get list of commands write in console:
php public/index.php
HipChat API
index.php hipchat message send <message> [--room=] [--from=] [--notify] [--color=(yellow|red|gray|green|purple|random)] [--format=(html|text)] Sends message
index.php hipchat room list Lists rooms
index.php hipchat room history <room> [--date=] Room's history
index.php hipchat room set topic <room> <topic> [--from=] Sets room topic