demian/laravel-notifications-gcm

Android GCM Push Notification Channel

0.0.3 2016-11-09 16:48 UTC

Requires

• php: >=5.5
• illuminate/events: ^5.1|^5.2|^5.3
• illuminate/notifications: ^5.3
• illuminate/queue: ^5.1|^5.2|^5.3
• illuminate/support: ^5.1|^5.2|^5.3
• zendframework/zend-http: >=2.0.0
• zendframework/zend-json: >=2.0.0

Requires (Dev)

• mockery/mockery: ^0.9.5
• phpunit/phpunit: 4.*

MIT

• Fruitcake

README

This package makes it easy to send notifications using Google Cloud Messaging (GCM) with Laravel 5.3.

This package is based on ZendService\Google\Gcm, so please read that documentation for more information.

Contents

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

Installation

Install this package with Composer:

composer require laravel-notification-channels/gcm

Register the ServiceProvider in your config/app.php:

NotificationChannels\Gcm\GcmServiceProvider::class,

Setting up the GCM service

You need to register for a server key for Google Cloud Messaging for your App in the Google API Console: https://console.cloud.google.com/apis/

Add the API key to your configuration in config/broadcasting.php

'connections' => [
  ....
  'gcm' => [
      'key' => env('GCM_KEY'),
  ],
  ...
]

Usage

You can now send messages to GCM by creating a GcmMessage:

use NotificationChannels\Gcm\GcmChannel;
use NotificationChannels\Gcm\GcmMessage;
use Illuminate\Notifications\Notification;

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

    public function toGcm($notifiable)
    {
        return GcmMessage::create()
            ->badge(1)
            ->title('Account approved')
            ->message("Your {$notifiable->service} account was approved!");
    }
}

In your notifiable model, make sure to include a routeNotificationForGcm() method, which return one or an array of tokens.

public function routeNotificationForGcm()
{
    return $this->gcm_token;
}

Available methods

• title($str)
• message($str)
• badge($integer)
• priorty(GcmMessage::PRIORITY_NORMAL or GcmMessage::PRIORITY_HIGH)
• data($key, $mixed)
• action($action, $params) (Will set an action data key)

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

• Fruitcake
• All Contributors

License

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