--- /dev/null
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
+*/
+
+namespace Doctrine\ORM\Tools;
+
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\DBAL\Types\Type;
+
+/**
+ * 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
+ * @author Benjamin Eberlei <kontakt@beberlei.de>
+ * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
+ * @author Jonathan Wage <jonwage@gmail.com>
+ * @author Roman Borschel <roman@code-factory.org>
+ */
+class SchemaValidator
+{
+ /**
+ * @var EntityManager
+ */
+ private $em;
+
+ /**
+ * @param EntityManager $em
+ */
+ public function __construct(EntityManager $em)
+ {
+ $this->em = $em;
+ }
+
+ /**
+ * Checks the internal consistency of all 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) {
+ if ($ce = $this->validateClass($class)) {
+ $errors[$class->name] = $ce;
+ }
+ }
+
+ return $errors;
+ }
+
+ /**
+ * Validate a single class of the current
+ *
+ * @param ClassMetadataInfo $class
+ * @return array
+ */
+ public function validateClass(ClassMetadataInfo $class)
+ {
+ $ce = array();
+ $cmf = $this->em->getMetadataFactory();
+
+ foreach ($class->fieldMappings as $fieldName => $mapping) {
+ if (!Type::hasType($mapping['type'])) {
+ $ce[] = "The field '" . $class->name . "#" . $fieldName."' uses a non-existant type '" . $mapping['type'] . "'.";
+ }
+ }
+
+ foreach ($class->associationMappings as $fieldName => $assoc) {
+ if (!class_exists($assoc['targetEntity']) || $cmf->isTransient($assoc['targetEntity'])) {
+ $ce[] = "The target entity '" . $assoc['targetEntity'] . "' specified on " . $class->name . '#' . $fieldName . ' is unknown or not an entity.';
+ return $ce;
+ }
+
+ if ($assoc['mappedBy'] && $assoc['inversedBy']) {
+ $ce[] = "The association " . $class . "#" . $fieldName . " cannot be defined as both inverse and owning.";
+ }
+
+ $targetMetadata = $cmf->getMetadataFor($assoc['targetEntity']);
+
+ if (isset($assoc['id']) && $targetMetadata->containsForeignIdentifier) {
+ $ce[] = "Cannot map association '" . $class->name. "#". $fieldName ." as identifier, because " .
+ "the target entity '". $targetMetadata->name . "' also maps an association as identifier.";
+ }
+
+ /* @var $assoc AssociationMapping */
+ if ($assoc['mappedBy']) {
+ if ($targetMetadata->hasField($assoc['mappedBy'])) {
+ $ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the owning side ".
+ "field " . $assoc['targetEntity'] . "#" . $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['targetEntity'] . "#" . $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['targetEntity'] . "#" . $assoc['mappedBy'] . " does not contain the required ".
+ "'inversedBy=".$fieldName."' attribute.";
+ } else if ($targetMetadata->associationMappings[$assoc['mappedBy']]['inversedBy'] != $fieldName) {
+ $ce[] = "The mappings " . $class->name . "#" . $fieldName . " and " .
+ $assoc['targetEntity'] . "#" . $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['targetEntity'] . "#" . $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['targetEntity'] . "#" . $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['targetEntity'] . "#" . $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['targetEntity'] . "#" . $assoc['inversedBy'] . " are ".
+ "incosistent with each other.";
+ }
+
+ // Verify inverse side/owning side match each other
+ if (array_key_exists($assoc['inversedBy'], $targetMetadata->associationMappings)) {
+ $targetAssoc = $targetMetadata->associationMappings[$assoc['inversedBy']];
+ if ($assoc['type'] == ClassMetadataInfo::ONE_TO_ONE && $targetAssoc['type'] !== ClassMetadataInfo::ONE_TO_ONE){
+ $ce[] = "If association " . $class->name . "#" . $fieldName . " is one-to-one, then the inversed " .
+ "side " . $targetMetadata->name . "#" . $assoc['inversedBy'] . " has to be one-to-one as well.";
+ } else if ($assoc['type'] == ClassMetadataInfo::MANY_TO_ONE && $targetAssoc['type'] !== ClassMetadataInfo::ONE_TO_MANY){
+ $ce[] = "If association " . $class->name . "#" . $fieldName . " is many-to-one, then the inversed " .
+ "side " . $targetMetadata->name . "#" . $assoc['inversedBy'] . " has to be one-to-many.";
+ } else if ($assoc['type'] == ClassMetadataInfo::MANY_TO_MANY && $targetAssoc['type'] !== ClassMetadataInfo::MANY_TO_MANY){
+ $ce[] = "If association " . $class->name . "#" . $fieldName . " is many-to-many, then the inversed " .
+ "side " . $targetMetadata->name . "#" . $assoc['inversedBy'] . " has to be many-to-many as well.";
+ }
+ }
+ }
+
+ if ($assoc['isOwningSide']) {
+ if ($assoc['type'] == ClassMetadataInfo::MANY_TO_MANY) {
+ $identifierColumns = $class->getIdentifierColumnNames();
+ foreach ($assoc['joinTable']['joinColumns'] as $joinColumn) {
+ if (!in_array($joinColumn['referencedColumnName'], $identifierColumns)) {
+ $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
+ "has to be a primary key column on the target entity class '".$class->name."'.";
+ break;
+ }
+ }
+
+ $identifierColumns = $targetMetadata->getIdentifierColumnNames();
+ foreach ($assoc['joinTable']['inverseJoinColumns'] as $inverseJoinColumn) {
+ if (!in_array($inverseJoinColumn['referencedColumnName'], $identifierColumns)) {
+ $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
+ "has to be a primary key column on the target entity class '".$targetMetadata->name."'.";
+ break;
+ }
+ }
+
+ if (count($targetMetadata->getIdentifierColumnNames()) != count($assoc['joinTable']['inverseJoinColumns'])) {
+ $ce[] = "The inverse join columns of the many-to-many table '" . $assoc['joinTable']['name'] . "' " .
+ "have to contain to ALL identifier columns of the target entity '". $targetMetadata->name . "', " .
+ "however '" . implode(", ", array_diff($targetMetadata->getIdentifierColumnNames(), array_values($assoc['relationToTargetKeyColumns']))) .
+ "' are missing.";
+ }
+
+ if (count($class->getIdentifierColumnNames()) != count($assoc['joinTable']['joinColumns'])) {
+ $ce[] = "The join columns of the many-to-many table '" . $assoc['joinTable']['name'] . "' " .
+ "have to contain to ALL identifier columns of the source entity '". $class->name . "', " .
+ "however '" . implode(", ", array_diff($class->getIdentifierColumnNames(), array_values($assoc['relationToSourceKeyColumns']))) .
+ "' are missing.";
+ }
+
+ } else if ($assoc['type'] & ClassMetadataInfo::TO_ONE) {
+ $identifierColumns = $targetMetadata->getIdentifierColumnNames();
+ foreach ($assoc['joinColumns'] as $joinColumn) {
+ if (!in_array($joinColumn['referencedColumnName'], $identifierColumns)) {
+ $ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
+ "has to be a primary key column on the target entity class '".$targetMetadata->name."'.";
+ }
+ }
+
+ if (count($identifierColumns) != count($assoc['joinColumns'])) {
+ $ids = array();
+ foreach ($assoc['joinColumns'] as $joinColumn) {
+ $ids[] = $joinColumn['name'];
+ }
+
+ $ce[] = "The join columns of the association '" . $assoc['fieldName'] . "' " .
+ "have to match to ALL identifier columns of the target entity '". $class->name . "', " .
+ "however '" . implode(", ", array_diff($targetMetadata->getIdentifierColumnNames(), $ids)) .
+ "' are missing.";
+ }
+ }
+ }
+
+ if (isset($assoc['orderBy']) && $assoc['orderBy'] !== null) {
+ foreach ($assoc['orderBy'] as $orderField => $orientation) {
+ if (!$targetMetadata->hasField($orderField)) {
+ $ce[] = "The association " . $class->name."#".$fieldName." is ordered by a foreign field " .
+ $orderField . " that is not a field on the target entity " . $targetMetadata->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.";
+ }
+ }
+
+ return $ce;
+ }
+
+ /**
+ * @param string $columnName
+ * @param ClassMetadataInfo $class
+ * @return bool
+ */
+ private function columnExistsOnEntity($columnName, $class)
+ {
+ if (isset($class->fieldNames[$columnName])) {
+ return true;
+ }
+ foreach ($class->associationMappings as $assoc) {
+ if ($assoc['isOwningSide']) {
+ foreach ($assoc['joinColumns'] as $columnMapping) {
+ if ($columnMapping['name'] == $columnName) {
+ return true;
+ }
+ }
+ }
+ }
+ return false;
+ }
+
+ /**
+ * 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, true)) == 0);
+ }
+}
projects / zf2.biz / application_blanche.git / blobdiff