vendor/doctrine/orm/src/Tools/SchemaValidator.php line 121

  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Tools;
  7. use BackedEnum;
  8. use Doctrine\DBAL\Types\AsciiStringType;
  9. use Doctrine\DBAL\Types\BigIntType;
  10. use Doctrine\DBAL\Types\BooleanType;
  11. use Doctrine\DBAL\Types\DecimalType;
  12. use Doctrine\DBAL\Types\FloatType;
  13. use Doctrine\DBAL\Types\GuidType;
  14. use Doctrine\DBAL\Types\IntegerType;
  15. use Doctrine\DBAL\Types\JsonType;
  16. use Doctrine\DBAL\Types\SimpleArrayType;
  17. use Doctrine\DBAL\Types\SmallIntType;
  18. use Doctrine\DBAL\Types\StringType;
  19. use Doctrine\DBAL\Types\TextType;
  20. use Doctrine\DBAL\Types\Type;
  21. use Doctrine\Deprecations\Deprecation;
  22. use Doctrine\ORM\EntityManagerInterface;
  23. use Doctrine\ORM\Mapping\ClassMetadata;
  24. use Doctrine\ORM\Mapping\ClassMetadataInfo;
  25. use ReflectionEnum;
  26. use ReflectionNamedType;
  28. use function array_diff;
  29. use function array_filter;
  30. use function array_key_exists;
  31. use function array_map;
  32. use function array_push;
  33. use function array_search;
  34. use function array_values;
  35. use function assert;
  36. use function class_exists;
  37. use function class_parents;
  38. use function count;
  39. use function get_class;
  40. use function implode;
  41. use function in_array;
  42. use function interface_exists;
  43. use function is_a;
  44. use function sprintf;
  46. use const PHP_VERSION_ID;
  48. /**
  49.  * Performs strict validation of the mapping schema
  50.  *
  51.  * @link        www.doctrine-project.com
  52.  *
  53.  * @psalm-import-type FieldMapping from ClassMetadata
  54.  */
  55. class SchemaValidator
  56. {
  57.     /** @var EntityManagerInterface */
  58.     private $em;
  60.     /** @var bool */
  61.     private $validatePropertyTypes;
  63.     /**
  64.      * It maps built-in Doctrine types to PHP types
  65.      */
  66.     private const BUILTIN_TYPES_MAP = [
  67.         AsciiStringType::class => ['string'],
  68.         BigIntType::class => ['int', 'string'],
  69.         BooleanType::class => ['bool'],
  70.         DecimalType::class => ['string'],
  71.         FloatType::class => ['float'],
  72.         GuidType::class => ['string'],
  73.         IntegerType::class => ['int'],
  74.         JsonType::class => ['array'],
  75.         SimpleArrayType::class => ['array'],
  76.         SmallIntType::class => ['int'],
  77.         StringType::class => ['string'],
  78.         TextType::class => ['string'],
  79.     ];
  81.     public function __construct(EntityManagerInterface $em, bool $validatePropertyTypes = true)
  82.     {
  83.         $this->em                    = $em;
  84.         $this->validatePropertyTypes = $validatePropertyTypes;
  85.     }
  87.     /**
  88.      * Checks the internal consistency of all mapping files.
  89.      *
  90.      * There are several checks that can't be done at runtime or are too expensive, which can be verified
  91.      * with this command. For example:
  92.      *
  93.      * 1. Check if a relation with "mappedBy" is actually connected to that specified field.
  94.      * 2. Check if "mappedBy" and "inversedBy" are consistent to each other.
  95.      * 3. Check if "referencedColumnName" attributes are really pointing to primary key columns.
  96.      *
  97.      * @psalm-return array<string, list<string>>
  98.      */
  99.     public function validateMapping()
  100.     {
  101.         $errors  = [];
  102.         $cmf     = $this->em->getMetadataFactory();
  103.         $classes = $cmf->getAllMetadata();
  105.         foreach ($classes as $class) {
  106.             $ce = $this->validateClass($class);
  107.             if ($ce) {
  108.                 $errors[$class->name] = $ce;
  109.             }
  110.         }
  112.         return $errors;
  113.     }
  115.     /**
  116.      * Validates a single class of the current.
  117.      *
  118.      * @return string[]
  119.      * @psalm-return list<string>
  120.      */
  121.     public function validateClass(ClassMetadataInfo $class)
  122.     {
  123.         if (! $class instanceof ClassMetadata) {
  124.             Deprecation::trigger(
  125.                 'doctrine/orm',
  126.                 'https://github.com/doctrine/orm/pull/249',
  127.                 'Passing an instance of %s to %s is deprecated, please pass a ClassMetadata instance instead.',
  128.                 get_class($class),
  129.                 __METHOD__,
  130.                 ClassMetadata::class
  131.             );
  132.         }
  134.         $ce  = [];
  135.         $cmf = $this->em->getMetadataFactory();
  137.         foreach ($class->fieldMappings as $fieldName => $mapping) {
  138.             if (! Type::hasType($mapping['type'])) {
  139.                 $ce[] = "The field '" . $class->name . '#' . $fieldName . "' uses a non-existent type '" . $mapping['type'] . "'.";
  140.             }
  141.         }
  143.         // PHP 7.4 introduces the ability to type properties, so we can't validate them in previous versions
  144.         if (PHP_VERSION_ID >= 70400 && $this->validatePropertyTypes) {
  145.             array_push($ce, ...$this->validatePropertiesTypes($class));
  146.         }
  148.         if ($class->isEmbeddedClass && count($class->associationMappings) > 0) {
  149.             $ce[] = "Embeddable '" . $class->name . "' does not support associations";
  151.             return $ce;
  152.         }
  154.         foreach ($class->associationMappings as $fieldName => $assoc) {
  155.             if (! class_exists($assoc['targetEntity']) || $cmf->isTransient($assoc['targetEntity'])) {
  156.                 $ce[] = "The target entity '" . $assoc['targetEntity'] . "' specified on " . $class->name . '#' . $fieldName . ' is unknown or not an entity.';
  158.                 return $ce;
  159.             }
  161.             $targetMetadata = $cmf->getMetadataFor($assoc['targetEntity']);
  163.             if ($targetMetadata->isMappedSuperclass) {
  164.                 $ce[] = "The target entity '" . $assoc['targetEntity'] . "' specified on " . $class->name . '#' . $fieldName . ' is a mapped superclass. This is not possible since there is no table that a foreign key could refer to.';
  166.                 return $ce;
  167.             }
  169.             if ($assoc['mappedBy'] && $assoc['inversedBy']) {
  170.                 $ce[] = 'The association ' . $class . '#' . $fieldName . ' cannot be defined as both inverse and owning.';
  171.             }
  173.             if (isset($assoc['id']) && $targetMetadata->containsForeignIdentifier) {
  174.                 $ce[] = "Cannot map association '" . $class->name . '#' . $fieldName . ' as identifier, because ' .
  175.                         "the target entity '" . $targetMetadata->name . "' also maps an association as identifier.";
  176.             }
  178.             if ($assoc['mappedBy']) {
  179.                 if ($targetMetadata->hasField($assoc['mappedBy'])) {
  180.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the owning side ' .
  181.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' which is not defined as association, but as field.';
  182.                 }
  184.                 if (! $targetMetadata->hasAssociation($assoc['mappedBy'])) {
  185.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the owning side ' .
  186.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' which does not exist.';
  187.                 } elseif ($targetMetadata->associationMappings[$assoc['mappedBy']]['inversedBy'] === null) {
  188.                     $ce[] = 'The field ' . $class->name . '#' . $fieldName . ' is on the inverse side of a ' .
  189.                             'bi-directional relationship, but the specified mappedBy association on the target-entity ' .
  190.                             $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' does not contain the required ' .
  191.                             "'inversedBy=\"" . $fieldName . "\"' attribute.";
  192.                 } elseif ($targetMetadata->associationMappings[$assoc['mappedBy']]['inversedBy'] !== $fieldName) {
  193.                     $ce[] = 'The mappings ' . $class->name . '#' . $fieldName . ' and ' .
  194.                             $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' are ' .
  195.                             'inconsistent with each other.';
  196.                 }
  197.             }
  199.             if ($assoc['inversedBy']) {
  200.                 if ($targetMetadata->hasField($assoc['inversedBy'])) {
  201.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the inverse side ' .
  202.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' which is not defined as association.';
  203.                 }
  205.                 if (! $targetMetadata->hasAssociation($assoc['inversedBy'])) {
  206.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the inverse side ' .
  207.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' which does not exist.';
  208.                 } elseif ($targetMetadata->associationMappings[$assoc['inversedBy']]['mappedBy'] === null) {
  209.                     $ce[] = 'The field ' . $class->name . '#' . $fieldName . ' is on the owning side of a ' .
  210.                             'bi-directional relationship, but the specified inversedBy association on the target-entity ' .
  211.                             $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' does not contain the required ' .
  212.                             "'mappedBy=\"" . $fieldName . "\"' attribute.";
  213.                 } elseif ($targetMetadata->associationMappings[$assoc['inversedBy']]['mappedBy'] !== $fieldName) {
  214.                     $ce[] = 'The mappings ' . $class->name . '#' . $fieldName . ' and ' .
  215.                             $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' are ' .
  216.                             'inconsistent with each other.';
  217.                 }
  219.                 // Verify inverse side/owning side match each other
  220.                 if (array_key_exists($assoc['inversedBy'], $targetMetadata->associationMappings)) {
  221.                     $targetAssoc = $targetMetadata->associationMappings[$assoc['inversedBy']];
  222.                     if ($assoc['type'] === ClassMetadata::ONE_TO_ONE && $targetAssoc['type'] !== ClassMetadata::ONE_TO_ONE) {
  223.                         $ce[] = 'If association ' . $class->name . '#' . $fieldName . ' is one-to-one, then the inversed ' .
  224.                                 'side ' . $targetMetadata->name . '#' . $assoc['inversedBy'] . ' has to be one-to-one as well.';
  225.                     } elseif ($assoc['type'] === ClassMetadata::MANY_TO_ONE && $targetAssoc['type'] !== ClassMetadata::ONE_TO_MANY) {
  226.                         $ce[] = 'If association ' . $class->name . '#' . $fieldName . ' is many-to-one, then the inversed ' .
  227.                                 'side ' . $targetMetadata->name . '#' . $assoc['inversedBy'] . ' has to be one-to-many.';
  228.                     } elseif ($assoc['type'] === ClassMetadata::MANY_TO_MANY && $targetAssoc['type'] !== ClassMetadata::MANY_TO_MANY) {
  229.                         $ce[] = 'If association ' . $class->name . '#' . $fieldName . ' is many-to-many, then the inversed ' .
  230.                                 'side ' . $targetMetadata->name . '#' . $assoc['inversedBy'] . ' has to be many-to-many as well.';
  231.                     }
  232.                 }
  233.             }
  235.             if ($assoc['isOwningSide']) {
  236.                 if ($assoc['type'] === ClassMetadata::MANY_TO_MANY) {
  237.                     $identifierColumns = $class->getIdentifierColumnNames();
  238.                     foreach ($assoc['joinTable']['joinColumns'] as $joinColumn) {
  239.                         if (! in_array($joinColumn['referencedColumnName'], $identifierColumns, true)) {
  240.                             $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
  241.                                 "has to be a primary key column on the target entity class '" . $class->name . "'.";
  242.                             break;
  243.                         }
  244.                     }
  246.                     $identifierColumns = $targetMetadata->getIdentifierColumnNames();
  247.                     foreach ($assoc['joinTable']['inverseJoinColumns'] as $inverseJoinColumn) {
  248.                         if (! in_array($inverseJoinColumn['referencedColumnName'], $identifierColumns, true)) {
  249.                             $ce[] = "The referenced column name '" . $inverseJoinColumn['referencedColumnName'] . "' " .
  250.                                 "has to be a primary key column on the target entity class '" . $targetMetadata->name . "'.";
  251.                             break;
  252.                         }
  253.                     }
  255.                     if (count($targetMetadata->getIdentifierColumnNames()) !== count($assoc['joinTable']['inverseJoinColumns'])) {
  256.                         $ce[] = "The inverse join columns of the many-to-many table '" . $assoc['joinTable']['name'] . "' " .
  257.                                 "have to contain to ALL identifier columns of the target entity '" . $targetMetadata->name . "', " .
  258.                                 "however '" . implode(', ', array_diff($targetMetadata->getIdentifierColumnNames(), array_values($assoc['relationToTargetKeyColumns']))) .
  259.                                 "' are missing.";
  260.                     }
  262.                     if (count($class->getIdentifierColumnNames()) !== count($assoc['joinTable']['joinColumns'])) {
  263.                         $ce[] = "The join columns of the many-to-many table '" . $assoc['joinTable']['name'] . "' " .
  264.                                 "have to contain to ALL identifier columns of the source entity '" . $class->name . "', " .
  265.                                 "however '" . implode(', ', array_diff($class->getIdentifierColumnNames(), array_values($assoc['relationToSourceKeyColumns']))) .
  266.                                 "' are missing.";
  267.                     }
  268.                 } elseif ($assoc['type'] & ClassMetadata::TO_ONE) {
  269.                     $identifierColumns = $targetMetadata->getIdentifierColumnNames();
  270.                     foreach ($assoc['joinColumns'] as $joinColumn) {
  271.                         if (! in_array($joinColumn['referencedColumnName'], $identifierColumns, true)) {
  272.                             $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
  273.                                     "has to be a primary key column on the target entity class '" . $targetMetadata->name . "'.";
  274.                         }
  275.                     }
  277.                     if (count($identifierColumns) !== count($assoc['joinColumns'])) {
  278.                         $ids = [];
  280.                         foreach ($assoc['joinColumns'] as $joinColumn) {
  281.                             $ids[] = $joinColumn['name'];
  282.                         }
  284.                         $ce[] = "The join columns of the association '" . $assoc['fieldName'] . "' " .
  285.                                 "have to match to ALL identifier columns of the target entity '" . $targetMetadata->name . "', " .
  286.                                 "however '" . implode(', ', array_diff($targetMetadata->getIdentifierColumnNames(), $ids)) .
  287.                                 "' are missing.";
  288.                     }
  289.                 }
  290.             }
  292.             if (isset($assoc['orderBy']) && $assoc['orderBy'] !== null) {
  293.                 foreach ($assoc['orderBy'] as $orderField => $orientation) {
  294.                     if (! $targetMetadata->hasField($orderField) && ! $targetMetadata->hasAssociation($orderField)) {
  295.                         $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is ordered by a foreign field ' .
  296.                                 $orderField . ' that is not a field on the target entity ' . $targetMetadata->name . '.';
  297.                         continue;
  298.                     }
  300.                     if ($targetMetadata->isCollectionValuedAssociation($orderField)) {
  301.                         $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is ordered by a field ' .
  302.                                 $orderField . ' on ' . $targetMetadata->name . ' that is a collection-valued association.';
  303.                         continue;
  304.                     }
  306.                     if ($targetMetadata->isAssociationInverseSide($orderField)) {
  307.                         $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is ordered by a field ' .
  308.                                 $orderField . ' on ' . $targetMetadata->name . ' that is the inverse side of an association.';
  309.                         continue;
  310.                     }
  311.                 }
  312.             }
  313.         }
  315.         if (
  316.             ! $class->isInheritanceTypeNone()
  317.             && ! $class->isRootEntity()
  318.             && ($class->reflClass !== null && ! $class->reflClass->isAbstract())
  319.             && ! $class->isMappedSuperclass
  320.             && array_search($class->name, $class->discriminatorMap, true) === false
  321.         ) {
  322.             $ce[] = "Entity class '" . $class->name . "' is part of inheritance hierarchy, but is " .
  323.                 "not mapped in the root entity '" . $class->rootEntityName . "' discriminator map. " .
  324.                 'All subclasses must be listed in the discriminator map.';
  325.         }
  327.         foreach ($class->subClasses as $subClass) {
  328.             if (! in_array($class->name, class_parents($subClass), true)) {
  329.                 $ce[] = "According to the discriminator map class '" . $subClass . "' has to be a child " .
  330.                         "of '" . $class->name . "' but these entities are not related through inheritance.";
  331.             }
  332.         }
  334.         return $ce;
  335.     }
  337.     /**
  338.      * Checks if the Database Schema is in sync with the current metadata state.
  339.      *
  340.      * @return bool
  341.      */
  342.     public function schemaInSyncWithMetadata()
  343.     {
  344.         return count($this->getUpdateSchemaList()) === 0;
  345.     }
  347.     /**
  348.      * Returns the list of missing Database Schema updates.
  349.      *
  350.      * @return array<string>
  351.      */
  352.     public function getUpdateSchemaList(): array
  353.     {
  354.         $schemaTool = new SchemaTool($this->em);
  356.         $allMetadata = $this->em->getMetadataFactory()->getAllMetadata();
  358.         return $schemaTool->getUpdateSchemaSql($allMetadata, true);
  359.     }
  361.     /** @return list<string> containing the found issues */
  362.     private function validatePropertiesTypes(ClassMetadataInfo $class): array
  363.     {
  364.         return array_values(
  365.             array_filter(
  366.                 array_map(
  367.                     /** @param FieldMapping $fieldMapping */
  368.                     function (array $fieldMapping) use ($class): ?string {
  369.                         $fieldName = $fieldMapping['fieldName'];
  370.                         assert(isset($class->reflFields[$fieldName]));
  371.                         $propertyType = $class->reflFields[$fieldName]->getType();
  373.                         // If the field type is not a built-in type, we cannot check it
  374.                         if (! Type::hasType($fieldMapping['type'])) {
  375.                             return null;
  376.                         }
  378.                         // If the property type is not a named type, we cannot check it
  379.                         if (! ($propertyType instanceof ReflectionNamedType) || $propertyType->getName() === 'mixed') {
  380.                             return null;
  381.                         }
  383.                         $metadataFieldType = $this->findBuiltInType(Type::getType($fieldMapping['type']));
  385.                         //If the metadata field type is not a mapped built-in type, we cannot check it
  386.                         if ($metadataFieldType === null) {
  387.                             return null;
  388.                         }
  390.                         $propertyType = $propertyType->getName();
  392.                         // If the property type is the same as the metadata field type, we are ok
  393.                         if (in_array($propertyType, $metadataFieldType, true)) {
  394.                             return null;
  395.                         }
  397.                         if (is_a($propertyType, BackedEnum::class, true)) {
  398.                             $backingType = (string) (new ReflectionEnum($propertyType))->getBackingType();
  400.                             if (! in_array($backingType, $metadataFieldType, true)) {
  401.                                 return sprintf(
  402.                                     "The field '%s#%s' has the property type '%s' with a backing type of '%s' that differs from the metadata field type '%s'.",
  403.                                     $class->name,
  404.                                     $fieldName,
  405.                                     $propertyType,
  406.                                     $backingType,
  407.                                     implode('|', $metadataFieldType)
  408.                                 );
  409.                             }
  411.                             if (! isset($fieldMapping['enumType']) || $propertyType === $fieldMapping['enumType']) {
  412.                                 return null;
  413.                             }
  415.                             return sprintf(
  416.                                 "The field '%s#%s' has the property type '%s' that differs from the metadata enumType '%s'.",
  417.                                 $class->name,
  418.                                 $fieldName,
  419.                                 $propertyType,
  420.                                 $fieldMapping['enumType']
  421.                             );
  422.                         }
  424.                         if (
  425.                             isset($fieldMapping['enumType'])
  426.                             && $propertyType !== $fieldMapping['enumType']
  427.                             && interface_exists($propertyType)
  428.                             && is_a($fieldMapping['enumType'], $propertyType, true)
  429.                         ) {
  430.                             $backingType = (string) (new ReflectionEnum($fieldMapping['enumType']))->getBackingType();
  432.                             if (in_array($backingType, $metadataFieldType, true)) {
  433.                                 return null;
  434.                             }
  436.                             return sprintf(
  437.                                 "The field '%s#%s' has the metadata enumType '%s' with a backing type of '%s' that differs from the metadata field type '%s'.",
  438.                                 $class->name,
  439.                                 $fieldName,
  440.                                 $fieldMapping['enumType'],
  441.                                 $backingType,
  442.                                 implode('|', $metadataFieldType)
  443.                             );
  444.                         }
  446.                         if (
  447.                             $fieldMapping['type'] === 'json'
  448.                             && in_array($propertyType, ['string', 'int', 'float', 'bool', 'true', 'false', 'null'], true)
  449.                         ) {
  450.                             return null;
  451.                         }
  453.                         return sprintf(
  454.                             "The field '%s#%s' has the property type '%s' that differs from the metadata field type '%s' returned by the '%s' DBAL type.",
  455.                             $class->name,
  456.                             $fieldName,
  457.                             $propertyType,
  458.                             implode('|', $metadataFieldType),
  459.                             $fieldMapping['type']
  460.                         );
  461.                     },
  462.                     $class->fieldMappings
  463.                 )
  464.             )
  465.         );
  466.     }
  468.     /**
  469.      * The exact DBAL type must be used (no subclasses), since consumers of doctrine/orm may have their own
  470.      * customization around field types.
  471.      *
  472.      * @return list<string>|null
  473.      */
  474.     private function findBuiltInType(Type $type): ?array
  475.     {
  476.         $typeName = get_class($type);
  478.         return self::BUILTIN_TYPES_MAP[$typeName] ?? null;
  479.     }
  480. }