CSV validator library.
Go to file
Simon Vieille 104b25d17c README 2016-12-03 18:46:28 +01:00
src/Deblan/CsvValidator PSR2 compliance 2016-12-02 13:50:07 +01:00
tests tests 2016-12-02 15:18:33 +01:00
.gitignore init 2015-03-17 17:54:50 +01:00
LICENSE Init commit 2015-03-17 16:13:33 +01:00
README.md README 2016-12-03 18:46:28 +01:00
composer.json Packaging 2016-10-13 15:53:40 +02:00
example.php Renaming of method 2016-05-30 12:02:49 +02:00
phpci.yml phpci file 2016-12-03 18:41:54 +01:00
phpunit.xml init 2015-03-17 17:54:50 +01:00

README.md

csv-validator

CSV validator library

That uses the constraints of Symfony framework: http://symfony.com/doc/current/reference/constraints.html.

Installation

You need composer:

composer require deblan/csv-validator

Example

<?php

use Deblan\Csv\CsvParser;
use Deblan\CsvValidator\Validator;
use Symfony\Component\Validator\Validation;
use Symfony\Component\Validator\Constraints\Email;
use Symfony\Component\Validator\Constraints\Date;
use Symfony\Component\Validator\Constraints\Callback;
use Symfony\Component\Validator\Context\ExecutionContextInterface;

require __DIR__.'/vendor/autoload.php';

// Initialisation of the validator
$validator = new Validator();

// The first field must contain an email
$validator->addFieldConstraint(0, new Email());

// The second field must contain a date
$validator->addFieldConstraint(1, new Date());

// Validate the legend
$validator->setExpectedLegend(array('foo', 'bar', 'bim'));

// An line must contain 3 columns
$validator->addDataConstraint(new Callback(function($data, ExecutionContextInterface $context) {
    if (count($data) !== 6) { // 6 because of the legend (3 fields * 2)
        $context->addViolation('The line must contain 3 columns');
    }
}));

// Initialisation of the parser
$parser = new CsvParser(__DIR__.'/tests/fixtures/example.csv');
$parser->setHasLegend(true);

$validator->validate($parser);

if ($validator->isValid() === false) {
    foreach ($validator->getErrors() as $error) {
        $line = $error->getLine();
        $column = $error->getColumn();
        $message = $error->getViolation()->getMessage();

        echo <<<EOF
<ul>
    <li>Line: $line</li>
    <li>Column: $column</li>
    <li>
        <p>$message</p>
    </li>
</ul>

EOF;
    }
}

Contributors

  • Simon Vieille
  • Gautier Deruette