eskater / laravel-fcm
A package to send Firebase notification cross Laravel Application
Requires
- php: ^5.6|^7.0
- illuminate/support: ~5.1.0|~5.2.0|~5.3.0|~5.4.0|~5.5.0|~5.6.0|~5.7.0
README
Original library - Kawankoding\Fcm
Laravel FCM
A Simple package that help you send a firebase notification with your laravel applications
Installation
You can pull the package via composer :
$ composer require eskater/laravel-fcm
Next, You must register the service provider :
// config/app.php 'Providers' => [ ... Eskater\Fcm\FcmServiceProvider::class, ]
If you want to make use of the facade you must install it as well:
// config/app.php 'aliases' => [ ... 'Fcm' => Eskater\Fcm\FcmFacade::class, ];
Next, You must publish the config file to define your fcm server key :
php artisan vendor:publish --provider="Eskater\Fcm\FcmServiceProvider"
This is the contents of the published file:
return [ /* * Your Fcm Server Key * Change to yours */ 'server_key' => '', ];
Usage
If You want to send a FCM with just notification parameter, this is an example of usage sending a FCM with only data parameter :
fcm() ->to($recipients) // $recipients must an array ->data([ 'title' => 'Test FCM', 'body' => 'This is a test of FCM', ]) ->send();
If You want to send a FCM to topic, use method toTopic($topic) instead to() :
fcm() ->toTopic($topic) // $topic must an string (topic name) ->notification([ 'title' => 'Test FCM', 'body' => 'This is a test of FCM', ]) ->send();
If You want to send a FCM with just notification parameter,this is an example of usage sending a FCM with only notification parameter :
fcm() ->to($recipients) // $recipients must an array ->notification([ 'title' => 'Test FCM', 'body' => 'This is a test of FCM', ]) ->send();
If You want to send a FCM with both data & notification parameter, this is an example of usage sending a FCM with both data & notification parameter :
fcm() ->to($recipients) // $recipients must an array ->data([ 'title' => 'Test FCM', 'body' => 'This is a test of FCM', ]) ->useKey($serverKey) // $serverKey using another key ->notification([ 'title' => 'Test FCM', 'body' => 'This is a test of FCM', ]) ->send();