From da3046c9906eaf849a83a323fda977ad4ff53920 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Michal=20Kv=C3=A1=C4=8Dek?= <michal@binarity.cz>
Date: Mon, 15 Feb 2016 10:32:19 +0100
Subject: [PATCH] FEATURE #1422: prepare application for registering widgets

---
 app/Enumerations/WidgetTypes.php              | 21 ++++++++
 app/Enumerations/WidgetTypesWithHandlers.php  | 21 ++++++++
 .../Registrators/WidgetRegistrator.php        | 46 +++++++++++++++++
 app/Providers/AppServiceProvider.php          | 21 +++++++-
 .../Contracts/AdminDashboardWidget.php        | 12 +++++
 app/Widgets/Contracts/PublicWidget.php        | 49 +++++++++++++++++++
 app/Widgets/Contracts/WidgetRenderer.php      | 37 ++++++++++++++
 .../Exceptions/MissingParameterException.php  | 14 ++++++
 app/Widgets/NonInstallableWidget.php          | 15 ++++++
 app/Widgets/Widget.php                        |  8 +++
 10 files changed, 243 insertions(+), 1 deletion(-)
 create mode 100644 app/Enumerations/WidgetTypes.php
 create mode 100644 app/Enumerations/WidgetTypesWithHandlers.php
 create mode 100644 app/Handlers/Registrators/WidgetRegistrator.php
 create mode 100644 app/Widgets/Contracts/AdminDashboardWidget.php
 create mode 100644 app/Widgets/Contracts/PublicWidget.php
 create mode 100644 app/Widgets/Contracts/WidgetRenderer.php
 create mode 100644 app/Widgets/Exceptions/MissingParameterException.php
 create mode 100644 app/Widgets/NonInstallableWidget.php
 create mode 100644 app/Widgets/Widget.php

diff --git a/app/Enumerations/WidgetTypes.php b/app/Enumerations/WidgetTypes.php
new file mode 100644
index 00000000..60b3ad9d
--- /dev/null
+++ b/app/Enumerations/WidgetTypes.php
@@ -0,0 +1,21 @@
+<?php
+namespace App\Enumerations;
+
+use App\Models\WidgetType;
+
+class WidgetTypes extends BaseEnumeration
+{
+    /**
+     * Init list of all installed modules
+     *
+     * @throws Exceptions\EnumerationExistsException
+     */
+    protected static function init()
+    {
+        $widgets = WidgetType::all(['id', 'name']);
+
+        foreach ($widgets as $widget) {
+            self::push($widget->id, $widget->name);
+        }
+    }
+}
\ No newline at end of file
diff --git a/app/Enumerations/WidgetTypesWithHandlers.php b/app/Enumerations/WidgetTypesWithHandlers.php
new file mode 100644
index 00000000..3a66666f
--- /dev/null
+++ b/app/Enumerations/WidgetTypesWithHandlers.php
@@ -0,0 +1,21 @@
+<?php
+namespace App\Enumerations;
+
+use App\Models\WidgetType;
+
+class WidgetTypesWithHandlers extends BaseEnumeration
+{
+    /**
+     * Init list of all installed modules
+     *
+     * @throws Exceptions\EnumerationExistsException
+     */
+    protected static function init()
+    {
+        $modules = WidgetType::all(['handler', 'name']);
+
+        foreach ($modules as $module) {
+            self::push($module->handler, $module->name);
+        }
+    }
+}
\ No newline at end of file
diff --git a/app/Handlers/Registrators/WidgetRegistrator.php b/app/Handlers/Registrators/WidgetRegistrator.php
new file mode 100644
index 00000000..36814493
--- /dev/null
+++ b/app/Handlers/Registrators/WidgetRegistrator.php
@@ -0,0 +1,46 @@
+<?php
+namespace App\Handlers\Registrators;
+
+use App\Enumerations\WidgetTypesWithHandlers;
+use App\Models\WidgetType;
+use App\Widgets\Contracts\PublicWidget;
+use Symfony\Component\Process\Exception\InvalidArgumentException;
+
+class WidgetRegistrator
+{
+    protected $widgets;
+
+    function __construct()
+    {
+        $this->widgets = WidgetTypesWithHandlers::getSimple();
+    }
+
+    /**
+     * Method used for registering new widgets
+     *
+     * @param $classname
+     */
+    public function register($classname)
+    {
+        $class = new $classname;
+        if (!$class instanceof PublicWidget) {
+            throw new InvalidArgumentException($class . ' must implement PublicWidget interface.');
+        }
+
+        // register widget as new widget type
+        if (!in_array($classname, $this->widgets)) {
+            $widgetName = call_user_func($classname . '::getName');
+            $widgetDescription = call_user_func($classname . '::getDescription');
+
+            // create row in widget types
+            WidgetType::create([
+                                   'handler'     => $classname,
+                                   'name'        => $widgetName,
+                                   'description' => $widgetDescription
+                               ]);
+        }
+
+        // install widget (if neccessary)
+        call_user_func($classname . '::install');
+    }
+}
diff --git a/app/Providers/AppServiceProvider.php b/app/Providers/AppServiceProvider.php
index 0bd35d0c..ac6555dc 100644
--- a/app/Providers/AppServiceProvider.php
+++ b/app/Providers/AppServiceProvider.php
@@ -2,6 +2,7 @@
 
 namespace App\Providers;
 
+use App\Handlers\Registrators\WidgetRegistrator;
 use Illuminate\Support\ServiceProvider;
 
 class AppServiceProvider extends ServiceProvider
