PushCrew Push Notifications Channel for Laravel 5.3

This package makes it easy to send notifications using [PushCrew](link to service) with Laravel 5.3.

Contents

• Installation
  • Setting up the PushCrew service
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

You can install the package via composer:

composer require laravel-notification-channels/pushcrew

Setting up the PushCrew service

Add your PushCrew API Token to your config/services.php:

// config/services.php
'pushcrew' => [
    'token' => env('PUSHCREW_API_TOKEN'),
]

Usage

Now you can use the channel in your via() method inside the notification:

use NotificationChannels\PushCrew\PushCrewChannel;
use NotificationChannels\PushCrew\PushCrewMessage;
use Illuminate\Notifications\Notification;

class AccountApproved extends Notification
{
    public function via($notifiable)
    {
        return [PushCrewChannel::class];
    }

    public function toPushCrew($notifiable)
    {
        return PushCrewMessage::create()
                    ->subject("Your account was approved!")
                    ->body("Click here to see details.")
                    ->icon('https://upload.wikimedia.org/wikipedia/commons/4/4f/Laravel_logo.png')
                    ->url('http://pushcrew.com');
    }
}

In order to let your Notification know which PushCrew subscriber(s) you are targeting, add the routeNotificationForPushCrew method to your Notifiable model.

You can either return a single subscriber-id, or if you want to notify multiple subscriber IDs just return an array containing all IDs.

public function routeNotificationForOneSignal()
{
    return 'PUSHCREW_SUBSCRIBER_ID';
}

Available Message methods

• subject(''): Accepts a string value for the title.
• body(''): Accepts a string value for the notification body.
• icon(''): Accepts an url for the icon.
• url(''): Accepts an url for the notification click event.

For more information take a look here.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email bellini.davide@gmail.com instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

• Davide Bellini
• All Contributors

License

The MIT License (MIT). Please see License File for more information.