frdteknikelektro/smsgateway-me

SMSGatewayMe Notifications Channel for Laravel

v1.0.1 2016-10-12 07:25 UTC

This package is auto-updated.

Last update: 2024-11-08 09:39:03 UTC


README

Here's the latest documentation on Laravel 5.3 Notifications System:

https://laravel.com/docs/master/notifications

SMSGatewayMe Notifications Channel for Laravel

Latest Version on Packagist Software License Build Status StyleCI SensioLabsInsight Quality Score Code Coverage Total Downloads

This package makes it easy to send notifications using SMSGatewayMe with Laravel 5.3.

Contents

Installation

You can install the package via composer:

composer require frdteknikelektro/smsgateway-me

You must install the service provider:

// config/app.php
'providers' => [
    ...
    NotificationChannels\SMSGatewayMe\SMSGatewayMeServiceProvider::class,
],

Setting up the SMSGatewayMe service

Sign up on SMSGatewayMe. Setting all needed, then add this to your config:

// config/services.php
...
'smsgateway-me' => [
    'email' => env('SMSGATEWAYME_EMAIL', 'email@example.com'),
    'password' => env('SMSGATEWAYME_PASSWORD', 'password'),
    'device_id' => env('SMSGATEWAYME_DEVICE_ID', '00000')
],
...

Usage

You can now use the channel in your via() method inside the Notification class.

use NotificationChannels\SMSGatewayMe\SMSGatewayMeChannel;
use NotificationChannels\SMSGatewayMe\SMSGatewayMeMessage;
use Illuminate\Notifications\Notification;

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

    public function toSmsGatewayMe($notifiable)
    {
        return (new SMSGatewayMeMessage)->text('Your invoice has been paid');
    }
}

Routing a message

You should add a routeNotificationForSmsGatewayMe() method in your notifiable model:

...
/**
 * Route notifications for the SMSGatewayMe channel.
 *
 * @return int
 */
public function routeNotificationForSmsGatewayMe()
{
    return $this->phone_number;
}
...

Available methods

  • text($text): (string) SMS Text.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

Before running a test please configure routeNotificationForSmsGatewayMe() and sendDataProvider() on test/Test.php

$ composer test

This test will send Hello World SMS.

Security

If you discover any security related issues, please email frdteknikelektro@gmail.com instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

License

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