SumoCoders\FrameworkCoreBundle\Validator\UniqueDataTransferObjectValidator

Complexity

Total Complexity

44

Size/Duplication

Total Lines	230
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
F	validate()	0	114	26
B	formatWithIdentifiers()	0	28	6
A	getIdentifiers()	0	15	3
A	getRepository()	0	27	4
A	getObjectManager()	0	24	4

<?php

namespace SumoCoders\FrameworkCoreBundle\Validator;

use Doctrine\Common\Persistence\ManagerRegistry;
use Doctrine\Common\Persistence\Mapping\ClassMetadata;
use Doctrine\Common\Persistence\ObjectManager;
use Doctrine\Common\Persistence\ObjectRepository;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Exception\UnexpectedTypeException;
use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
use Symfony\Component\Validator\ConstraintValidator;

/**
 * Unique Entity Validator checks if one or a set of fields contain unique values.
 */
class UniqueDataTransferObjectValidator extends ConstraintValidator
{
    /** @var ManagerRegistry */
    private $registry;

    public function __construct(ManagerRegistry $registry)
    {
        $this->registry = $registry;
    }

    /**
     * @param object $dataTransferObject
     * @param Constraint $constraint
     *
     * @throws UnexpectedTypeException
     * @throws ConstraintDefinitionException
     */
    public function validate($dataTransferObject, Constraint $constraint): void
    {
        if (!$constraint instanceof UniqueDataTransferObject) {
            throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\UniqueDataTransferObject');
        }

        if (!\is_array($constraint->fields) && !\is_string($constraint->fields)) {
            throw new UnexpectedTypeException($constraint->fields, 'array');
        }

        if ($constraint->errorPath !== null && !\is_string($constraint->errorPath)) {
            throw new UnexpectedTypeException($constraint->errorPath, 'string or null');
        }

        $fields = (array) $constraint->fields;

        if (\count($fields) === 0) {
            throw new ConstraintDefinitionException('At least one field has to be specified.');
        }

        if ($dataTransferObject === null) {
            return;
        }

        $om = $this->getObjectManager($dataTransferObject, $constraint);

        $class = $om->getClassMetadata($constraint->entityClass ?? \get_class($dataTransferObject->getEntity()));

        $criteria = array();
        $hasNullValue = false;

        foreach ($fields as $fieldName) {
            if (!$class->hasField($fieldName) && !$class->hasAssociation($fieldName)) {
                throw new ConstraintDefinitionException(
                    sprintf(
                        'The field "%s" is not mapped by Doctrine, so it cannot be validated for uniqueness.',
                        $fieldName
                    )
                );
            }

            $fieldValue = $dataTransferObject->$fieldName;

            if ($fieldValue === null) {
                $hasNullValue = true;
            }

            if ($constraint->ignoreNull && $fieldValue === null) {
                continue;
            }

            $criteria[$fieldName] = $fieldValue;

            if ($criteria[$fieldName] !== null && $class->hasAssociation($fieldName)) {
                /* Ensure the Proxy is initialized before using reflection to
                 * read its identifiers. This is necessary because the wrapped
                 * getter methods in the Proxy are being bypassed.
                 */
                $om->initializeObject($criteria[$fieldName]);
            }
        }

        // validation doesn't fail if one of the fields is null and if null values should be ignored
        if ($hasNullValue && $constraint->ignoreNull) {
            return;
        }

        // skip validation if there are no criteria (this can happen when the
        // "ignoreNull" option is enabled and fields to be checked are null
        if (empty($criteria)) {
            return;
        }

        $repository = $this->getRepository($dataTransferObject, $constraint, $om, $class);

        $result = $repository->{$constraint->repositoryMethod}($criteria);

        if ($result instanceof \IteratorAggregate) {
            $result = $result->getIterator();
        }

        /* If the result is a MongoCursor, it must be advanced to the first
         * element. Rewinding should have no ill effect if $result is another
         * iterator implementation.
         */
        if ($result instanceof \Iterator) {
            $result->rewind();
        } elseif (\is_array($result)) {
            reset($result);
        }

        /* If no entity matched the query criteria or a single entity matched,
         * which is the same as the entity being validated, the criteria is
         * unique.
         */
        if (\count($result) === 0
            || (
                \count($result) === 1
                && $dataTransferObject->getEntity() === ($result instanceof \Iterator ? $result->current() : current($result))
            )) {
            return;
        }

        $errorPath = $constraint->errorPath ?? $fields[0];
        $invalidValue = $criteria[$errorPath] ?? $criteria[$fields[0]];

        $this->context->buildViolation($constraint->message)
            ->atPath($errorPath)
            ->setParameter('{{ value }}', $this->formatWithIdentifiers($om, $class, $invalidValue))
            ->setInvalidValue($invalidValue)
            ->setCode(UniqueDataTransferObject::NOT_UNIQUE_ERROR)
            ->setCause($result)
            ->addViolation();
    }

