add plugin functionalities

Author: techws-dev

classes/PopularArticles.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Grav\Plugin\PopularArticles;
+
+use Grav\Common\Grav;
+use Grav\Plugin\Admin\Popularity;
+use Grav\Common\Page\Collection;
+
+class PopularArticles
+{
+    private $popularityFile;
+    private $grav;
+    private $articles;
+
+    public function __construct()
+    {
+        $this->grav = Grav::instance();
+
+        // Admin plugin is required
+        $this->popularityFile = $this->grav['locator']->findResource('log://popularity', true, true)
+            . DIRECTORY_SEPARATOR
+            . Popularity::TOTALS_FILE;
+    }
+
+    public function get()
+    {
+        if ( !$this->articles ) $this->articles = $this->build();
+
+        return $this->articles;
+    }
+
+    public function build()
+    {
+        // Get config or default
+        $NUMBER_OF_ARTICLES = $this->grav['config']->get('plugins.popular-articles.articles_count') ?? 5;
+        $BLOG_ROUTE = $this->grav['config']->get('plugins.popular-articles.blog_route') ?? '/blog';
+
+        $popularityData = [];
+
+        if ( file_exists($this->popularityFile) ) {
+            // Read json from popularity file
+            $popularityData = (array)json_decode(
+                file_get_contents($this->popularityFile),
+                true
+            );
+
+            // Sort data by number of visits desc
+            arsort( $popularityData );
+
+            // Filter on existing pages
+            $popularityData = array_filter(
+                $popularityData,
+                function($key) use ($BLOG_ROUTE) {
+                    $page = $this->grav['page']->find($key);
+                    return $page !== null && strpos($key, $BLOG_ROUTE . '/') === 0;
+                },
+                ARRAY_FILTER_USE_KEY
+            );
+        }
+
+        // Limit number of articles returned
+        $popularityData = array_slice($popularityData, 0, $NUMBER_OF_ARTICLES);
+
+        // Return the collection of pages
+        $pagesCollection = new Collection();
+
+        foreach($popularityData as $route => $count) {
+            $page = $this->grav['page']->find($route);
+
+            $pagesCollection->addPage($page);
+        }
+
+        return $pagesCollection;
+    }
+}

languages.yaml

@@ -1,4 +1,9 @@
 en:
   PLUGIN_POPULAR_ARTICLES:
+    POPULAR_ARTICLES: Popular articles
     BLOG_ROUTE_LABEL: Route to blog
     ARTICLES_COUNT_LABEL: Number of articles to display
+
+fr:
+  PLUGIN_POPULAR_ARTICLES:
+    POPULAR_ARTICLES: Articles populaires

popular-articles.php

@@ -3,6 +3,7 @@
 
 use Composer\Autoload\ClassLoader;
 use Grav\Common\Plugin;
+use Grav\Plugin\PopularArticles\PopularArticles;
 
 /**
  * Class PopularArticlesPlugin
@@ -24,8 +25,7 @@ public static function getSubscribedEvents(): array
     {
         return [
             'onPluginsInitialized' => [
-                // Uncomment following line when plugin requires Grav < 1.7
-                // ['autoload', 100000],
+                ['autoload', 100000], // TODO: Remove when plugin requires Grav >=1.7
                 ['onPluginsInitialized', 0]
             ]
         ];
@@ -53,7 +53,25 @@ public function onPluginsInitialized(): void
 
         // Enable the main events we are interested in
         $this->enable([
-            // Put your main events here
+            'onTwigTemplatePaths' => ['onTwigTemplatePaths', 0],
+            'onTwigSiteVariables' => ['onTwigSiteVariables', 0]
         ]);
     }
+
+    /**
+     * Add current directory to twig lookup paths.
+     */
+    public function onTwigTemplatePaths()
+    {
+        $this->grav['twig']->twig_paths[] = __DIR__ . '/templates';
+    }
+
+    /**
+     * Set needed variables to display the popular articles.
+     */
+    public function onTwigSiteVariables()
+    {
+        $twig = $this->grav['twig'];
+        $twig->twig_vars['popular_articles'] = new PopularArticles();
+    }
 }

templates/partials/popular_articles.html.twig

@@ -0,0 +1,15 @@
+{% set articles_list = popular_articles.get() %}
+
+<h4>
+    {{ 'PLUGIN_POPULAR_ARTICLES.POPULAR_ARTICLES'|t }}
+</h4>
+
+<ul>
+    {% for article in articles_list %}
+    <li>
+        <a href="{{ base_url }}{{ article.route }}">
+            {{ article.title }}
+        </a>
+    </li>
+    {% endfor %}
+</ul>