Merge pull request #75 from buzkall/with-key

Fixed add withKey method

Author: CodeWithDennis

README.md

@@ -132,6 +132,13 @@ Hide specific options in the tree
 ->hiddenOptions([2, 3, 4])
 ```
 
+Specify a different key for your model. 
+For example: you have id, code and parent_code. Your model uses id as key, but the parent-child relation is established between code and parent_code
+
+```PHP
+->withKey('code')
+```
+
 ## Filters
 Use the tree in your table filters. Here's an example to show you how.
 

src/SelectTree.php

@@ -37,6 +37,8 @@ class SelectTree extends Field implements HasAffixActions
 
     protected bool $independent = true;
 
+    protected ?string $customKey = null;
+
     protected string $titleAttribute;
 
     protected string $parentAttribute;
@@ -111,7 +113,7 @@ protected function setUp(): void
 
             $form->model($record)->saveRelationships();
 
-            return $record->getKey();
+            return $this->getCustomKey($record);
         });
 
         $this->suffixActions([
@@ -181,22 +183,24 @@ private function buildTreeFromResults($results, $parent = null): Collection
 
     private function buildNode($result, $resultMap, $disabledOptions, $hiddenOptions): array
     {
+        $key = $this->getCustomKey($result);
+
         // Create a node with 'name' and 'value' attributes
         $node = [
             'name' => $result->{$this->getTitleAttribute()},
-            'value' => $result->getKey(),
+            'value' => $key,
             'parent' => $result->{$this->getParentAttribute()},
-            'disabled' => in_array($result->getKey(), $disabledOptions),
-            'hidden' => in_array($result->getKey(), $hiddenOptions),
+            'disabled' => in_array($key, $disabledOptions),
+            'hidden' => in_array($key, $hiddenOptions),
         ];
 
         // Check if the result has children
-        if (isset($resultMap[$result->getKey()])) {
+        if (isset($resultMap[$key])) {
             $children = collect();
             // Recursively build child nodes
-            foreach ($resultMap[$result->getKey()] as $child) {
+            foreach ($resultMap[$key] as $child) {
                 // don't add the hidden ones
-                if (in_array($child->getKey(), $hiddenOptions)) {
+                if (in_array($this->getCustomKey($child), $hiddenOptions)) {
                     continue;
                 }
                 $childNode = $this->buildNode($child, $resultMap, $disabledOptions, $hiddenOptions);
@@ -302,6 +306,13 @@ public function independent(bool $independent = true): static
         return $this;
     }
 
+    public function withKey(string $customKey): static
+    {
+        $this->customKey = $customKey;
+
+        return $this;
+    }
+
     public function disabledOptions(Closure|array $disabledOptions): static
     {
         $this->disabledOptions = $disabledOptions;
@@ -350,6 +361,11 @@ public function getIndependent(): bool
         return $this->evaluate($this->independent);
     }
 
+    public function getCustomKey($record)
+    {
+        return is_null($this->customKey) ? $record->getKey() : $record->{$this->customKey};
+    }
+
     public function getWithCount(): bool
     {
         return $this->evaluate($this->withCount);