. */ namespace Doctrine\ORM\Tools; use Doctrine\ORM\EntityManager; use Doctrine\ORM\Mapping\ManyToManyMapping; use Doctrine\ORM\Mapping\OneToOneMapping; /** * Performs strict validation of the mapping schema * * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @link www.doctrine-project.com * @since 1.0 * @version $Revision$ * @author Benjamin Eberlei * @author Guilherme Blanco * @author Jonathan Wage * @author Roman Borschel */ class SchemaValidator { /** * @var EntityManager */ private $em; /** * @param EntityManager $em */ public function __construct(EntityManager $em) { $this->em = $em; } /** * Checks the internal consistency of mapping files. * * There are several checks that can't be done at runtime or are too expensive, which can be verified * with this command. For example: * * 1. Check if a relation with "mappedBy" is actually connected to that specified field. * 2. Check if "mappedBy" and "inversedBy" are consistent to each other. * 3. Check if "referencedColumnName" attributes are really pointing to primary key columns. * 4. Check if there are public properties that might cause problems with lazy loading. * * @return array */ public function validateMapping() { $errors = array(); $cmf = $this->em->getMetadataFactory(); $classes = $cmf->getAllMetadata(); foreach ($classes AS $class) { $ce = array(); /* @var $class ClassMetadata */ foreach ($class->associationMappings AS $fieldName => $assoc) { if (!$cmf->hasMetadataFor($assoc->targetEntityName)) { $ce[] = "The target entity '" . $assoc->targetEntityName . "' specified on " . $class->name . '#' . $fieldName . ' is unknown.'; } if ($assoc->mappedBy && $assoc->inversedBy) { $ce[] = "The association " . $class . "#" . $fieldName . " cannot be defined as both inverse and owning."; } $targetMetadata = $cmf->getMetadataFor($assoc->targetEntityName); /* @var $assoc AssociationMapping */ if ($assoc->mappedBy) { if ($targetMetadata->hasField($assoc->mappedBy)) { $ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the owning side ". "field " . $assoc->targetEntityName . "#" . $assoc->mappedBy . " which is not defined as association."; } if (!$targetMetadata->hasAssociation($assoc->mappedBy)) { $ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the owning side ". "field " . $assoc->targetEntityName . "#" . $assoc->mappedBy . " which does not exist."; } else if ($targetMetadata->associationMappings[$assoc->mappedBy]->inversedBy == null) { $ce[] = "The field " . $class->name . "#" . $fieldName . " is on the inverse side of a ". "bi-directional relationship, but the specified mappedBy association on the target-entity ". $assoc->targetEntityName . "#" . $assoc->mappedBy . " does not contain the required ". "'inversedBy' attribute."; } else if ($targetMetadata->associationMappings[$assoc->mappedBy]->inversedBy != $fieldName) { $ce[] = "The mappings " . $class->name . "#" . $fieldName . " and " . $assoc->targetEntityName . "#" . $assoc->mappedBy . " are ". "incosistent with each other."; } } if ($assoc->inversedBy) { if ($targetMetadata->hasField($assoc->inversedBy)) { $ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the inverse side ". "field " . $assoc->targetEntityName . "#" . $assoc->inversedBy . " which is not defined as association."; } if (!$targetMetadata->hasAssociation($assoc->inversedBy)) { $ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the inverse side ". "field " . $assoc->targetEntityName . "#" . $assoc->inversedBy . " which does not exist."; } else if ($targetMetadata->associationMappings[$assoc->inversedBy]->mappedBy == null) { $ce[] = "The field " . $class->name . "#" . $fieldName . " is on the owning side of a ". "bi-directional relationship, but the specified mappedBy association on the target-entity ". $assoc->targetEntityName . "#" . $assoc->mappedBy . " does not contain the required ". "'inversedBy' attribute."; } else if ($targetMetadata->associationMappings[$assoc->inversedBy]->mappedBy != $fieldName) { $ce[] = "The mappings " . $class->name . "#" . $fieldName . " and " . $assoc->targetEntityName . "#" . $assoc->inversedBy . " are ". "incosistent with each other."; } } if ($assoc->isOwningSide) { if ($assoc instanceof ManyToManyMapping) { foreach ($assoc->joinTable['joinColumns'] AS $joinColumn) { if (!isset($class->fieldNames[$joinColumn['referencedColumnName']])) { $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' does not " . "have a corresponding field with this column name on the class '" . $class->name . "'."; break; } $fieldName = $class->fieldNames[$joinColumn['referencedColumnName']]; if (!in_array($fieldName, $class->identifier)) { $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " . "has to be a primary key column."; } } foreach ($assoc->joinTable['inverseJoinColumns'] AS $inverseJoinColumn) { $targetClass = $cmf->getMetadataFor($assoc->targetEntityName); if (!isset($targetClass->fieldNames[$inverseJoinColumn['referencedColumnName']])) { $ce[] = "The inverse referenced column name '" . $inverseJoinColumn['referencedColumnName'] . "' does not " . "have a corresponding field with this column name on the class '" . $targetClass->name . "'."; break; } $fieldName = $targetClass->fieldNames[$inverseJoinColumn['referencedColumnName']]; if (!in_array($fieldName, $targetClass->identifier)) { $ce[] = "The referenced column name '" . $inverseJoinColumn['referencedColumnName'] . "' " . "has to be a primary key column."; } } } else if ($assoc instanceof OneToOneMapping) { foreach ($assoc->joinColumns AS $joinColumn) { $targetClass = $cmf->getMetadataFor($assoc->targetEntityName); if (!isset($targetClass->fieldNames[$joinColumn['referencedColumnName']])) { $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' does not " . "have a corresponding field with this column name on the class '" . $targetClass->name . "'."; break; } $fieldName = $targetClass->fieldNames[$joinColumn['referencedColumnName']]; if (!in_array($fieldName, $targetClass->identifier)) { $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " . "has to be a primary key column."; } } } } if (isset($assoc->orderBy) && $assoc->orderBy !== null) { $targetClass = $cmf->getMetadataFor($assoc->targetEntityName); foreach ($assoc->orderBy AS $orderField => $orientation) { if (!$targetClass->hasField($orderField)) { $ce[] = "The association " . $class->name."#".$fieldName." is ordered by a foreign field " . $orderField . " that is not a field on the target entity " . $targetClass->name; } } } } foreach ($class->reflClass->getProperties(\ReflectionProperty::IS_PUBLIC) as $publicAttr) { if ($publicAttr->isStatic()) { continue; } $ce[] = "Field '".$publicAttr->getName()."' in class '".$class->name."' must be private ". "or protected. Public fields may break lazy-loading."; } foreach ($class->subClasses AS $subClass) { if (!in_array($class->name, class_parents($subClass))) { $ce[] = "According to the discriminator map class '" . $subClass . "' has to be a child ". "of '" . $class->name . "' but these entities are not related through inheritance."; } } if ($ce) { $errors[$class->name] = $ce; } } return $errors; } /** * Check if the Database Schema is in sync with the current metadata state. * * @return bool */ public function schemaInSyncWithMetadata() { $schemaTool = new SchemaTool($this->em); $allMetadata = $this->em->getMetadataFactory()->getAllMetadata(); return (count($schemaTool->getUpdateSchemaSql($allMetadata, false)) == 0); } }