Merge pull request #21 from telkins/dev/custom-edge-model

Dev/custom edge model

README.md

@@ -159,6 +159,31 @@ $ancestors = MyModel::dagAncestorsOf($myModel->id, 'my-source', 1)->get();
 
 Not providing the `$maxHops` parameter means that all descendants, ancestors, or relations will be returned.
 
+### Custom DAG edge model
+
+You can use your own model class if you need to customise the behavior of the DAG edge model.
+
+Your custom model class must extend the `Telkins\Models\DagEdge` class:
+
+```php
+namespace App\Models;
+
+use Telkins\Models\DagEdge as BaseModel;
+
+class MyDagEdge extends BaseModel
+{
+...
+```
+
+You can then specify the fully qualified class name of your custom model in the package config file.
+
+```php
+// config/laravel-dag-manager.php
+...
+'edge_model' => \App\Models\MyDagEdge::class,
+...
+```
+
 ## Testing
 
 ```bash

config/laravel-dag-manager.php

@@ -44,4 +44,14 @@
 
     'table_name' => 'dag_edges',
 
+    /**
+     *-------------------------------------------------------------------------
+     * Edge Model
+     *-------------------------------------------------------------------------
+     *
+     * The fully qualified class name of the DAG edge model.
+     */
+
+    'edge_model' => \Telkins\Dag\Models\DagEdge::class,
+
 ];

src/Concerns/UsesDagConfig.php

@@ -15,4 +15,9 @@ public function defaultTableName(): ?string
     {
         return config('laravel-dag-manager.table_name');
     }
-}
+
+    public function dagEdgeModel(): ?string
+    {
+        return config('laravel-dag-manager.edge_model');
+    }
+}

src/Tasks/AddDagEdge.php

@@ -7,12 +7,15 @@
 use Illuminate\Database\Query\Builder;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
+use Telkins\Dag\Concerns\UsesDagConfig;
 use Telkins\Dag\Exceptions\CircularReferenceException;
 use Telkins\Dag\Exceptions\TooManyHopsException;
 use Telkins\Dag\Models\DagEdge;
 
 class AddDagEdge
 {
+    use UsesDagConfig;
+
     protected ?string $connection;
     protected int $endVertex;
     protected int $maxHops;
@@ -51,7 +54,9 @@ public function execute(): ?Collection
 
     protected function edgeExists(): bool
     {
-        return DagEdge::where([
+        $edgeClass = $this->dagEdgeModel();
+
+        return $edgeClass::where([
                 ['start_vertex', $this->startVertex],
                 ['end_vertex', $this->endVertex],
                 ['hops', 0],
@@ -68,7 +73,9 @@ protected function guardAgainstCircularRelation(): void
             throw new CircularReferenceException();
         }
 
-        if (DagEdge::where([
+        $edgeClass = $this->dagEdgeModel();
+
+        if ($edgeClass::where([
                 ['start_vertex', $this->endVertex],
                 ['end_vertex', $this->startVertex],
                 ['source', $this->source],
@@ -92,7 +99,9 @@ protected function createEdge(): DagEdge
 
     protected function createDirectEdge(): DagEdge
     {
-        $edge = DagEdge::create([
+        $edgeClass = $this->dagEdgeModel();
+
+        $edge = $edgeClass::create([
             'start_vertex' => $this->startVertex,
             'end_vertex'   => $this->endVertex,
             'hops'         => 0,
@@ -187,7 +196,9 @@ protected function executeInsert(Builder $select): void
 
     protected function getNewlyInsertedEdges(DagEdge $edge): Collection
     {
-        return DagEdge::where('direct_edge_id', $edge->id)
+        $edgeClass = $this->dagEdgeModel();
+
+        return $edgeClass::where('direct_edge_id', $edge->id)
             ->orderBy('hops')
             ->get();
     }

src/Tasks/RemoveDagEdge.php

@@ -6,10 +6,13 @@
 
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
+use Telkins\Dag\Concerns\UsesDagConfig;
 use Telkins\Dag\Models\DagEdge;
 
 class RemoveDagEdge
 {
+    use UsesDagConfig;
+
     protected ?string $connection;
     protected int $endVertex;
     protected string $source;
@@ -30,7 +33,9 @@ public function __construct(int $startVertex, int $endVertex, string $source, st
      */
     public function execute(): bool
     {
-        $edge = DagEdge::where([
+        $edgeClass = $this->dagEdgeModel();
+
+        $edge = $edgeClass::where([
             ['start_vertex', $this->startVertex],
             ['end_vertex', $this->endVertex],
             ['hops', 0],