lucasvdh/laravel-iban

A Laravel plugin for IBAN validation

Laravel IBAN validation

IBAN validation made easy., _(*1)

, _(*2)

Getting started

1. Include the package in your application
2. Register the service provider
3. Example usage

Include the package in your application

``` bash $ composer require lucasvdh/laravel-iban:5.*, <sub>(*3)</sub>

Or add a requirement to your project's composer.json

``` javascript
"require": {
    "lucasvdh/laravel-iban": "5.*"
},

TODO: register package at the packagist, <sub>(*4)</sub>

Register the service

Add the following to your config/app.php, <sub>(*5)</sub>

``` php <?php, <sub>(*6)</sub>

return [, <sub>(*7)</sub>

...

'providers' => [
    ... 

    IBAN\ServiceProvider::class,
],

...

// Optionally you can register the Facade alias
'aliases' => [
    ...

    'IBAN' => IBAN\Facades\IBAN::class,
],

];, <sub>(*8)</sub>

Example usages
--------------

IBAN validation can be used in the following ways:
1. [Via the facade](#via-the-facade)
2. [Via dependency injection](#via-dependency-injection)
3. [Via validation rules](#via-validation-rules)

#### Via the facade
``` php
function validateIBAN($iban) 
{
    echo $iban;

    if (\IBAN::validate($iban)) {
        echo 'is a valid IBAN';
    } else {
        echo 'is NOT valid IBAN';
    }

    echo "\r\n";
}

validateIBAN('NL39 RABO 0300 0652 64');
validateIBAN('123456789');

This results in, <sub>(*9)</sub>

NL39 RABO 0300 0652 64 is a valid IBAN
123456789 is NOT a valid IBAN

Via dependency injection

``` php <?php namespace App\Http\Controllers;, <sub>(*10)</sub>

use IBAN\Services\IBANService;, <sub>(*11)</sub>

class IBANController extends Controller {, <sub>(*12)</sub>

public function validate(IBANService $IBANService, $iban)
{
    if ($IBANService->validate($iban)) {
        return response()->json([
            'message' => $iban . 'is a valid IBAN'
        ]);
    } else {
        return response()->json([
            'message' => $iban . 'is NOT a valid IBAN'
        ]);
    }
}

}, <sub>(*13)</sub>

#### Via validation rules

``` php
$validator = Validator::make(
    ['required_iban_field' => 'required|iban'],
    ['optional_iban_field' => 'sometimes|iban'],
);