sonvq / onesignal-laravel
OneSignal Push Wrapper Laravel
Requires
- php: >=5.4.0
- guzzlehttp/guzzle: ^6.2
- illuminate/support: 4.*|5.*
- symfony/psr-http-message-bridge: 1.*
Requires (Dev)
- vlucas/phpdotenv: ^2.2
This package is not auto-updated.
Last update: 2024-12-22 02:04:23 UTC
README
Introduction
This is a simple OneSignal wrapper library for Laravel. It simplifies the basic notification flow with the defined methods. You can send a message to all users or you can notify a single user. Before you start installing this service, please complete your OneSignal setup at https://onesignal.com and finish all the steps that is necessary to obtain an application id and REST API Keys.
Installation
First, you'll need to require the package with Composer:
composer require sonvq/onesignal-laravel
Aftwards, run composer update
from your command line.
Then, update config/app.php
by adding an entry for the service provider.
'providers' => [ // ... Sonvq\OneSignal\OneSignalServiceProvider::class ];
Then, register class alias by adding an entry in aliases section
'aliases' => [ // ... 'OneSignal' => Sonvq\OneSignal\OneSignalFacade::class ];
Finally, from the command line again, run
php artisan vendor:publish --tag=config
to publish the default configuration file.
This will publish a configuration file named onesignal.php
which includes your OneSignal authorization keys.
Note: If the previous command does not publish the config file successfully, please check the steps involving providers and aliases in the
config/app.php
file.
Configuration
You need to fill in onesignal.php
file that is found in your applications config
directory.
app_id
is your OneSignal App ID and rest_api_key
is your REST API Key.
Usage
Sending a Notification To All Users
You can easily send a message to all registered users with the command
OneSignal::sendNotificationToAll("Some Message", $heading = null, $data = null, $url = null, $buttons = null, $schedule = null);
$url
, $data
, $buttons
and $schedule
fields are exceptional. If you provide a $url
parameter, users will be redirecting to that url.
Sending a Notification To A Specific User
After storing a user's tokens in a table, you can simply send a message with
OneSignal::sendNotificationToUser("Some Message", $userId, $heading = null, $data = null, $url = null, $buttons = null, $schedule = null);
$userId
is the user's unique id where he/she is registered for notifications. Read https://documentation.onesignal.com/docs/web-push-tagging-guide for additional details.
$url
, $data
, $buttons
and $schedule
fields are exceptional. If you provide a $url
parameter, users will be redirecting to that url.
Sending a Notification To Segment
You can simply send a notification to a specific segment with
OneSignal::sendNotificationToSegment("Some Message", $segment, $data = null, $url = null, $buttons = null, $schedule = null);
$url
, $data
, $buttons
and $schedule
fields are exceptional. If you provide a $url
parameter, users will be redirecting to that url.
Sending a Custom Notification
You can send a custom message with
OneSignal::sendNotificationCustom($parameters);
### Sending a Custom Notification
Sending a async Custom Notification
You can send a async custom message with
OneSignal::async()->sendNotificationCustom($parameters);
Please refer to https://documentation.onesignal.com/reference for all customizable parameters.