Refactor API to match the widget wording

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

1 files changed, 72 insertions, 0 deletions

diff --git a/lib/public/Dashboard/IWidget.php b/lib/public/Dashboard/IWidget.php
new file mode 100644
index 00000000000..42e2c7df5b2
--- /dev/null
+++ b/lib/public/Dashboard/IWidget.php
@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @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;
+
+/**
+ * Interface IWidget
+ *
+ * @package OCP\Dashboard
+ * @since 20.0.0
+ */
+interface IWidget {
+
+	/**
+	 * @return string Unique id that identifies the widget, e.g. the app id
+	 * @since 20.0.0
+	 */
+	public function getId(): string;
+
+	/**
+	 * @return string User facing title of the widget
+	 * @since 20.0.0
+	 */
+	public function getTitle(): string;
+
+	/**
+	 * @return int Initial order for widget sorting
+	 * @since 20.0.0
+	 */
+	public function getOrder(): int;
+
+	/**
+	 * @return string css class that displays an icon next to the widget title
+	 * @since 20.0.0
+	 */
+	public function getIconClass(): string;
+
+	/**
+	 * @return string|null The absolute url to the apps own view
+	 * @since 20.0.0
+	 */
+	public function getUrl(): ?string;
+
+	/**
+	 * Execute widget bootstrap code like loading scripts and providing initial state
+	 * @since 20.0.0
+	 */
+	public function load(): void;
+}