Laravel Luhn

, _(*1)

marvinlabs/laravel-luhn is a laravel package providing various Laravel utilities to work with the Luhn algorithm such as:, _(*2)

a few validation rules
dependency injection
facade

The Luhn algorithm is used widely to verify that numbers are valid: credit card numbers, SIREN company codes, etc., _(*3)

Installation

You can install the package via composer:, _(*4)

``` bash composer require marvinlabs/laravel-luhn, _(*5)


If you are using Laravel 5.5, the service provider and facade will automatically be discovered. 

On earlier versions, you need to do that manually. You must install the service provider:

```php
// config/app.php
'providers' => [
    ...
    MarvinLabs\Luhn\LuhnServiceProvider::class
];

And optionally register an alias for the facade., _(*6)

// config/app.php
'aliases' => [
    ...
    'Luhn' => MarvinLabs\Luhn\Facades\Luhn::class,
];

Usage

Algorithm implementation

The package provides an implementation to the algorithm interface defined in \MarvinLabs\Luhn\Contracts\LuhnAlgorithm., _(*7)

The contract provides 3 public methods to:, _(*8)

Check if an input string is valid according to the Luhn algorithm
Compute the check digit to append to a string in order to make it valid
Compute the checksum according to the Luhn algorithm

Facade

A facade is provided to access the Luhn algorithm implementation., _(*9)

Luhn::isValid('1234');
Luhn::computeCheckDigit('1234');
Luhn::computeCheckSum('1234');

Dependency injection

You can get an implementation of the Luhn algorithm at any time using the Laravel container., _(*10)

$luhn = app(\MarvinLabs\Luhn\Contracts\LuhnAlgorithm::class); // Using the interface
$luhn = app('luhn'); // This shortcut works too, up to you ;)

Validation

The package provides custom rules to validate a string., _(*11)

$validator = Validator::make($data, [
    'number1' => 'luhn',         // Using shorthand notation
    'number2' => new LuhnRule(), // Using custom rule class
]);