feat(plugins): added plugin administration backend

Author: thorsten

CHANGELOG.md

@@ -11,6 +11,7 @@ This is a log of major user-visible changes in each phpMyFAQ release.
 - added configuration to edit robots.txt (Thorsten)
 - added Symfony Routing for administration backend (Thorsten)
 - added code snippets plugin with syntax highlighting in WYSIWYG editor (Thorsten)
+- added plugin administration backend (Thorsten)
 - improved online update feature (Thorsten)
 - migrated from WYSIWYG editor from TinyMCE to Jodit Editor (Thorsten)
 - migrated from Webpack to Vite v6 (Thorsten)

phpmyfaq/assets/templates/admin/configuration/elasticsearch.twig

@@ -5,7 +5,6 @@
     <h1 class="h2">
       <i aria-hidden="true" class="bi bi-wrench"></i>
       {{ 'msgAdminHeaderElasticsearch' | translate }}
-      <?= Translation::get('msgAdminHeaderElasticsearch') ?>
     </h1>
     <div class="btn-toolbar mb-2 mb-md-0">
       <div class="btn-group mr-2">

phpmyfaq/assets/templates/admin/configuration/plugins.twig

@@ -0,0 +1,43 @@
+{% extends '@admin/index.twig' %}
+
+{% block content %}
+<div class="d-flex justify-content-between flex-wrap flex-md-nowrap align-items-center pt-3 pb-2 mb-3 border-bottom">
+  <h1 class="h2">
+    <i aria-hidden="true" class="bi bi-wrench"></i>
+    {{ 'msgPlugins' | translate }}
+  </h1>
+</div>
+
+<div class="row">
+  <div class="col-lg-12">
+
+    <p>
+      {{ 'msgPluginListing' | translate }}
+    </p>
+
+    <table class="table table-striped">
+      <thead>
+        <tr>
+          <th>{{ 'msgPluginName' | translate }}</th>
+          <th>{{ 'msgPluginVersion' | translate }}</th>
+          <th>{{ 'msgPluginAuthor' | translate }}</th>
+          <th>{{ 'msgPluginDescription' | translate }}</th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for plugin in pluginList %}
+        <tr>
+          <td>{{ plugin.name }}</td>
+          <td>{{ plugin.version }}</td>
+          <td>{{ plugin.author }}</td>
+          <td>{{ plugin.description }}</td>
+        </tr>
+        {% endfor %}
+      </tbody>
+    </table>
+
+  </div>
+</div>
+
+{% endblock %}
+

phpmyfaq/content/plugins/HelloWorld/HelloWorldPlugin.php

@@ -32,7 +32,17 @@ public function getName(): string
 
     public function getVersion(): string
     {
-        return '0.1.0';
+        return '0.2.0';
+    }
+
+    public function getDescription(): string
+    {
+        return 'A simple Hello World plugin';
+    }
+
+    public function getAuthor(): string
+    {
+        return 'phpMyFAQ Team';
     }
 
     public function getDependencies(): array

phpmyfaq/src/admin-routes.php

@@ -34,6 +34,7 @@
 use phpMyFAQ\Controller\Administration\NewsController;
 use phpMyFAQ\Controller\Administration\OpenQuestionsController;
 use phpMyFAQ\Controller\Administration\PasswordChangeController;
+use phpMyFAQ\Controller\Administration\PluginController;
 use phpMyFAQ\Controller\Administration\RatingController;
 use phpMyFAQ\Controller\Administration\ReportController;
 use phpMyFAQ\Controller\Administration\SessionKeepAliveController;
@@ -152,6 +153,11 @@
         'controller' => [ConfigurationController::class, 'index'],
         'methods' => 'GET'
     ],
+    'admin.configuration.plugins' => [
+        'path' => '/plugins',
+        'controller' => [PluginController::class, 'index'],
+        'methods' => 'GET'
+    ],
     'admin.dashboard' => [
         'path' => '/',
         'controller' => [DashboardController::class, 'index'],

phpmyfaq/src/phpMyFAQ/Controller/Administration/AbstractAdministrationController.php

@@ -222,6 +222,11 @@ private function getSecondLevelEntries(Helper $adminHelper): array
             'msgAdminHeaderUpdate',
             'update'
         );
+        $secLevelEntries['config'] .= $adminHelper->addMenuEntry(
+            PermissionType::CONFIGURATION_EDIT->value,
+            'msgPlugins',
+            'plugins'
+        );
         if ($this->configuration->get('search.enableElasticsearch')) {
             $secLevelEntries['config'] .= $adminHelper->addMenuEntry(
                 PermissionType::CONFIGURATION_EDIT->value,
@@ -314,6 +319,7 @@ private function getPageFlags(Request $request): array
             case 'admin.instances':
             case 'admin.stopwords':
             case 'admin.system':
+            case 'admin.configuration.plugins':
             case 'admin.update':
                 $configurationPage = true;
                 break;

phpmyfaq/src/phpMyFAQ/Controller/Administration/PluginController.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpMyFAQ\Controller\Administration;
+
+use phpMyFAQ\Core\Exception;
+use phpMyFAQ\Plugin\PluginException;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+use Twig\Error\LoaderError;
+
+class PluginController extends AbstractAdministrationController
+{
+    /**
+     * @throws PluginException
+     * @throws LoaderError
+     * @throws Exception
+     * @throws \Exception
+     */
+    #[Route('/plugins')]
+    public function index(Request $request): Response
+    {
+        $pluginManager = $this->container->get('phpmyfaq.plugin.plugin-manager');
+        $pluginManager->loadPlugins();
+
+        return $this->render(
+            '@admin/configuration/plugins.twig',
+            [
+                ... $this->getHeader($request),
+                ... $this->getFooter(),
+                'pluginList' => $pluginManager->getPlugins(),
+            ]
+        );
+    }
+}

phpmyfaq/src/phpMyFAQ/Plugin/PluginInterface.php

@@ -35,6 +35,20 @@ public function getName(): string;
      */
     public function getVersion(): string;
 
+    /**
+     * Returns the description of the plugin
+     *
+     * @return string
+     */
+    public function getDescription(): string;
+
+    /**
+     * Returns the author of the plugin
+     *
+     * @return string
+     */
+    public function getAuthor(): string;
+
     /**
      * Returns the dependencies of the plugin
      *

phpmyfaq/src/phpMyFAQ/System.php

@@ -62,7 +62,7 @@ class System
     /**
      * Plugin version.
      */
-    private const PLUGIN_VERSION = '0.1.0';
+    private const PLUGIN_VERSION = '0.2.0';
 
     /**
      * Minimum required PHP version.

phpmyfaq/src/services.php

@@ -47,6 +47,8 @@
 use phpMyFAQ\Language;
 use phpMyFAQ\News;
 use phpMyFAQ\Notification;
+use phpMyFAQ\Plugin\PluginManager;
+use phpMyFAQ\Plugins;
 use phpMyFAQ\Question;
 use phpMyFAQ\Rating;
 use phpMyFAQ\Search;
@@ -248,6 +250,8 @@
             new Reference('phpmyfaq.configuration')
         ]);
 
+    $services->set('phpmyfaq.plugin.plugin-manager', PluginManager::class);
+
     $services->set('phpmyfaq.question', Question::class)
         ->args([
             new Reference('phpmyfaq.configuration')