Cleanup public api methods

Signed-off-by: Julius Härtl <jus@bitgrid.net>

diff --git a/apps/dashboard/lib/Controller/DashboardController.php b/apps/dashboard/lib/Controller/DashboardController.php
index 040f54a1f531d9430eab8591b5e0bbbc0286630b..f753ad06f82cf4572f494c1d994b3069de1ddedd 100644 (file)
--- a/apps/dashboard/lib/Controller/DashboardController.php
+++ b/apps/dashboard/lib/Controller/DashboardController.php
@@ -28,7 +28,7 @@ use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\TemplateResponse;
 use OCP\Dashboard\IManager;
 use OCP\Dashboard\IPanel;
-use OCP\Dashboard\IRegisterPanelEvent;
+use OCP\Dashboard\RegisterPanelEvent;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\IInitialStateService;
 use OCP\IRequest;
@@ -42,7 +42,13 @@ class DashboardController extends Controller {
        /** @var IManager */
        private $dashboardManager;
 
-       public function __construct($appName, IRequest $request, IInitialStateService $initialStateService, IEventDispatcher $eventDispatcher, IManager $dashboardManager) {
+       public function __construct(
+               $appName,
+               IRequest $request,
+               IInitialStateService $initialStateService,
+               IEventDispatcher $eventDispatcher,
+               IManager $dashboardManager
+       ) {
                parent::__construct($appName, $request);
 
                $this->inititalStateService = $initialStateService;
@@ -56,7 +62,7 @@ class DashboardController extends Controller {
         * @return TemplateResponse
         */
        public function index(): TemplateResponse {
-               $this->eventDispatcher->dispatchTyped(new IRegisterPanelEvent($this->dashboardManager));
+               $this->eventDispatcher->dispatchTyped(new RegisterPanelEvent($this->dashboardManager));
 
                $dashboardManager = $this->dashboardManager;
                $panels = array_map(function (IPanel $panel) {

diff --git a/lib/private/Dashboard/Manager.php b/lib/private/Dashboard/Manager.php
index 0d149dc9a13ecc84559f58397cf3c9da79deca41..f9c857f831f27d0ae68de2d8907a7334006e063e 100644 (file)
--- a/lib/private/Dashboard/Manager.php
+++ b/lib/private/Dashboard/Manager.php
@@ -26,6 +26,7 @@ namespace OC\Dashboard;
 use OCP\AppFramework\QueryException;
 use OCP\Dashboard\IManager;
 use OCP\Dashboard\IPanel;
+use OCP\ILogger;
 use OCP\IServerContainer;
 
 class Manager implements IManager {
@@ -43,10 +44,7 @@ class Manager implements IManager {
                $this->serverContainer = $serverContainer;
        }
 
-       /**
-        * @inheritDoc
-        */
-       public function registerPanel(IPanel $panel): void {
+       private function registerPanel(IPanel $panel): void {
                if (array_key_exists($panel->getId(), $this->panels)) {
                        throw new \InvalidArgumentException('Dashboard panel with this id has already been registered');
                }
@@ -86,7 +84,7 @@ class Manager implements IManager {
                                 * we can not inject it. Thus the static call.
                                 */
                                \OC::$server->getLogger()->logException($e, [
-                                       'message' => 'Could not register lazy crash reporter: ' . $e->getMessage(),
+                                       'message' => 'Could not register lazy dashboard panel: ' . $e->getMessage(),
                                        'level' => ILogger::FATAL,
                                ]);
                        }

diff --git a/lib/public/Dashboard/IManager.php b/lib/public/Dashboard/IManager.php
index 21d67407fb85159aed5c5ba44c9d9ebb0d1ca9de..51ee7d2fbe5b169babb0d5465e216743378a1b1f 100644 (file)
--- a/lib/public/Dashboard/IManager.php
+++ b/lib/public/Dashboard/IManager.php
@@ -31,12 +31,6 @@ namespace OCP\Dashboard;
  */
 interface IManager {
 
-       /**
-        * @param IPanel $panel
-        * @since 20.0.0
-        */
-       public function registerPanel(IPanel $panel): void;
-
        /**
         * @param string $panelClass
         * @since 20.0.0

diff --git a/lib/public/Dashboard/IPanel.php b/lib/public/Dashboard/IPanel.php
index 1b0e3c11d1a7f19ce6ef6a6847a4b52eb628186f..d7e7b157964e36ea93cfb9587ecc9d343180bb51 100644 (file)
--- a/lib/public/Dashboard/IPanel.php
+++ b/lib/public/Dashboard/IPanel.php
@@ -55,12 +55,6 @@ interface IPanel {
         */
        public function getIconClass(): string;
 
-       /**
-        * @return string The absolute path to an icon in SVG
-        * @since 20.0.0
-        */
-       public function getIconUrl(): string;
-
        /**
         * @return string The absolute url to the apps own view
         * @since 20.0.0

diff --git a/lib/public/Dashboard/IRegisterPanelEvent.php b/lib/public/Dashboard/IRegisterPanelEvent.php
deleted file mode 100644 (file)
index 1ca42a6..0000000
--- a/lib/public/Dashboard/IRegisterPanelEvent.php
+++ /dev/null
@@ -1,56 +0,0 @@
-<?php
-/**
- * @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
- *
- * @author Julius Härtl <jus@bitgrid.net>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
- */
-
-namespace OCP\Dashboard;
-
-use OCP\EventDispatcher\Event;
-
-/**
- * Class IRegisterPanelEvent
- *
- * This event is dispatched to allow apps supporting older Nextcloud versions to
- * still register their dashboard panels so that they are only constructed when
- * they are needed. Deprecated right away so we can drop it again after 19 is EOL
- * and backward compatible apps can use OCP\AppFramework\Bootstrap\IBootstrap
- *
- * @package OCP\Dashboard
- * @since 20.0.0
- * @deprecated 20.0.0
- */
-class IRegisterPanelEvent extends Event {
-       private $manager;
-
-       public function __construct(IManager $manager) {
-               parent::__construct();
-
-               $this->manager = $manager;
-       }
-
-       /**
-        * @param IPanel $panel
-        * @since 20.0.0
-        */
-       public function registerPanel(IPanel $panel) {
-               $this->manager->registerPanel($panel);
-       }
-}

diff --git a/lib/public/Dashboard/RegisterPanelEvent.php b/lib/public/Dashboard/RegisterPanelEvent.php
new file mode 100644 (file)
index 0000000..bc0028d
--- /dev/null
+++ b/lib/public/Dashboard/RegisterPanelEvent.php
@@ -0,0 +1,56 @@
+<?php
+/**
+ * @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Dashboard;
+
+use OCP\EventDispatcher\Event;
+
+/**
+ * Class RegisterPanelEvent
+ *
+ * This event is dispatched to allow apps supporting older Nextcloud versions to
+ * still register their dashboard panels so that they are only constructed when
+ * they are needed. Deprecated right away so we can drop it again after 19 is EOL
+ * and backward compatible apps can use OCP\AppFramework\Bootstrap\IBootstrap
+ *
+ * @package OCP\Dashboard
+ * @since 20.0.0
+ * @deprecated 20.0.0
+ */
+class RegisterPanelEvent extends Event {
+       private $manager;
+
+       public function __construct(IManager $manager) {
+               parent::__construct();
+
+               $this->manager = $manager;
+       }
+
+       /**
+        * @param string $panelClass
+        * @since 20.0.0
+        */
+       public function registerPanel(string $panelClass) {
+               $this->manager->lazyRegisterPanel($panelClass);
+       }
+}