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

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.             $targetMetadata = $cmf->getMetadataFor($assoc['targetEntity']);
  110.             if ($targetMetadata->isMappedSuperclass) {
  111.                 $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.';
  113.                 return $ce;
  114.             }
  116.             if ($assoc['mappedBy'] && $assoc['inversedBy']) {
  117.                 $ce[] = 'The association ' . $class . '#' . $fieldName . ' cannot be defined as both inverse and owning.';
  118.             }
  120.             if (isset($assoc['id']) && $targetMetadata->containsForeignIdentifier) {
  121.                 $ce[] = "Cannot map association '" . $class->name . '#' . $fieldName . ' as identifier, because ' .
  122.                         "the target entity '" . $targetMetadata->name . "' also maps an association as identifier.";
  123.             }
  125.             if ($assoc['mappedBy']) {
  126.                 if ($targetMetadata->hasField($assoc['mappedBy'])) {
  127.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the owning side ' .
  128.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' which is not defined as association, but as field.';
  129.                 }
  131.                 if (! $targetMetadata->hasAssociation($assoc['mappedBy'])) {
  132.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the owning side ' .
  133.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' which does not exist.';
  134.                 } elseif ($targetMetadata->associationMappings[$assoc['mappedBy']]['inversedBy'] === null) {
  135.                     $ce[] = 'The field ' . $class->name . '#' . $fieldName . ' is on the inverse side of a ' .
  136.                             'bi-directional relationship, but the specified mappedBy association on the target-entity ' .
  137.                             $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' does not contain the required ' .
  138.                             "'inversedBy=\"" . $fieldName . "\"' attribute.";
  139.                 } elseif ($targetMetadata->associationMappings[$assoc['mappedBy']]['inversedBy'] !== $fieldName) {
  140.                     $ce[] = 'The mappings ' . $class->name . '#' . $fieldName . ' and ' .
  141.                             $assoc['targetEntity'] . '#' . $assoc['mappedBy'] . ' are ' .
  142.                             'inconsistent with each other.';
  143.                 }
  144.             }
  146.             if ($assoc['inversedBy']) {
  147.                 if ($targetMetadata->hasField($assoc['inversedBy'])) {
  148.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the inverse side ' .
  149.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' which is not defined as association.';
  150.                 }
  152.                 if (! $targetMetadata->hasAssociation($assoc['inversedBy'])) {
  153.                     $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' refers to the inverse side ' .
  154.                             'field ' . $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' which does not exist.';
  155.                 } elseif ($targetMetadata->associationMappings[$assoc['inversedBy']]['mappedBy'] === null) {
  156.                     $ce[] = 'The field ' . $class->name . '#' . $fieldName . ' is on the owning side of a ' .
  157.                             'bi-directional relationship, but the specified inversedBy association on the target-entity ' .
  158.                             $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' does not contain the required ' .
  159.                             "'mappedBy=\"" . $fieldName . "\"' attribute.";
  160.                 } elseif ($targetMetadata->associationMappings[$assoc['inversedBy']]['mappedBy'] !== $fieldName) {
  161.                     $ce[] = 'The mappings ' . $class->name . '#' . $fieldName . ' and ' .
  162.                             $assoc['targetEntity'] . '#' . $assoc['inversedBy'] . ' are ' .
  163.                             'inconsistent with each other.';
  164.                 }
  166.                 // Verify inverse side/owning side match each other
  167.                 if (array_key_exists($assoc['inversedBy'], $targetMetadata->associationMappings)) {
  168.                     $targetAssoc = $targetMetadata->associationMappings[$assoc['inversedBy']];
  169.                     if ($assoc['type'] === ClassMetadata::ONE_TO_ONE && $targetAssoc['type'] !== ClassMetadata::ONE_TO_ONE) {
  170.                         $ce[] = 'If association ' . $class->name . '#' . $fieldName . ' is one-to-one, then the inversed ' .
  171.                                 'side ' . $targetMetadata->name . '#' . $assoc['inversedBy'] . ' has to be one-to-one as well.';
  172.                     } elseif ($assoc['type'] === ClassMetadata::MANY_TO_ONE && $targetAssoc['type'] !== ClassMetadata::ONE_TO_MANY) {
  173.                         $ce[] = 'If association ' . $class->name . '#' . $fieldName . ' is many-to-one, then the inversed ' .
  174.                                 'side ' . $targetMetadata->name . '#' . $assoc['inversedBy'] . ' has to be one-to-many.';
  175.                     } elseif ($assoc['type'] === ClassMetadata::MANY_TO_MANY && $targetAssoc['type'] !== ClassMetadata::MANY_TO_MANY) {
  176.                         $ce[] = 'If association ' . $class->name . '#' . $fieldName . ' is many-to-many, then the inversed ' .
  177.                                 'side ' . $targetMetadata->name . '#' . $assoc['inversedBy'] . ' has to be many-to-many as well.';
  178.                     }
  179.                 }
  180.             }
  182.             if ($assoc['isOwningSide']) {
  183.                 if ($assoc['type'] === ClassMetadata::MANY_TO_MANY) {
  184.                     $identifierColumns = $class->getIdentifierColumnNames();
  185.                     foreach ($assoc['joinTable']['joinColumns'] as $joinColumn) {
  186.                         if (! in_array($joinColumn['referencedColumnName'], $identifierColumns, true)) {
  187.                             $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
  188.                                 "has to be a primary key column on the target entity class '" . $class->name . "'.";
  189.                             break;
  190.                         }
  191.                     }
  193.                     $identifierColumns = $targetMetadata->getIdentifierColumnNames();
  194.                     foreach ($assoc['joinTable']['inverseJoinColumns'] as $inverseJoinColumn) {
  195.                         if (! in_array($inverseJoinColumn['referencedColumnName'], $identifierColumns, true)) {
  196.                             $ce[] = "The referenced column name '" . $inverseJoinColumn['referencedColumnName'] . "' " .
  197.                                 "has to be a primary key column on the target entity class '" . $targetMetadata->name . "'.";
  198.                             break;
  199.                         }
  200.                     }
  202.                     if (count($targetMetadata->getIdentifierColumnNames()) !== count($assoc['joinTable']['inverseJoinColumns'])) {
  203.                         $ce[] = "The inverse join columns of the many-to-many table '" . $assoc['joinTable']['name'] . "' " .
  204.                                 "have to contain to ALL identifier columns of the target entity '" . $targetMetadata->name . "', " .
  205.                                 "however '" . implode(', ', array_diff($targetMetadata->getIdentifierColumnNames(), array_values($assoc['relationToTargetKeyColumns']))) .
  206.                                 "' are missing.";
  207.                     }
  209.                     if (count($class->getIdentifierColumnNames()) !== count($assoc['joinTable']['joinColumns'])) {
  210.                         $ce[] = "The join columns of the many-to-many table '" . $assoc['joinTable']['name'] . "' " .
  211.                                 "have to contain to ALL identifier columns of the source entity '" . $class->name . "', " .
  212.                                 "however '" . implode(', ', array_diff($class->getIdentifierColumnNames(), array_values($assoc['relationToSourceKeyColumns']))) .
  213.                                 "' are missing.";
  214.                     }
  215.                 } elseif ($assoc['type'] & ClassMetadata::TO_ONE) {
  216.                     $identifierColumns = $targetMetadata->getIdentifierColumnNames();
  217.                     foreach ($assoc['joinColumns'] as $joinColumn) {
  218.                         if (! in_array($joinColumn['referencedColumnName'], $identifierColumns, true)) {
  219.                             $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
  220.                                     "has to be a primary key column on the target entity class '" . $targetMetadata->name . "'.";
  221.                         }
  222.                     }
  224.                     if (count($identifierColumns) !== count($assoc['joinColumns'])) {
  225.                         $ids = [];
  227.                         foreach ($assoc['joinColumns'] as $joinColumn) {
  228.                             $ids[] = $joinColumn['name'];
  229.                         }
  231.                         $ce[] = "The join columns of the association '" . $assoc['fieldName'] . "' " .
  232.                                 "have to match to ALL identifier columns of the target entity '" . $targetMetadata->name . "', " .
  233.                                 "however '" . implode(', ', array_diff($targetMetadata->getIdentifierColumnNames(), $ids)) .
  234.                                 "' are missing.";
  235.                     }
  236.                 }
  237.             }
  239.             if (isset($assoc['orderBy']) && $assoc['orderBy'] !== null) {
  240.                 foreach ($assoc['orderBy'] as $orderField => $orientation) {
  241.                     if (! $targetMetadata->hasField($orderField) && ! $targetMetadata->hasAssociation($orderField)) {
  242.                         $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is ordered by a foreign field ' .
  243.                                 $orderField . ' that is not a field on the target entity ' . $targetMetadata->name . '.';
  244.                         continue;
  245.                     }
  247.                     if ($targetMetadata->isCollectionValuedAssociation($orderField)) {
  248.                         $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is ordered by a field ' .
  249.                                 $orderField . ' on ' . $targetMetadata->name . ' that is a collection-valued association.';
  250.                         continue;
  251.                     }
  253.                     if ($targetMetadata->isAssociationInverseSide($orderField)) {
  254.                         $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is ordered by a field ' .
  255.                                 $orderField . ' on ' . $targetMetadata->name . ' that is the inverse side of an association.';
  256.                         continue;
  257.                     }
  258.                 }
  259.             }
  260.         }
  262.         if (
  263.             ! $class->isInheritanceTypeNone()
  264.             && ! $class->isRootEntity()
  265.             && ($class->reflClass !== null && ! $class->reflClass->isAbstract())
  266.             && ! $class->isMappedSuperclass
  267.             && array_search($class->name, $class->discriminatorMap, true) === false
  268.         ) {
  269.             $ce[] = "Entity class '" . $class->name . "' is part of inheritance hierarchy, but is " .
  270.                 "not mapped in the root entity '" . $class->rootEntityName . "' discriminator map. " .
  271.                 'All subclasses must be listed in the discriminator map.';
  272.         }
  274.         foreach ($class->subClasses as $subClass) {
  275.             if (! in_array($class->name, class_parents($subClass), true)) {
  276.                 $ce[] = "According to the discriminator map class '" . $subClass . "' has to be a child " .
  277.                         "of '" . $class->name . "' but these entities are not related through inheritance.";
  278.             }
  279.         }
  281.         return $ce;
  282.     }
  284.     /**
  285.      * Checks if the Database Schema is in sync with the current metadata state.
  286.      *
  287.      * @return bool
  288.      */
  289.     public function schemaInSyncWithMetadata()
  290.     {
  291.         return count($this->getUpdateSchemaList()) === 0;
  292.     }
  294.     /**
  295.      * Returns the list of missing Database Schema updates.
  296.      *
  297.      * @return array<string>
  298.      */
  299.     public function getUpdateSchemaList(): array
  300.     {
  301.         $schemaTool = new SchemaTool($this->em);
  303.         $allMetadata = $this->em->getMetadataFactory()->getAllMetadata();
  305.         return $schemaTool->getUpdateSchemaSql($allMetadata, true);
  306.     }
  307. }