jonlod/onesignal-laravel

OneSignal Push Wrapper Laravel

OneSignal Push Notifications for Laravel

Introduction

This is a rehash from the original Berkayk package., _(*1)

Installation

First, you'll need to require the package with Composer:, _(*2)

composer require jonlod/onesignal-laravel

Auto discovery is on. if you use Laravel 5.4 or lower =>, _(*3)

----- <=5.4, _(*4)

update config/app.php by adding an entry for the service provider., _(*5)

'providers' => [
    // ...
    jonlod\OneSignal\OneSignalServiceProvider::class
];

Then, register class alias by adding an entry in aliases section, _(*6)

'aliases' => [
    // ...
    'OneSignal' => jonlod\OneSignal\OneSignalFacade::class
];

------- <=5.4, _(*7)

Finally, from the command line again, run, _(*8)

php artisan vendor:publish --tag=config

to publish the default configuration file. This will publish a configuration file named onesignal.php., _(*9)

Configuration

Keys should be set in the .env, _(*10)

ONESIGNAL_APP_ID=<*****>
ONESIGNAL_REST_API_KEY=<*******>

Tomorrow hour can be changed in the onesignal.php config file. This is only used for delayed push notifications on the next day., _(*11)

App prep

Apps should fill in the external id parameter with the user id., _(*12)

Models

App\Models\User is used as default path for the user model, _(*13)

Async

All pushes use the job: SendPushes. This is automatically queued if a queue is available., _(*14)

Usage

Include the trait anywhere., _(*15)

Sending a Notifications

Push::pushToAll(...);
Push::pushToAllTag(...);
Push::pushToUser(...);
Push::pushToUsers(...);
Push::pushToAllTomorrow(...);
Push::pushToAllScheduled(...);

Helpers

Trans all

Push::transAll(...);

In the config 'languages.options' needs to be set. This will automatically translate to all available languages with possible translations in the replacements too., _(*16)

Best to use this when there is translatable content, onesignal will choose the correct language on the device., _(*17)

English is always required, _(*18)