Improved highlighting

Author: pdphilip

src/Eloquent/Model.php

@@ -12,7 +12,11 @@
 use PDPhilip\Elasticsearch\Query\Builder as QueryBuilder;
 use RuntimeException;
 
-
+/**
+ * @property object $searchHighlights
+ * @property array $searchHighlightsAsArray
+ * @property object $withHighlights
+ */
 abstract class Model extends BaseModel
 {
     use HybridRelations, ModelDocs;
@@ -139,9 +143,41 @@ public function getMeta()
         return (object)$this->_meta;
     }
 
-    public function getHighlights()
+    public function getSearchHighlightsAttribute()
+    {
+        if (!empty($this->_meta['highlights'])) {
+            $data = [];
+            $this->_mergeFlatKeysIntoNestedArray($data, $this->_meta['highlights']);
+            
+            return (object)$data;
+        }
+        
+        return null;
+    }
+    
+    public function getSearchHighlightsAsArrayAttribute()
     {
-        return $this->_meta['highlights'] ?? [];
+        if (!empty($this->_meta['highlights'])) {
+            return $this->_meta['highlights'];
+        }
+        
+        return [];
+    }
+    
+    public function getWithHighlightsAttribute()
+    {
+        $data = $this->attributes;
+        $mutators = array_values(array_diff($this->getMutatedAttributes(), ['id', 'search_highlights', 'search_highlights_as_array', 'with_highlights']));
+        if ($mutators) {
+            foreach ($mutators as $mutator) {
+                $data[$mutator] = $this->{$mutator};
+            }
+        }
+        if (!empty($this->_meta['highlights'])) {
+            $this->_mergeFlatKeysIntoNestedArray($data, $this->_meta['highlights']);
+        }
+        
+        return (object)$data;
     }
 
     /**
@@ -414,4 +450,32 @@ public function saveWithoutRefresh(array $options = [])
         return $saved;
     }
 
+    
+    //----------------------------------------------------------------------
+    // Helpers
+    //----------------------------------------------------------------------
+    
+    protected function _mergeFlatKeysIntoNestedArray(&$data, $attrs)
+    {
+        foreach ($attrs as $key => $value) {
+            if ($value) {
+                $value = implode('......', $value);
+                $parts = explode('.', $key);
+                $current = &$data;
+                
+                foreach ($parts as $partIndex => $part) {
+                    if ($partIndex === count($parts) - 1) {
+                        $current[$part] = $value;
+                    } else {
+                        if (!isset($current[$part]) || !is_array($current[$part])) {
+                            $current[$part] = [];
+                        }
+                        $current = &$current[$part];
+                    }
+                }
+            }
+            
+        }
+    }
+    
 }