leonardoteixeira / pushover
A simple PHP library for the Pushover service
Installs: 26 978
Dependents: 3
Suggesters: 0
Security: 0
Stars: 16
Watchers: 6
Forks: 6
Open Issues: 1
Requires
- php: >=5.4.0
- rmccue/requests: >=1.0
Requires (Dev)
- phpunit/phpunit: 4.1.*
This package is not auto-updated.
Last update: 2024-11-20 03:48:18 UTC
README
A simple PHP library for the Pushover service.
This library was written using the PSR-4 standards.
Installation
Use the Composer to install.
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:
$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.
$message->setPriority(Priority::EMERGENCY); $message->setRetry(60); $message->setExpire(10800); $message->setCallback('http://callback-url.com/');
You can poll the notification status using poll
.
Running the tests
vendor/bin/phpunit