kavenegar/laravel

laravel 4 and 5 kavenegar integration

Kavenegar Laravel

First of all you will ned an API Key . You can get one Here., _(*1)

Supported Laravel Versions:

• V.4
• V.5
• V.6
• V.7
• V.8
• V.9
• V.10 > We highly recomment you to always use the latest version of laravel

Installation

Step 1 - Install the package

• Method 1: You can install kavenegar/laravel with Composer directly in your project:

composer require kavenegar/laravel

• Method 2: Add this line to Composer.json file in your project

"kavenegar/php": "*"

Then run following command to download extension using composer, _(*2)

$ composer update

Step 2

Head to config/app.php and add this line to the end of providers Array:, _(*3)

Kavenegar\Laravel\ServiceProvider::class,

So that array must me something like this:, _(*4)

'providers' => [
        /*
        * Laravel Framework Service Providers...
        */
        .
        .
        .
        Kavenegar\Laravel\ServiceProvider::class
]

Then in the config/app.php and add this line to the end of aliases Array:, _(*5)

'Kavenegar' => Kavenegar\Laravel\Facade::class,

Step 3 - Publish

Run this command in your project dirctory:, _(*6)

php artisan vendor:publish

In the message appear, find the number of Kavenegar, enter the related number then hit Enter. for Example in the below case you must enter 9 then enter:, _(*7)

Which provider or tag files would you like to publish?:
[0 ] Publish files from all providers and tags listed below
[1 ] Provider: Facade\Ignition\IgnitionServiceProvider
[2 ] Provider: Fideloper\Proxy\TrustedProxyServiceProvider
[3 ] Provider: Fruitcake\Cors\CorsServiceProvider
[4 ] Provider: Illuminate\Foundation\Providers\FoundationServiceProvider
[5 ] Provider: Illuminate\Mail\MailServiceProvider
[6 ] Provider: Illuminate\Notifications\NotificationServiceProvider
[7 ] Provider: Illuminate\Pagination\PaginationServiceProvider
**_ [8 ] Provider: Kavenegar\Laravel\ServiceProviderLaravel9_**
.
.
.

Step 4 - Api-Key

Now you must define your API Key to project. for this head to config/kavenegar.php then put your API KEY in the code:, _(*8)

<?php
return [
    'apikey' => ' ',
];

All Set

Usage

You can use the package where ever you want., _(*9)

• First use the class:

use Kavenegar;

Then use this pattern to send SMS:, _(*10)

try{
    $sender = "10004346";       //This is the Sender number

    $message = "خدمات پیام کوتاه کاوه نگار";        //The body of SMS

    $receptor = array("09361234567","09191234567");         //Receptors numbers

    $result = Kavenegar::Send($sender,$receptor,$message);
    if($result){
        foreach($result as $r){
            echo "messageid = $r->messageid";
            echo "message = $r->message";
            echo "status = $r->status";
            echo "statustext = $r->statustext";
            echo "sender = $r->sender";
            echo "receptor = $r->receptor";
            echo "date = $r->date";
            echo "cost = $r->cost";
        }
    }
}
catch(\Kavenegar\Exceptions\ApiException $e){
    // در صورتی که خروجی وب سرویس 200 نباشد این خطا رخ می دهد
    echo $e->errorMessage();
}
catch(\Kavenegar\Exceptions\HttpException $e){
    // در زمانی که مشکلی در برقرای ارتباط با وب سرویس وجود داشته باشد این خطا رخ می دهد
    echo $e->errorMessage();
}catch(\Exceptions $ex){
   // در صورت بروز خطایی دیگر
    echo $ex->getMessage()
}

Use this pattern to send VerifyLookup SMS:, _(*11)

try{
    $receptor = "09123456789";
    $token = "123";
    $token2 = "456";
    $token3 = "789";
    $template="verify";
    //Send null for tokens not defined in the template
    //Pass token10 and token20 as parameter 6th and 7th
    $result = Kavenegar::VerifyLookup($receptor, $token, $token2, $token3, $template, $type = null);
    if($result){
        foreach($result as $r){
            echo "messageid = $r->messageid";
            echo "message = $r->message";
            echo "status = $r->status";
            echo "statustext = $r->statustext";
            echo "sender = $r->sender";
            echo "receptor = $r->receptor";
            echo "date = $r->date";
            echo "cost = $r->cost";
        }
    }
}
catch(\Kavenegar\Exceptions\ApiException $e){
    // در صورتی که خروجی وب سرویس 200 نباشد این خطا رخ می دهد
    echo $e->errorMessage();
}
catch(\Kavenegar\Exceptions\HttpException $e){
    // در زمانی که مشکلی در برقرای ارتباط با وب سرویس وجود داشته باشد این خطا رخ می دهد
    echo $e->errorMessage();
}

You can find all the Error handlings and API parameters and Usage methods in the KaveNegar website., _(*12)

Usage in Notifications

Also you can use KavengarChannel for your notification:, _(*13)

create your notification:, _(*14)

php artisan make:notification InvoicePaid

extend your notification from KavenegarBaseNotification:, _(*15)

class InvoicePaid extends KavenegarBaseNotification
{

}

overide the toKavengar function:, _(*16)

class InvoicePaid extends KavenegarBaseNotification
{

   public function __construct(Invoice $invoice)
   {
       $this->invoice = $invoice;
   }

    public function toKavenegar($notifiable)
    {
        return (new KavenegarMessage("فاکتور شما به شماره $invoice->id پرداخت شد."))->from('10004346');
    }
}

you should add Notifiable trait and routeNotificationForKavenegar method in your model, _(*17)

class User extends Authenticatable
{
    use Notifiable;

    public function routeNotificationForKavenegar($driver, $notification = null)
    {
        return $this->mobile;
    }

}

** Notice: IF you DO NOT add routeNotificationForKavenegar in your notifiable model then you should set your receiver in your notification : **, _(*18)

class InvoicePaid extends KavenegarBaseNotification
{

    public function toKavenegar($notifiable)
    {
        return (new KavenegarMessage('فاکتور شما به شماره ۱۲۳۴ پرداخت شد.'))->from('10004346')->to('092100000');
    }
}

for send verify lookup message you should use verifyLookup method for set method name and tokens:, _(*19)

class InvoicePaid extends KavenegarBaseNotification
{

    public function toKavenegar($notifiable)
    {
        return (new KavenegarMessage())
            ->verifyLookup('verify_first',['token1','token2']);
    }
}

Contribution

Bug fixes, docs, and enhancements welcome! Please let us know support@kavenegar.com, _(*20)

http://kavenegar.com, _(*21)