deblan/csv-validator
2
0
Fork 2
Code Issues Pull requests Releases 1 Activity

Php doc

Browse source
This commit is contained in:
Simon Vieille 2016-05-20 12:03:28 +02:00
commit 93e94be9c4
6 changed files with 242 additions and 135 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/Deblan/CsvValidator/Constraints/Csv.php
View file

@ -1,25 +0,0 @@
<?php
namespace Deblan\CsvValidator\Constraints;
use Symfony\Component\Validator\Constraints\File;
class Csv extends File
{
const FIELD_NOT_VALID = 10;
const FIELD_NOT_DETECTED = 11;
const LINE_NOT_VALID = 12;
protected static $errorNames = [
self::FIELD_NOT_VALID = 'FIELD_NOT_VALID',
self::FIELD_NOT_DETECTED = 'FIELD_NOT_DETECTED',
self::LINE_NOT_VALID = 'LINE_NOT_VALID',
];
public $fieldsConstraints = [];
public $lineConstraints = [];
public $fieldNotValidMessage = 'The field {{ field }} of the line {{ line }} is not valid. {{ message }}';
public $fieldNotDetectedMessage = 'The field {{ field }} of the line {{ line }} is missing.';
public $lineNotValidMessage = 'The line {{ line }} is not valid. {{ message }}';
}

99
src/Deblan/CsvValidator/Constraints/CsvValidator.php
View file

@ -1,99 +0,0 @@
<?php
namespace Deblan\CsvValidator\Constraints;
use Symfony\Component\Validator\Constraints\FileValidator;
use Symfony\Component\Validator\Constraint;
use Deblan\Csv\CsvParser;
class CsvValidator extends FileValidator
{
public function validate($value, Constraint $constraint)
{
if (!$constraint instanceof Csv) {
throw new UnexpectedTypeException($constraint, __NAMESPACE__.'\Csv');
}
$violations = count($this->context->getViolations());
parent::validate($value, $constraint);
if (null === $constraint->parser) {
throw new \RuntimeException('You must set a CSV parser.');
}
if (!is_object($constraint->parser) || !($value instanceof CsvParser)) {
throw new \RuntimeException('You must be an instance of Deblan\\Csv\\CsvParser.');
}
if (empty($constraint->fieldsConstraints) && empty($constraint->lineConstraints)) {
return;
}
$context = $this->context;
$parser = $constraint->parser;
$parser->setFilename($value);
$parser->parse();
foreach ($parser->getDatas() as $line => $data) {
if ($parser->getHasLegend() && $line === 0) {
continue;
}
foreach ($constraint->lineConstraints as $lineConstraint) {
$violations = $this->getConstraintViolations($context, $data, $lineConstraint);
foreach ($violations as $violation) {
$this->buildViolationInContext($context, $constraint->lineNotValidMessage)
->setParameter('{{ line }}', $line + 1)
->setParameter('{{ message }}', $violation->getMessage())
->setInvalidValue(null)
->setCode(Csv::LINE_NOT_VALID)
->addViolation();
}
}
foreach ($constraint->fieldsConstraints as $field => $fieldConstraints) {
if (!array_key_exists($field, $line)) {
$this->buildViolationInContext($context, $constraint->fieldNotDetectedMessage)
->setParameter('{{ field }}', ctype_digit($field) ? $field + 1 : $field)
->setParameter('{{ line }}', $line + 1)
->setParameter('{{ message }}', $violation->getMessage())
->setInvalidValue(null)
->setCode(Csv::FIELD_NOT_DETECTED)
->addViolation();
continue;
}
foreach ($fieldConstraints as $fieldConstraint) {
$violations = $this->getConstraintViolations($context, $data[$field], $fieldConstraint);
foreach ($violations as $violation) {
$this->buildViolationInContext($context, $constraint->fieldNotValidMessage)
->setParameter('{{ field }}', ctype_digit($field) ? $field + 1 : $field)
->setParameter('{{ line }}', $k + 1)
->setParameter('{{ message }}', $violation->getMessage())
->setInvalidValue(null)
->setCode(Csv::FIELD_NOT_VALID)
->addViolation();
}
}
}
}
}
protected function getConstraintViolations($context, $data, Constraint $constraint)
{
if ($context instanceof ExecutionContextInterface) {
$violations = $context->getValidator()
->inContext($context)
->validate($data, $constraint);
} else {
// 2.4 API
$violations = $context->validateValue($data, $constraint);
}
return $violations;
}
}

86
src/Deblan/CsvValidator/Validator.php
View file

