Merge pull request #4 from moufmouf/1.0

Modifying parent/children relationship method signatures to return more data

Author: moufmouf

README.md

@@ -61,11 +61,21 @@ Therefore, a "user" ID has to match a "contact", but a "contact" has not necessa
 
 You can use `SchemaAnalyzer` to detect parent / child relationships.
 
+- `getParentRelationship` takes a table name in parameter and returns the DBAL `ForeignKeyConstraint` representing
+  the relationship between this table and its parent.
+- `getChildrenRelationships` takes a table name in parameter and returns an array of DBAL `ForeignKeyConstraint` 
+  representing the relationship between this table and its children.
+  
+
 ```php
-$parent = $schemaAnalyzer->getParentTable("user");
+$parentKeyConstraint = $schemaAnalyzer->getParentRelationship("user");
+/* @var $parentKeyConstraint ForeignKeyConstraint */
+$parent = $parentKeyConstraint->getForeignTableName();
 // This will return the "contact" table (as a string)
 
-$children = $schemaAnalyzer->getChildrenTables("contact");
+$childrenKeyConstraints = $schemaAnalyzer->getChildrenRelationships("contact");
+/* @var $childrenKeyConstraints ForeignKeyConstraint[] */
+$children = array_map(function($item) { return $item->getLocalTableName(); }, $childrenKeyConstraints);
 // This will return an array of tables whose parent is contact: ["user"]
 ```
 

src/SchemaAnalyzer.php

@@ -461,12 +461,12 @@ private function isInheritanceRelationship(ForeignKeyConstraint $fk)
      *
      * @param string $tableName
      *
-     * @return string|null
+     * @return ForeignKeyConstraint|null
      */
-    public function getParentTable($tableName)
+    public function getParentRelationship($tableName)
     {
         return $this->fromCache($this->cachePrefix.'_parent_'.$tableName, function () use ($tableName) {
-            return $this->getParentTableWithoutCache($tableName);
+            return $this->getParentRelationshipWithoutCache($tableName);
         });
     }
 
@@ -477,18 +477,18 @@ public function getParentTable($tableName)
      *
      * @param string $tableName
      *
-     * @return string|null
+     * @return ForeignKeyConstraint|null
      */
-    private function getParentTableWithoutCache($tableName)
+    private function getParentRelationshipWithoutCache($tableName)
     {
         $table = $this->getSchema()->getTable($tableName);
         foreach ($table->getForeignKeys() as $fk) {
             if ($this->isInheritanceRelationship($fk)) {
-                return $fk->getForeignTableName();
+                return $fk;
             }
         }
 
-        return;
+        return null;
     }
 
     /**
@@ -498,12 +498,12 @@ private function getParentTableWithoutCache($tableName)
      *
      * @param string $tableName
      *
-     * @return string[]
+     * @return ForeignKeyConstraint[]
      */
-    public function getChildrenTables($tableName)
+    public function getChildrenRelationships($tableName)
     {
         return $this->fromCache($this->cachePrefix.'_children_'.$tableName, function () use ($tableName) {
-            return $this->getChildrenTablesWithoutCache($tableName);
+            return $this->getChildrenRelationshipsWithoutCache($tableName);
         });
     }
 
@@ -514,9 +514,9 @@ public function getChildrenTables($tableName)
      *
      * @param string $tableName
      *
-     * @return string[]
+     * @return ForeignKeyConstraint[]
      */
-    private function getChildrenTablesWithoutCache($tableName)
+    private function getChildrenRelationshipsWithoutCache($tableName)
     {
         $schema = $this->getSchema();
         $children = [];
@@ -526,7 +526,7 @@ private function getChildrenTablesWithoutCache($tableName)
             }
             foreach ($table->getForeignKeys() as $fk) {
                 if ($fk->getForeignTableName() === $tableName && $this->isInheritanceRelationship($fk)) {
-                    $children[] = $fk->getLocalTableName();
+                    $children[] = $fk;
                 }
             }
         }

tests/SchemaAnalyzerTest.php

@@ -473,10 +473,10 @@ public function testInheritanceRelationship()
         $this->assertCount(1, $fks);
         $this->assertEquals('id', $fks[0]->getLocalColumns()[0]);
 
-        $this->assertEquals('contact', $schemaAnalyzer->getParentTable('user'));
-        $this->assertNull($schemaAnalyzer->getParentTable('contact'));
+        $this->assertEquals('contact', $schemaAnalyzer->getParentRelationship('user')->getForeignTableName());
+        $this->assertNull($schemaAnalyzer->getParentRelationship('contact'));
 
-        $this->assertEquals(['user'], $schemaAnalyzer->getChildrenTables('contact'));
-        $this->assertEquals([], $schemaAnalyzer->getChildrenTables('user'));
+        $this->assertEquals('user', $schemaAnalyzer->getChildrenRelationships('contact')[0]->getLocalTableName());
+        $this->assertEquals([], $schemaAnalyzer->getChildrenRelationships('user'));
     }
 }