Coder Social home page Coder Social logo

freddygenicho / laravel-africastalking-notification Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 15 KB

Laravel Africastalking Notification Channel

License: MIT License

PHP 100.00%
laravel africastalking laravel-notification-channels laravel-notifications

laravel-africastalking-notification's Introduction

laravel-africastalking-notification

Laravel AfricasTalking Notification Channel

Build Status GitHub stars GitHub forks GitHub license GitHub issues Twitter

Use this package to send sms notifications via Africastaclking. Laravel 5.3+ required.

Install

This package can be installed through Composer.

composer require freddygenicho/laravel-africastalking-notification

If installing on < Laravel 5.5 then add the service provider:

// config/app.php
'providers' => [
    ...
    FreddyGenicho\AfricasTalking\AfricasTalkingNotificationServiceProvider::class,
    ...
];

First, publish configuration files

php artisan vendor:publish --provider="FreddyGenicho\AfricasTalking\AfricasTalkingNotificationServiceProvider"

This will publish the africastalking configuration file into the config directory as africastalking.php. This file contains all the configurations required to use the package.

Example Usage

Use Artisan to create a notification:

php artisan make:notification SomeNotification

Return [africasTalking] in the public function via($notifiable) method of your notification:

/**
* @param $notifiable
* @return array
*/
public function via($notifiable)
{
    return ['africasTalking'];
}

Add the method public function toAfricasTalking($notifiable) to your notification, and return an instance of AfricasTalkingMessage:

use FreddyGenicho\AfricasTalking\Message\AfricasTalkingMessage;

...
/**
* Get the AfricasTalking representation of the notification.
* @param $notifiable
* @return AfricasTalkingMessage
*/
public function toAfricasTalking($notifiable)
{
   return (new AfricasTalkingMessage())
          ->content('Hello world')
          ->from('Genicho');
}

In order to let your Notification know which phone are you sending/calling to, the channel will look for the phone_number attribute of the Notifiable model. If you want to override this behaviour, add the routeNotificationForAfricasTalking method to your Notifiable model.

public function routeNotificationForAfricasTalking()
{
    return '+25412345678';
}

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

License

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

laravel-africastalking-notification's People

Contributors

freddygenicho avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.