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

Open in your IDE?
  1. <?php
  2. /*
  3.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  4.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  5.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  6.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  7.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  8.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  9.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14.  *
  15.  * This software consists of voluntary contributions made by many individuals
  16.  * and is licensed under the MIT license. For more information, see
  17.  * <http://www.doctrine-project.org>.
  18.  */
  20. namespace Doctrine\ORM\Tools;
  22. use Doctrine\ORM\EntityManagerInterface;
  23. use Doctrine\ORM\Mapping\ClassMetadataInfo;
  24. use Doctrine\DBAL\Types\Type;
  25. use function count;
  27. /**
  28.  * Performs strict validation of the mapping schema
  29.  *
  30.  * @license     http://www.opensource.org/licenses/mit-license.php MIT
  31.  * @link        www.doctrine-project.com
  32.  * @since       1.0
  33.  * @author      Benjamin Eberlei <kontakt@beberlei.de>
  34.  * @author      Guilherme Blanco <guilhermeblanco@hotmail.com>
  35.  * @author      Jonathan Wage <jonwage@gmail.com>
  36.  * @author      Roman Borschel <roman@code-factory.org>
  37.  */
  38. class SchemaValidator
  39. {
  40.     /**
  41.      * @var EntityManagerInterface
  42.      */
  43.     private $em;
  45.     /**
  46.      * @param EntityManagerInterface $em
  47.      */
  48.     public function __construct(EntityManagerInterface $em)
  49.     {
  50.         $this->em = $em;
  51.     }
  53.     /**
  54.      * Checks the internal consistency of all mapping files.
  55.      *
  56.      * There are several checks that can't be done at runtime or are too expensive, which can be verified
  57.      * with this command. For example:
  58.      *
  59.      * 1. Check if a relation with "mappedBy" is actually connected to that specified field.
  60.      * 2. Check if "mappedBy" and "inversedBy" are consistent to each other.
  61.      * 3. Check if "referencedColumnName" attributes are really pointing to primary key columns.
  62.      *
  63.      * @return array
  64.      */
  65.     public function validateMapping()
  66.     {
  67.         $errors = [];
  68.         $cmf = $this->em->getMetadataFactory();
  69.         $classes = $cmf->getAllMetadata();
  71.         foreach ($classes as $class) {
  72.             if ($ce = $this->validateClass($class)) {
  73.                 $errors[$class->name] = $ce;
  74.             }
  75.         }
  77.         return $errors;
  78.     }
  80.     /**
  81.      * Validates a single class of the current.
  82.      *
  83.      * @param ClassMetadataInfo $class
  84.      *
  85.      * @return string[]
  86.      *
  87.      * @psalm-return list<string>
  88.      */
  89.     public function validateClass(ClassMetadataInfo $class)
  90.     {
  91.         $ce = [];
  92.         $cmf = $this->em->getMetadataFactory();
  94.         foreach ($class->fieldMappings as $fieldName => $mapping) {
  95.             if (!Type::hasType($mapping['type'])) {
  96.                 $ce[] = "The field '" . $class->name . "#" . $fieldName."' uses a non-existent type '" . $mapping['type'] . "'.";
  97.             }
  98.         }
  100.         if ($class->isEmbeddedClass && count($class->associationMappings) > 0) {
  101.             $ce[] = "Embeddable '" . $class->name . "' does not support associations";
  103.             return $ce;
  104.         }
  106.         foreach ($class->associationMappings as $fieldName => $assoc) {
  107.             if (!class_exists($assoc['targetEntity']) || $cmf->isTransient($assoc['targetEntity'])) {
  108.                 $ce[] = "The target entity '" . $assoc['targetEntity'] . "' specified on " . $class->name . '#' . $fieldName . ' is unknown or not an entity.';
  110.                 return $ce;
  111.             }
  113.             if ($assoc['mappedBy'] && $assoc['inversedBy']) {
  114.                 $ce[] = "The association " . $class . "#" . $fieldName . " cannot be defined as both inverse and owning.";
  115.             }
  117.             $targetMetadata = $cmf->getMetadataFor($assoc['targetEntity']);
  119.             if (isset($assoc['id']) && $targetMetadata->containsForeignIdentifier) {
  120.                 $ce[] = "Cannot map association '" . $class->name. "#". $fieldName ." as identifier, because " .
  121.                         "the target entity '". $targetMetadata->name . "' also maps an association as identifier.";
  122.             }
  124.             if ($assoc['mappedBy']) {
  125.                 if ($targetMetadata->hasField($assoc['mappedBy'])) {
  126.                     $ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the owning side ".
  127.                             "field " . $assoc['targetEntity'] . "#" . $assoc['mappedBy'] . " which is not defined as association, but as field.";
  128.                 }
  129.                 if (!$targetMetadata->hasAssociation($assoc['mappedBy'])) {
  130.                     $ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the owning side ".
  131.                             "field " . $assoc['targetEntity'] . "#" . $assoc['mappedBy'] . " which does not exist.";
  132.                 } elseif ($targetMetadata->associationMappings[$assoc['mappedBy']]['inversedBy'] == null) {
  133.                     $ce[] = "The field " . $class->name . "#" . $fieldName . " is on the inverse side of a ".
  134.                             "bi-directional relationship, but the specified mappedBy association on the target-entity ".
  135.                             $assoc['targetEntity'] . "#" . $assoc['mappedBy'] . " does not contain the required ".
  136.                             "'inversedBy=\"" . $fieldName . "\"' attribute.";
  137.                 } elseif ($targetMetadata->associationMappings[$assoc['mappedBy']]['inversedBy'] != $fieldName) {
  138.                     $ce[] = "The mappings " . $class->name . "#" . $fieldName . " and " .
  139.                             $assoc['targetEntity'] . "#" . $assoc['mappedBy'] . " are ".
  140.                             "inconsistent with each other.";
  141.                 }
  142.             }
  144.             if ($assoc['inversedBy']) {
  145.                 if ($targetMetadata->hasField($assoc['inversedBy'])) {
  146.                     $ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the inverse side ".
  147.                             "field " . $assoc['targetEntity'] . "#" . $assoc['inversedBy'] . " which is not defined as association.";
  148.                 }
  150.                 if (!$targetMetadata->hasAssociation($assoc['inversedBy'])) {
  151.                     $ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the inverse side ".
  152.                             "field " . $assoc['targetEntity'] . "#" . $assoc['inversedBy'] . " which does not exist.";
  153.                 } elseif ($targetMetadata->associationMappings[$assoc['inversedBy']]['mappedBy'] == null) {
  154.                     $ce[] = "The field " . $class->name . "#" . $fieldName . " is on the owning side of a ".
  155.                             "bi-directional relationship, but the specified mappedBy association on the target-entity ".
  156.                             $assoc['targetEntity'] . "#" . $assoc['mappedBy'] . " does not contain the required ".
  157.                             "'inversedBy' attribute.";
  158.                 } elseif ($targetMetadata->associationMappings[$assoc['inversedBy']]['mappedBy'] != $fieldName) {
  159.                     $ce[] = "The mappings " . $class->name . "#" . $fieldName . " and " .
  160.                             $assoc['targetEntity'] . "#" . $assoc['inversedBy'] . " are ".
  161.                             "inconsistent with each other.";
  162.                 }
  164.                 // Verify inverse side/owning side match each other
  165.                 if (array_key_exists($assoc['inversedBy'], $targetMetadata->associationMappings)) {
  166.                     $targetAssoc = $targetMetadata->associationMappings[$assoc['inversedBy']];
  167.                     if ($assoc['type'] == ClassMetadataInfo::ONE_TO_ONE && $targetAssoc['type'] !== ClassMetadataInfo::ONE_TO_ONE) {
  168.                         $ce[] = "If association " . $class->name . "#" . $fieldName . " is one-to-one, then the inversed " .
  169.                                 "side " . $targetMetadata->name . "#" . $assoc['inversedBy'] . " has to be one-to-one as well.";
  170.                     } elseif ($assoc['type'] == ClassMetadataInfo::MANY_TO_ONE && $targetAssoc['type'] !== ClassMetadataInfo::ONE_TO_MANY) {
  171.                         $ce[] = "If association " . $class->name . "#" . $fieldName . " is many-to-one, then the inversed " .
  172.                                 "side " . $targetMetadata->name . "#" . $assoc['inversedBy'] . " has to be one-to-many.";
  173.                     } elseif ($assoc['type'] == ClassMetadataInfo::MANY_TO_MANY && $targetAssoc['type'] !== ClassMetadataInfo::MANY_TO_MANY) {
  174.                         $ce[] = "If association " . $class->name . "#" . $fieldName . " is many-to-many, then the inversed " .
  175.                                 "side " . $targetMetadata->name . "#" . $assoc['inversedBy'] . " has to be many-to-many as well.";
  176.                     }
  177.                 }
  178.             }
  180.             if ($assoc['isOwningSide']) {
  181.                 if ($assoc['type'] == ClassMetadataInfo::MANY_TO_MANY) {
  182.                     $identifierColumns = $class->getIdentifierColumnNames();
  183.                     foreach ($assoc['joinTable']['joinColumns'] as $joinColumn) {
  184.                         if (!in_array($joinColumn['referencedColumnName'], $identifierColumns)) {
  185.                             $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
  186.                                 "has to be a primary key column on the target entity class '".$class->name."'.";
  187.                             break;
  188.                         }
  189.                     }
  191.                     $identifierColumns = $targetMetadata->getIdentifierColumnNames();
  192.                     foreach ($assoc['joinTable']['inverseJoinColumns'] as $inverseJoinColumn) {
  193.                         if (! in_array($inverseJoinColumn['referencedColumnName'], $identifierColumns)) {
  194.                             $ce[] = "The referenced column name '" . $inverseJoinColumn['referencedColumnName'] . "' " .
  195.                                 "has to be a primary key column on the target entity class '" .$targetMetadata->name . "'.";
  196.                             break;
  197.                         }
  198.                     }
  200.                     if (count($targetMetadata->getIdentifierColumnNames()) != count($assoc['joinTable']['inverseJoinColumns'])) {
  201.                         $ce[] = "The inverse join columns of the many-to-many table '" . $assoc['joinTable']['name'] . "' " .
  202.                                 "have to contain to ALL identifier columns of the target entity '". $targetMetadata->name . "', " .
  203.                                 "however '" . implode(", ", array_diff($targetMetadata->getIdentifierColumnNames(), array_values($assoc['relationToTargetKeyColumns']))) .
  204.                                 "' are missing.";
  205.                     }
  207.                     if (count($class->getIdentifierColumnNames()) != count($assoc['joinTable']['joinColumns'])) {
  208.                         $ce[] = "The join columns of the many-to-many table '" . $assoc['joinTable']['name'] . "' " .
  209.                                 "have to contain to ALL identifier columns of the source entity '". $class->name . "', " .
  210.                                 "however '" . implode(", ", array_diff($class->getIdentifierColumnNames(), array_values($assoc['relationToSourceKeyColumns']))) .
  211.                                 "' are missing.";
  212.                     }
  214.                 } elseif ($assoc['type'] & ClassMetadataInfo::TO_ONE) {
  215.                     $identifierColumns = $targetMetadata->getIdentifierColumnNames();
  216.                     foreach ($assoc['joinColumns'] as $joinColumn) {
  217.                         if (!in_array($joinColumn['referencedColumnName'], $identifierColumns)) {
  218.                             $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
  219.                                     "has to be a primary key column on the target entity class '".$targetMetadata->name."'.";
  220.                         }
  221.                     }
  223.                     if (count($identifierColumns) != count($assoc['joinColumns'])) {
  224.                         $ids = [];
  226.                         foreach ($assoc['joinColumns'] as $joinColumn) {
  227.                             $ids[] = $joinColumn['name'];
  228.                         }
  230.                         $ce[] = "The join columns of the association '" . $assoc['fieldName'] . "' " .
  231.                                 "have to match to ALL identifier columns of the target entity '". $targetMetadata->name . "', " .
  232.                                 "however '" . implode(", ", array_diff($targetMetadata->getIdentifierColumnNames(), $ids)) .
  233.                                 "' are missing.";
  234.                     }
  235.                 }
  236.             }
  238.             if (isset($assoc['orderBy']) && $assoc['orderBy'] !== null) {
  239.                 foreach ($assoc['orderBy'] as $orderField => $orientation) {
  240.                     if (!$targetMetadata->hasField($orderField) && !$targetMetadata->hasAssociation($orderField)) {
  241.                         $ce[] = "The association " . $class->name."#".$fieldName." is ordered by a foreign field " .
  242.                                 $orderField . " that is not a field on the target entity " . $targetMetadata->name . ".";
  243.                         continue;
  244.                     }
  245.                     if ($targetMetadata->isCollectionValuedAssociation($orderField)) {
  246.                         $ce[] = "The association " . $class->name."#".$fieldName." is ordered by a field " .
  247.                                 $orderField . " on " . $targetMetadata->name . " that is a collection-valued association.";
  248.                         continue;
  249.                     }
  250.                     if ($targetMetadata->isAssociationInverseSide($orderField)) {
  251.                         $ce[] = "The association " . $class->name."#".$fieldName." is ordered by a field " .
  252.                                 $orderField . " on " . $targetMetadata->name . " that is the inverse side of an association.";
  253.                         continue;
  254.                     }
  255.                 }
  256.             }
  257.         }
  259.         foreach ($class->subClasses as $subClass) {
  260.             if (!in_array($class->name, class_parents($subClass))) {
  261.                 $ce[] = "According to the discriminator map class '" . $subClass . "' has to be a child ".
  262.                         "of '" . $class->name . "' but these entities are not related through inheritance.";
  263.             }
  264.         }
  266.         return $ce;
  267.     }
  269.     /**
  270.      * Checks if the Database Schema is in sync with the current metadata state.
  271.      *
  272.      * @return bool
  273.      */
  274.     public function schemaInSyncWithMetadata()
  275.     {
  276.         $schemaTool = new SchemaTool($this->em);
  278.         $allMetadata = $this->em->getMetadataFactory()->getAllMetadata();
  280.         return count($schemaTool->getUpdateSchemaSql($allMetadata, true)) == 0;
  281.     }
  282. }