BAP-7269: Can't add ManyToOne relation from Contact entity to Country…

… entity - review fixes
oroinc · Feb 26, 2016 · 9c4cd7b · 9c4cd7b
1 parent 5fcdc67
commit 9c4cd7b
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 32 deletions.
diff --git a/src/Oro/Bundle/EntityExtendBundle/Exception/InvalidRelationEntityException.php b/src/Oro/Bundle/EntityExtendBundle/Exception/InvalidRelationEntityException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Oro\Bundle\EntityExtendBundle\Exception;
+
+use Oro\Bundle\EntityBundle\Exception\EntityExceptionInterface;
+use Oro\Bundle\EntityBundle\Exception\RuntimeException;
+
+/**
+ * This exception is thrown when an entity is not valid for extend relation.
+ */
+class InvalidRelationEntityException extends RuntimeException implements EntityExceptionInterface
+{
+}
diff --git a/src/Oro/Bundle/EntityExtendBundle/ORM/RelationMetadataBuilder.php b/src/Oro/Bundle/EntityExtendBundle/ORM/RelationMetadataBuilder.php
@@ -7,7 +7,10 @@
 use Oro\Bundle\EntityConfigBundle\Config\ConfigInterface;
 use Oro\Bundle\EntityConfigBundle\Config\ConfigManager;
 use Oro\Bundle\EntityConfigBundle\Config\Id\FieldConfigId;
+
+use Oro\Bundle\EntityExtendBundle\Exception\InvalidRelationEntityException;
 use Oro\Bundle\EntityExtendBundle\Extend\RelationType;
+
 use Oro\Bundle\EntityExtendBundle\Tools\ExtendConfigDumper;
 use Oro\Bundle\EntityExtendBundle\Tools\ExtendDbIdentifierNameGenerator;
 use Oro\Bundle\EntityExtendBundle\Tools\ExtendHelper;
@@ -77,7 +80,7 @@ protected function buildManyToOneRelation(
         array $relation
     ) {
         $targetEntity   = $relation['target_entity'];
-        $targetIdColumn = $this->getPrimaryKeyColumn($targetEntity);
+        $targetIdColumn = $this->getSinglePrimaryKeyColumn($targetEntity);
         $cascade        = !empty($relation['cascade']) ? $relation['cascade'] : [];
         $cascade[]      = 'detach';
 
@@ -128,12 +131,7 @@ protected function buildOneToManyRelation(
             && RelationType::ONE_TO_MANY === ExtendHelper::getRelationType($relationKey)
             && $this->isDefaultRelationRequired($fieldId)
         ) {
-            $this->buildDefaultRelation(
-                $metadataBuilder,
-                $fieldId,
-                $targetEntity,
-                $this->getPrimaryKeyColumn($targetEntity)
-            );
+            $this->buildDefaultRelation($metadataBuilder, $fieldId, $targetEntity);
         }
     }
 
@@ -152,12 +150,7 @@ protected function buildManyToManyRelation(
         if ($relation['owner']) {
             $this->buildManyToManyOwningSideRelation($metadataBuilder, $fieldId, $relation);
             if ($this->isDefaultRelationRequired($fieldId)) {
-                $this->buildDefaultRelation(
-                    $metadataBuilder,
-                    $fieldId,
-                    $targetEntity,
-                    $this->getPrimaryKeyColumn($targetEntity)
-                );
+                $this->buildDefaultRelation($metadataBuilder, $fieldId, $targetEntity);
             }
         } elseif (!empty($relation['target_field_id'])) {
             $this->buildManyToManyTargetSideRelation(
@@ -193,8 +186,8 @@ protected function buildManyToManyOwningSideRelation(
             $fieldId->getFieldName(),
             $targetEntity
         );
-        $selfIdColumn    = $this->getPrimaryKeyColumn($entityClassName);
-        $targetIdColumn = $this->getPrimaryKeyColumn($targetEntity);
+        $selfIdColumn = $this->getSinglePrimaryKeyColumn($entityClassName);
+        $targetIdColumn = $this->getSinglePrimaryKeyColumn($targetEntity);
         $builder->setJoinTable($joinTableName);
 
         if ($selfIdColumn !== 'id') {
@@ -251,22 +244,23 @@ protected function buildManyToManyTargetSideRelation(
      * @param ClassMetadataBuilder $metadataBuilder
      * @param FieldConfigId        $fieldId
      * @param string               $targetEntity
-     * @param string               $targetIdColumn
      *
      */
     protected function buildDefaultRelation(
         ClassMetadataBuilder $metadataBuilder,
         FieldConfigId $fieldId,
-        $targetEntity,
-        $targetIdColumn
+        $targetEntity
     ) {
-        $builder = $metadataBuilder->createManyToOne(
+        $targetIdColumn = $this->getSinglePrimaryKeyColumn($targetEntity);
+        $builder        = $metadataBuilder->createManyToOne(
             ExtendConfigDumper::DEFAULT_PREFIX . $fieldId->getFieldName(),
             $targetEntity
         );
-
         $builder->addJoinColumn(
-            $this->nameGenerator->generateRelationDefaultColumnName($fieldId->getFieldName(), '_' . $targetIdColumn),
+            $this->nameGenerator->generateRelationDefaultColumnName(
+                $fieldId->getFieldName(),
+                '_' . $targetIdColumn
+            ),
             $targetIdColumn,
             true,
             false,
@@ -324,12 +318,18 @@ protected function getFieldConfig(FieldConfigId $fieldId)
      *
      * @return string
      */
-    protected function getPrimaryKeyColumn($entityName)
+    protected function getSinglePrimaryKeyColumn($entityName)
     {
         $pkColumns = ['id'];
-        if ($this->configManager->getProvider('extend')->hasConfig($entityName)) {
-            $config = $this->configManager->getProvider('extend')->getConfig($entityName);
-            $pkColumns = $config->get('pk_columns', false, $pkColumns);
+        if ($this->configManager->hasConfig($entityName)) {
+            $entityConfig = $this->configManager->getEntityConfig('extend', $entityName);
+            $pkColumns = $entityConfig->get('pk_columns', false, $pkColumns);
+            if (count($pkColumns) > 1) {
+                // TODO This restriction should be removed in scope of https://magecore.atlassian.net/browse/BAP-9815
+                throw new InvalidRelationEntityException(
+                    sprintf('Entity class %s has not single primary key.', $entityName)
+                );
+            }
         }
 
         return reset($pkColumns);

diff --git a/src/Oro/Bundle/EntityExtendBundle/Tools/ExtendConfigLoader.php b/src/Oro/Bundle/EntityExtendBundle/Tools/ExtendConfigLoader.php
@@ -128,13 +128,10 @@ protected function loadEntityConfigs(ClassMetadata $metadata, $force)
         parent::loadEntityConfigs($metadata, $force);
 
         $className = $metadata->getName();
-        if ($this->hasEntityConfigs($metadata)) {
-            if ($this->configManager->getProvider('extend')->hasConfig($className)) {
-                $configInterface = $this->configManager->getProvider('extend')->getConfig($className);
-                $configInterface
-                    ->set('pk_columns', $metadata->getIdentifierColumnNames());
-                $this->configManager->persist($configInterface);
-            }
+        if ($this->hasEntityConfigs($metadata) && $this->configManager->hasConfig($className)) {
+            $entityConfig = $this->configManager->getEntityConfig('extend', $className);
+            $entityConfig->set('pk_columns', $metadata->getIdentifierColumnNames());
+            $this->configManager->persist($entityConfig);
         }
     }
 }