From 544fcdb549381f233dbfd9ca57cf6e7afb490104 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Wed, 27 May 2020 09:10:40 +0200 Subject: [PATCH] Deprecate old dashboard API MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- lib/public/Dashboard/IDashboardManager.php | 7 +++++++ lib/public/Dashboard/IDashboardWidget.php | 8 ++++++++ lib/public/Dashboard/Model/IWidgetConfig.php | 6 ++++++ lib/public/Dashboard/Model/IWidgetRequest.php | 8 ++++++++ lib/public/Dashboard/Model/WidgetSetting.php | 13 +++++++++++++ lib/public/Dashboard/Model/WidgetSetup.php | 13 +++++++++++++ lib/public/Dashboard/Model/WidgetTemplate.php | 18 ++++++++++++++++++ .../Dashboard/Service/IEventsService.php | 4 ++++ .../Dashboard/Service/IWidgetsService.php | 2 ++ 9 files changed, 79 insertions(+) diff --git a/lib/public/Dashboard/IDashboardManager.php b/lib/public/Dashboard/IDashboardManager.php index 812338bfb3..164a86cd8b 100644 --- a/lib/public/Dashboard/IDashboardManager.php +++ b/lib/public/Dashboard/IDashboardManager.php @@ -38,6 +38,7 @@ use OCP\Dashboard\Service\IWidgetsService; * The call can be done from any Service. * * @since 15.0.0 + * @deprecated 20.0.0 * * @package OCP\Dashboard */ @@ -48,6 +49,7 @@ interface IDashboardManager { * Register a IWidgetsService. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param IWidgetsService $widgetsService */ @@ -58,6 +60,7 @@ interface IDashboardManager { * Register a IEventsService. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param IEventsService $eventsService */ @@ -70,6 +73,7 @@ interface IDashboardManager { * @see IWidgetConfig * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $widgetId * @param string $userId @@ -92,6 +96,7 @@ interface IDashboardManager { * that are running dashboard. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $widgetId * @param array $users @@ -106,6 +111,7 @@ interface IDashboardManager { * Create push notifications for groups. (ie. createUsersEvent()) * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $widgetId * @param array $groups @@ -120,6 +126,7 @@ interface IDashboardManager { * Create push notifications for everyone. (ie. createUsersEvent()) * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $widgetId * @param array $payload diff --git a/lib/public/Dashboard/IDashboardWidget.php b/lib/public/Dashboard/IDashboardWidget.php index ef8b9c74d1..4d1b0c1147 100644 --- a/lib/public/Dashboard/IDashboardWidget.php +++ b/lib/public/Dashboard/IDashboardWidget.php @@ -45,6 +45,7 @@ use OCP\Dashboard\Model\WidgetTemplate; * Multiple widget can be defined in the same appinfo/info.xml. * * @since 15.0.0 + * @deprecated 20.0.0 * * @package OCP\Dashboard */ @@ -54,6 +55,7 @@ interface IDashboardWidget { * Should returns the (unique) Id of the widget. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -64,6 +66,7 @@ interface IDashboardWidget { * Should returns the [display] name of the widget. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -75,6 +78,7 @@ interface IDashboardWidget { * This description is displayed in the listing of the available widgets. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -88,6 +92,7 @@ interface IDashboardWidget { * @see WidgetTemplate * * @since 15.0.0 + * @deprecated 20.0.0 * * @return WidgetTemplate */ @@ -101,6 +106,7 @@ interface IDashboardWidget { * @see WidgetSetup * * @since 15.0.0 + * @deprecated 20.0.0 * * @return WidgetSetup */ @@ -119,6 +125,7 @@ interface IDashboardWidget { * @see IWidgetConfig * * @since 15.0.0 + * @deprecated 20.0.0 * * @param IWidgetConfig $settings */ @@ -134,6 +141,7 @@ interface IDashboardWidget { * @see IWidgetRequest * * @since 15.0.0 + * @deprecated 20.0.0 * * @param IWidgetRequest $request */ diff --git a/lib/public/Dashboard/Model/IWidgetConfig.php b/lib/public/Dashboard/Model/IWidgetConfig.php index 41c9e23317..078c14c742 100644 --- a/lib/public/Dashboard/Model/IWidgetConfig.php +++ b/lib/public/Dashboard/Model/IWidgetConfig.php @@ -36,6 +36,7 @@ use OCP\Dashboard\IDashboardWidget; * @see IDashboardWidget::loadWidget * * @since 15.0.0 + * @deprecated 20.0.0 * * @package OCP\Dashboard\Model */ @@ -46,6 +47,7 @@ interface IWidgetConfig { * Returns the userId * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -56,6 +58,7 @@ interface IWidgetConfig { * Returns the widgetId * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -75,6 +78,7 @@ interface IWidgetConfig { * ] * * @since 15.0.0 + * @deprecated 20.0.0 * * @return array */ @@ -105,6 +109,7 @@ interface IWidgetConfig { * Dashboard app. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return array */ @@ -115,6 +120,7 @@ interface IWidgetConfig { * Returns if the widget is enabled/displayed in this user's dashboard. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return bool */ diff --git a/lib/public/Dashboard/Model/IWidgetRequest.php b/lib/public/Dashboard/Model/IWidgetRequest.php index 18ad855006..5f1f2e396c 100644 --- a/lib/public/Dashboard/Model/IWidgetRequest.php +++ b/lib/public/Dashboard/Model/IWidgetRequest.php @@ -38,6 +38,7 @@ use OCP\Dashboard\IDashboardWidget; * @see IDashboardWidget::requestWidget * * @since 15.0.0 + * @deprecated 20.0.0 * * @package OCP\Dashboard\Model */ @@ -47,6 +48,7 @@ interface IWidgetRequest { * Get the widgetId. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -57,6 +59,7 @@ interface IWidgetRequest { * Get the WidgetClass. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return IDashboardWidget */ @@ -76,6 +79,7 @@ interface IWidgetRequest { * callback); * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -88,6 +92,7 @@ interface IWidgetRequest { * @see getRequest * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -98,6 +103,7 @@ interface IWidgetRequest { * Returns the result. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return array */ @@ -108,6 +114,7 @@ interface IWidgetRequest { * add a result (as string) * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $key * @param string $result @@ -120,6 +127,7 @@ interface IWidgetRequest { * add a result (as array) * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $key * @param array $result diff --git a/lib/public/Dashboard/Model/WidgetSetting.php b/lib/public/Dashboard/Model/WidgetSetting.php index 6242960760..406811e1f8 100644 --- a/lib/public/Dashboard/Model/WidgetSetting.php +++ b/lib/public/Dashboard/Model/WidgetSetting.php @@ -45,6 +45,7 @@ use JsonSerializable; * @see WidgetTemplate::addSetting * * @since 15.0.0 + * @deprecated 20.0.0 * * @package OCP\Dashboard\Model */ @@ -73,6 +74,7 @@ final class WidgetSetting implements JsonSerializable { * WidgetSetting constructor. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $type */ @@ -85,6 +87,7 @@ final class WidgetSetting implements JsonSerializable { * Set the name of the setting (full string, no space) * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $name * @@ -100,6 +103,7 @@ final class WidgetSetting implements JsonSerializable { * Get the name of the setting * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -112,6 +116,7 @@ final class WidgetSetting implements JsonSerializable { * Set the title/display name of the setting. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $title * @@ -127,6 +132,7 @@ final class WidgetSetting implements JsonSerializable { * Get the title of the setting * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -139,6 +145,7 @@ final class WidgetSetting implements JsonSerializable { * Set the type of the setting (input, checkbox, ...) * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $type * @@ -154,6 +161,7 @@ final class WidgetSetting implements JsonSerializable { * Get the type of the setting. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -166,6 +174,7 @@ final class WidgetSetting implements JsonSerializable { * Set the placeholder (in case of type=input) * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $text * @@ -181,6 +190,7 @@ final class WidgetSetting implements JsonSerializable { * Get the placeholder. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -193,6 +203,7 @@ final class WidgetSetting implements JsonSerializable { * Set the default value of the setting. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $value * @@ -208,6 +219,7 @@ final class WidgetSetting implements JsonSerializable { * Get the default value. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -218,6 +230,7 @@ final class WidgetSetting implements JsonSerializable { /** * @since 15.0.0 + * @deprecated 20.0.0 * * @return array */ diff --git a/lib/public/Dashboard/Model/WidgetSetup.php b/lib/public/Dashboard/Model/WidgetSetup.php index 18dc0abd48..2a1fc87741 100644 --- a/lib/public/Dashboard/Model/WidgetSetup.php +++ b/lib/public/Dashboard/Model/WidgetSetup.php @@ -38,6 +38,7 @@ use JsonSerializable; * @see IDashboardWidget::getWidgetSetup * * @since 15.0.0 + * @deprecated 20.0.0 * * @package OCP\Dashboard\Model */ @@ -73,6 +74,7 @@ final class WidgetSetup implements JsonSerializable { * * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $type * @@ -90,6 +92,7 @@ final class WidgetSetup implements JsonSerializable { * Returns all sizes defined for the widget. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return array */ @@ -101,6 +104,7 @@ final class WidgetSetup implements JsonSerializable { * Add a new size to the setup. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $type * @param int $width @@ -121,6 +125,7 @@ final class WidgetSetup implements JsonSerializable { * Returns menu entries. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return array */ @@ -136,6 +141,7 @@ final class WidgetSetup implements JsonSerializable { * $text is the display name of the menu entry. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $function * @param string $icon @@ -161,6 +167,7 @@ final class WidgetSetup implements JsonSerializable { * $delay is the time in seconds between each call. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $function * @param int $delay @@ -180,6 +187,7 @@ final class WidgetSetup implements JsonSerializable { * Get delayed jobs. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return array */ @@ -192,6 +200,7 @@ final class WidgetSetup implements JsonSerializable { * Get the push function, called when an event is send to the front-end * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -204,6 +213,7 @@ final class WidgetSetup implements JsonSerializable { * frontend. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $function * @@ -220,6 +230,7 @@ final class WidgetSetup implements JsonSerializable { * Returns the default settings for a widget. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return array */ @@ -235,6 +246,7 @@ final class WidgetSetup implements JsonSerializable { * @see WidgetSetting * * @since 15.0.0 + * @deprecated 20.0.0 * * @param array $settings * @@ -249,6 +261,7 @@ final class WidgetSetup implements JsonSerializable { /** * @since 15.0.0 + * @deprecated 20.0.0 * * @return array */ diff --git a/lib/public/Dashboard/Model/WidgetTemplate.php b/lib/public/Dashboard/Model/WidgetTemplate.php index e25abb0254..10285cfb00 100644 --- a/lib/public/Dashboard/Model/WidgetTemplate.php +++ b/lib/public/Dashboard/Model/WidgetTemplate.php @@ -37,6 +37,7 @@ use JsonSerializable; * @see IDashboardWidget::getWidgetTemplate * * @since 15.0.0 + * @deprecated 20.0.0 * * @package OCP\Dashboard\Model */ @@ -66,6 +67,7 @@ final class WidgetTemplate implements JsonSerializable { * Get the icon class of the widget. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -80,6 +82,7 @@ final class WidgetTemplate implements JsonSerializable { * @see addCss * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $icon * @@ -95,6 +98,7 @@ final class WidgetTemplate implements JsonSerializable { * Get CSS files to be included when displaying a widget * * @since 15.0.0 + * @deprecated 20.0.0 * * @return array */ @@ -106,6 +110,7 @@ final class WidgetTemplate implements JsonSerializable { * path and name of CSS files * * @since 15.0.0 + * @deprecated 20.0.0 * * @param array $css * @@ -121,6 +126,7 @@ final class WidgetTemplate implements JsonSerializable { * Add a CSS file to be included when displaying a widget. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $css * @@ -136,6 +142,7 @@ final class WidgetTemplate implements JsonSerializable { * Get JS files to be included when loading a widget * * @since 15.0.0 + * @deprecated 20.0.0 * * @return array */ @@ -147,6 +154,7 @@ final class WidgetTemplate implements JsonSerializable { * Set an array of JS files to be included when loading a widget. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param array $js * @@ -162,6 +170,7 @@ final class WidgetTemplate implements JsonSerializable { * Add a JS file to be included when loading a widget. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $js * @@ -177,6 +186,7 @@ final class WidgetTemplate implements JsonSerializable { * Get the HTML file that contains the content of the widget. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -188,6 +198,7 @@ final class WidgetTemplate implements JsonSerializable { * Set the HTML file that contains the content of the widget. * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $content * @@ -203,6 +214,7 @@ final class WidgetTemplate implements JsonSerializable { * Get the JS function to be called when loading the widget. * * @since 15.0.0 + * @deprecated 20.0.0 * * @return string */ @@ -215,6 +227,7 @@ final class WidgetTemplate implements JsonSerializable { * dashboard * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $function * @@ -232,6 +245,7 @@ final class WidgetTemplate implements JsonSerializable { * @see WidgetSetting * * @since 15.0.0 + * @deprecated 20.0.0 * * @return WidgetSetting[] */ @@ -243,6 +257,7 @@ final class WidgetTemplate implements JsonSerializable { * Define all WidgetSetting for the widget. * * @since 15.0.0 + * @deprecated 20.0.0 * * @see WidgetSetting * @@ -262,6 +277,7 @@ final class WidgetTemplate implements JsonSerializable { * @see WidgetSetting * * @since 15.0.0 + * @deprecated 20.0.0 * * @param WidgetSetting $setting * @@ -279,6 +295,7 @@ final class WidgetTemplate implements JsonSerializable { * @see WidgetSetting::setName * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $key * @@ -295,6 +312,7 @@ final class WidgetTemplate implements JsonSerializable { /** * @since 15.0.0 + * @deprecated 20.0.0 * * @return array */ diff --git a/lib/public/Dashboard/Service/IEventsService.php b/lib/public/Dashboard/Service/IEventsService.php index f79d1a28e5..0e5931878e 100644 --- a/lib/public/Dashboard/Service/IEventsService.php +++ b/lib/public/Dashboard/Service/IEventsService.php @@ -35,6 +35,7 @@ use OCP\Dashboard\IDashboardManager; * are used by the IDashboardManager when creating push event. * * @since 15.0.0 + * @deprecated 20.0.0 * * @package OCP\Dashboard\Service */ @@ -47,6 +48,7 @@ interface IEventsService { * @see IDashboardManager::createUsersEvent * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $widgetId * @param array $users @@ -62,6 +64,7 @@ interface IEventsService { * @see IDashboardManager::createGroupsEvent * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $widgetId * @param array $groups @@ -77,6 +80,7 @@ interface IEventsService { * @see IDashboardManager::createGlobalEvent * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $widgetId * @param array $payload diff --git a/lib/public/Dashboard/Service/IWidgetsService.php b/lib/public/Dashboard/Service/IWidgetsService.php index dea20489e1..059d91a666 100644 --- a/lib/public/Dashboard/Service/IWidgetsService.php +++ b/lib/public/Dashboard/Service/IWidgetsService.php @@ -36,6 +36,7 @@ use OCP\Dashboard\Model\IWidgetConfig; * configuration of a widget for a user. * * @since 15.0.0 + * @deprecated 20.0.0 * * @package OCP\Dashboard\Service */ @@ -45,6 +46,7 @@ interface IWidgetsService { * Returns the IWidgetConfig for a widgetId and userId * * @since 15.0.0 + * @deprecated 20.0.0 * * @param string $widgetId * @param string $userId