sllh/iso-codes-validator

Symfony validator wrapper of ronanguilloux/isocodes

IsoCodesValidator

Symfony validator wrapper of IsoCodes project., _(*1)

, _(*2)

, _(*3)

, _(*4)

Installation

First of all, you need to require this library through composer:, _(*5)

``` bash $ composer require sllh/iso-codes-validator, <sub>(*6)</sub>

After this, you can use it as is.

If you are using it on a **Symfony** project,
you should read the following instructions for a better integration.

### As a Symfony bundle

If your project **is not using** [Symfony Full Stack](http://symfony.com/projects/symfonyfs),
you must add the following dependencies:

```bash
$ composer require symfony/dependency-injection symfony/http-kernel symfony/finder

Translations

If you wish to use default validator messages translations in this bundle, you have to make sure you have translator enabled in your config., <sub>(*7)</sub>

``` yaml, <sub>(*8)</sub>

app/config/config.yml

framework: translator: ~, <sub>(*9)</sub>

#### Enable the bundle

``` php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new SLLH\IsoCodesValidator\Bridge\Symfony\Bundle\SLLHIsoCodesValidatorBundle(),
    );
}

Usage

IsoCodesValidator is based on Symfony Validator library., <sub>(*10)</sub>

Manual usage

Create and use IsoCodes constraints by using the Symfony Validation class:, <sub>(*11)</sub>

use Symfony\Component\Validator\Validation;
use SLLH\IsoCodesValidator\Constraints\Vat;

$validator = Validation::createValidator();

$violations = $validator->validateValue('DE123456789', new Vat());

With annotations

Validation of objects is possible using "constraint mapping". With such a mapping you can put constraints onto properties and objects of classes. Whenever an object of this class is validated, its properties and method results are matched against the constraints., <sub>(*12)</sub>

use Symfony\Component\Validator\Validation;
use Symfony\Component\Validator\Constraints as Assert;
use SLLH\IsoCodesValidator\Constraints as IsoCodesAssert;

class Company
{
    /**
     * @Assert\NotBlank
     * @IsoCodesAssert\Siret
     */
    private $siret;

    /**
     * @Assert\NotBlank
     * @IsoCodesAssert\Siren
     */
    private $siren;

    /**
     * @IsoCodesAssert\Vat
     */
    private $vat;

    /**
     * @IsoCodesAssert\ZipCode(country = "FR")
     */
    private $zipCode;

    public function __construct($siret, $siren, $vat, $zipCode)
    {
        $this->siret = $siret;
        $this->siren = $siren;
        $this->vat = $vat;
        $this->zipCode = $zipCode
    }
}

$validator = Validation::createValidatorBuilder()
    ->enableAnnotationMapping()
    ->getValidator();

$company = new Company('48853781200015', '432167567', 'DE123456789', '59000');

$violations = $validator->validate($company);

Constraints reference

Constraints classes can be found on src/Constraints., <sub>(*13)</sub>

All works "as is" without any options unless message., <sub>(*14)</sub>

Only ZipCode constraint accept a country option to limit validation ('all' by default)., <sub>(*15)</sub>

Please note that some IsoCodes classes are already implemented on Symfony Validator component. It's up to you to decide which one to use., <sub>(*16)</sub>

If you think an IsoCodes class is missing, feel free to open an issue or make a PR., <sub>(*17)</sub>

License

This bundle is under the MIT license. See the complete license on the LICENSE file., <sub>(*18)</sub>

TODO

• Try to implement OrganismeType12NormeB2 (Maybe with a special form type?)
• Implement and test xml/yaml assert config for Symfony: http://symfony.com/doc/current/book/validation.html#the-basics-of-validation