trez/raygan-sms-notification-channel

Raygan SMS Channel for Laravel 5.3+

2.0 2019-01-25 12:29 UTC

README

This package makes it easy to send notifications using RayganSms API with Laravel 5.3+.

RayganSms notifications channel for Laravel 5.3+

Latest Version on Packagist Software License StyleCI Scrutinizer Code Quality Build Status Code Intelligence Status Quality Score Total Downloads

این پکیج امکان ارسال اعلانات (notifications) را با استفاده از پکیج RayganSms API فراهم می سازد.

محتوا

نصب و پیکره بندی

با استفاده از composer قادر به نصب این سرویس می باشید:

composer require trez/raygan-sms-notification-channel
توجه داشته باشید سرویس RayganSms API به همراه این پکیج بصورت اتوماتیک بر روی پروژه شما نصب می شود. بنابراین چنانچه از قبل پکیج RayganSms API بر روی پروژه شما نصب و تنظیمات مربوطه را انجام داده اید ، اقدامات مرتبط با نصب به پایان رسیده، در غیر این صورت مطابق مستندات مربوطه این پکیج (پیکره بندی در لاراول)اقدام نمایید.

نحوه استفاده

با استفاده از متد ()via این کانال را به notefication خود اضافه نموده و متد toRayganSms را مطابق زیر جهت ارسال اعلان اضافه می نماییم:

use Illuminate\Notifications\Notification;
use NotificationChannels\RayganSms\RaygansmsChannel;
use NotificationChannels\RayganSms\TextMessage;
use NotificationChannels\RayganSms\AuthCodeMessage;

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

    public function toRayganSms($notifiable)
    {
        return (new TextMessage)
            ->content("your message to send ...");
    }
}
جهت ارسال کد فعال سازی به کاربر می توان به صورت زیر عمل نمود :
...
    public function toRayganSms($notifiable)
    {
        return (new AuthCodeMessage)
                    ->content('Welcome');
    }
    ...
و چنانچه بخواهیم کد فعال سازی دلخواه ارسال کنیم :
...
    public function toRayganSms($notifiable)
    {
        return (new AuthCodeMessage)
                    ->content('کد تایید شما : 325689')
                    ->autoGenerate(false);
    }

نکته: جهت اطمینان از ارسال پیام به شماره کاربر، از مدل که معمولا مدل User می باشد جهت استخراج شماره تماس کاربر استفاده می نمایید، ابتدا trait زیر را به مدل خود اضافه نمائید :
    use Notifiable;
سپس متد زیر را به مدل اضافه نمائید :
    public function routeNotificationForRayganSms()
    {
        return $this->phone_number;
    }
توجه داشته باشید در این مدل ستون حاوی شماره تماس کاربر phone_number می باشد. در غیر اینصورت this->phone_number$ را مطابق با نام ستون حاوی شماره تماس کاربر تغییر دهید.

تولیدکننده

لایسنس

لایسنس این پکیج (MIT) می باشد . جهت اطلاعات در مورد این لایسنس به License File مراجعه نمایید.