Merge branch 'release/0.3.0'

CHANGELOG.md

@@ -0,0 +1,29 @@
+# v0.3.0
+## 01/06/2016
+
+1. [](#bugfix)
+    * Correctly add the templates path
+
+# v0.2.2
+## 11/20/2015
+
+1. [](#bugfix)
+    * Only load the messages on guestbook pages, if the page exists
+
+# v0.2.1
+## 11/06/2015
+
+1. [](#bugfix)
+    * Show "Guestbook" in the available page templates
+
+# v0.2.0
+## 10/27/2015
+
+1. [](#bugfix)
+    * Fix loading guestbook messages on the first page load
+
+# v0.1.0
+## 10/16/2015
+
+1. [](#new)
+    * ChangeLog started...

blueprints.yaml

@@ -1,5 +1,5 @@
 name: Guestbook
-version: 0.1.0
+version: 0.3.0
 description: Adds a Guestbook functionality to a page
 icon: book
 author:
@@ -30,17 +30,6 @@ form:
       validate:
         type: bool
 
-    use_captcha:
-      type: toggle
-      label: Use Captcha
-      highlight: 1
-      default: 0
-      options:
-        1: 'True'
-        0: 'False'
-      validate:
-        type: bool
-
     filename:
       type: text
       label: Filename

guestbook.php

@@ -21,6 +21,9 @@ public static function getSubscribedEvents()
     {
         return [
             'onPluginsInitialized' => ['onPluginsInitialized', 0],
+            'onFormProcessed' => ['onFormProcessed', 10],
+            'onDataTypeExcludeFromDataManagerPluginHook' => ['onDataTypeExcludeFromDataManagerPluginHook', 0],
+            'onGetPageTemplates' => ['onGetPageTemplates', 0]
         ];
     }
 
@@ -30,22 +33,71 @@ public function onPluginsInitialized()
     {
         if (!$this->isAdmin()) {
             $this->enable([
-                'onTwigTemplatePaths' => ['onTwigTemplatePaths', 0],
+                'onPageInitialized' => ['onPageInitialized', 0],
+                'onTwigTemplatePaths' => ['onTwigTemplatePaths', 0]
             ]);
+        }
+    }
+
+    /**
+     * Initialize configuration
+     */
+    public function onPageInitialized()
+    {
+        /** @var Page $page */
+        $page = $this->grav['page'];
 
-            $page = $this->grav['uri']->param('page');
-            $messages = $this->getMessages($page);
+        if ($page->template() == 'guestbook') {
+            //Call this here to get the messages on the page load
+            $this->fetchMessages();
+        }
+    }
 
-            if ($page > 0) {
-                echo json_encode($messages);
-                exit();
-            }
+    /**
+     * Add page template types.
+     */
+    public function onGetPageTemplates(Event $event)
+    {
+        /** @var Types $types */
+        $types = $event->types;
+        $types->scanTemplates('plugins://guestbook/templates');
+    }
 
-            $this->grav['twig']->guestbookMessages = $messages;
+    /**
+     * Handle form processing instructions.
+     *
+     * @param Event $event
+     */
+    public function onFormProcessed(Event $event)
+    {
+        if (!$this->active) {
+            return;
         }
+
+        //Call this here to get the messages updated after the form is processed
+        $this->fetchMessages();
     }
 
-    private function getMessages($page = 0) {
+    /**
+     * Fetch the page messages.
+     *
+     * @param Event $event
+     */
+    public function fetchMessages()
+    {
+        $page = $this->grav['uri']->param('page');
+        $messages = $this->getMessages($page);
+
+        if ($page > 0) {
+            echo json_encode($messages);
+            exit();
+        }
+
+        $this->grav['twig']->guestbookMessages = $messages;
+    }
+
+    private function getMessages($page = 0)
+    {
         $itemsPerPage = 5;
 
         $lang = $this->grav['language']->getActive();
@@ -79,4 +131,12 @@ public function onTwigTemplatePaths()
     {
         $this->grav['twig']->twig_paths[] = __DIR__ . '/templates';
     }
+
+    /**
+     * Exclude comments from the Data Manager plugin
+     */
+    public function onDataTypeExcludeFromDataManagerPluginHook()
+    {
+        $this->grav['admin']->dataTypesExcludedFromDataManagerPlugin[] = 'guestbook';
+    }
 }

guestbook.yaml

@@ -1,3 +1,2 @@
 enabled: true
-use_captcha: true
 filename: messages.yaml

languages.yaml

@@ -2,4 +2,10 @@ en:
   PLUGIN_GUESTBOOK:
     MESSAGES: Messages
     WRITTEN_ON: Written on
-    BY: by
+    BY: by
+
+fr:
+  PLUGIN_GUESTBOOK:
+    MESSAGES: Messages
+    WRITTEN_ON: Ecrits le
+    BY: par