gvital3230/laravel-notification-channel-viber-net-ua

viber.net.ua notification channel for Laravel

1.1.3 2022-07-22 11:12 UTC

Requires

• php: >=7.2
• ext-json: *
• guzzlehttp/guzzle: 6.* || ~7.0
• illuminate/notifications: ~5.5 || ~6.0 || ~7.0 || ~8.0
• illuminate/support: ~5.5 || ~6.0 || ~7.0 || ~8.0
• myclabs/php-enum: ^1.7

Requires (Dev)

• mockery/mockery: ^1.0
• phpunit/phpunit: ^8.0

MIT

• Vitalii Goncharov

README

This package makes it easy to send notifications using ViberNetUa with Laravel 5.5+, 6.0 and 7.0

Contents

• Installation
  • Setting up the ViberNetUa service
• Usage
  • On-Demand Notifications
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

You can install this package via composer:

composer require gvital3230/laravel-notification-channel-viber-net-ua

Setting up the ViberNetUa service

Add your ViberNetUa sms gate login, password and default sender name to your config/services.php:

// config/services.php
...
    'vibernetua' => [
        'endpoint' => env('VIBERNETUA_ENDPOINT', 'https://my2.viber.net.ua/api/v2/viber/dispatch'),
        'token' => env('VIBERNETUA_TOKEN'),
        'sender' => env('VIBERNETUA_SENDER'),
        'debug' => env('VIBERNETUA_DEBUG'),
        'sandboxMode' => env('VIBERNETUA_SANDBOX_MODE', false),
    ],
...

Usage

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

use Illuminate\Notifications\Notification;
use NotificationChannels\ViberNetUa\ViberNetUaMessage;

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

    public function toViberNetUa($notifiable)
    {
        return (new ViberNetUaMessage(
            \NotificationChannels\ViberNetUa\ViberNetUaMessageType::TYPE_ONLY_MESSAGE(), 
            'Account approved', 
            'Congratulations, your accaunt was approved!'));       
    }
}

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

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

On-Demand Notifications

Sometimes you may need to send a notification to someone who is not stored as a "user" of your application. Using the Notification::route method, you may specify ad-hoc notification routing information before sending the notification:

Notification::route('vibernetua', '[phone]')                      
            ->notify(new AccountApproved());

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

• Vitalii Goncharov
• All Contributors

License

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