Arp\LaminasEntity\Validator\AbstractValidator

Complexity

Total Complexity

18

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getFilterCriteria()	0	41	5
C	getValidationValues()	0	45	12

<?php

declare(strict_types=1);

namespace Arp\LaminasEntity\Validator;

use Arp\DoctrineEntityRepository\EntityRepositoryInterface;
use Arp\Entity\EntityInterface;
use Laminas\Validator\Exception\RuntimeException;

The type Laminas\Validator\Exception\RuntimeException was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * @author  Alex Patterson <alex.patterson.webdev@gmail.com>
 * @package Arp\LaminasEntity\Validator
 */
abstract class AbstractValidator extends \Laminas\Validator\AbstractValidator

The type Laminas\Validator\AbstractValidator was not found. Maybe you did not declare it correctly or list all dependencies?

{
    /**
     * @var EntityRepositoryInterface
     */
    protected $repository;

    /**
     * @var string[]
     */
    private $fieldNames;

    /**
     * @param EntityRepositoryInterface $repository
     * @param array                     $fieldNames
     * @param null|array                $options
     */
    public function __construct(EntityRepositoryInterface $repository, array $fieldNames, $options = null)
    {
        $this->repository = $repository;
        $this->fieldNames = $fieldNames;

        parent::__construct($options);
    }

    /**
     * @param mixed  $values   The values that should be validated.
     * @param array  $context  Additional information that can be used to validate.
     *
     * @return array
     *
     * @throws RuntimeException  If the match cannot be performed or the provided data is invalid.
     */
    protected function getFilterCriteria($values, array $context = []): array
    {
        $data = $this->getValidationValues($values, $context);

        // String index array, map index to a field name.
        $isHashMap = (array_values($data) !== $data);
        $criteria = [];

        $entityName = $this->repository->getClassName();

        if ($isHashMap) {
            foreach ($this->fieldNames as $fieldName) {
                if (!array_key_exists($fieldName, $data)) {
                    throw new RuntimeException(
                        sprintf(
                            'The expected validation value for field \'%s::%s\' could not not found in \'%s\'.',
                            $entityName,
                            $fieldName,
                            __METHOD__
                        )
                    );
                }

                $criteria[$fieldName] = $data[$fieldName];
            }
        } else {
            $criteria = @array_combine($this->fieldNames, $data);

            if (!is_array($criteria)) {
                throw new RuntimeException(
                    sprintf(
                        'The expected validation for \'%s\' field values could not be found for ' .
                        'numerically index array in \'%s\'.',
                        $entityName,
                        __METHOD__
                    )
                );
            }
        }

        return $criteria;
    }

    /**
     * Create an array of field name to field values based on the provided value.
     *
     * @param mixed  $values   The values that should be validated.
     * @param array  $context  Additional information that can be used to validate.
     *
     * @return array
     *
     * @throws RuntimeException  If the criteria cannot be created.
     */
    private function getValidationValues($values, array $context = []): array
    {
        if (null === $values || empty($values)) {
            /**
             * @NOTE If you have NULL/empty here you probably have a config issue. This validator would normally
             * require a UNIQUE value to be compared, empty string obviously will not work.
             *
             * SUGGESTION - Perhaps you need to have a not empty validator registered before this one
             * with break_chain_on_failure = true? This will prevent the NULL from being passed here.
             */
            $values = '';
        } elseif ($values instanceof EntityInterface) {
            $values = $values->getId();
        }

        if (is_scalar($values) && isset($this->fieldNames[0]) && 1 === count($this->fieldNames)) {
            /**
             * Here we are mapping the single scalar value to the single match field, casting the value to an array.
             */
            $values = [
                $this->fieldNames[0] => $values,
            ];
        } elseif (
            is_scalar($values)
            && (count($this->fieldNames) > 1
            || (bool)$this->getOption('useContext') ?: true)
        ) {
            /**
             * @note if we have a scalar value and more than one field in the match criteria then we have to use
             *       the context as the replacement.
             */
            $values = $context;
        }

        if (! is_array($values)) {
            throw new RuntimeException(
                sprintf(
                    'The \'values\' argument of type \'%s\' could not be resolved \'array\' in \'%s\'.',
                    gettype($values),
                    __METHOD__
                )
            );
        }

        return $values;
    }
}