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

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