PushCrew notifications channel for Laravel 5.3
PHP
Latest commit 8518e88 Jan 4, 2017 @billmn billmn committed on GitHub Typo
Permalink
Failed to load latest commit information.
src Initial commit Oct 6, 2016
tests Fixed CS Nov 28, 2016
.editorconfig Initial commit Oct 6, 2016
.gitattributes Initial commit Oct 6, 2016
.gitignore Initial commit Oct 6, 2016
.scrutinizer.yml Initial commit Oct 6, 2016
.styleci.yml Initial commit Oct 6, 2016
.travis.yml Initial commit Oct 6, 2016
CHANGELOG.md Initial commit Oct 6, 2016
CONTRIBUTING.md Initial commit Oct 6, 2016
LICENSE.md Initial commit Oct 6, 2016
README.md Typo Jan 4, 2017
composer.json Code review Oct 19, 2016
phpunit.xml.dist Initial commit Oct 6, 2016

README.md

PushCrew Push Notifications Channel for Laravel 5.3

Latest Version on Packagist Software License Build Status StyleCI SensioLabsInsight Quality Score Code Coverage Total Downloads

This package makes it easy to send notifications using PushCrew with Laravel 5.3.

Contents

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 routeNotificationForPushCrew()
{
    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

License

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