grigio/notifications

Notification handler

v2.1.0 2020-03-09 08:59 UTC

Requires

• php: >=5.5
• ext-json: *
• guzzlehttp/guzzle: ^6.5.2
• league/pipeline: ^1.0.0

MIT

• Farshad Fakhar

• email
• sms
• notification
• smsir
• sms_ir

README

PHP Notification handler

Supported notification channels

• Sms.ir
• Laravel email

Instalation

• composer require grigio/notifications

• php artisan vendor:publish and choose config

• Add this environment variables to .env

    SMSIR_SECRET_KEY=
    SMSIR_API_KEY=
    SMSIR_NUMBER=
  

• Email channel use MAIL_USERNAME as from address and APP_NAME as name for sending emails

• Create your notification class like this

  class YourNotification extends GrigioNotification {
  
    public function viaSmsIR()
    {
        $data = $this->data();
        $this->setReceiver(
          //Get mobile from $data
        );
        $this->setMessage(
            //Put your message here
        );
        return $this->sendPrepration();
    }
  
    public function viaEmail()
    {
        $data = $this->data();
        $this->setSubject(
          // Email title
        );
        $this->setReceiver(
          //Reciver email address
        );
        $this->setMessage(view('Your Email Template', ['data' => $data]));
        return $this->sendPrepration();
  
    }
  }
  

• Use Notifible trait in your model

• Now in your method that you want send notification

   $order->notify(new YourNotification($order));

Channel Development

• Create a class like this

class SmsIRChannel extends GerigioChannel implements ChannelContract
{
   /**
    * Name of the method for this channel in notification class
    */
   public $channel = 'fill with notification class method name';

   /**
    * Channel Send Method
    * Do process of sending message
    */
   public function send()
   {
       // You access seted datas in notification class as an array
       $message = $this->getMessage();
       // Do the process of sending notification
   }
}

• Register it in config/grigionotification.php
• Add channel method to your notification class. Now you have a new channel :)

If you like to help us send your new channel as a pull request <3