@ -6,21 +6,50 @@ use Deblan\Csv\CsvParser;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintViolationList;
use Symfony\Component\Validator\Validator\RecursiveValidator;
use Symfony\Component\Validator\ConstraintViolation;
/**
* Class Validator
* @author Simon Vieille <simon@deblan.fr>
*/
class Validator
{
/**
* @var CsvParser
*/
protected $parser;
/**
* @var RecursiveValidator
*/
protected $validator;
/**
* @var array
*/
protected $fieldsConstraints = [];
/**
* @var array
*/
protected $dataConstraints = [];
/**
* @var boolean
*/
protected $hasValidate = false;
/**
* @var array
*/
protected $errors = [];
/**
* Constructor
*
* @param CsvParser $parser
* @param RecursiveValidator $validator
*/
public function __construct(CsvParser $parser, RecursiveValidator $validator)
{
$this->parser = $parser;
@ -28,6 +57,13 @@ class Validator
$this->validator = $validator;
}
/**
* Append a constraint to a specific column
*
* @param $key The column number
* @param Constraint $constraint The constraint
* @return Validator
*/
public function addFieldConstraint($key, Constraint $constraint)
{
if (!array_key_exists($key, $this->fieldsConstraints)) {
@ -39,13 +75,23 @@ class Validator
return $this;
}
public function addDataContraint(Constraint $constraint)
/**
* Append a constraint to a specific line
*
* @param $key The column number
* @param Constraint $constraint The constraint
* @return Validator
*/
public function addDataConstraint(Constraint $constraint)
{
$this->dataConstraints[] = $constraint;
return $this;
}
/**
* Run the validation
*/
public function validate()
{
if ($this->hasValidate) {
@ -75,27 +121,35 @@ class Validator
$this->hasValidate = true;
}
/**
* Add violations
*
* @param ConstraintViolationList $violations
* @param integer $line The line of the violations
* @param integer|null $key The column of the violations
*/
protected function mergeViolationsMessages(ConstraintViolationList $violations, $line, $key = null)
{
if (count($violations) === 0) {
return;
}
if (!array_key_exists($line, $this->errors)) {
$this->errors[$line] = [];
}
if (is_int($key)) {
$key++;
}
foreach ($violations as $violation) {
$message = sprintf('Line %d%s: %s', $line + 1, $key !== null ? ', field '.($key) : '', $violation->getMessage());
$this->errors[$line][] = $message;
$this->errors[] = new Violation($line + 1, $key, $violation);
}
}
/**
* Create and append a violation from a string error
*
* @param string $message The error message
* @param integer $line The line of the violations
* @param integer|null $key The column of the violations
*/
protected function mergeErrorMessage($message, $line, $key = null)
{
if (!array_key_exists($line, $this->errors)) {
@ -106,11 +160,16 @@ class Validator
$key++;
}
$message = sprintf('Line %d%s: %s', $line + 1, $key !== null ? ', field '.($key) : '', $message);
$this->errors[$line][] = $message;
$violation = new ConstraintViolation($message, $message, [], null, '', null);
$this->errors[] = new Violation($line + 1, $key, $violation);
}
/**
* Returns the validation status
*
* @return boolean
* @throw RuntimeException No validation yet
*/
public function isValid()
{
if (!$this->hasValidate) {
@ -120,6 +179,11 @@ class Validator
return empty($this->errors);
}
/**
* Returns the errors
*
* @return array
*/
public function getErrors()
{
return $this->errors;

100
src/Deblan/CsvValidator/Violation.php Normal file
View file

@ -0,0 +1,100 @@
<?php
namespace Deblan\CsvValidator;
use Symfony\Component\Validator\ConstraintViolation;
/**
* Class Violation
* @author Simon Vieille <simon@deblan.fr>
*/
class Violation
{
/**
* @var integer
*/
protected $line;
/**
* @var integer
*/
protected $column;
/**
* @var ConstraintViolation
*/
protected $violation;
/**
* Constructor
*
* @param integer $line The line of the violation
* @param integer $column The column of the violation
* @param ConstraintViolation $violation The violation
*/
public function __construct($line, $column, ConstraintViolation $violation)
{
$this->setLine($line)
->setColumn($column)
->setViolation($violation);
}
/**
* @param int $line
* @return Violation
*/
public function setLine($line)
{
$this->line = (int) $line;
return $this;
}
/**
* @return int $line
*/
public function getLine()
{
return $this->line;
}
/**
* @param int $column
* @return Violation
*/
public function setColumn($column)
{
$this->column = (int) $column;
return $this;
}
/**
* @return int $column
*/
public function getColumn()
{
return $this->column;
}
/**
* @param ConstraintViolation $violation
* @return
*/
public function setViolation(ConstraintViolation $violation)
{
$this->violation = $violation;
return $this;
}
/**
* @return ConstraintViolation $violation
*/
public function getViolation()
{
return $this->violation;
}
}