@@ -13,7 +14,7 @@ class AppServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        //
+        $this->registerWidgets();
     }
 
     /**
@@ -31,5 +32,23 @@ class AppServiceProvider extends ServiceProvider
         // register PingPong module extension
         $this->app->register('Pingpong\Modules\ModulesServiceProvider');
         $this->app->register('Pingpong\Menus\MenusServiceProvider');
+
+        // create singletons for registering widgets
+        $this->app->singleton('registerWidget', function ($app) {
+            return new WidgetRegistrator($app);
+        });
+    }
+
+    /**
+     * Method for registering widgets.
+     */
+    private function registerWidgets()
+    {
+        /**
+         * @var $registrator WidgetRegistrator
+         */
+        $registrator = $this->app->make('registerWidget');
+
+        // register all available widgets
     }
 }
diff --git a/app/Widgets/Contracts/AdminDashboardWidget.php b/app/Widgets/Contracts/AdminDashboardWidget.php
new file mode 100644
index 00000000..b150f0d8
--- /dev/null
+++ b/app/Widgets/Contracts/AdminDashboardWidget.php
@@ -0,0 +1,12 @@
+<?php
+namespace App\Widgets\Contracts;
+
+interface AdminDashboardWidget extends PublicWidget
+{
+    /**
+     * Getter for list of all roles which are allowed to display the widget
+     *
+     * @return array
+     */
+    public static function renderForRoles();
+}
\ No newline at end of file
diff --git a/app/Widgets/Contracts/PublicWidget.php b/app/Widgets/Contracts/PublicWidget.php
new file mode 100644
index 00000000..65461887
--- /dev/null
+++ b/app/Widgets/Contracts/PublicWidget.php
@@ -0,0 +1,49 @@
+<?php
+namespace App\Widgets\Contracts;
+
+use App\Http\Requests\Request;
+use App\Models\Widget;
+
+interface PublicWidget
+{
+    /**
+     * Name getter
+     *
+     * @return string
+     */
+    public static function getName();
+
+    /**
+     * Getter for description
+     *
+     * @return string
+     */
+    public static function getDescription();
+
+    /**
+     * Getter for presenter/renderer of this widget
+     *
+     * @return WidgetRenderer
+     */
+    public static function getPresenter();
+
+    /**
+     * @param Widget  $widget
+     * @param Request $request
+     *
+     * @return mixed
+     */
+    public static function save(Widget $widget, Request $request);
+
+    /**
+     * Function for installing given widget
+     *
+     * @return mixed
+     */
+    public static function install();
+
+    /**
+     * Function for uninstalling widget
+     */
+    public static function uninstall();
+}
\ No newline at end of file
diff --git a/app/Widgets/Contracts/WidgetRenderer.php b/app/Widgets/Contracts/WidgetRenderer.php
new file mode 100644
index 00000000..4e2457c8
--- /dev/null
+++ b/app/Widgets/Contracts/WidgetRenderer.php
@@ -0,0 +1,37 @@
+<?php
+namespace App\Widgets\Contracts;
+
+use App\Models\Widget;
+use App\Models\WidgetType;
+
+interface WidgetRenderer
+{
+    /**
+     * Method used for displaying widget.
+     *
+     * This method renders some HTML code for displaying.
+     *
+     * @param object $settings
+     *
+     * @return mixed
+     */
+    public static function render($settings);
+
+    /**
+     * Display form for creating new instance of widget
+     *
+     * @param WidgetType $type
+     *
+     * @return mixed
+     */
+    public static function renderAddForm(WidgetType $type);
+
+    /**
+     * Display form for editing already existing widget
+     *
+     * @param Widget $widget
+     *
+     * @return mixed
+     */
+    public static function renderEditForm(Widget $widget);
+}
\ No newline at end of file
diff --git a/app/Widgets/Exceptions/MissingParameterException.php b/app/Widgets/Exceptions/MissingParameterException.php
new file mode 100644
index 00000000..0f2ff5a3
--- /dev/null
+++ b/app/Widgets/Exceptions/MissingParameterException.php
@@ -0,0 +1,14 @@
+<?php
+namespace App\Widgets\Exceptions;
+
+use Exception;
+
+class MissingParameterException extends \Exception
+{
+    public function __construct($message = "", $code = 0, Exception $previous = null)
+    {
+        $message = trans('admin/widgets.missingValue', ['field' => $message]);
+
+        parent::__construct($message, $code, $previous);
+    }
+}
\ No newline at end of file
diff --git a/app/Widgets/NonInstallableWidget.php b/app/Widgets/NonInstallableWidget.php
new file mode 100644
index 00000000..0c568849
--- /dev/null
+++ b/app/Widgets/NonInstallableWidget.php
@@ -0,0 +1,15 @@
+<?php
+namespace App\Widgets;
+
+abstract class NonInstallableWidget extends Widget
+{
+    public static function install()
+    {
+        // nothing to do
+    }
+
+    public static function uninstall()
+    {
+        // nothing to do
+    }
+}
\ No newline at end of file
diff --git a/app/Widgets/Widget.php b/app/Widgets/Widget.php
new file mode 100644
index 00000000..c5186d69
--- /dev/null
+++ b/app/Widgets/Widget.php
@@ -0,0 +1,8 @@
+<?php
+namespace App\Widgets;
+
+use App\Widgets\Contracts\PublicWidget;
+
+abstract class Widget implements PublicWidget {
+
+}
\ No newline at end of file