daim2k5/laravel-push-notification

Laravel package to send push notifications to mobile devices (apns, gcm)

Laravel Push Notification

Package to enable sending push notifications to devices, _(*1)

Installation

Update your composer.json file to include this package as a dependency, _(*2)

Laravel 5 & Lumen, _(*3)

"daim2k5/laravel-push-notification": "1.*"

Register the PushNotification service provider by adding it to the providers array., _(*4)

'providers' => array(
    ...
    'Davibennun\LaravelPushNotification\LaravelPushNotificationServiceProvider'
)

Alias the PushNotification facade by adding it to the aliases array in the app/config/app.php file., _(*5)

'aliases' => array(
    ...
    'PushNotification' => 'Davibennun\LaravelPushNotification\Facades\PushNotification'
)

Configuration

Copy the config file into your project by running: (Lumen users skip this), _(*6)

Laravel 5, _(*7)

php artisan vendor:publish --provider="Davibennun\LaravelPushNotification\LaravelPushNotificationServiceProvider" --tag="config"

This will generate a config file like this, _(*8)

array(
    'appNameIOS'=>array(
        'environment' => 'development',
        'certificate' => '/path/to/certificate.pem',
        'passPhrase'  => 'password',
        'service'     => 'apns'
    ),
    'appNameAndroid'=>array(
        'environment' => 'production',
        'apiKey'      => 'yourAPIKey',
        'service'     => 'gcm'
    )
);

Where all first level keys corresponds to an service configuration, each service has its own properties, android for instance have apiKey and IOS uses certificate and passPhrase. You can set as many services configurations as you want, one for each app., _(*9)

Dont forget to set service key to identify IOS 'service'=>'apns' and Android 'service'=>'gcm'

The certificate path must be an absolute path, so in the configuration file you can use these:

//Path to the 'app' folder
'certificate'=>app_path().'/myCert.pem'

Laravel functions are also available public_path() storage_path() base_path(), _(*10)

Usage

PushNotification::app('appNameIOS')
                ->to($deviceToken)
                ->send('Hello World, i`m a push message');

Where app argument appNameIOS refers to defined service in config file., _(*11)

Dynamic configuration and Lumen users

You can set the app config array directly: (keep in mind the array schema), _(*12)

//iOS app
PushNotification::app(['environment' => 'development',
        'certificate' => '/path/to/certificate.pem',
        'passPhrase'  => 'password',
        'service'     => 'apns']);
//Android app       
PushNotification::app(['environment' => 'production',
        'apiKey'      => 'yourAPIKey',
        'service'     => 'gcm']);

To multiple devices and optioned message:, _(*13)

$devices = PushNotification::DeviceCollection(array(
    PushNotification::Device('token', array('badge' => 5)),
    PushNotification::Device('token1', array('badge' => 1)),
    PushNotification::Device('token2')
));
$message = PushNotification::Message('Message Text',array(
    'badge' => 1,
    'sound' => 'example.aiff',

    'actionLocKey' => 'Action button title!',
    'locKey' => 'localized key',
    'locArgs' => array(
        'localized args',
        'localized args',
    ),
    'launchImage' => 'image.jpg',

    'custom' => array('custom data' => array(
        'we' => 'want', 'send to app'
    ))
));

$collection = PushNotification::app('appNameIOS')
    ->to($devices)
    ->send($message);

// get response for each device push
foreach ($collection->pushManager as $push) {
    $response = $push->getAdapter()->getResponse();
}

// access to adapter for advanced settings
$push = PushNotification::app('appNameAndroid');
$push->adapter->setAdapterParameters(['sslverifypeer' => false]);

This package is wrapps Notification Package and adds some flavor to it., _(*14)

Usage advice

This package should be used with Laravel Queues, so pushes dont blocks the user and are processed in the background, meaning a better flow., _(*15)