Merge pull request #39057 from nextcloud/feat/ocp/type-icapabilities

feat(ocp): More specific type for ICapabilities::getCapabilities
nextcloud · Jul 3, 2023 · 67709b3 · 67709b3
2 parents 1d5beb3 + 1949996
commit 67709b3
Show file tree

Hide file tree

Showing 11 changed files with 15 additions and 29 deletions.
diff --git a/apps/cloud_federation_api/lib/Capabilities.php b/apps/cloud_federation_api/lib/Capabilities.php
@@ -36,9 +36,6 @@ public function __construct(IURLGenerator $urlGenerator) {
 
 	/**
 	 * 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
@@ -38,8 +38,6 @@ public function __construct(IConfig $config) {
 
 	/**
 	 * 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
@@ -50,8 +50,6 @@ public function __construct(IConfig $config, IManager $shareManager) {
 
 	/**
 	 * 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
@@ -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
@@ -42,8 +42,6 @@ public function __construct(
 
 	/**
 	 * 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
@@ -37,8 +37,6 @@ public function __construct(IAppManager $appManager) {
 
 	/**
 	 * 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
@@ -64,8 +64,6 @@ public function __construct(ThemingDefaults $theming, Util $util, IURLGenerator
 
 	/**
 	 * 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
@@ -40,9 +40,6 @@ public function __construct(IEmojiHelper $emojiHelper) {
 		$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
@@ -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
@@ -44,8 +44,6 @@ public function __construct(IConfig $config) {
 
 	/**
 	 * Return this classes capabilities
-	 *
-	 * @return array
 	 */
 	public function getCapabilities() {
 		return [

diff --git a/lib/public/Capabilities/ICapability.php b/lib/public/Capabilities/ICapability.php
@@ -25,19 +25,28 @@
  * Minimal interface that has to be implemented for a class to be considered
  * a capability.
  *
- * In an application use:
- *   $this->getContainer()->registerCapability('OCA\MY_APP\Capabilities');
- * To register capabilities.
- *
- * The class 'OCA\MY_APP\Capabilities' must then implement ICapability
+ * In an application use \OCP\AppFramework\Bootstrap\IRegistrationContext::registerCapability
+ * to register capabilities.
  *
  * @since 8.2.0
  */
 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<string, array<string, mixed>> Indexed array containing the app's capabilities
 	 * @since 8.2.0
 	 */
 	public function getCapabilities();