batyukovstudio/laravel-notification-channels-pushsms-ru

PushSMS notifications channel for Laravel

dev-master 2022-11-07 10:41 UTC

Requires

• php: >=7.4
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.0.1
• illuminate/notifications: 5.1 - 5.8|^6.0|^7.0|^8.0|^9.0
• illuminate/queue: 5.1 - 5.8|^6.0|^7.0|^8.0|^9.0
• illuminate/support: 5.1 - 5.8|^6.0|^7.0|^8.0|^9.0

Requires (Dev)

• mockery/mockery: ^1.3.1
• phpunit/phpunit: ^9.3

MIT

• batyukovstudio

• notifications
• laravel
• pushsms

README

This package makes it easy to send notifications using pushsms.ru with Laravel.

Contents

• Installation
  • Setting up the PushSMS service
• Usage
  • Message method

Installation

Install this package with Composer:

composer require batyukovstudio/laravel-notification-channels-pushsms-ru

The service provider gets loaded automatically. Or you can do this manually:

// config/app.php
'providers' => [
    ...
    NotificationChannels\PushSMS\PushSmsServiceProvider::class,
],

Setting up the PushSms service

Add your PushSms token to your .env:

// .env
...
PUSHSMS_TOKEN=qwerty123

Usage

You need to replace Notification extend with PushSmsNotification class.

namespace App\Notifications;

use NotificationChannels\PushSMS\Notifications\PushSmsNotification;

class MyNotification extends PushSmsNotification
{
    use Queueable;
    
    // ...
}

PushSmsNotification contains $content variable for your text message and toPushSms method. This method will receive a $notifiable entity and should return an NotificationChannels\PushSMS\ApiActions\PushSmsMessage instance:

// PushSmsNotification
}
use Illuminate\Notifications\Notification;
use NotificationChannels\PushSMS\ApiActions\PushSmsMessage;
use NotificationChannels\PushSMS\Notifications\Interfaces\PushSmsable;

abstract class PushSmsNotification extends Notification implements PushSmsable
{
    protected string $content;

    public function toPushSms($notifiable): PushSmsMessage
    {
        return PushSmsMessage::create()->content($this->content);
    }
}

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

namespace App\Notifications;

use NotificationChannels\PushSMS\Notifications\PushSmsNotification;
use NotificationChannels\PushSMS\PushSmsChannel;

class MyNotification extends PushSmsNotification
{
    public function via($notifiable)
    {
        return [PushSmsChannel::class];
    }
}

In your notifiable model, make sure to include a routeNotificationForPushsms() method, which returns a phone number or an array of phone numbers.

public function routeNotificationForPushsms()
{
    return $this->phone;
}

Message method

content(): Set a content of the notification message.