leonardoteixeira/pushover

A simple PHP library for the Pushover service

Pushover for PHP

, _(*1)

A simple PHP library for the Pushover service., _(*2)

This library was written using the PSR-4 standards., _(*3)

Installation

Use the Composer to install., _(*4)

composer.json

{
    "require": {
        "leonardoteixeira/pushover": "1.*"
    }
}

Running the composer

composer install

Usage

Basic Example

<?php

require 'vendor/autoload.php';

use LeonardoTeixeira\Pushover\Client;
use LeonardoTeixeira\Pushover\Message;
use LeonardoTeixeira\Pushover\Exceptions\PushoverException;

$client = new Client('YOUR_USER_CODE_HERE', 'YOUR_TOKEN_HERE');

$message = new Message('Your message here.');

try {
    $client->push($message);
    echo 'The message has been pushed!', PHP_EOL;
} catch (PushoverException $e) {
    echo 'ERROR: ', $e->getMessage(), PHP_EOL;
}

You also can pass a title and the priority on constructor:, _(*5)

$message = new Message('Your message here.', 'Title here', Priority::HIGH);

Complete Example

<?php

require 'vendor/autoload.php';

date_default_timezone_set('UTC');

use LeonardoTeixeira\Pushover\Client;
use LeonardoTeixeira\Pushover\Message;
use LeonardoTeixeira\Pushover\Priority;
use LeonardoTeixeira\Pushover\Sound;
use LeonardoTeixeira\Pushover\Exceptions\PushoverException;
use LeonardoTeixeira\Pushover\Receipt;
use LeonardoTeixeira\Pushover\Status;

$client = new Client('YOUR_USER_CODE_HERE', 'YOUR_TOKEN_HERE');

$message = new Message();
$message->setMessage('Your messsage <b>here</b>.');
$message->setTitle('Title here');
$message->setUrl('http://www.example.com/');
$message->setAttachment('pic.jpg');
$message->setUrlTitle('Click me!');
$message->setPriority(Priority::HIGH);
$message->setSound(Sound::SIREN);
$message->setHtml(true);
$message->setDate(new \DateTime());

try {
    $receipt = $client->push($message);
    echo 'The message has been pushed!', PHP_EOL;
    $status = $client->poll($receipt);
} catch (PushoverException $e) {
    echo 'ERROR: ', $e->getMessage(), PHP_EOL;
}

Emergency Priority

For the emergency priority you must provide the parameters retry and expire. The callback parameter is optional., _(*6)

More information, _(*7)

$message->setPriority(Priority::EMERGENCY);
$message->setRetry(60);
$message->setExpire(10800);
$message->setCallback('http://callback-url.com/');

You can poll the notification status using poll., _(*8)

Running the tests

vendor/bin/phpunit