Merge branch 'release/3.3.1'

Author: rhukster

CHANGELOG.md

@@ -1,8 +1,20 @@
+# v3.3.1
+## 02/25/2021
+
+1. [](#improved)
+    * Upgraded to TNTSearch version `2.6.0`
+    * Added German (de) language [#103](https://github.com/trilbymedia/grav-plugin-tntsearch/pull/103)
+1. [](#bugfix)
+    * Fixed `query` truncation when containing a hash (`#`) and preventing proper search results [#110](https://github.com/trilbymedia/grav-plugin-tntsearch/pull/110)
+    * Fixed `q` query parameter not working [#111](https://github.com/trilbymedia/grav-plugin-tntsearch/pull/111)
+    * Fix default stemmer and description [#105](https://github.com/trilbymedia/grav-plugin-tntsearch/pull/105)  
+    * Fixed PHP 8 compatibility issues
+
 # v3.3.0
 ## 12/02/2020
 
-1. [](#new)
-    * Upgraded to TNTSearch version 2.5
+1. [](#improved)
+    * Upgraded to TNTSearch version `2.5.0`
     * Pass phpstan level 7 tests
 1. [](#bugfix)
     * Fixed FlexPages events for add+delete

README.md

@@ -105,11 +105,12 @@ The configuration options are as follows:
 * `fuzzy` - matches if the words are 'close' but not necessarily exact matches
 * `phrases` - automatically handle phrases support
 * `stemmer` - can be one of these types:
-  * `default` - no stemmer
+  * `default` - Porter stemmer for English language
+  * `no` - no stemmer
   * `arabic` - Arabic language
   * `german` - German language
   * `italian` - Italian language
-  * `porter` - Porter language
+  * `porter` - Porter stemmer for English language
   * `russian` - Russian language
   * `ukrainian` - Ukrainian language
 * `display_route` - display the route in the search results
@@ -236,11 +237,11 @@ For example, say we have a homepage that is built from a few modular sub-pages w
 ```twig
 {% for module in page.collection() %}
 <p>
-    {{ module.content }}
+    {{ module.content|raw }}
 </p>
 {% endfor %}
 
-{{ page.content }}
+{{ page.content|raw }}
 ``` 
 
 As you can see this simply ensures the module pages as defined in the page's collection are displayed, then the actual page content is displayed.  

app/search.js

@@ -59,7 +59,7 @@ const throttling = throttle(async ({ input, results, historyValue = false } = {}
     }
 
     const params = {
-        q: value,
+        q: encodeURIComponent(value),
         l: data.limit,
         sl: data.snippet,
         search_type: data.search_type,

assets/tntsearch.js

@@ -1,7 +1,7 @@
 name: TNT Search
 type: plugin
 slug: tntsearch
-version: 3.3.0
+version: 3.3.1
 testing: false
 description: Powerful indexed-based full text search engine powered by TNTSearch
 icon: binoculars
@@ -173,13 +173,14 @@ form:
       size: small
       classes: fancy
       label: Stemmer
-      help: An automated process which produces a base string in an attempt to represent related words
+      help: An automated process which produces a base string in an attempt to represent related words. If your content is not in the language listed, for best search results it is recommended to disable the stemmer.
       options:
-        default: Default
+        default: Default (English)
+        no: Disabled
         arabic: Arabic
+        porter: English
         german: German
         italian: Italian
-        porter: Porter
         russian: Russian
         ukrainian: Ukrainian
 

blueprints.yaml

@@ -6,12 +6,12 @@
 use Grav\Common\Yaml;
 use Grav\Common\Page\Page;
 use Grav\Plugin\TNTSearchPlugin;
+use PDO;
 
-class GravConnector extends \PDO
+class GravConnector extends PDO
 {
     public function __construct()
     {
-
     }
 
     /**
@@ -23,11 +23,13 @@ public function getAttribute($attribute): bool
         return false;
     }
 
-    /**
-     * @param string $query
+    /***
+     * @param string $statement
+     * @param int|null $fetch_style
+     * @param mixed ...$extra
      * @return GravResultObject
      */
-    public function query($query)
+    public function query(string $statement, ?int $fetch_style = null, ...$extra): GravResultObject
     {
         $counter = 0;
         $results = [];

classes/GravConnector.php

@@ -208,7 +208,7 @@ public static function getCleanContent($page)
         }
 
         $content = strip_tags($content);
-        $content = preg_replace('/[ \t]+/', ' ', preg_replace('/\s*$^\s*/m', "\n", $content));
+        $content = preg_replace(['/[ \t]+/', '/\s*$^\s*/m'], [' ', "\n"], $content) ?? $content;
 
         // Restore active page in Grav.
         unset($grav['page']);

classes/GravTNTSearch.php

@@ -12,13 +12,9 @@
  */
 class TNTSearchIndexerCommand extends ConsoleCommand
 {
-    /**
-     * @var array
-     */
+    /** @var array */
     protected $options = [];
-    /**
-     * @var array
-     */
+    /** @var array */
     protected $colors = [
         'DEBUG'     => 'green',
         'INFO'      => 'cyan',
@@ -33,7 +29,7 @@ class TNTSearchIndexerCommand extends ConsoleCommand
     /**
      * @return void
      */
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setName('index')
@@ -54,10 +50,11 @@ protected function configure()
     }
 
     /**
-     * @return void
+     * @return int
      */
-    protected function serve()
+    protected function serve(): int
     {
+        /** @var string|null $langCode */
         $langCode = $this->input->getOption('language');
 
         error_reporting(1);
@@ -82,6 +79,8 @@ protected function serve()
             $this->output->writeln('');
             $this->output->writeln('Indexed in ' . $end . 's');
         }
+
+        return 0;
     }
 
     /**

cli/TNTSearchIndexerCommand.php

@@ -13,14 +13,9 @@
  */
 class TNTSearchQueryCommand extends ConsoleCommand
 {
-    /**
-     * @var array
-     */
+    /** @var array */
     protected $options = [];
-
-    /**
-     * @var array
-     */
+    /** @var array */
     protected $colors = [
         'DEBUG'     => 'green',
         'INFO'      => 'cyan',
@@ -56,24 +51,24 @@ protected function configure()
     }
 
     /**
-     * @return void
+     * @return int
      */
-    protected function serve()
+    protected function serve(): int
     {
-        $this->setLanguage($this->input->getOption('language'));
-        $this->initializePages();
+        /** @var string|null $langCode */
+        $langCode = $this->input->getOption('language');
+        /** @var string $query */
+        $query = $this->input->getArgument('query');
 
-        $this->doQuery();
-        $this->output->writeln('');
-    }
+        $this->setLanguage($langCode);
+        $this->initializePages();
 
-    /**
-     * @return void
-     */
-    private function doQuery()
-    {
         $gtnt = TNTSearchPlugin::getSearchObjectType(['json' => true]);
-        print_r($gtnt->search($this->input->getArgument('query')));
+        print_r($gtnt->search($query));
+
+        $this->output->newLine();
+
+        return 0;
     }
 }
 

cli/TNTSearchQueryCommand.php

@@ -16,6 +16,7 @@
   "require": {
     "php": ">=7.1.3",
     "ext-json": "*",
+    "ext-pdo": "*",
     "teamtnt/tntsearch": "^2.0"
   },
   "autoload": {