    private function formatWithIdentifiers(ObjectManager $em, ClassMetadata $class, $value): string
    {
        if (!\is_object($value) || $value instanceof \DateTimeInterface) {
            return $this->formatValue($value, self::PRETTY_DATE);
        }

        $idClass = \get_class($value);
        $identifiers = $this->getIdentifiers($em, $class, $value, $idClass);

        if (!$identifiers) {

The expression $identifiers of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            return sprintf('object("%s")', $idClass);
        }

        array_walk(
            $identifiers,
            function (&$id, $field) {
                if (!\is_object($id) || $id instanceof \DateTimeInterface) {
                    $idAsString = $this->formatValue($id, self::PRETTY_DATE);
                } else {
                    $idAsString = sprintf('object("%s")', \get_class($id));
                }

                $id = sprintf('%s => %s', $field, $idAsString);
            }
        );

        return sprintf('object("%s") identified by (%s)', $idClass, implode(', ', $identifiers));
    }

    private function getIdentifiers(ObjectManager $om, ClassMetadata $class, $value, string $idClass): array
    {
        if ($class->getName() === $idClass) {
            return $class->getIdentifierValues($value);
        }

        // non unique value might be a composite PK that consists of other entity objects
        if ($om->getMetadataFactory()->hasMetadataFor($idClass)) {
            return $om->getClassMetadata($idClass)->getIdentifierValues($value);
        }

        // this case might happen if the non unique column has a custom doctrine type and its value is an object
        // in which case we cannot get any identifiers for it
        return array();
    }

    private function getRepository($dataTransferObject, Constraint $constraint, ObjectManager $om, ClassMetadata $class): ObjectRepository
    {
        if ($constraint->entityClass === null) {
            return $om->getRepository(\get_class($dataTransferObject->getEntity()));
        }

        /* Retrieve repository from given entity name.
         * We ensure the retrieved repository can handle the entity
         * by checking the entity is the same, or subclass of the supported entity.
         */
        $repository = $om->getRepository($constraint->entityClass);
        $supportedClass = $repository->getClassName();

        if ($dataTransferObject->getEntity() !== null
            && !$dataTransferObject->getEntity() instanceof $supportedClass) {
            throw new ConstraintDefinitionException(
                sprintf(
                    'The "%s" entity repository does not support the "%s" entity. The entity should be an instance of or extend "%s".',
                    $constraint->entityClass,
                    $class->getName(),
                    $supportedClass
                )
            );
        }

        return $repository;
    }

    private function getObjectManager($dataTransferObject, Constraint $constraint): ObjectManager
    {
        if ($constraint->em) {
            $om = $this->registry->getManager($constraint->em);

            if (!$om) {
                throw new ConstraintDefinitionException(
                    sprintf('Object manager "%s" does not exist.', $constraint->em)
                );
            }

            return $om;
        }

        $om = $this->registry->getManagerForClass(
            $constraint->entityClass ?? \get_class($dataTransferObject->getEntity())
        );

        if (!$om) {
            return $this->registry->getManager();
        }

        return $om;
    }
}