Fix #2, improve code quality, bump FullPage.js-version

CHANGELOG.md

@@ -1,3 +1,13 @@
+# v1.2.0
+## 03-06-2018
+
+1. [](#new)
+    * Bumped FullPage.js-version to 2.9.7
+2. [](#improved)
+    * Inline documentation
+3. [](#bugfix)
+    * Prevent caching to fix #2
+
 # v1.1.0-beta.1
 ## 11-02-2018
 

Utilities.php

@@ -6,27 +6,39 @@
 use Grav\Common\Page\Page;
 use Grav\Common\Page\Collection;
 
+/**
+ * Fullpage-plugin Utilities
+ */
 class Utilities
 {
     /**
      * Plugin configuration
+     * 
      * @var array
      */
     protected $config;
 
     /**
      * Instantiate Fullpage Utilities
      */
+
+    /**
+     * Instantiate Fullpage Utilities
+     *
+     * @param array $config Plugin configuration
+     */
     public function __construct($config)
     {
         $this->config = $config;
     }
 
     /**
      * Creates page-structure recursively
-     * @param string $route Route to page
-     * @param string $mode Reserved collection-mode for handling child-pages
+     * 
+     * @param string  $route Route to page
+     * @param string  $mode  Reserved collection-mode for handling child-pages
      * @param integer $depth Reserved placeholder for recursion depth
+     * 
      * @return array Page-structure with children
      */
     public function buildTree($route, $mode = false, $depth = 0)
@@ -94,7 +106,9 @@ public function buildTree($route, $mode = false, $depth = 0)
 
     /**
      * Create HTML to use with fullPage.js
+     * 
      * @param array $pages Page-structure with children
+     * 
      * @return string HTML-structure
      */
     public function buildContent($pages)
@@ -202,7 +216,9 @@ public function interpretShortcodes($content)
 
     /**
      * Generate menu with anchors and titles from pages
+     * 
      * @param array $tree Page-structure with children
+     * 
      * @return array Slide-anchors with titles
      */
     public function buildMenu($tree)
@@ -221,7 +237,9 @@ public function buildMenu($tree)
 
     /**
      * Format styles for inlining
+     * 
      * @param array $styles Array of quote-enclosed properties and values
+     * 
      * @return string CSS-styles
      */
     public function applyStyles($styles)
@@ -251,8 +269,11 @@ public function applyStyles($styles)
 
     /**
      * Find contrasting color from 50%-equation
+     * 
      * @param string $hexcolor Hexadecimal color-value
+     * 
      * @return string black|white
+     * 
      * @see https://24ways.org/2010/calculating-color-contrast
      */
     public function getContrast50($hexcolor)
@@ -262,8 +283,11 @@ public function getContrast50($hexcolor)
 
     /**
      * Find contrasting color from YIQ-equation
+     * 
      * @param string $hexcolor Hexadecimal color-value
+     * 
      * @return string black|white
+     * 
      * @see https://24ways.org/2010/calculating-color-contrast
      */
     public function getContrastYIQ($hexcolor)
@@ -277,10 +301,13 @@ public function getContrastYIQ($hexcolor)
 
     /**
      * Flatten a multidimensional array to one dimension, optionally preserving keys
-     * @param array $array Array to flatten
+     * 
+     * @param array   $array        Array to flatten
      * @param integer $preserveKeys 0 (default) to not preserve keys, 1 to preserve string keys only, 2 to preserve all keys
-     * @param array &$out Internal parameter for recursion
+     * @param array   $out          Internal parameter for recursion
+     * 
      * @return array Flattened array
+     * 
      * @see https://stackoverflow.com/a/7256477/603387
      */
     public function flattenArray($array, $preserveKeys = 0, &$out = array())
@@ -299,10 +326,13 @@ public function flattenArray($array, $preserveKeys = 0, &$out = array())
 
     /**
      * Insert string within string
-     * @param string $str Original string
+     * 
+     * @param string $str    Original string
      * @param string $insert String to insert
-     * @param int $index Position to insert to
+     * @param int    $index  Position to insert to
+     * 
      * @return string Original string with new string inserted
+     * 
      * @see https://stackoverflow.com/a/30820401/603387
      */
     public function stringInsert($str, $insert, $index)

blueprints.yaml

@@ -1,6 +1,6 @@
 name: FullPage
-version: 1.0.0
-testing: true
+version: 1.2.0
+testing: false
 description: Fullscreen navigational slideshows through fullPage.js
 icon: arrows-alt
 author:

fullpage.php

@@ -8,27 +8,31 @@
 use Grav\Common\Page\Collection;
 use RocketTheme\Toolbox\Event\Event;
 
-require('Utilities.php');
+require 'Utilities.php';
 use Fullpage\Utilities;
 
 /**
  * Creates slides using fullPage.js
  *
  * Class FullPageJsPlugin
+ * 
  * @package Grav\Plugin
- * @return void
+ * @return  void
  * @license MIT License by Ole Vik
  */
 class FullPagePlugin extends Plugin
 {
+
     /**
-     * [$options description]
+     * Grav cache setting
+     *
      * @var [type]
      */
-    protected $options;
+    protected $cache;
 
     /**
      * Register intial event
+     * 
      * @return array
      */
     public static function getSubscribedEvents()
@@ -40,6 +44,7 @@ public static function getSubscribedEvents()
 
     /**
      * Declare config from plugin-config
+     * 
      * @return array Plugin configuration
      */
     public function config()
@@ -55,20 +60,27 @@ public function config()
 
     /**
      * Initialize the plugin and events
+     *
+     * @param Event $event RocketTheme events
+     * 
+     * @return void
      */
     public function onPluginsInitialized(Event $event)
     {
         if ($this->isAdmin()) {
             return;
         }
+        $this->grav['config']->set('system.cache.enabled', false);
         $this->enable([
             'onPageContentProcessed' => ['pageIteration', 0],
-            'onTwigTemplatePaths' => ['templates', 0]
+            'onTwigTemplatePaths' => ['templates', 0],
+            'onShutdown' => ['onShutdown', 0]
         ]);
     }
 
     /**
      * Construct the page
+     * 
      * @return void
      */
     public function pageIteration()
@@ -141,10 +153,21 @@ public function pageIteration()
 
     /**
      * Add templates-directory to Twig paths
+     * 
      * @return void
      */
     public function templates()
     {
         $this->grav['twig']->twig_paths[] = __DIR__ . '/templates';
     }
+
+    /**
+     * Reset cache on shutdown
+     * 
+     * @return void
+     */
+    public function onShutdown()
+    {
+        $this->grav['config']->set('system.cache.enabled', $this->cache);
+    }
 }