Download the PHP package jlorente/laravel-pushy without Composer
On this page you can find all versions of the php package jlorente/laravel-pushy. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-pushy
Pushy SDK for Laravel
Laravel integration for the Pushy SDK including a notification channel.
Installation
The preferred way to install this extension is through composer.
With Composer installed, you can then install the extension using the following commands:
or add
to the section of your composer.json
file.
Configuration
- Register the ServiceProvider in your config/app.php service provider list.
config/app.php
- Add the following facade to the $aliases section.
config/app.php
-
Publish the package in order to copy the configuration file to the config folder.
- Set the api_key in the config/pushy.php file or use the predefined env variables.
config/pushy.php
or .env
Usage
You can use the facade alias Pushy to execute api calls. The authentication params will be automaticaly injected.
Notification Channel
A notification channel is included in this package and allows you to integrate the Pushy send notifications service with the Laravel notifications.
Formatting Notifications
If you want to send a notification to Pushy, you should define a toPushy method on the notification class. This method will receive a $notifiable entity and should return a Jlorente\Laravel\Pushy\Notifications\Messages\PushyMessage instance or an array with the payload to be sent on the notification:
Once done, you must add the notification channel in the array of the via() method of the notification:
You can find more info about Laravel notifications in this page.
Routing the Notifications
When sending notifications via Pushy channel, the notification system will automatically look for a pushy_token attribute on the notifiable entity. If you would like to customize the token of the device the notification is delivered to, define a routeNotificationForPushy method on the entity:
You can find more info about Laravel notifications in this page.
License
Copyright © 2019 José Lorente Martín [email protected].
Licensed under the BSD 3-Clause License. See LICENSE.txt for details.