DAN feedback

Author: Kharhamel

src/Utils/AbstractBeanPropertyDescriptor.php

@@ -10,7 +10,7 @@
 /**
  * This class represent a property in a bean (a property has a getter, a setter, etc...).
  */
-abstract class AbstractBeanPropertyDescriptor
+abstract class AbstractBeanPropertyDescriptor implements MethodDescriptorInterface
 {
     /**
      * @var Table
@@ -80,6 +80,14 @@ public function getSetterName(): string
         return $this->namingStrategy->getSetterName($this);
     }
 
+    /**
+     * Alias of the method getGetterName(). Used to validate MethodDescriptorInterface
+     */
+    public function getName(): string
+    {
+        return $this->getGetterName();
+    }
+
     public function getGetterName(): string
     {
         return $this->namingStrategy->getGetterName($this);

src/Utils/BeanDescriptor.php

@@ -111,7 +111,7 @@ class BeanDescriptor implements BeanDescriptorInterface
      */
     private $registry;
     /**
-     * @var int[]
+     * @var MethodDescriptorInterface[][]
      */
     private $descriptorsByMethodName = [];
     /**
@@ -159,14 +159,7 @@ public function initBeanPropertyDescriptors(): void
 
         //init the list of method names with regular properties names
         foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) {
-            $name = $beanPropertyDescriptor->getGetterName();
-            if (!isset($this->descriptorsByMethodName[$name])) {
-                $this->descriptorsByMethodName[$name] = 0;
-            }
-            $this->descriptorsByMethodName[$name] ++;
-            if ($this->descriptorsByMethodName[$name] > 1) {
-                $beanPropertyDescriptor->useAlternativeName();
-            }
+            $this->checkForDuplicate($beanPropertyDescriptor);
         }
     }
 
@@ -405,8 +398,8 @@ private function getDirectForeignKeysDescriptors(): array
         $descriptors = [];
 
         foreach ($fks as $fk) {
-            /** @var DirectForeignKeyMethodDescriptor $desc */
-            $desc = $this->checkForDuplicate(new DirectForeignKeyMethodDescriptor($fk, $this->table, $this->namingStrategy, $this->annotationParser, $this->beanNamespace));
+            $desc = new DirectForeignKeyMethodDescriptor($fk, $this->table, $this->namingStrategy, $this->annotationParser, $this->beanNamespace);
+            $this->checkForDuplicate($desc);
             $descriptors[] = $desc;
         }
 
@@ -429,14 +422,14 @@ private function getPivotTableDescriptors(): array
 
             if ($fks[0]->getForeignTableName() === $this->table->getName()) {
                 list($localFk, $remoteFk) = $fks;
-                /** @var PivotTableMethodsDescriptor $desc */
-                $desc = $this->checkForDuplicate(new PivotTableMethodsDescriptor($table, $localFk, $remoteFk, $this->namingStrategy, $this->beanNamespace, $this->annotationParser));
+                $desc = new PivotTableMethodsDescriptor($table, $localFk, $remoteFk, $this->namingStrategy, $this->beanNamespace, $this->annotationParser);
+                $this->checkForDuplicate($desc);
                 $descs[] = $desc;
             }
             if ($fks[1]->getForeignTableName() === $this->table->getName()) {
                 list($remoteFk, $localFk) = $fks;
-                /** @var PivotTableMethodsDescriptor $desc */
-                $desc = $this->checkForDuplicate(new PivotTableMethodsDescriptor($table, $localFk, $remoteFk, $this->namingStrategy, $this->beanNamespace, $this->annotationParser));
+                $desc = new PivotTableMethodsDescriptor($table, $localFk, $remoteFk, $this->namingStrategy, $this->beanNamespace, $this->annotationParser);
+                $this->checkForDuplicate($desc);
                 $descs[] = $desc;
             }
         }
@@ -446,25 +439,26 @@ private function getPivotTableDescriptors(): array
     }
 
     /**
-     * Check the method name isn't already used and flag the $descriptor to use its alternative name if it is the case
+     * Check the method name isn't already used and flag the associated descriptors to use their alternative names if it is the case
      */
