Next major version 2 with PHP 8.1, Symfony 6, Tabler UI, 2FA ... (#2902)

src/Widget/WidgetInterface.php

@@ -9,6 +9,9 @@
 
 namespace App\Widget;
 
+use App\Entity\User;
+use Symfony\Component\Form\Form;
+
 interface WidgetInterface
 {
     public const COLOR_TODAY = 'green';
@@ -17,6 +20,16 @@ interface WidgetInterface
     public const COLOR_YEAR = 'yellow';
     public const COLOR_TOTAL = 'red';
 
+    public const WIDTH_FULL = 4;
+    public const WIDTH_LARGE = 3;
+    public const WIDTH_HALF = 2;
+    public const WIDTH_SMALL = 1;
+
+    public const HEIGHT_MAXIMUM = 6;
+    public const HEIGHT_LARGE = 5;
+    public const HEIGHT_MEDIUM = 3;
+    public const HEIGHT_SMALL = 1;
+
     /**
      * Returns a unique ID for this widget.
      *
@@ -25,16 +38,36 @@ interface WidgetInterface
     public function getId(): string;
 
     /**
-     * Returns the widget title.
-     *
-     * If no title is necessary, return an empty string.
+     * Returns the widget title (must be non-empty).
      *
      * @return string
      */
     public function getTitle(): string;
 
     /**
-     * Returns the widgets data, to be used in the frontend rendering.
+     * Returns the height for this widget.
+     *
+     * @return int
+     */
+    public function getHeight(): int;
+
+    /**
+     * Returns the width for this widget.
+     *
+     * @return int
+     */
+    public function getWidth(): int;
+
+    /**
+     * Injects the current user.
+     *
+     * @param User $user
+     * @return void
+     */
+    public function setUser(User $user): void;
+
+    /**
+     * Returns the widget data, to be used in the frontend rendering.
      *
      * If your widget relies on options to dynamically change the result data,
      * make sure that the given $options will overwrite the internal option for
@@ -65,7 +98,43 @@ interface WidgetInterface
      * The given option should be persisted and permanently overwrite the internal option.
      *
      * @param string $name
-     * @param mixed $value
+     * @param string|bool|int $value
      */
-    public function setOption(string $name, $value): void;
+    public function setOption(string $name, string|bool|int $value): void;
+
+    /**
+     * Return a list of granted syntax string.
+     * If ANY of the given permission strings matches, access is granted.
+     *
+     * @return string[]
+     */
+    public function getPermissions(): array;
+
+    /**
+     * Returns the template, which is used to render the widget.
+     *
+     * @return string
+     */
+    public function getTemplateName(): string;
+
+    /**
+     * Whether this widget can be configured with options.
+     *
+     * @return bool
+     */
+    public function hasForm(): bool;
+
+    /**
+     * A form to edit the widget options or null, if it can't be configured.
+     *
+     * @return Form|null
+     */
+    public function getForm(): ?Form;
+
+    /**
+     * Whether this is a widget that is supposed to be selectable by the end-user.
+     *
+     * @return bool
+     */
+    public function isInternal(): bool;
 }