pharmit/push

A push library for Laravel for both Google and Apple

Laravel Push

This package provides a Push service for both iOS and Android. It implements the iOS APS 2.0 (HTTP2) API, which requires a version of cURL with HTTP2 enabled. Contrary to other packages, this package can give feedback on failed push tokens., _(*1)

Installation

To install the package, run the composer command:, _(*2)

composer require pharmit/push, _(*3)

Open app.php from your config directory and add to the providers array: 'PharmIT\Push\PushServiceProvider',, _(*4)

And add to the alias array: 'Push' => 'PharmIT\Push\PushServiceFacade',, _(*5)

Then publish the configuration by executing: php artisan vendor:publish, _(*6)

Server settings

Since the new Apple APS API uses HTTP2 and support for HTTP2 is not good, make sure you have a cURL compiled with HTTP2 support. This has been fully implemented in cURL version 7.43.0 and up. However cURL needs to be specifically compiled with this feature. When the used cURL does not have support for HTTP2, it will throw an (odd) SSL error when trying to send a push message., _(*7)

Configuration

The package contains a configuration file called, "push.php". Listed below are the configuration settings., _(*8)

throwExceptionOnError

When this variable is set to true all errors will throw an exception. Otherwise it will return the variable false. Defaults to true., _(*9)

defaultEnvironment

This option controls which environment is selected by default, note that it falls back to this option when either the selected options cannot be cannot be found or is not present. When even the default environment cannot be found an exception will be thrown unless throwExceptionOnError is set to false., _(*10)

apple

This array contains all configuration options for APS., _(*11)

certificate

The path to the certificate relative to project root, _(*12)

environment

Either "production" or "development" determines which environment will be used when contacting Apple, _(*13)

passphrase

The passphrase for the certificate (optional), _(*14)

topic

The application identifier, e.g. "nl.PharmIT.MedApp", _(*15)

google

This array contains all configuration options for Google's GCM, which is currently just a single option., _(*16)

apikey

The GCM API key, _(*17)

Usage

The following is a minimal code example for the Google API:, _(*18)

// Get an instance
$google = Push::getPushService('google')
            ->setMessageText('Hi, how are you?')
            ->addRecipient('<PUSH_ID>')
            ->addRecipients(['<PUSH_ID>','<PUSH_ID>']);

// Get all push ID's to which the push message has been sent
$success = $google->send();

// Get all push ID's to which the push message could <u>not</u> be sent.
$failed = $google->getFailedRecipients();

For APS the exact same pattern can be used, but the parameter given to the getPushService call, has to be 'apple' instead of 'google'., _(*19)