vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaValidator.php line 156

Open in your IDE?
  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 is_a;
  43. use function sprintf;
  45. use const PHP_VERSION_ID;
  47. /**
  48.  * Performs strict validation of the mapping schema
  49.  *
  50.  * @link        www.doctrine-project.com
  51.  *
  52.  * @psalm-import-type FieldMapping from ClassMetadata
  53.  */
  54. class SchemaValidator
  55. {
  56.     /** @var EntityManagerInterface */
  57.     private $em;
  59.     /**
  60.      * It maps built-in Doctrine types to PHP types
  61.      */
  62.     private const BUILTIN_TYPES_MAP = [
  63.         AsciiStringType::class => 'string',
  64.         BigIntType::class => 'string',
  65.         BooleanType::class => 'bool',
  66.         DecimalType::class => 'string',
  67.         FloatType::class => 'float',
  68.         GuidType::class => 'string',
  69.         IntegerType::class => 'int',
  70.         JsonType::class => 'array',
  71.         SimpleArrayType::class => 'array',
  72.         SmallIntType::class => 'int',
  73.         StringType::class => 'string',
  74.         TextType::class => 'string',
  75.     ];
  77.     public function __construct(EntityManagerInterface $em)
  78.     {
  79.         $this->em = $em;
  80.     }
  82.     /**
  83.      * Checks the internal consistency of all mapping files.
  84.      *
  85.      * There are several checks that can't be done at runtime or are too expensive, which can be verified
  86.      * with this command. For example:
  87.      *
  88.      * 1. Check if a relation with "mappedBy" is actually connected to that specified field.
  89.      * 2. Check if "mappedBy" and "inversedBy" are consistent to each other.
  90.      * 3. Check if "referencedColumnName" attributes are really pointing to primary key columns.
  91.      *
  92.      * @psalm-return array<string, list<string>>
  93.      */
  94.     public function validateMapping()
  95.     {
  96.         $errors  = [];
  97.         $cmf     = $this->em->getMetadataFactory();
  98.         $classes = $cmf->getAllMetadata();
  100.         foreach ($classes as $class) {
  101.             $ce = $this->validateClass($class);
  102.             if ($ce) {
  103.                 $errors[$class->name] = $ce;
  104.             }
  105.         }
  107.         return $errors;
  108.     }
  110.     /**
  111.      * Validates a single class of the current.
  112.      *
  113.      * @return string[]
  114.      * @psalm-return list<string>
  115.      */
  116.     public function validateClass(ClassMetadataInfo $class)
  117.     {
  118.         if (! $class instanceof ClassMetadata) {
  119.             Deprecation::trigger(
  120.                 'doctrine/orm',
  121.                 'https://github.com/doctrine/orm/pull/249',
  122.                 'Passing an instance of %s to %s is deprecated, please pass a ClassMetadata instance instead.',
  123.                 get_class($class),
  124.                 __METHOD__,
  125.                 ClassMetadata::class
  126.             );
  127.         }
  129.         $ce  = [];
  130.         $cmf = $this->em->getMetadataFactory();
  132.         foreach ($class->fieldMappings as $fieldName => $mapping) {
  133.             if (! Type::hasType($mapping['type'])) {
  134.                 $ce[] = "The field '" . $class->name . '#' . $fieldName . "' uses a non-existent type '" . $mapping['type'] . "'.";
  135.             }
  136.         }
  138.         // PHP 7.4 introduces the ability to type properties, so we can't validate them in previous versions
  139.         if (PHP_VERSION_ID >= 70400) {
  140.             array_push($ce, ...$this->validatePropertiesTypes($class));
  141.         }
  143.         if ($class->isEmbeddedClass && count($class->associationMappings) > 0) {
  144.             $ce[] = "Embeddable '" . $class->name . "' does not support associations";
  146.             return $ce;
  147.         }
  149.         foreach ($class->associationMappings as $fieldName => $assoc) {
  150.             if (! class_exists($assoc['targetEntity']) || $cmf->isTransient($assoc['targetEntity'])) {
  151.                 $ce[] = "The target entity '" . $assoc['targetEntity'] . "' specified on " . $class->name . '#' . $fieldName . ' is unknown or not an entity.';
  153.                 return $ce;
  154.             }
  156.             $targetMetadata = $cmf->getMetadataFor($assoc['targetEntity']);
  158.             if ($targetMetadata->isMappedSuperclass) {
  159.                 $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.';
  161.                 return $ce;
  162.             }
  164.             if ($assoc['mappedBy'] && $assoc['inversedBy']) {
  165.                 $ce[] = 'The association ' . $class . '#' . $fieldName . ' cannot be defined as both inverse and owning.';
  166.             }
  168.             if (isset($assoc['id']) && $targetMetadata->containsForeignIdentifier) {
  169.                 $ce[] = "Cannot map association '" . $class->name . '#' . $fieldName . ' as identifier, because ' .
  170.                         "the target entity '" . $targetMetadata->name . "' also maps an association as identifier.";
  171.             }
  173.             if ($assoc['mappedBy']) {
  174.                 if ($targetMetadata->hasField($assoc['mappedBy'])) {
  175.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the owning side ' .
  176.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' which is not defined as association, but as field.';
  177.                 }
  179.                 if (! $targetMetadata->hasAssociation($assoc['mappedBy'])) {
  180.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the owning side ' .
  181.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' which does not exist.';
  182.                 } elseif ($targetMetadata->associationMappings[$assoc['mappedBy']]['inversedBy'] === null) {
  183.                     $ce[] = 'The field ' . $class->name . '#' . $fieldName . ' is on the inverse side of a ' .
  184.                             'bi-directional relationship, but the specified mappedBy association on the target-entity ' .
  185.                             $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' does not contain the required ' .
  186.                             "'inversedBy=\"" . $fieldName . "\"' attribute.";
  187.                 } elseif ($targetMetadata->associationMappings[$assoc['mappedBy']]['inversedBy'] !== $fieldName) {
  188.                     $ce[] = 'The mappings ' . $class->name . '#' . $fieldName . ' and ' .
  189.                             $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' are ' .
  190.                             'inconsistent with each other.';
  191.                 }
  192.             }
  194.             if ($assoc['inversedBy']) {
  195.                 if ($targetMetadata->hasField($assoc['inversedBy'])) {
  196.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the inverse side ' .
  197.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' which is not defined as association.';
  198.                 }
  200.                 if (! $targetMetadata->hasAssociation($assoc['inversedBy'])) {
  201.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the inverse side ' .
  202.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' which does not exist.';
  203.                 } elseif ($targetMetadata->associationMappings[$assoc['inversedBy']]['mappedBy'] === null) {
  204.                     $ce[] = 'The field ' . $class->name . '#' . $fieldName . ' is on the owning side of a ' .
  205.                             'bi-directional relationship, but the specified inversedBy association on the target-entity ' .
  206.                             $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' does not contain the required ' .
  207.                             "'mappedBy=\"" . $fieldName . "\"' attribute.";
  208.                 } elseif ($targetMetadata->associationMappings[$assoc['inversedBy']]['mappedBy'] !== $fieldName) {
  209.                     $ce[] = 'The mappings ' . $class->name . '#' . $fieldName . ' and ' .
  210.                             $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' are ' .
  211.                             'inconsistent with each other.';
  212.                 }
  214.                 // Verify inverse side/owning side match each other
  215.                 if (array_key_exists($assoc['inversedBy'], $targetMetadata->associationMappings)) {
  216.                     $targetAssoc = $targetMetadata->associationMappings[$assoc['inversedBy']];
  217.                     if ($assoc['type'] === ClassMetadata::ONE_TO_ONE && $targetAssoc['type'] !== ClassMetadata::ONE_TO_ONE) {
  218.                         $ce[] = 'If association ' . $class->name . '#' . $fieldName . ' is one-to-one, then the inversed ' .
  219.                                 'side ' . $targetMetadata->name . '#' . $assoc['inversedBy'] . ' has to be one-to-one as well.';
  220.                     } elseif ($assoc['type'] === ClassMetadata::MANY_TO_ONE && $targetAssoc['type'] !== ClassMetadata::ONE_TO_MANY) {
  221.                         $ce[] = 'If association ' . $class->name . '#' . $fieldName . ' is many-to-one, then the inversed ' .
  222.                                 'side ' . $targetMetadata->name . '#' . $assoc['inversedBy'] . ' has to be one-to-many.';
  223.                     } elseif ($assoc['type'] === ClassMetadata::MANY_TO_MANY && $targetAssoc['type'] !== ClassMetadata::MANY_TO_MANY) {
  224.                         $ce[] = 'If association ' . $class->name . '#' . $fieldName . ' is many-to-many, then the inversed ' .
  225.                                 'side ' . $targetMetadata->name . '#' . $assoc['inversedBy'] . ' has to be many-to-many as well.';
  226.                     }
  227.                 }
  228.             }
  230.             if ($assoc['isOwningSide']) {
  231.                 if ($assoc['type'] === ClassMetadata::MANY_TO_MANY) {
  232.                     $identifierColumns = $class->getIdentifierColumnNames();
  233.                     foreach ($assoc['joinTable']['joinColumns'] as $joinColumn) {
  234.                         if (! in_array($joinColumn['referencedColumnName'], $identifierColumns, true)) {
  235.                             $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
  236.                                 "has to be a primary key column on the target entity class '" . $class->name . "'.";
  237.                             break;
  238.                         }
  239.                     }
  241.                     $identifierColumns = $targetMetadata->getIdentifierColumnNames();
  242.                     foreach ($assoc['joinTable']['inverseJoinColumns'] as $inverseJoinColumn) {
  243.                         if (! in_array($inverseJoinColumn['referencedColumnName'], $identifierColumns, true)) {
  244.                             $ce[] = "The referenced column name '" . $inverseJoinColumn['referencedColumnName'] . "' " .
  245.                                 "has to be a primary key column on the target entity class '" . $targetMetadata->name . "'.";
  246.                             break;
  247.                         }
  248.                     }
  250.                     if (count($targetMetadata->getIdentifierColumnNames()) !== count($assoc['joinTable']['inverseJoinColumns'])) {
  251.                         $ce[] = "The inverse join columns of the many-to-many table '" . $assoc['joinTable']['name'] . "' " .
  252.                                 "have to contain to ALL identifier columns of the target entity '" . $targetMetadata->name . "', " .
  253.                                 "however '" . implode(', ', array_diff($targetMetadata->getIdentifierColumnNames(), array_values($assoc['relationToTargetKeyColumns']))) .
  254.                                 "' are missing.";
  255.                     }
  257.                     if (count($class->getIdentifierColumnNames()) !== count($assoc['joinTable']['joinColumns'])) {
  258.                         $ce[] = "The join columns of the many-to-many table '" . $assoc['joinTable']['name'] . "' " .
  259.                                 "have to contain to ALL identifier columns of the source entity '" . $class->name . "', " .
  260.                                 "however '" . implode(', ', array_diff($class->getIdentifierColumnNames(), array_values($assoc['relationToSourceKeyColumns']))) .
  261.                                 "' are missing.";
  262.                     }
  263.                 } elseif ($assoc['type'] & ClassMetadata::TO_ONE) {
  264.                     $identifierColumns = $targetMetadata->getIdentifierColumnNames();
  265.                     foreach ($assoc['joinColumns'] as $joinColumn) {
  266.                         if (! in_array($joinColumn['referencedColumnName'], $identifierColumns, true)) {
  267.                             $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
  268.                                     "has to be a primary key column on the target entity class '" . $targetMetadata->name . "'.";
  269.                         }
  270.                     }
  272.                     if (count($identifierColumns) !== count($assoc['joinColumns'])) {
  273.                         $ids = [];
  275.                         foreach ($assoc['joinColumns'] as $joinColumn) {
  276.                             $ids[] = $joinColumn['name'];
  277.                         }
  279.                         $ce[] = "The join columns of the association '" . $assoc['fieldName'] . "' " .
  280.                                 "have to match to ALL identifier columns of the target entity '" . $targetMetadata->name . "', " .
  281.                                 "however '" . implode(', ', array_diff($targetMetadata->getIdentifierColumnNames(), $ids)) .
  282.                                 "' are missing.";
  283.                     }
  284.                 }
  285.             }
  287.             if (isset($assoc['orderBy']) && $assoc['orderBy'] !== null) {
  288.                 foreach ($assoc['orderBy'] as $orderField => $orientation) {
  289.                     if (! $targetMetadata->hasField($orderField) && ! $targetMetadata->hasAssociation($orderField)) {
  290.                         $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is ordered by a foreign field ' .
  291.                                 $orderField . ' that is not a field on the target entity ' . $targetMetadata->name . '.';
  292.                         continue;
  293.                     }
  295.                     if ($targetMetadata->isCollectionValuedAssociation($orderField)) {
  296.                         $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is ordered by a field ' .
  297.                                 $orderField . ' on ' . $targetMetadata->name . ' that is a collection-valued association.';
  298.                         continue;
  299.                     }
  301.                     if ($targetMetadata->isAssociationInverseSide($orderField)) {
  302.                         $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is ordered by a field ' .
  303.                                 $orderField . ' on ' . $targetMetadata->name . ' that is the inverse side of an association.';
  304.                         continue;
  305.                     }
  306.                 }
  307.             }
  308.         }
  310.         if (
  311.             ! $class->isInheritanceTypeNone()
  312.             && ! $class->isRootEntity()
  313.             && ($class->reflClass !== null && ! $class->reflClass->isAbstract())
  314.             && ! $class->isMappedSuperclass
  315.             && array_search($class->name, $class->discriminatorMap, true) === false
  316.         ) {
  317.             $ce[] = "Entity class '" . $class->name . "' is part of inheritance hierarchy, but is " .
  318.                 "not mapped in the root entity '" . $class->rootEntityName . "' discriminator map. " .
  319.                 'All subclasses must be listed in the discriminator map.';
  320.         }
  322.         foreach ($class->subClasses as $subClass) {
  323.             if (! in_array($class->name, class_parents($subClass), true)) {
  324.                 $ce[] = "According to the discriminator map class '" . $subClass . "' has to be a child " .
  325.                         "of '" . $class->name . "' but these entities are not related through inheritance.";
  326.             }
  327.         }
  329.         return $ce;
  330.     }
  332.     /**
  333.      * Checks if the Database Schema is in sync with the current metadata state.
  334.      *
  335.      * @return bool
  336.      */
  337.     public function schemaInSyncWithMetadata()
  338.     {
  339.         return count($this->getUpdateSchemaList()) === 0;
  340.     }
  342.     /**
  343.      * Returns the list of missing Database Schema updates.
  344.      *
  345.      * @return array<string>
  346.      */
  347.     public function getUpdateSchemaList(): array
  348.     {
  349.         $schemaTool = new SchemaTool($this->em);
  351.         $allMetadata = $this->em->getMetadataFactory()->getAllMetadata();
  353.         return $schemaTool->getUpdateSchemaSql($allMetadata, true);
  354.     }
  356.     /** @return list<string> containing the found issues */
  357.     private function validatePropertiesTypes(ClassMetadataInfo $class): array
  358.     {
  359.         return array_values(
  360.             array_filter(
  361.                 array_map(
  362.                     /** @param FieldMapping $fieldMapping */
  363.                     function (array $fieldMapping) use ($class): ?string {
  364.                         $fieldName = $fieldMapping['fieldName'];
  365.                         assert(isset($class->reflFields[$fieldName]));
  366.                         $propertyType = $class->reflFields[$fieldName]->getType();
  368.                         // If the field type is not a built-in type, we cannot check it
  369.                         if (! Type::hasType($fieldMapping['type'])) {
  370.                             return null;
  371.                         }
  373.                         // If the property type is not a named type, we cannot check it
  374.                         if (! ($propertyType instanceof ReflectionNamedType)) {
  375.                             return null;
  376.                         }
  378.                         $metadataFieldType = $this->findBuiltInType(Type::getType($fieldMapping['type']));
  380.                         //If the metadata field type is not a mapped built-in type, we cannot check it
  381.                         if ($metadataFieldType === null) {
  382.                             return null;
  383.                         }
  385.                         $propertyType = $propertyType->getName();
  387.                         // If the property type is the same as the metadata field type, we are ok
  388.                         if ($propertyType === $metadataFieldType) {
  389.                             return null;
  390.                         }
  392.                         if (
  393.                             is_a($propertyType, BackedEnum::class, true)
  394.                             && $metadataFieldType === (string) (new ReflectionEnum($propertyType))->getBackingType()
  395.                         ) {
  396.                             if (! isset($fieldMapping['enumType']) || $propertyType === $fieldMapping['enumType']) {
  397.                                 return null;
  398.                             }
  400.                             return sprintf(
  401.                                 "The field '%s#%s' has the property type '%s' that differs from the metadata enumType '%s'.",
  402.                                 $class->name,
  403.                                 $fieldName,
  404.                                 $propertyType,
  405.                                 $fieldMapping['enumType']
  406.                             );
  407.                         }
  409.                         return sprintf(
  410.                             "The field '%s#%s' has the property type '%s' that differs from the metadata field type '%s' returned by the '%s' DBAL type.",
  411.                             $class->name,
  412.                             $fieldName,
  413.                             $propertyType,
  414.                             $metadataFieldType,
  415.                             $fieldMapping['type']
  416.                         );
  417.                     },
  418.                     $class->fieldMappings
  419.                 )
  420.             )
  421.         );
  422.     }
  424.     /**
  425.      * The exact DBAL type must be used (no subclasses), since consumers of doctrine/orm may have their own
  426.      * customization around field types.
  427.      */
  428.     private function findBuiltInType(Type $type): ?string
  429.     {
  430.         $typeName = get_class($type);
  432.         return self::BUILTIN_TYPES_MAP[$typeName] ?? null;
  433.     }
  434. }