kavenegar/laravel-notification

laravel notificatiion channel for Kavenegar

Kavenegar notifications channel for Laravel 5.3 | 5.4

This package makes it easy to send Kavenegar SMS notifications with Laravel 5.3 or 5.4., _(*1)

Contents

• Installation
  • Setting up your Kavenegar account
• Usage
• Contributing

Installation

You can install the package via composer:, _(*2)

``` bash composer require kavenegar/laravel-notification, <sub>(*3)</sub>

You must install the service provider:

```php
// config/app.php
'providers' => [
    ...
    Kavenegar\LaravelNotification\KavenegarServiceProvider::class,
],

Setting up your Kavenegar account

Add your Kavenegar Account Key and Sender Number (optional) to your config/services.php:, <sub>(*4)</sub>

// config/services.php
...
'kavenegar' => [
    'key' => env('KAVENEGAR_API_KEY'),
    'sender' => env('KAVENEGAR_SENDER')
],
...

Usage

Now you can use the channel in your via() method inside the notification:, <sub>(*5)</sub>

``` php use Kavenegar\LaravelNotification\KavenegarChannel; use Illuminate\Notifications\Notification;, <sub>(*6)</sub>

class HappyNewYear extends Notification { public function via($notifiable) { return [KavenegarChannel::class]; }, <sub>(*7)</sub>

public function toSMS($notifiable)
{
    return 'Happy new year :D';
}

}, <sub>(*8)</sub>

In order to let your Notification know which phone number you are sending to, add the `routeNotificationForSms` method to your Notifiable model e.g your User Model

```php
public function routeNotificationForSms()
{
    return $this->phone; // where `phone` is a field in your users table;
}

Contributing

Bug fixes, docs, and enhancements welcome! Please let us know support@kavenegar.com, <sub>(*9)</sub>