redjanym/pushover-php

PHP SDK for the pushover.net API

v1.0 2018-12-26 10:04 UTC

GPL-3.0-only

• Redjan Ymeraj

README

PHP SDK(not official) for the pushover.net API

Installation

• Use composer:

composer require redjanym/pushover-php "dev-master"

• Download and include file:

Download the repository, unzip the files and require Pushover.php

include "path/to/Pushover.php";

Usage

The class Pushover.php is composed of several setter methods to provide information about the message to send like title, message, url etc and access different API endpoints like sending message, validate user, work with receipts and more. In this step we assume you have already setup your account in Pushover and are in possession of the APP anf USER keys.

Example

Sending a simple message.

$pushOver = new Pushover("YOUR_APP_TOKEN", "YOUR_USER_KEY");

$pushOver
    ->setTitle("Test title")
    ->setMessage('Test message')
;

$pushOver->send();

var_dump($pushOver->getResponse());

More examples are available in the examples directory . Be sure to add your config keys into the config.php file.

Symfony Framework

After installing the library via composer you can define the class as a service.

First create two parameters to store your token and key.

parameters:
    pushover_app_token: "YOUR_APP_TOKEN"
    pushover_user_key: "YOUR_USER_KEY"

Then declare service for Symfony 2-4:

service:
...................
    app.redjanym_pushover:
        class: Pushover
        arguments: ["%pushover_app_token%", "%pushover_user_key%"]

Or by using AutoWiring:

service:
...................
    Pushover:
        arguments: 
            $pushoverAppToken: "%pushover_app_token%"
            $pushoverUserKey: "%pushover_user_key%"

Usage is the same as before but in Symfony yu need to get the service first.

$pushOver = $this->get("app.redjanym_pushover");
$pushOver
    ->setTitle("Test title")
    ->setMessage('Test message')
;

$pushOver->send();

var_dump($pushOver->getResponse());

Having issues? Not receiving notifications?

Be sure to have create the two environment variables described above and/or check the response value of the requests sent in Pushover

To do

Add support for attachments.