PushNotification Package

This is a lightly and easy to use package to send push notification.

Installation

type in console:

    composer require edujugon/push-notification

Or update your composer.json file.

"edujugon/push-notification": "2.1.*"

Then

composer install

Laravel 5.*

Register the PushNotification service by adding it to the providers array.

'providers' => array(
    ...
    Edujugon\PushNotification\Providers\PushNotificationServiceProvider::class
)

Let's add the Alias facade, add it to the aliases array.

'aliases' => array(
    ...
    'PushNotification' => Edujugon\PushNotification\Facades\PushNotification::class,
)

Publish the package's configuration file to the application's own config directory

php artisan vendor:publish --provider="Edujugon\PushNotification\Providers\PushNotificationServiceProvider" --tag="config"

Usage

$push = new PushNotification;

By default it will use GCM as Push Service provider.

For APN Service:

$push = new PushNotification('apn');

For FCM Service:

$push = new PushNotification('fcm');

Push Service configuration

The default configuration for all Push service providers is located in Config/config.php

The default configuration parameters for GCM and FCM are :

• priority => normal
• dry_run => false

You can dynamically update those values or adding new ones calling the method setConfig like so:

$push->setConfig([
    'priority' => 'high',
    'dry_run' => true,
    'time_to_live' => 3
]);

The default configuration parameters for APN are:

• certificate => DIR . '/iosCertificates/yourCertificate.pem'
• passPhrase => 'MyPassPhrase'
• dry_run => false

Also you can update those values and add more dynamically

$push->setConfig([
    'passPhrase' => 'NewPass',
    'custom' => 'MycustomValue',
    'dry_run' => true
]);

Even you may update the url of the Push Service dynamically like so:

$puhs->setUrl('http://newPushServiceUrl.com');

Not update the url unless it's really necessary.

Filling the Notification options

You can chain the methods when load the notification options.

GCM sample:

$push->setMessage(['message'=>'This is the message','title'=>'This is the title'])
                ->setApiKey('Server-API-Key')
                ->setDevicesToken(['deviceToken1','deviceToken2','deviceToken3'...]);

APN sample:

$push->setMessage([
            'aps' => [
                'alert' => [
                    'title' => 'This is the title',
                    'body' => 'This is the body'
                ],
                'sound' => 'default'

            ],
            'extraPayLoad' => [
                'custom' => 'My custom data',
            ]
        ])
    ->setDevicesToken(['deviceToken1','deviceToken2','deviceToken3'...]);

or do it separately

$push->setMessage([
    'message'=>'This is the message',
    'title'=>'This is the title'
]);
$push->setApiKey('Server-API-Key');
$push->setDevicesToken(['deviceToken1'
    ,'deviceToken2',
    'deviceToken3'
]);

If you want send the notification to only 1 device, you may pass the value as string.

$push->setDevicesToken('deviceToken');

Send the Notification

Method send() can be also chained to the above methods.

$push->setMessage(['message'=>'This is the message','title'=>'This is the title'])
                    ->setApiKey('Server-API-Key')
                    ->setDevicesToken(['deviceToken1','deviceToken2','deviceToken3'...])
                    ->send();

Retrieve the Notification Response

If you want to retrieve the push service response, you can call the method getFeedback:

$push->getFeedback();

Or again, chain it to the above methods:

$push->setMessage(['message'=>'This is the message','title'=>'This is the title'])
                    ->setApiKey('Server-API-Key')
                    ->setDevicesToken(['deviceToken1','deviceToken2','deviceToken3'...])
                    ->send()
                    ->getFeedback();

It will return an object with the response.

Check if there was any error sending the push notification

if(isset($push->feedback->error)){
    ....
}

Get Unregistered Devices tokens

After sending a notification, you may retrieve the list of unregistered tokens

$push->getUnregisteredDeviceTokens();

This method returns an array of unregistered tokens from the Push service provider. If there isn't any unregistered token, it will return an empty array.

Laravel Alias Facade

After register the Alias Facade for this Package, you can use it like follows:

PushNotification::setService('fcm')
                        ->setMessage(['message'=>'This is the message','title'=>'This is the title'])
                        ->setApiKey('Server-API-Key')
                        ->setDevicesToken(['deviceToken1','deviceToken2','deviceToken3'...])
                        ->send()
                        ->getFeedback();

It would return the Push Feedback of the Notification sent.