alekseyshavrak/laravel-smsru

SmsRu Notifications Driver

dev-master 2020-11-23 20:32 UTC

Requires

• php: >=7.2
• illuminate/support: ~5.7|~5.8|^6.0|^7.0|^8.0

Requires (Dev)

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

MIT

• Aleksey Shavrak

README

This package makes it easy to send notifications using sms.ru with Laravel > 5.*.

Contents

• Installation
  • Setting up the configuration
• Usage
  • Available Message methods
• Changelog
• Testing
• Contributing
• Credits
• License

Installation

You can install this package via composer:

composer require alekseyshavrak/laravel-smsru

Next add the service provider to your config/app.php:

...
'providers' => [
    ...
     NotificationChannels\SmsRu\SmsRuServiceProvider::class,
],
...

Setting up the configuration

Add your API ID (secret key) and default sender name to your config/services.php:

// config/services.php
...
'smsru' => [
    'api_id' => env('SMSRU_API_ID'),
    'sender' => 'John_Doe'
],
...

Usage

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

use NotificationChannels\SmsRu\SmsRuChannel;
use NotificationChannels\SmsRu\SmsRuMessage;
use Illuminate\Notifications\Notification;

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

    public function toSmsRu($notifiable)
    {
        return SmsRuMessage::create('message text');
    }
}

In order to let your Notification know which phone number you are targeting, add the routeNotificationForSmsRu method to your Notifiable model.

Available message methods

• from(): Sets the sender's name.
• text(): Sets a text of the notification message.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Credits

• Aleksey Shabrak
• All Contributors

License

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