-    public function checkForDuplicate(MethodDescriptorInterface $descriptor): MethodDescriptorInterface
+    private function checkForDuplicate(MethodDescriptorInterface $descriptor): void
     {
         $name = $descriptor->getName();
         if (!isset($this->descriptorsByMethodName[$name])) {
-            $this->descriptorsByMethodName[$name] = 0;
+            $this->descriptorsByMethodName[$name] = [];
         }
-        $this->descriptorsByMethodName[$name] ++;
-        if ($this->descriptorsByMethodName[$name] > 1) {
-            $descriptor->useAlternativeName();
+        $this->descriptorsByMethodName[$name][] = $descriptor;
+        if (count($this->descriptorsByMethodName[$name]) > 1) {
+            foreach ($this->descriptorsByMethodName[$name] as $duplicateDescriptor) {
+                $duplicateDescriptor->useAlternativeName();
+            }
         }
-        return $descriptor;
     }
 
     /**
      * Returns the list of method descriptors (and applies the alternative name if needed).
      *
-     * @return MethodDescriptorInterface[]
+     * @return RelationshipMethodDescriptorInterface[]
      */
     public function getMethodDescriptors(): array
     {

src/Utils/DirectForeignKeyMethodDescriptor.php

@@ -18,7 +18,7 @@
 /**
  * Represents a method to get a list of beans from a direct foreign key pointing to our bean.
  */
-class DirectForeignKeyMethodDescriptor implements MethodDescriptorInterface
+class DirectForeignKeyMethodDescriptor implements RelationshipMethodDescriptorInterface
 {
     use ForeignKeyAnalyzerTrait;
 

src/Utils/MethodDescriptorInterface.php

@@ -3,8 +3,6 @@
 
 namespace TheCodingMachine\TDBM\Utils;
 
-use Zend\Code\Generator\MethodGenerator;
-
 interface MethodDescriptorInterface
 {
     /**
@@ -14,36 +12,8 @@ interface MethodDescriptorInterface
      */
     public function getName() : string;
 
-    /**
-     * Returns the name of the class that will be returned by the getter (short name).
-     *
-     * @return string
-     */
-    public function getBeanClassName(): string;
-
     /**
      * Requests the use of an alternative name for this method.
      */
     public function useAlternativeName(): void;
-
-    /**
-     * Returns the code of the method.
-     *
-     * @return MethodGenerator[]
-     */
-    public function getCode() : array;
-
-    /**
-     * Returns an array of classes that needs a "use" for this method.
-     *
-     * @return string[]
-     */
-    public function getUsedClasses() : array;
-
-    /**
-     * Returns the code to past in jsonSerialize.
-     *
-     * @return string
-     */
-    public function getJsonSerializeCode() : string;
 }

src/Utils/PivotTableMethodsDescriptor.php

@@ -17,7 +17,7 @@
 use Zend\Code\Generator\ParameterGenerator;
 use function var_export;
 
-class PivotTableMethodsDescriptor implements MethodDescriptorInterface
+class PivotTableMethodsDescriptor implements RelationshipMethodDescriptorInterface
 {
     /**
      * @var Table

src/Utils/RelationshipMethodDescriptorInterface.php

@@ -0,0 +1,49 @@
+<?php
+declare(strict_types=1);
+
+namespace TheCodingMachine\TDBM\Utils;
+
+use Zend\Code\Generator\MethodGenerator;
+
+interface RelationshipMethodDescriptorInterface extends MethodDescriptorInterface
+{
+    /**
+     * Returns the name of the method to be generated.
+     *
+     * @return string
+     */
+    public function getName() : string;
+
+    /**
+     * Returns the name of the class that will be returned by the getter (short name).
+     *
+     * @return string
+     */
+    public function getBeanClassName(): string;
+
+    /**
+     * Requests the use of an alternative name for this method.
+     */
+    public function useAlternativeName(): void;
+
+    /**
+     * Returns the code of the method.
+     *
+     * @return MethodGenerator[]
+     */
+    public function getCode() : array;
+
+    /**
+     * Returns an array of classes that needs a "use" for this method.
+     *
+     * @return string[]
+     */
+    public function getUsedClasses() : array;
+
+    /**
+     * Returns the code to past in jsonSerialize.
+     *
+     * @return string
+     */
+    public function getJsonSerializeCode() : string;
+}