From b723a2b8cada8c742ea1cadbbad2319c737cca9b Mon Sep 17 00:00:00 2001
From: Roeland Jago Douma <roeland@famdouma.nl>
Date: Thu, 22 Mar 2018 15:54:55 +0100
Subject: [PATCH] Document parameters
Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
---
lib/public/User/Backend/ABackend.php | 3 +++
lib/public/User/Backend/ICheckPasswordBackend.php | 4 ++++
lib/public/User/Backend/ICountUsersBackend.php | 2 ++
lib/public/User/Backend/ICreateUserBackend.php | 4 ++++
lib/public/User/Backend/IGetDisplayNameBackend.php | 3 +++
lib/public/User/Backend/IGetHomeBackend.php | 3 +++
lib/public/User/Backend/IProvideAvatarBackend.php | 3 +++
lib/public/User/Backend/ISetDisplayNameBackend.php | 4 ++++
lib/public/User/Backend/ISetPasswordBackend.php | 4 ++++
9 files changed, 30 insertions(+)
diff --git a/lib/public/User/Backend/ABackend.php b/lib/public/User/Backend/ABackend.php
index 48d410737de..a110ba5202a 100644
--- a/lib/public/User/Backend/ABackend.php
+++ b/lib/public/User/Backend/ABackend.php
@@ -35,6 +35,9 @@ abstract class ABackend implements IUserBackend, UserInterface {
/**
* @deprecated 14.0.0
+ *
+ * @param int $actions The action to check for
+ * @return bool
*/
public function implementsActions($actions): bool {
$implements = 0;
diff --git a/lib/public/User/Backend/ICheckPasswordBackend.php b/lib/public/User/Backend/ICheckPasswordBackend.php
index 858c2d8c7da..b28c94f1a6c 100644
--- a/lib/public/User/Backend/ICheckPasswordBackend.php
+++ b/lib/public/User/Backend/ICheckPasswordBackend.php
@@ -30,6 +30,10 @@ namespace OCP\User\Backend;
interface ICheckPasswordBackend {
/**
* @since 14.0.0
+ *
+ * @param string $uid The username
+ * @param string $password The password
+ * @return string|bool The uid on success false on failure
*/
public function checkPassword(string $loginName, string $password);
}
diff --git a/lib/public/User/Backend/ICountUsersBackend.php b/lib/public/User/Backend/ICountUsersBackend.php
index 358557920da..1cb46712aa0 100644
--- a/lib/public/User/Backend/ICountUsersBackend.php
+++ b/lib/public/User/Backend/ICountUsersBackend.php
@@ -31,6 +31,8 @@ interface ICountUsersBackend {
/**
* @since 14.0.0
+ *
+ * @return int|bool The number of users on success false on failure
*/
public function countUsers();
}
diff --git a/lib/public/User/Backend/ICreateUserBackend.php b/lib/public/User/Backend/ICreateUserBackend.php
index d3454c613c1..09a20e12453 100644
--- a/lib/public/User/Backend/ICreateUserBackend.php
+++ b/lib/public/User/Backend/ICreateUserBackend.php
@@ -31,6 +31,10 @@ interface ICreateUserBackend {
/**
* @since 14.0.0
+ *
+ * @param string $uid The username of the user to create
+ * @param string $password The password of the new user
+ * @return bool
*/
public function createUser(string $uid, string $password): bool;
}
diff --git a/lib/public/User/Backend/IGetDisplayNameBackend.php b/lib/public/User/Backend/IGetDisplayNameBackend.php
index f703e17157a..6382ddd6eb6 100644
--- a/lib/public/User/Backend/IGetDisplayNameBackend.php
+++ b/lib/public/User/Backend/IGetDisplayNameBackend.php
@@ -31,6 +31,9 @@ interface IGetDisplayNameBackend {
/**
* @since 14.0.0
+ *
+ * @param string $uid user ID of the user
+ * @return string display name
*/
public function getDisplayName($uid): string;
}
diff --git a/lib/public/User/Backend/IGetHomeBackend.php b/lib/public/User/Backend/IGetHomeBackend.php
index 607070932e8..20fcd004bba 100644
--- a/lib/public/User/Backend/IGetHomeBackend.php
+++ b/lib/public/User/Backend/IGetHomeBackend.php
@@ -31,6 +31,9 @@ interface IGetHomeBackend {
/**
* @since 14.0.0
+ *
+ * @param string $uid the username
+ * @return string|bool Datadir on success false on failure
*/
public function getHome(string $uid);
}
diff --git a/lib/public/User/Backend/IProvideAvatarBackend.php b/lib/public/User/Backend/IProvideAvatarBackend.php
index 9aefda0e272..328c7450b40 100644
--- a/lib/public/User/Backend/IProvideAvatarBackend.php
+++ b/lib/public/User/Backend/IProvideAvatarBackend.php
@@ -31,6 +31,9 @@ interface IProvideAvatarBackend {
/**
* @since 14.0.0
+ *
+ * @param string $uid
+ * @return bool
*/
public function canChangeAvatar(string $uid): bool;
}
diff --git a/lib/public/User/Backend/ISetDisplayNameBackend.php b/lib/public/User/Backend/ISetDisplayNameBackend.php
index 23f8478282d..ac41cd3e2c3 100644
--- a/lib/public/User/Backend/ISetDisplayNameBackend.php
+++ b/lib/public/User/Backend/ISetDisplayNameBackend.php
@@ -31,6 +31,10 @@ interface ISetDisplayNameBackend {
/**
* @since 14.0.0
+ *
+ * @param string $uid The username
+ * @param string $displayName The new display name
+ * @return bool
*/
public function setDisplayName(string $uid, string $displayName): bool;
}
diff --git a/lib/public/User/Backend/ISetPasswordBackend.php b/lib/public/User/Backend/ISetPasswordBackend.php
index ec008b33a5a..687ac5f70bb 100644
--- a/lib/public/User/Backend/ISetPasswordBackend.php
+++ b/lib/public/User/Backend/ISetPasswordBackend.php
@@ -31,6 +31,10 @@ interface ISetPasswordBackend {
/**
* @since 14.0.0
+ *
+ * @param string $uid The username
+ * @param string $password The new password
+ * @return bool
*/
public function setPassword(string $uid, string $password): bool;
}
--
GitLab