zerifas/pushover

Pushover Notifications

0.0.1 2014-07-03 00:03 UTC

Requires

• ext-curl: *

MIT

• Mat Gadd

README

Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop.

This simple PHP library allows you to utilise Pushover from your PHP code.

Features

• Supports full API feature set (including notification priority).
• Requires only curl extension.
• PSR-2 standard adherence.

Requirements

• PHP ~5.3
• curl extension

Usage

At its simplest, you create a connection, and pass Notification objects and the user token:

$pushover = new Zerifas\Pushover\Connection($applicationToken);
$notification = new Zerifas\Pushover\Notification('Hello, world!');
$success = $pushover->notifyUser($notification, $userToken);

You may also want to omit the user token passed to notifyUser if you're only delivering to one user:

$pushover = new Zerifas\Pushover\Connection($applicationToken, $userToken);
$notification = new Zerifas\Pushover\Notification('Hello, world!');
$success = $pushover->notifyUser($notification);

The Notification class supports all the options defined in the API, and a fluent interface.

$pushover = new Zerifas\Pushover\Connection($applicationToken, $userToken);

$notification = new Zerifas\Pushover\Notification('Hello, world!');
$notification->setTitle('Title')
    ->setUrl('http://www.pushover.net/')
    ->setUrlTitle('Pushover')
    ->setPriority(Zerifas\Pushover\Notification::PRIORITY_QUIET)
    ->setTimestamp(time())
    ->setSound('cosmic')
;
$success = $pushover->notifyUser($notification);

You can also get the status code and response as an array if required:

$pushover = new Zerifas\Pushover\Connection($applicationToken, $userToken);
$notification = new Zerifas\Pushover\Notification('Hello, world!');
$success = $pushover->notifyUser($notification);
$statusCode = $pushover->getLastStatusCode();
$response = $pushover->getLastResponse();
$requestId = $response['request'];
$errors = $response['errors'];