wonderpush/wonderpush-php-lib

PHP library for WonderPush

v2.1.1 2020-05-12 10:33 UTC

Requires

• php: >=5.3.3
• ext-curl: *
• ext-json: *

Requires (Dev)

• phpcompatibility/php-compatibility: ^9.2
• phpunit/phpunit: ~4.8
• satooshi/php-coveralls: ^1.0
• squizlabs/php_codesniffer: ^2.3

Apache-2.0

• WonderPush

• api
• push notification
• wonderpush

README

Find the full WonderPush services documentation at: https://docs.wonderpush.com/docs.

Introduction

This project contain a PHP library for interacting with the WonderPush services. It helps you performing calls to the Management API. This contrasts with the SDKs, which are targeted at being integrated within your apps and handle interactions with the users.

APIs

WonderPush comes as two APIs, one aimed at the user devices, and the other optional one aimed at your servers and tools. The former is simply called the REST API, whereas the latter is called the Management API.

This tool helps you performing calls to the Management API.

Management API Reference

All references for the WonderPush Management API are available on the WonderPush documentation pages: https://docs.wonderpush.com/reference.

Documentation

Please see https://wonderpush.github.io/wonderpush-php-lib for up-to-date documentation.

Requirements

PHP 5.3.3 and later.

Composer

You can install the bindings via Composer. Run the following command:

composer require wonderpush/wonderpush-php-lib

To use the bindings, use Composer's autoload:

require_once('vendor/autoload.php');

Manual Installation

If you do not wish to use Composer, you can download the latest release. Then, to use the bindings, include the init.php file.

require_once('/path/to/wonderpush-php-lib/init.php');

Dependencies

The bindings require the following extension in order to work properly:

• curl
• json

If you use Composer, these dependencies should be handled automatically. If you install manually, you'll want to make sure that these extensions are available.

Getting Started

Simple usage looks like:

$wonderpush = new \WonderPush\WonderPush(WONDERPUSH_ACCESS_TOKEN, WONDERPUSH_APPLICATION_ID);
$response = $wonderpush->deliveries()->create(
    \WonderPush\Params\DeliveriesCreateParams::_new()
        ->setTargetSegmentIds('@ALL')
        ->setNotification(\WonderPush\Obj\Notification::_new()
            ->setAlert(\WonderPush\Obj\NotificationAlert::_new()
                ->setTitle('Using the PHP library')
                ->setText('Hello, WonderPush!')
            ))
);
echo $response->getNotificationId();

Configuring a Logger

The library does minimal logging, but it can be configured with a PSR-3 compatible logger so that messages end up there instead of error_log:

$wonderpush->setLogger($logger);

Development

Install dependencies:

composer install

Tests

Install dependencies as mentioned above (which will resolve PHPUnit), then you can run the test suite:

./test

Or to run an individual test file:

vendor/bin/phpunit tests/SomeTest.php