srph/luhn

An implementation of Luhn algorithm (aka mod-10 algorithm) in PHP.

php-luhn

An implementation of Luhn algorithm (aka mod-10 algorithm) to validate (verify the checksum of) credit card numbers in PHP., _(*1)

* This was written to try out PHPUnit, but feel free to use it for anything as long as the MIT License permits., _(*2)

Installation

To install this library, simply run composer require in your project's root directory:, _(*3)

$ composer require srph/luhn

Usage

This library is very easy to use! Our function only accepts one string argument and returns a boolean., _(*4)

<?php
/**
 * SRPH\Luhn\luhn(<string>);
 */
SRPH\Luhn\luhn('79927398712') => true
?>

For PHP >=v5.6, you can use the use function (aka import function) syntax:, _(*5)

 true
?>

Contribution

Feel free to submit any inquiry, question, issue or pull-request!, _(*6)

Building

* For contributors or for learning purposes only., _(*7)

Requirements: - PHP >=v5.x (Ehh?) - Composer (Install development dependencies) - Git (To clone the repository), _(*8)

First, clone the repository, and then install the development dependencies., _(*9)

$ git clone https://github.com/srph/luhn.php.git && cd luhn.php
$ composer install

You're good to go., _(*10)

Automation

# ensure that you are in the root directory of the project
$ phpunit # run tests

Acknowledgement

php-luhn © 2015+, Kier Borromeo (srph). Released under the MIT License., _(*11)

srph.github.io  ·  GitHub @srph  ·  Twitter @_srph, _(*12)