feat: --rel-target option

Author: jose-ba

bin/php-class-diagram

@@ -39,6 +39,7 @@ $options = getopt('hv', [
     'exclude::',
     'rel-target-from::',
     'rel-target-to::',
+    'rel-target::',
     'rel-target-depth::',
 ], $rest_index);
 $arguments = array_slice($argv, $rest_index);
@@ -70,6 +71,8 @@ OPTIONS
       --exclude='wildcard'         exclude target file pattern. You can specify multiple exclude patterns.
       --rel-target-from='clases'   comma separated list of classes to filter dependencies from
       --rel-target-to='classes'    comma separated list of classes to filter dependencies to
+      --rel-target='classes'       comma separated list of classes to filter dependencies from or to. this option overrides
+                                   --rel-target-from and --rel-target-to if set.
       --rel-target-depth=integer   max depth of dependencies to show when using --from or --to filters
 EOS;
 

src/Config/Options.php

@@ -191,6 +191,18 @@ public function toClass(): array
         return explode(',', $this->opt['rel-target-to']);
     }
 
+    /**
+     * @return array<string>
+     */
+    public function targetClass(): array
+    {
+        if (!isset($this->opt['rel-target'])) {
+            return [];
+        }
+
+        return explode(',', $this->opt['rel-target']);
+    }
+
     public function depth(): int
     {
         return (int) ($this->opt['rel-target-depth'] ?? PHP_INT_MAX);

src/DiagramElement/RelationsFilter.php

@@ -29,6 +29,12 @@ public function filterRelations(array $relation_expressions): array
         $output = [];
         $fromClasses = $this->options->fromClass();
         $toClasses = $this->options->toClass();
+
+        if ([] !== $this->options->targetClass()) {
+            $fromClasses = $this->options->targetClass();
+            $toClasses = $this->options->targetClass();
+        }
+
         $this->maxDepth = $this->options->depth() - 1;
         $this->relationExpressions = $relation_expressions;
 

test/RelationsFilterTest.php

@@ -75,6 +75,28 @@ public function testFiltersInboundRelations(): void
         $this->assertSame("  Relation ..> PackageRelations", $result[4]);
     }
 
+    public function testFiltersTargetRelations(): void
+    {
+        $relationsFilter = new RelationsFilter(new Options([
+            'rel-target' => 'Entry'
+        ]));
+
+        $result = $relationsFilter->filterRelations($this->fixture);
+
+        $this->assertSame("  Entry \"1\" ..> \"*\" Arrow", $result[0]);
+        $this->assertSame("  Entry ..> Division_DivisionColor", $result[1]);
+        $this->assertSame("  Entry ..> ArrowDependency", $result[2]);
+        $this->assertSame("  Entry ..> ArrowInheritance", $result[3]);
+        $this->assertSame("  Package \"1\" ..> \"*\" Package", $result[4]);
+        $this->assertSame("  Package \"1\" ..> \"*\" Entry", $result[5]);
+        $this->assertSame("  Package ..> Entry", $result[6]);
+        $this->assertSame("  Package ..> Package", $result[7]);
+        $this->assertSame("  PackageRelations ..> Package", $result[8]);
+        $this->assertSame("  Relation ..> Package", $result[9]);
+        $this->assertSame("  Relation \"1\" ..> \"*\" Entry", $result[10]);
+        $this->assertSame("  Relation ..> PackageRelations", $result[11]);
+    }
+
     public function testFiltersInboundRelationsWithDepth(): void
     {
         $relationsFilter = new RelationsFilter(new Options([