midnite81/gocardless

A Laravel 5 Intergration for GoCardless

dev-master 2018-10-11 14:32 UTC

Requires

• gocardless/gocardless-pro: ^2.1
• laravel/framework: ^5.0

Requires (Dev)

• mockery/mockery: ^1.1
• orchestra/testbench: ^3.0|^3.1|^3.2|^3.3|^3.4|^3.6|^3.7
• phpunit/phpunit: ^5.0|^6.0|^7.0
• satooshi/php-coveralls: 1.0.*

MIT

• Simon Rogers

README

This package is a laravel 5 wrapper for the GoCardless API. This package is in PreRelease and currently relies on dev-master. When ready for release, it will be tagged correctly.

Installation

This package requires PHP 5.6+, and comes with a Laravel 5 Service Provider and Facade for Laravel integration. Please note, you do not need to have laravel installed to use this package.

To install through composer include the package in your composer.json.

"midnite81/gocardless": "dev-master"

Run composer install or composer update to download the dependencies or you can run composer require midnite81/gocardless.

Laravel 5 Integration

To use the package with Laravel 5 add the GoCardless Service Provider to the list of Service Providers in app/config/app.php.

'providers' => [
    ...
    Midnite81\GoCardless\GoCardlessServiceProvider::class
    ...
];

Add the GoCardless facade to your aliases array.

'aliases' => [

  'GoCardless' => Midnite81\GoCardless\Facades\GoCardless::class,
  
];

Publish the required files

Publish the config and migration files using php artisan vendor:publish --provider="Midnite81\GoCardless\GoCardlessServiceProvider"

Environmental Variables

Once you have published the files, you will need to update your .env to include the following env keys.

GOCARDLESS_ENVIRONMENT=<live|sandbox>
GOCARDLESS_API_KEY_PRODUCTION=<your production api key>
GOCARDLESS_API_KEY_SANDBOX=<your sandbox api key>
GOCARDLESS_PUBLISH_MIGRATIONS=<true|false>

Check the config

You should take a look at the config/gocardless.php configuration file as there are a number of settings you should be aware of. For example, you can prefix migrations with a custom prefix of your own. Please update these if necessary.

Accessing the GoCardless Client

To access GoCardless you can either use the Facade or the GoCardless Client instance is bound to the IOC container and you can then dependency inject it via its contract.

GoCardless::getClient();

public function __construct(Midnite81\GoCardless\Contracts\Services\Client $client)
{
    $this->client = $client;
}