README

Laravel integration for the Esendex SDK including a notification channel.

Installation

The preferred way to install this extension is through composer.

With Composer installed, you can then install the extension using the following commands:

$ php composer.phar require jlorente/laravel-esendex

or add

... "require": { "jlorente/laravel-esendex": "*" }

to the require section of your composer.json file.

Configuration

1. Register the ServiceProvider in your config/app.php service provider list.

config/app.php

return [ //other stuff 'providers' => [ //other stuff \Jlorente\Laravel\Esendex\EsendexServiceProvider::class, ]; ];

1. If you want, you can add the following facade to the $aliases section.

config/app.php

return [ //other stuff 'aliases' => [ //other stuff 'Esendex' => \Jlorente\Laravel\Esendex\Facades\Esendex::class, ]; ];

1. Set the reference, username and password of your esendex account in the config/services.php file inside an array with 'esendex' as key.

config/services.php

return [ //other stuff 'esendex' => [ 'reference' => '', // your account reference 'username' => '', // your account username 'password' => '', // your account password 'default_from' => 'Laravel', // optional name of the sender 'dry_run' => false, // only for the notification channel, if true, no sms's will be sent 'throw_exception_on_error' => true // This will throw up the Esendex sdk exception if an exception is thrown by the dispatchService on the EsendexSmsChannel ]; ];

Usage

You can use the facade alias Esendex to execute services of the esendex sdk. The authentication params will be automaticaly injected.

Esendex::dispatchService()->send(new DispatchMessage( $sender , $phone , $text , Message::SmsType ));

You can see a full list of the esendex sdk services in this page.

Notification Channel

A notification channel is included in this package and allows you to integrate the Esendex service with the Laravel notifications.

Formatting Notifications

If a notification supports being sent as an SMS through Esendex, you should define a toEsendex method on the notification class. This method will receive a $notifiable entity and should return a Jlorente\Laravel\Esendex\Notifications\Messages\EsendexMessage instance or a string containing the message to send:

/**  * Get the Esendex / SMS representation of the notification.  *  * @param mixed $notifiable  * @return \Jlorente\Laravel\Esendex\Notifications\Messages\EsendexMessage|string  */ public function toEsendex($notifiable) { return (new EsendexMessage) ->content('Your SMS message content'); }

Once done, you must add the notification channel in the array of the via() method of the notification:

/**  * Get the notification channels.  *  * @param mixed $notifiable  * @return array|string  */ public function via($notifiable) { return [EsendexSmsChannel::class]; }

Customizing The Name of the Sender

If you would like to send some notifications with a sender name that is different from the one specified in your config/services.php file, you may use the from method on a EsendexMessage instance:

/**  * Get the Esendex / SMS representation of the notification.  *  * @param mixed $notifiable  * @return \Jlorente\Laravel\Esendex\Notifications\Messages\EsendexMessage|string  */ public function toEsendex($notifiable) { return (new EsendexMessage) ->content('Your SMS message content') ->from('Popilio'); }

Routing the Notifications

When sending notifications via the esendex channel, the notification system will automatically look for a phone_number attribute on the notifiable entity. If you would like to customize the phone number the notification is delivered to, define a routeNotificationForEsendex method on the entity:

<?php namespace App; use Illuminate\Notifications\Notifiable; use Illuminate\Foundation\Auth\User as Authenticatable; class User extends Authenticatable { use Notifiable; /**  * Route notifications for the Esendex channel.  *  * @param \Illuminate\Notifications\Notification $notification  * @return string  */ public function routeNotificationForEsendex($notification) { return $this->phone; } }

You can find more info about Laravel notifications in this page.

License

Copyright © 2018 José Lorente Martín jose.lorente.martin@gmail.com.

Licensed under the BSD 3-Clause License. See LICENSE.txt for details.