Merge branch 'release/2.1.0'

CHANGELOG.md

@@ -1,3 +1,9 @@
+# v2.1.0
+## 05/27/2020
+
+1. [](#new)
+    * Added ability to search page headers (excluding title, taxonomy, content)
+
 # v2.0.0
 ## 05/13/2020
 

README.md

@@ -2,7 +2,7 @@
 
 ![SimpleSearch](assets/readme_1.png)
 
-`SimpleSearch` is a simple, yet very powerful [Grav][grav] plugin that adds search capabilities to your Grav instance. By default it can search Page **Titles**, **Content** and also **Taxonomy**.
+`SimpleSearch` is a simple, yet very powerful [Grav][grav] plugin that adds search capabilities to your Grav instance. By default it can search Page **Titles**, **Content**, **Taxonomy**, and also a raw page **Header**.
 
 # Installation
 
@@ -40,12 +40,17 @@ route: /search
 search_content: rendered
 template: simplesearch_results
 filters:
-    category: blog
+    category:
 filter_combinator: and
 ignore_accented_characters: false
 order:
     by: date
     dir: desc
+searchable_types:
+    title: true
+    content: true
+    taxonomy: true
+    header: false
 ```
 
 By creating the configuration file: `user/config/plugins/simplesearch.yaml` you have effectively created a site-wide configuration for SimpleSearch.  However, you may want to have multiple searches.

blueprints.yaml

@@ -1,5 +1,5 @@
 name: SimpleSearch
-version: 2.0.0
+version: 2.1.0
 description: "Don't be fooled, the **SimpleSearch** plugin provides a **fast** and highly **configurable** way to search your content."
 icon: search
 author:
@@ -103,9 +103,11 @@ form:
     searchable_types:
       type: checkboxes
       label: PLUGIN_SIMPLESEARCH.SEARCHABLE_TYPES
+      description: PLUGIN_SIMPLESEARCH.SEARCHABLE_TYPES_DESCRIPTION
       options:
         title: Title
         content: Content
+        header: Header
         taxonomy: Taxonomy
       use: keys
 

languages.yaml

@@ -28,7 +28,8 @@ en:
     AND_COMBINATOR: 'And - Boolean &&'
     OR_COMBINATOR: 'Or - Boolean ||'
     SEARCHABLE_TYPES: "Searchable Types"
-
+    SEARCHABLE_TYPES_DESCRIPTION: "<b>Title</b> = Search Page Title<br><b>Content</b> = Search Page Content<br><b>Header</b> = Search Raw Headers (excluding title, content, taxonomy)<br><b>Taxonomy</b> = Search Taxonomy"
+
 ro:
   PLUGIN_SIMPLESEARCH:
     SEARCH_PLACEHOLDER: "Caută …"

simplesearch.php

@@ -343,6 +343,10 @@ private function notFound($query, $page, $taxonomies)
                     $content = $page->content();
                 }
                 $result = $this->matchText(strip_tags($content), $query) === false;
+            } elseif ($type == 'header' && $enabled) {
+                $header = (array) $page->header();
+                $content = $this->getArrayValues($header);
+                $result = $this->matchText(strip_tags($content), $query) === false;
             }
             $results = $results && $result;
             if ($results === false) {
@@ -388,4 +392,17 @@ public function onTwigSiteVariables()
             $this->grav['assets']->addJs('plugin://simplesearch/js/simplesearch.js', ['group' => 'bottom']);
         }
     }
+
+    protected function getArrayValues($array, $ignore_keys = ['title','taxonomy','content'], $output = '') {
+        foreach ($array as $key => $child) {
+            if (!in_array($key, $ignore_keys)) {
+                if (is_array($child)) {
+                    $output .= " " . $this->getArrayValues($child, $ignore_keys, $output);
+                } else {
+                    $output .= " " . $child;
+                }
+            }
+        }
+        return trim($output);
+    }
 }

simplesearch.yaml

@@ -16,4 +16,5 @@ order:
 searchable_types:
     title: true
     content: true
-    taxonomy: true
+    taxonomy: true
+    header: false