mdiyakov / DoctrineSolrBundle

Config/ConfigValidator.php

<?php

namespace Mdiyakov\DoctrineSolrBundle\Config;

use Mdiyakov\DoctrineSolrBundle\Exception\ClientConfigException;
use Mdiyakov\DoctrineSolrBundle\Exception\ConfigFieldException;
use Mdiyakov\DoctrineSolrBundle\Exception\EntityClassConfigException;
use Mdiyakov\DoctrineSolrBundle\Exception\FilterConfigException;
use Mdiyakov\DoctrineSolrBundle\Exception\RequiredFieldException;
use Mdiyakov\DoctrineSolrBundle\Exception\SchemaConfigException;
use Mdiyakov\DoctrineSolrBundle\Exception\SchemaNotFoundException;

class ConfigValidator
{
    /**
     * @var string[]
     */
    private $discriminatorValues = [];

    /**
     * @var string[]
     */
    private $entityClasses = [];

    /**
     * @param string[][] $entityConfig
     * @param string[][] $schemes
     * @param string[][] $filters
     * @param string[] $clients
     * @throws SchemaNotFoundException
     */
    public function validate($entityConfig, $schemes, $filters, $clients)
    {
        if (!array_key_exists($entityConfig['schema'], $schemes)) {
            throw new SchemaNotFoundException(
                sprintf('Schema "%s" is not found in "schema" config section. Check config.yml', $entityConfig['schema'])

$entityConfig['schema'] of type string[] is incompatible with the type string expected by parameter $args of sprintf().

            );
        }

        $schemaConfig = $schemes[$entityConfig['schema']];
        $this->checkEntityContainRequiredFields($entityConfig['class'], $schemaConfig);

$entityConfig['class'] of type string[] is incompatible with the type string expected by parameter $entityClass of Mdiyakov\DoctrineSolrBundle\Config\ConfigValidator::checkEntityContainRequiredFields().

$schemaConfig of type string[] is incompatible with the type array<mixed,string[]> expected by parameter $schemaConfig of Mdiyakov\DoctrineSolrBundle\Config\ConfigValidator::checkEntityContainRequiredFields().

        $this->checkClassesForUnique($entityConfig['class']);
        $this->checkConfigFields($entityConfig, $schemaConfig);

$schemaConfig of type string[] is incompatible with the type array<mixed,string[]> expected by parameter $schemaConfig of Mdiyakov\DoctrineSolrBundle\Config\ConfigValidator::checkConfigFields().

        $this->checkFilters($entityConfig, $filters);
        $this->checkClients($schemaConfig, $clients);
        $this->checkDocumentFieldNamesAreUnique($schemaConfig);
    }

    /**
     * @param string $entityClass
     * @param string[][] $schemaConfig
     * @throws RequiredFieldException
     */
    private function checkEntityContainRequiredFields($entityClass, $schemaConfig)
    {
        foreach ($schemaConfig['fields'] as $fieldConfig) {
            $this->checkEntityHasField($entityClass, $fieldConfig['entity_field_name']);
        }
    }

    /**
     * @param string[][] $entityConfig
     * @param string[][] $schemaConfig
     * @throws ConfigFieldException
     */
    private function checkConfigFields($entityConfig, $schemaConfig)
    {
        $schemaConfigEntityFields = $schemaConfig['config_entity_fields'];
        if (!is_array($schemaConfigEntityFields)) {

The condition is_array($schemaConfigEntityFields) is always true.

            return;
        }

        $configFields = $entityConfig['config'];
        if (!is_array($configFields)) {

The condition is_array($configFields) is always true.

            throw new ConfigFieldException(
                sprintf('Config fields for "%s" entity are not defined. Check entity config', $entityConfig['class'])
            );
        }
        $configFieldsNames = [];
        foreach ($configFields as $configField) {
            $configFieldsNames[$configField['name']] = $configField['value'];
        }

        foreach ($schemaConfigEntityFields as $fieldConfig) {
            if (!array_key_exists($fieldConfig['config_field_name'], $configFieldsNames)) {
                throw new ConfigFieldException(
                    sprintf(
                        '"%s" config field is not defined in indexed_entities for entity %s',
                        $fieldConfig['config_field_name'],
                        $entityConfig['class']

$entityConfig['class'] of type string[] is incompatible with the type string expected by parameter $args of sprintf().

                    )
                );
            }

            if ($fieldConfig['discriminator'] === true) {
                $discriminatorValue = $configFieldsNames[$fieldConfig['config_field_name']];
                if (in_array($discriminatorValue, $this->discriminatorValues)) {
                    throw new ConfigFieldException(
                        sprintf(
                            '"%s" discriminator value has already been used.
                            It seems there are two entity classes inside "indexed_entities" with identical discriminator config field value',
                            $discriminatorValue
                        )
                    );
                }
                $this->discriminatorValues[] =  $discriminatorValue;
            }
        }
    }

