notifymehq / notifyme
Provides a common interface for notification services
Requires
- php: >=5.5.9
- guzzlehttp/guzzle: ^5.3|^6.0
Requires (Dev)
- phpunit/phpunit: ^4.8|^5.0
Replaces
- notifymehq/ballou: dev-master
- notifymehq/campfire: dev-master
- notifymehq/contracts: dev-master
- notifymehq/factory: dev-master
- notifymehq/gitter: dev-master
- notifymehq/hipchat: dev-master
- notifymehq/http: dev-master
- notifymehq/manager: dev-master
- notifymehq/pagerduty: dev-master
- notifymehq/pushover: dev-master
- notifymehq/slack: dev-master
- notifymehq/support: dev-master
- notifymehq/twilio: dev-master
- notifymehq/webhook: dev-master
- notifymehq/yo: dev-master
This package is not auto-updated.
Last update: 2022-02-01 12:53:57 UTC
README
Common interface for notification services.
Installation
Either PHP 5.5+ or HHVM 3.6+ are required.
To get the latest version of NotifyMe, simply require the project using Composer:
$ composer require notifymehq/notifyme
Instead, you may of course manually update your require block and run composer update
if you so choose:
{ "require": { "notifymehq/notifyme": "^1.0" } }
If you want, you can require only a single adapter. This works rather like the component system of laravel or symfony. We currently have the following adapters:
- Ballou (
notifymehq/ballou
) - Campfire (
notifymehq/campfire
) - Gitter (
notifymehq/gitter
) - Hipchat (
notifymehq/hipchat
) - Pagerduty (
notifymehq/pagerduty
) - Pushover (
notifymehq/pushover
) - Slack (
notifymehq/slack
) - Twilio (
notifymehq/twilio
) - Webhook (
notifymehq/webhook
) - Yo (
notifymehq/yo
)
Also, note, that our other components are:
- Contracts (
notifymehq/contracts
) - Factory (
notifymehq/factory
) - Http (
notifymehq/http
) - Manager (
notifymehq/manager
) - Support (
notifymehq/support
)
Finally, we have a totally seperate Laravel bridge available for use by installing notifyme/laravel
, then adding our service provider: NotifyMeHQ\Laravel\NotifyMeServiceProvider
.
Usage
- Create a factory :
$factory = new NotifyMeHQ\Factory\NotifyMeFactory();
- Make a notifier :
$notifier = $factory->make($config);
- Notify :
$response = $notifier->notify($to, $message);
- Check the response :
$response->isSent();
Example
Here is an example of a notification with Slack:
<?php // Create a factory for notifications $notifierFactory = new NotifyMeHQ\Factory\NotifyMeFactory(); // Create the new notification for slack $slackNotifier = $notifierFactory->make([ // Specify that we will use slack 'driver' => 'slack', // Add api token to get access to slack API 'token' => '', // Who send this message, here is a bot called 'Super Bot' 'from' => 'Super Bot', ]); /* @var \NotifyMeHQ\Contracts\ResponseInterface $response */ $response = $slackNotifier->notify('#sandbox', 'test message'); echo $response->isSent() ? 'Message sent' : 'Message going nowhere';
License
NotifyMe is licensed under The MIT License (MIT).