Merge pull request #26430 from nextcloud/enh/dashboard-api

4 files changed, 194 insertions, 0 deletions

diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index 64db044d38e..437a46be92b 100644
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -176,12 +176,14 @@ return array(
     'OCP\\DB\\QueryBuilder\\IQueryFunction' => $baseDir . '/lib/public/DB/QueryBuilder/IQueryFunction.php',
     'OCP\\DB\\Types' => $baseDir . '/lib/public/DB/Types.php',
     'OCP\\Dashboard\\Exceptions\\DashboardAppNotAvailableException' => $baseDir . '/lib/public/Dashboard/Exceptions/DashboardAppNotAvailableException.php',
+    'OCP\\Dashboard\\IAPIWidget' => $baseDir . '/lib/public/Dashboard/IAPIWidget.php',
     'OCP\\Dashboard\\IDashboardManager' => $baseDir . '/lib/public/Dashboard/IDashboardManager.php',
     'OCP\\Dashboard\\IDashboardWidget' => $baseDir . '/lib/public/Dashboard/IDashboardWidget.php',
     'OCP\\Dashboard\\IManager' => $baseDir . '/lib/public/Dashboard/IManager.php',
     'OCP\\Dashboard\\IWidget' => $baseDir . '/lib/public/Dashboard/IWidget.php',
     'OCP\\Dashboard\\Model\\IWidgetConfig' => $baseDir . '/lib/public/Dashboard/Model/IWidgetConfig.php',
     'OCP\\Dashboard\\Model\\IWidgetRequest' => $baseDir . '/lib/public/Dashboard/Model/IWidgetRequest.php',
+    'OCP\\Dashboard\\Model\\WidgetItem' => $baseDir . '/lib/public/Dashboard/Model/WidgetItem.php',
     'OCP\\Dashboard\\Model\\WidgetSetting' => $baseDir . '/lib/public/Dashboard/Model/WidgetSetting.php',
     'OCP\\Dashboard\\Model\\WidgetSetup' => $baseDir . '/lib/public/Dashboard/Model/WidgetSetup.php',
     'OCP\\Dashboard\\Model\\WidgetTemplate' => $baseDir . '/lib/public/Dashboard/Model/WidgetTemplate.php',
diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index 4f9314d088a..5430bfdeac4 100644
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -205,12 +205,14 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
         'OCP\\DB\\QueryBuilder\\IQueryFunction' => __DIR__ . '/../../..' . '/lib/public/DB/QueryBuilder/IQueryFunction.php',
         'OCP\\DB\\Types' => __DIR__ . '/../../..' . '/lib/public/DB/Types.php',
         'OCP\\Dashboard\\Exceptions\\DashboardAppNotAvailableException' => __DIR__ . '/../../..' . '/lib/public/Dashboard/Exceptions/DashboardAppNotAvailableException.php',
+        'OCP\\Dashboard\\IAPIWidget' => __DIR__ . '/../../..' . '/lib/public/Dashboard/IAPIWidget.php',
         'OCP\\Dashboard\\IDashboardManager' => __DIR__ . '/../../..' . '/lib/public/Dashboard/IDashboardManager.php',
         'OCP\\Dashboard\\IDashboardWidget' => __DIR__ . '/../../..' . '/lib/public/Dashboard/IDashboardWidget.php',
         'OCP\\Dashboard\\IManager' => __DIR__ . '/../../..' . '/lib/public/Dashboard/IManager.php',
         'OCP\\Dashboard\\IWidget' => __DIR__ . '/../../..' . '/lib/public/Dashboard/IWidget.php',
         'OCP\\Dashboard\\Model\\IWidgetConfig' => __DIR__ . '/../../..' . '/lib/public/Dashboard/Model/IWidgetConfig.php',
         'OCP\\Dashboard\\Model\\IWidgetRequest' => __DIR__ . '/../../..' . '/lib/public/Dashboard/Model/IWidgetRequest.php',
+        'OCP\\Dashboard\\Model\\WidgetItem' => __DIR__ . '/../../..' . '/lib/public/Dashboard/Model/WidgetItem.php',
         'OCP\\Dashboard\\Model\\WidgetSetting' => __DIR__ . '/../../..' . '/lib/public/Dashboard/Model/WidgetSetting.php',
         'OCP\\Dashboard\\Model\\WidgetSetup' => __DIR__ . '/../../..' . '/lib/public/Dashboard/Model/WidgetSetup.php',
         'OCP\\Dashboard\\Model\\WidgetTemplate' => __DIR__ . '/../../..' . '/lib/public/Dashboard/Model/WidgetTemplate.php',
diff --git a/lib/public/Dashboard/IAPIWidget.php b/lib/public/Dashboard/IAPIWidget.php
new file mode 100644
index 00000000000..42ba9544d8a
--- /dev/null
+++ b/lib/public/Dashboard/IAPIWidget.php
@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2021 Julien Veyssier <eneiluj@posteo.net>
+ *
+ * @author Julien Veyssier <eneiluj@posteo.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 IAPIWidget
+ *
+ * @since 22.0.0
+ */
+interface IAPIWidget extends IWidget {
+
+	/**
+	 * @return \OCP\Dashboard\Model\WidgetItem[] The widget items
+	 * @since 22.0.0
+	 */
+	public function getItems(string $userId, ?string $since = null, int $limit = 7): array;
+}
diff --git a/lib/public/Dashboard/Model/WidgetItem.php b/lib/public/Dashboard/Model/WidgetItem.php
new file mode 100644
index 00000000000..2bea9b93226
--- /dev/null
+++ b/lib/public/Dashboard/Model/WidgetItem.php
@@ -0,0 +1,149 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright 2021, Julien Veyssier <eneiluj@posteo.net>
+ *
+ * @author Julien Veyssier <eneiluj@posteo.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\Model;
+
+use JsonSerializable;
+
+/**
+ * Interface WidgetItem
+ *
+ * This class is used by IAPIWidget interface.
+ * It represents an widget item data that can be provided to clients via the Dashboard API
+ * @see IAPIWidget::getWidgetItems
+ *
+ * @since 22.0.0
+ *
+ */
+final class WidgetItem implements JsonSerializable {
+	/** @var string */
+	private $title = '';
+
+	/** @var string */
+	private $subtitle = '';
+
+	/** @var string */
+	private $link = '';
+
+	/** @var string */
+	private $iconUrl = '';
+
+	/** @var string
+	 * Timestamp or ID used by the dashboard API to avoid getting already retrieved items
+	 */
+	private $sinceId = '';
+
+
+	/**
+	 * WidgetItem constructor
+	 *
+	 * @since 22.0.0
+	 *
+	 * @param string $type
+	 */
+	public function __construct(string $title = '',
+								string $subtitle = '',
+								string $link = '',
+								string $iconUrl = '',
+								string $sinceId = '') {
+		$this->title = $title;
+		$this->subtitle = $subtitle;
+		$this->iconUrl = $iconUrl;
+		$this->link = $link;
+		$this->sinceId = $sinceId;
+	}
+
+	/**
+	 * Get the item title
+	 *
+	 * @since 22.0.0
+	 *
+	 * @return string
+	 */
+	public function getTitle(): string {
+		return $this->title;
+	}
+
+	/**
+	 * Get the item subtitle
+	 *
+	 * @since 22.0.0
+	 *
+	 * @return string
+	 */
+	public function getSubtitle(): string {
+		return $this->subtitle;
+	}
+
+	/**
+	 * Get the item link
+	 *
+	 * @since 22.0.0
+	 *
+	 * @return string
+	 */
+	public function getLink(): string {
+		return $this->link;
+	}
+
+	/**
+	 * Get the item icon URL
+	 * The icon should be a square svg or a jpg/png of at least 44x44px
+	 *
+	 * @since 22.0.0
+	 *
+	 * @return string
+	 */
+	public function getIconUrl(): string {
+		return $this->iconUrl;
+	}
+
+	/**
+	 * Get the item since ID
+	 *
+	 * @since 22.0.0
+	 *
+	 * @return string
+	 */
+	public function getSinceId(): string {
+		return $this->sinceId;
+	}
+
+	/**
+	 * @since 22.0.0
+	 *
+	 * @return array
+	 */
+	public function jsonSerialize(): array {
+		return [
+			'subtitle' => $this->getSubtitle(),
+			'title' => $this->getTitle(),
+			'link' => $this->getLink(),
+			'iconUrl' => $this->getIconUrl(),
+			'sinceId' => $this->getSinceId(),
+		];
+	}
+}