    /**
     * @param $schemaConfig
     * @param $clients
     * @throws ClientConfigException
     */
    private function checkClients($schemaConfig, $clients)
    {
        if (!empty($schemaConfig['client']) && !array_key_exists($schemaConfig['client'], $clients)) {
            throw new ClientConfigException(
                sprintf('Solarium client "%s" is not defined in "solarium_clients" section', $schemaConfig['client'])
            );
        }
    }

    /**
     * @param string[][] $entityConfig
     * @param string[][] $filters
     */
    private function checkFilters($entityConfig, $filters)
    {
        if (array_key_exists('filters', $entityConfig)) {

            $filtersKeys = array_fill_keys(
                array_merge(
                    array_keys($filters['fields']),
                    array_keys($filters['services'])
                ),
                true
            );

            foreach($entityConfig['filters'] as $filterName) {
                if (!array_key_exists($filterName, $filtersKeys)) {
                    throw new FilterConfigException(
                        sprintf('Filter "%s" is not defined in "filters" section', $filterName)
                    );
                }
            }

            if (array_key_exists('fields', $filters) && is_array($filters['fields'])) {
                foreach ($filters['fields'] as $filterName => $filterConfig) {
                    try {
                        $this->checkEntityHasField($entityConfig['class'], $filterConfig['entity_field_name']);
                    } catch (RequiredFieldException $e) {
                        $message = $e->getMessage() . ' Error occurred for "filters" section. Please check the filters configuration in config.yml';
                        throw new RequiredFieldException($message);
                    }

                }
            }
        }
    }

    /**
     * @param string[][] $schemaConfig
     * @throws SchemaConfigException
     */
    private function checkDocumentFieldNamesAreUnique($schemaConfig)
    {
        $schemaFields = [ $schemaConfig['config_entity_fields'], $schemaConfig['fields'] ];
        $documentFieldsNames = [];

        while ($fieldsConfig = array_shift($schemaFields)) {
            foreach ($fieldsConfig as $fieldConfig) {
                $documentFieldName = $fieldConfig['document_field_name'];
                if (array_key_exists($documentFieldName, $documentFieldsNames)) {
                    throw new SchemaConfigException(
                        sprintf('You have more than one fields with the same  document field name "%s"', $documentFieldName)
                    );
                }
                $documentFieldsNames[$documentFieldName] = true;
            }
        }
    }

    /**
     * @param string $entityClass
     * @param string $entityFieldName
     * @throws RequiredFieldException
     */
    private function checkEntityHasField($entityClass, $entityFieldName)
    {
        $reflection = new \ReflectionClass($entityClass);
        $getterMethodName = 'get' . ucfirst($entityFieldName);
        $isserMethodName = 'is' . ucfirst($entityFieldName);

        if ($reflection->hasMethod($getterMethodName)) {
            $getterReflectionMethod = new \ReflectionMethod($entityClass, $getterMethodName);
            if (!$getterReflectionMethod->isPublic()) {
                throw new RequiredFieldException(
                    sprintf(
                        'Getter method "%s" is not public in "%s".',
                        $getterMethodName,
                        $entityClass
                    )
                );
            }
        } elseif ($reflection->hasMethod($isserMethodName)) {
            $isserReflectionMethod = new \ReflectionMethod($entityClass, $isserMethodName);
            if (!$isserReflectionMethod->isPublic()) {
                throw new RequiredFieldException(
                    sprintf(
                        'Isser method "%s" is not public in "%s".',
                        $isserMethodName,
                        $entityClass
                    )
                );
            }
        } else {
            throw new RequiredFieldException(
                 sprintf(
                    'Either getter method "%s" or isser method "%s" is not found in %s.',
                    $getterMethodName,
                    $isserMethodName,
                    $entityClass
                )
            );
        }
    }

    /**
     * @param $entityClass
     * @throws EntityClassConfigException
     */
    private function checkClassesForUnique($entityClass)
    {
        if (!in_array($entityClass, $this->entityClasses)) {
            $this->entityClasses[] = $entityClass;
        } else {
            throw new EntityClassConfigException(
                sprintf(
                    'It seems entity class "%s" has been configured more than once inside "indexed_entities" section. You can not have different config for the single entity class',
                    $entityClass
                )
            );
        }
    }
}