minchao/mitake-laravel

Laravel Package for Mitake's PHP SDK

0.0.3 2018-09-05 14:31 UTC

Requires

• php: >=5.6
• illuminate/support: ^5.4
• minchao/mitake-php: ^0.3.0

Requires (Dev)

• orchestra/testbench: ^3.4
• phpunit/phpunit: ^5.7
• squizlabs/php_codesniffer: ^3.2

BSD-3-Clause

• laravel-service-provider
• mitake
• mitake-service-provider

README

This is a simple Laravel service provider for making it easy to access the Mitake PHP SDK in your Laravel and Lumen applications.

Installation

The Mitake service provider can be installed via Composer.

composer require minchao/mitake-laravel

To use the Mitake service provider, you must register the provider when bootstrapping your application.

Laravel

Laravel 5.5 and above

The package will automatically register provider and facade.

Laravel 5.4 and below

Add Mitake\Laravel\MitakeServiceProvider to the providers section of your config/app.php:

    'providers' => [
        // ...
        Mitake\Laravel\MitakeServiceProvider::class,
    ];

Add Mitake facade to the aliases section of your config/app.php:

    'aliases' => [
        // ...
        'Mitake' => Mitake\Laravel\Facade\Mitake::class,
    ];

Or use the facade class directly:

use Mitake\Laravel\Facade\Mitake;

Lumen

Register the Mitake\Laravel\MitakeServiceProvider in your bootstrap/app.php:

    $app->register(Mitake\Laravel\MitakeServiceProvider::class);

Copy the mitake.php config file in to your project:

mkdir config
cp vendor/minchao/mitake-laravel/config/mitake.php config/mitake.php

Configuration

Publish the package configuration using Artisan (Lumen doesn't support).

php artisan vendor:publish --provider="Mitake\Laravel\MitakeServiceProvider"

Then update config/mitake.php with your credentials. Alternatively, you can update your .env file.

MITAKE_USERNAME=username
MITAKE_PASSWORD=password

Usage

To use the Mitake SDK within your app, you need to retrieve it from the service container:

$mitake = app(\Mitake\Client::class);

$message = (new \Mitake\Message\Message())
    ->setDstaddr('0987654321')
    ->setSmbody('Hello, Laravel IoC Container');
$result = $mitake->send($message);

Or, you can use the Mitake facade:

$message = (new \Mitake\Message\Message())
    ->setDstaddr('0987654321')
    ->setSmbody('Hello, Facade');
$result = Mitake::send($message);

License

See the LICENSE file for license rights and limitations (BSD 3-Clause).