ravelino/laravel-wesender

A Laravel package for notifying via Wesender api.

dev-main 2020-11-29 08:55 UTC

Requires

• php: >=7.2
• illuminate/events: ^5.8 || ^6.0 || ^7.0 || ^8.0
• illuminate/notifications: ^5.8 || ^6.0 || ^7.0 || ^8.0
• illuminate/queue: ^5.8 || ^6.0 || ^7.0 || ^8.0
• illuminate/support: ^5.8 || ^6.0 || ^7.0 || ^8.0

Requires (Dev)

• mockery/mockery: ^1.3
• phpunit/phpunit: ^8.5

MIT

• Ravelino de Castro

• php
• sms
• notification
• laravel
• wesender

README

This package allows you to use Wesenderons with Laravel (tested in version 8) to send SMS.

Contents

• Installation
• Usage
  • Available Message methods
• Testing
• Security
• Contributing
• Credits
• License

Installation

You can install the package via composer:

composer require ravelino/laravel-wesender

Configuration

Add your ApKey to your .env:

WESENDER_API_KEY=******************************
WESENDER_SPECIAL_CHARACTERS=true

Advanced configuration

Run php artisan vendor:publish --provider="Ravelino\Wesender\WesenderProvider"

/config/wesender.php

Usage

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

use Ravelino\Wesender\WesenderChannel;
use Ravelino\Wesender\WesenderSmsMessage;
use Illuminate\Notifications\Notification;

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

    public function toWesender($notifiable)
    {
        return (new WesenderSmsMessage())
            ->content("Hello world!");
    }
}

In order to let your Notification know which phone are you sending, the channel will look for the phone_number attribute of the Notifiable model. If you want to override this behaviour, add the routeNotificationForWesender method to your Notifiable model.

public function routeNotificationForWesender()
{
    return '[phone]';
}

Available Message methods

WesenderSmsMessage

• content(''): Accepts a string value for the notification body.

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

• Ravelino de Castro
• All Contributors

License

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