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

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Tools;
  7. use Doctrine\DBAL\Types\Type;
  8. use Doctrine\Deprecations\Deprecation;
  9. use Doctrine\ORM\EntityManagerInterface;
  10. use Doctrine\ORM\Mapping\ClassMetadata;
  11. use Doctrine\ORM\Mapping\ClassMetadataInfo;
  13. use function array_diff;
  14. use function array_key_exists;
  15. use function array_search;
  16. use function array_values;
  17. use function class_exists;
  18. use function class_parents;
  19. use function count;
  20. use function get_class;
  21. use function implode;
  22. use function in_array;
  24. /**
  25.  * Performs strict validation of the mapping schema
  26.  *
  27.  * @link        www.doctrine-project.com
  28.  */
  29. class SchemaValidator
  30. {
  31.     /** @var EntityManagerInterface */
  32.     private $em;
  34.     public function __construct(EntityManagerInterface $em)
  35.     {
  36.         $this->em = $em;
  37.     }
  39.     /**
  40.      * Checks the internal consistency of all mapping files.
  41.      *
  42.      * There are several checks that can't be done at runtime or are too expensive, which can be verified
  43.      * with this command. For example:
  44.      *
  45.      * 1. Check if a relation with "mappedBy" is actually connected to that specified field.
  46.      * 2. Check if "mappedBy" and "inversedBy" are consistent to each other.
  47.      * 3. Check if "referencedColumnName" attributes are really pointing to primary key columns.
  48.      *
  49.      * @psalm-return array<string, list<string>>
  50.      */
  51.     public function validateMapping()
  52.     {
  53.         $errors  = [];
  54.         $cmf     = $this->em->getMetadataFactory();
  55.         $classes = $cmf->getAllMetadata();
  57.         foreach ($classes as $class) {
  58.             $ce = $this->validateClass($class);
  59.             if ($ce) {
  60.                 $errors[$class->name] = $ce;
  61.             }
  62.         }
  64.         return $errors;
  65.     }
  67.     /**
  68.      * Validates a single class of the current.
  69.      *
  70.      * @return string[]
  71.      * @psalm-return list<string>
  72.      */
  73.     public function validateClass(ClassMetadataInfo $class)
  74.     {
  75.         if (! $class instanceof ClassMetadata) {
  76.             Deprecation::trigger(
  77.                 'doctrine/orm',
  78.                 'https://github.com/doctrine/orm/pull/249',
  79.                 'Passing an instance of %s to %s is deprecated, please pass a ClassMetadata instance instead.',
  80.                 get_class($class),
  81.                 __METHOD__,
  82.                 ClassMetadata::class
  83.             );
  84.         }
  86.         $ce  = [];
  87.         $cmf = $this->em->getMetadataFactory();
  89.         foreach ($class->fieldMappings as $fieldName => $mapping) {
  90.             if (! Type::hasType($mapping['type'])) {
  91.                 $ce[] = "The field '" . $class->name . '#' . $fieldName . "' uses a non-existent type '" . $mapping['type'] . "'.";
  92.             }
  93.         }
  95.         if ($class->isEmbeddedClass && count($class->associationMappings) > 0) {
  96.             $ce[] = "Embeddable '" . $class->name . "' does not support associations";
  98.             return $ce;
  99.         }
  101.         foreach ($class->associationMappings as $fieldName => $assoc) {
  102.             if (! class_exists($assoc['targetEntity']) || $cmf->isTransient($assoc['targetEntity'])) {
  103.                 $ce[] = "The target entity '" . $assoc['targetEntity'] . "' specified on " . $class->name . '#' . $fieldName . ' is unknown or not an entity.';
  105.                 return $ce;
  106.             }
  108.             if ($assoc['mappedBy'] && $assoc['inversedBy']) {
  109.                 $ce[] = 'The association ' . $class . '#' . $fieldName . ' cannot be defined as both inverse and owning.';
  110.             }
  112.             $targetMetadata = $cmf->getMetadataFor($assoc['targetEntity']);
  114.             if (isset($assoc['id']) && $targetMetadata->containsForeignIdentifier) {
  115.                 $ce[] = "Cannot map association '" . $class->name . '#' . $fieldName . ' as identifier, because ' .
  116.                         "the target entity '" . $targetMetadata->name . "' also maps an association as identifier.";
  117.             }
  119.             if ($assoc['mappedBy']) {
  120.                 if ($targetMetadata->hasField($assoc['mappedBy'])) {
  121.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the owning side ' .
  122.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' which is not defined as association, but as field.';
  123.                 }
  125.                 if (! $targetMetadata->hasAssociation($assoc['mappedBy'])) {
  126.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the owning side ' .
  127.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' which does not exist.';
  128.                 } elseif ($targetMetadata->associationMappings[$assoc['mappedBy']]['inversedBy'] === null) {
  129.                     $ce[] = 'The field ' . $class->name . '#' . $fieldName . ' is on the inverse side of a ' .
  130.                             'bi-directional relationship, but the specified mappedBy association on the target-entity ' .
  131.                             $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' does not contain the required ' .
  132.                             "'inversedBy=\"" . $fieldName . "\"' attribute.";
  133.                 } elseif ($targetMetadata->associationMappings[$assoc['mappedBy']]['inversedBy'] !== $fieldName) {
  134.                     $ce[] = 'The mappings ' . $class->name . '#' . $fieldName . ' and ' .
  135.                             $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' are ' .
  136.                             'inconsistent with each other.';
  137.                 }
  138.             }
  140.             if ($assoc['inversedBy']) {
  141.                 if ($targetMetadata->hasField($assoc['inversedBy'])) {
  142.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the inverse side ' .
  143.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' which is not defined as association.';
  144.                 }
  146.                 if (! $targetMetadata->hasAssociation($assoc['inversedBy'])) {
  147.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the inverse side ' .
  148.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' which does not exist.';
  149.                 } elseif ($targetMetadata->associationMappings[$assoc['inversedBy']]['mappedBy'] === null) {
  150.                     $ce[] = 'The field ' . $class->name . '#' . $fieldName . ' is on the owning side of a ' .
  151.                             'bi-directional relationship, but the specified inversedBy association on the target-entity ' .
  152.                             $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' does not contain the required ' .
  153.                             "'mappedBy=\"" . $fieldName . "\"' attribute.";
  154.                 } elseif ($targetMetadata->associationMappings[$assoc['inversedBy']]['mappedBy'] !== $fieldName) {
  155.                     $ce[] = 'The mappings ' . $class->name . '#' . $fieldName . ' and ' .
  156.                             $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' are ' .
  157.                             'inconsistent with each other.';
  158.                 }
  160.                 // Verify inverse side/owning side match each other
  161.                 if (array_key_exists($assoc['inversedBy'], $targetMetadata->associationMappings)) {
  162.                     $targetAssoc = $targetMetadata->associationMappings[$assoc['inversedBy']];
  163.                     if ($assoc['type'] === ClassMetadata::ONE_TO_ONE && $targetAssoc['type'] !== ClassMetadata::ONE_TO_ONE) {
  164.                         $ce[] = 'If association ' . $class->name . '#' . $fieldName . ' is one-to-one, then the inversed ' .
  165.                                 'side ' . $targetMetadata->name . '#' . $assoc['inversedBy'] . ' has to be one-to-one as well.';
  166.                     } elseif ($assoc['type'] === ClassMetadata::MANY_TO_ONE && $targetAssoc['type'] !== ClassMetadata::ONE_TO_MANY) {
  167.                         $ce[] = 'If association ' . $class->name . '#' . $fieldName . ' is many-to-one, then the inversed ' .
  168.                                 'side ' . $targetMetadata->name . '#' . $assoc['inversedBy'] . ' has to be one-to-many.';
  169.                     } elseif ($assoc['type'] === ClassMetadata::MANY_TO_MANY && $targetAssoc['type'] !== ClassMetadata::MANY_TO_MANY) {
  170.                         $ce[] = 'If association ' . $class->name . '#' . $fieldName . ' is many-to-many, then the inversed ' .
  171.                                 'side ' . $targetMetadata->name . '#' . $assoc['inversedBy'] . ' has to be many-to-many as well.';
  172.                     }
  173.                 }
  174.             }
  176.             if ($assoc['isOwningSide']) {
  177.                 if ($assoc['type'] === ClassMetadata::MANY_TO_MANY) {
  178.                     $identifierColumns = $class->getIdentifierColumnNames();
  179.                     foreach ($assoc['joinTable']['joinColumns'] as $joinColumn) {
  180.                         if (! in_array($joinColumn['referencedColumnName'], $identifierColumns, true)) {
  181.                             $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
  182.                                 "has to be a primary key column on the target entity class '" . $class->name . "'.";
  183.                             break;
  184.                         }
  185.                     }
  187.                     $identifierColumns = $targetMetadata->getIdentifierColumnNames();
  188.                     foreach ($assoc['joinTable']['inverseJoinColumns'] as $inverseJoinColumn) {
  189.                         if (! in_array($inverseJoinColumn['referencedColumnName'], $identifierColumns, true)) {
  190.                             $ce[] = "The referenced column name '" . $inverseJoinColumn['referencedColumnName'] . "' " .
  191.                                 "has to be a primary key column on the target entity class '" . $targetMetadata->name . "'.";
  192.                             break;
  193.                         }
  194.                     }
  196.                     if (count($targetMetadata->getIdentifierColumnNames()) !== count($assoc['joinTable']['inverseJoinColumns'])) {
  197.                         $ce[] = "The inverse join columns of the many-to-many table '" . $assoc['joinTable']['name'] . "' " .
  198.                                 "have to contain to ALL identifier columns of the target entity '" . $targetMetadata->name . "', " .
  199.                                 "however '" . implode(', ', array_diff($targetMetadata->getIdentifierColumnNames(), array_values($assoc['relationToTargetKeyColumns']))) .
  200.                                 "' are missing.";
  201.                     }
  203.                     if (count($class->getIdentifierColumnNames()) !== count($assoc['joinTable']['joinColumns'])) {
  204.                         $ce[] = "The join columns of the many-to-many table '" . $assoc['joinTable']['name'] . "' " .
  205.                                 "have to contain to ALL identifier columns of the source entity '" . $class->name . "', " .
  206.                                 "however '" . implode(', ', array_diff($class->getIdentifierColumnNames(), array_values($assoc['relationToSourceKeyColumns']))) .
  207.                                 "' are missing.";
  208.                     }
  209.                 } elseif ($assoc['type'] & ClassMetadata::TO_ONE) {
  210.                     $identifierColumns = $targetMetadata->getIdentifierColumnNames();
  211.                     foreach ($assoc['joinColumns'] as $joinColumn) {
  212.                         if (! in_array($joinColumn['referencedColumnName'], $identifierColumns, true)) {
  213.                             $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
  214.                                     "has to be a primary key column on the target entity class '" . $targetMetadata->name . "'.";
  215.                         }
  216.                     }
  218.                     if (count($identifierColumns) !== count($assoc['joinColumns'])) {
  219.                         $ids = [];
  221.                         foreach ($assoc['joinColumns'] as $joinColumn) {
  222.                             $ids[] = $joinColumn['name'];
  223.                         }
  225.                         $ce[] = "The join columns of the association '" . $assoc['fieldName'] . "' " .
  226.                                 "have to match to ALL identifier columns of the target entity '" . $targetMetadata->name . "', " .
  227.                                 "however '" . implode(', ', array_diff($targetMetadata->getIdentifierColumnNames(), $ids)) .
  228.                                 "' are missing.";
  229.                     }
  230.                 }
  231.             }
  233.             if (isset($assoc['orderBy']) && $assoc['orderBy'] !== null) {
  234.                 foreach ($assoc['orderBy'] as $orderField => $orientation) {
  235.                     if (! $targetMetadata->hasField($orderField) && ! $targetMetadata->hasAssociation($orderField)) {
  236.                         $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is ordered by a foreign field ' .
  237.                                 $orderField . ' that is not a field on the target entity ' . $targetMetadata->name . '.';
  238.                         continue;
  239.                     }
  241.                     if ($targetMetadata->isCollectionValuedAssociation($orderField)) {
  242.                         $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is ordered by a field ' .
  243.                                 $orderField . ' on ' . $targetMetadata->name . ' that is a collection-valued association.';
  244.                         continue;
  245.                     }
  247.                     if ($targetMetadata->isAssociationInverseSide($orderField)) {
  248.                         $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is ordered by a field ' .
  249.                                 $orderField . ' on ' . $targetMetadata->name . ' that is the inverse side of an association.';
  250.                         continue;
  251.                     }
  252.                 }
  253.             }
  254.         }
  256.         if (! $class->isInheritanceTypeNone() && ! $class->isRootEntity() && ! $class->isMappedSuperclass && array_search($class->name, $class->discriminatorMap, true) === false) {
  257.             $ce[] = "Entity class '" . $class->name . "' is part of inheritance hierarchy, but is " .
  258.                 "not mapped in the root entity '" . $class->rootEntityName . "' discriminator map. " .
  259.                 'All subclasses must be listed in the discriminator map.';
  260.         }
  262.         foreach ($class->subClasses as $subClass) {
  263.             if (! in_array($class->name, class_parents($subClass), true)) {
  264.                 $ce[] = "According to the discriminator map class '" . $subClass . "' has to be a child " .
  265.                         "of '" . $class->name . "' but these entities are not related through inheritance.";
  266.             }
  267.         }
  269.         return $ce;
  270.     }
  272.     /**
  273.      * Checks if the Database Schema is in sync with the current metadata state.
  274.      *
  275.      * @return bool
  276.      */
  277.     public function schemaInSyncWithMetadata()
  278.     {
  279.         return count($this->getUpdateSchemaList()) === 0;
  280.     }
  282.     /**
  283.      * Returns the list of missing Database Schema updates.
  284.      *
  285.      * @return array<string>
  286.      */
  287.     public function getUpdateSchemaList(): array
  288.     {
  289.         $schemaTool = new SchemaTool($this->em);
  291.         $allMetadata = $this->em->getMetadataFactory()->getAllMetadata();
  293.         return $schemaTool->getUpdateSchemaSql($allMetadata, true);
  294.     }
  295. }