From 95145ee0c9a7c0fdab35998c4e159337e4fc1943 Mon Sep 17 00:00:00 2001 From: Christoph Wurst Date: Thu, 29 Jun 2023 09:50:09 +0200 Subject: [PATCH] feat(ocp): More specific type for ICapabilities::getCapabilities Signed-off-by: Christoph Wurst --- apps/cloud_federation_api/lib/Capabilities.php | 3 --- apps/files/lib/Capabilities.php | 2 -- apps/files_sharing/lib/Capabilities.php | 2 -- apps/files_trashbin/lib/Capabilities.php | 2 -- apps/files_versions/lib/Capabilities.php | 2 -- apps/provisioning_api/lib/Capabilities.php | 2 -- apps/theming/lib/Capabilities.php | 2 -- apps/user_status/lib/Capabilities.php | 3 --- apps/weather_status/lib/Capabilities.php | 3 --- lib/private/OCS/CoreCapabilities.php | 2 -- lib/public/Capabilities/ICapability.php | 14 +++++++++++++- 11 files changed, 13 insertions(+), 24 deletions(-) diff --git a/apps/cloud_federation_api/lib/Capabilities.php b/apps/cloud_federation_api/lib/Capabilities.php index 6164c0e0dba..91fd5219215 100644 --- a/apps/cloud_federation_api/lib/Capabilities.php +++ b/apps/cloud_federation_api/lib/Capabilities.php @@ -36,9 +36,6 @@ class Capabilities implements ICapability { /** * Function an app uses to return the capabilities - * - * @return array Array containing the apps capabilities - * @since 8.2.0 */ public function getCapabilities() { $url = $this->urlGenerator->linkToRouteAbsolute('cloud_federation_api.requesthandlercontroller.addShare'); diff --git a/apps/files/lib/Capabilities.php b/apps/files/lib/Capabilities.php index 3eb43578351..5cb976a47be 100644 --- a/apps/files/lib/Capabilities.php +++ b/apps/files/lib/Capabilities.php @@ -38,8 +38,6 @@ class Capabilities implements ICapability { /** * Return this classes capabilities - * - * @return array */ public function getCapabilities() { return [ diff --git a/apps/files_sharing/lib/Capabilities.php b/apps/files_sharing/lib/Capabilities.php index 58104864631..8b1160aeb63 100644 --- a/apps/files_sharing/lib/Capabilities.php +++ b/apps/files_sharing/lib/Capabilities.php @@ -50,8 +50,6 @@ class Capabilities implements ICapability { /** * Return this classes capabilities - * - * @return array */ public function getCapabilities() { $res = []; diff --git a/apps/files_trashbin/lib/Capabilities.php b/apps/files_trashbin/lib/Capabilities.php index 28acf0c8d27..c0788ff7308 100644 --- a/apps/files_trashbin/lib/Capabilities.php +++ b/apps/files_trashbin/lib/Capabilities.php @@ -33,8 +33,6 @@ class Capabilities implements ICapability { /** * Return this classes capabilities - * - * @return array */ public function getCapabilities() { return [ diff --git a/apps/files_versions/lib/Capabilities.php b/apps/files_versions/lib/Capabilities.php index afc6fa39da7..6439c18772b 100644 --- a/apps/files_versions/lib/Capabilities.php +++ b/apps/files_versions/lib/Capabilities.php @@ -42,8 +42,6 @@ class Capabilities implements ICapability { /** * Return this classes capabilities - * - * @return array */ public function getCapabilities() { $groupFolderInstalled = $this->appManager->isInstalled('groupfolders'); diff --git a/apps/provisioning_api/lib/Capabilities.php b/apps/provisioning_api/lib/Capabilities.php index 835bbfe9b5c..614c20e66a8 100644 --- a/apps/provisioning_api/lib/Capabilities.php +++ b/apps/provisioning_api/lib/Capabilities.php @@ -37,8 +37,6 @@ class Capabilities implements ICapability { /** * Function an app uses to return the capabilities - * - * @return array Array containing the apps capabilities */ public function getCapabilities() { $federatedScopeEnabled = $this->appManager->isEnabledForUser('federation'); diff --git a/apps/theming/lib/Capabilities.php b/apps/theming/lib/Capabilities.php index 10828619e60..5c063715f43 100644 --- a/apps/theming/lib/Capabilities.php +++ b/apps/theming/lib/Capabilities.php @@ -64,8 +64,6 @@ class Capabilities implements IPublicCapability { /** * Return this classes capabilities - * - * @return array */ public function getCapabilities() { $backgroundLogo = $this->config->getAppValue('theming', 'backgroundMime', ''); diff --git a/apps/user_status/lib/Capabilities.php b/apps/user_status/lib/Capabilities.php index 5b3e105d31a..67e73f2733c 100644 --- a/apps/user_status/lib/Capabilities.php +++ b/apps/user_status/lib/Capabilities.php @@ -40,9 +40,6 @@ class Capabilities implements ICapability { $this->emojiHelper = $emojiHelper; } - /** - * @inheritDoc - */ public function getCapabilities() { return [ 'user_status' => [ diff --git a/apps/weather_status/lib/Capabilities.php b/apps/weather_status/lib/Capabilities.php index c9de0039a39..60cbb4602fd 100644 --- a/apps/weather_status/lib/Capabilities.php +++ b/apps/weather_status/lib/Capabilities.php @@ -43,9 +43,6 @@ class Capabilities implements ICapability { public function __construct() { } - /** - * @inheritDoc - */ public function getCapabilities() { return [ Application::APP_ID => [ diff --git a/lib/private/OCS/CoreCapabilities.php b/lib/private/OCS/CoreCapabilities.php index 2c630531b17..9cead57c6a3 100644 --- a/lib/private/OCS/CoreCapabilities.php +++ b/lib/private/OCS/CoreCapabilities.php @@ -44,8 +44,6 @@ class CoreCapabilities implements ICapability { /** * Return this classes capabilities - * - * @return array */ public function getCapabilities() { return [ diff --git a/lib/public/Capabilities/ICapability.php b/lib/public/Capabilities/ICapability.php index fed1dba49d1..7a7cf2ad2a4 100644 --- a/lib/public/Capabilities/ICapability.php +++ b/lib/public/Capabilities/ICapability.php @@ -37,7 +37,19 @@ interface ICapability { /** * Function an app uses to return the capabilities * - * @return array Array containing the apps capabilities + * ```php + * return [ + * 'myapp' => [ + * 'awesomefeature' => true, + * 'featureversion' => 3, + * ], + * 'morecomplex' => [ + * 'a' => [1, 2], + * ], + * ]; + * ``` + * + * @return array> Indexed array containing the app's capabilities * @since 8.2.0 */ public function getCapabilities();