License plate validator and formatter

CI	Status
Lint
Coverage
Tests

This library can be used to validate and format license plate numbers.

Countries supported

Europe

• Belgium (1971-now)
• Finland (1922-now)
• France (1976-now)
• Germany (unknown date-now)
• Italy (1994-now)
• Luxembourg (unknown date-now)
• Netherlands (1951-now)
• Spain (1900-now)
• United Kingdom (1903-now)

Africa

• Central African Republic (2006-now)
• Gabon (1962-now)

Asia

• Israel (unknown date-now)

Oceania

• New Zealand (1964-now)

South America

• Brazil (1990-now)

More

• More countries will be added in the future

How to install

composer require automex/amex-license-plate-formatter-php

Or add the following to your composer.json:

{
    "require": {
        "automex/amex-license-plate-formatter-php": "^1.0.0"
    }
}

How to use

Call the constructor of the license plate class of your choice with the user input as the first parameter:

<?php
$licenseplate = new \Amex\LicensePlate\DutchLicensePlate('08ttnp');
if($licenseplate->isValid())
{
    echo $licenseplate->format(); // Outputs 08-TT-NP in this case
}

Since the license plate classes for each country implement the LicensePlateInterface, they expose isValid() and format() methods. Country-specific methods may also be available. Please check the code of the specific class to get the complete picture.

Please note that this library does not check if a license plate actually exists, nor does it exclude combinations that aren't allowed.

License

The code and the documentation are released under the LPGLv2.1 License.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Patrick Groot 🚇 ⚠️ 💻

This project follows the all-contributors specification. Contributions of any kind welcome!