Some code refactoring

Author: Sonja Broda

README.md

@@ -64,6 +64,17 @@ foreach($relatedImages as $image) {
 
 ```
 
+### Config options
+
+You can set the cache to true or false using the `texnixe.related.cache` option.
+
+```
+return [
+  'texnixe.related.cache' => true
+];
+```
+
+
 ### Options
 
 You can pass an array of options:
@@ -79,6 +90,7 @@ $relatedPages = $page->related(array(
   ));
 ?>
 ```
+
 #### searchCollection
 
 The pages collection to search in.
@@ -104,9 +116,14 @@ Default: 1
 Filter related items by language in a multi-language installation.
 Default: false
 
+## Disclaimer
+
+This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you encounter any problem, please [create an issue](https://github.com/texnixe/kirby3-codepen/issues/new).
 
 ## License
 
-Kirby 3 Related is open-sourced software licensed under the MIT license.
+[MIT](https://opensource.org/licenses/MIT)
+
+
+It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.
 
-Copyright © 2019 Sonja Broda info@texniq.de https://sonjabroda.com

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "texnixe/related",
     "description": "Fetch related pages or files based on the values of a given field ",
-    "version": "0.9.2",
+    "version": "1.0.0",
     "type": "kirby-plugin",
     "license": "MIT",
     "authors": [

hooks.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace texnixe\Related;
+
+return [
+    'page.update:after' => function() {
+        Related::flush();
+    },
+    'page.create:after' => function() {
+        Related::flush();
+    },
+    'file.create:after' => function() {
+        Related::flush();
+    },
+    'page.update:after' => function() {
+        Related::flush();
+    }
+];

index.php

@@ -1,8 +1,11 @@
 <?php
+
+namespace texnixe\Related;
+
 /**
  * Kirby 3 Related Pages Plugin
  *
- * @version   0.9.2
+ * @version   1.0.0
  * @author    Sonja Broda <info@texniq.de>
  * @copyright Sonja Broda <info@texniq.de>
  * @link      https://github.com/texnixe/kirby-related
@@ -13,9 +16,9 @@
     'texnixe\\related\\related' => 'src/Related.php'
 ], __DIR__);
 
-Kirby::plugin('texnixe/related', [
+\Kirby::plugin('texnixe/related', [
     'options' => [
-        'cache' => true,
+        'cache' => option('texnixe.related.cache', true),
         'expires' => (60*24*7), // minutes
         'defaults' => [
             'searchField'      => 'tags',
@@ -26,28 +29,15 @@
     ],
     'pageMethods' => [
         'related' => function (array $options = []) {
-            return Texnixe\Related\Related::getRelated($this, $options);
+            return Related::getRelated($this, $options);
         }
     ],
     'fileMethods' => [
         'related' => function (array $options = []) {
-            return Texnixe\Related\Related::getRelated($this, $options);
+            return Related::getRelated($this, $options);
         }
     ],
-    'hooks' => [
-        'page.update:after' => function() {
-            Texnixe\Related\Related::flush();
-        },
-        'page.create:after' => function() {
-            Texnixe\Related\Related::flush();
-        },
-        'file.create:after' => function() {
-            Texnixe\Related\Related::flush();
-        },
-        'page.update:after' => function() {
-            Texnixe\Related\Related::flush();
-        }
-    ]
+    'hooks' => require __DIR__ . '/hooks.php'
 ]);
 
 

package.json

@@ -3,7 +3,7 @@
   "description": "Kirby Related plugin",
   "author": "Sonja Broda <sonja@texniq.de>",
   "license": "MIT",
-  "version": "0.9.2",
+  "version": "1.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/texnixe/kirby-related"

src/Related.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Texnixe\Related;
+namespace texnixe\Related;
 
 
 class Related
@@ -47,7 +47,7 @@ public static function data($basis, $options = [])
         $languageFilter   = $options['languageFilter'];
 
          // get search items from active basis
-         $searchItems     = $basis->{$searchField}()->split(',');
+         $searchItems     = $basis->{$searchField}()->split($delimiter);
          $noOfSearchItems = count($searchItems);
 
         if($noOfSearchItems > 0) {
@@ -76,10 +76,10 @@ public static function data($basis, $options = [])
 
     public static function getClassName($basis, $items = '')
     {
-        if(is_a($basis, 'Kirby\Cms\Page')) {
+        if(is_a($basis, '\Kirby\Cms\Page')) {
             return pages($items);
         }
-        if(is_a($basis, 'Kirby\Cms\File')) {
+        if(is_a($basis, '\Kirby\Cms\File')) {
             return new \Kirby\Cms\Files($items);
         }
     }