summaryrefslogtreecommitdiffstats
path: root/lib/public/iusermanager.php
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
committerMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
commit7644950b48b094bfe5675348aefb7cf5747d325b (patch)
treea1792e21239a86f471da99b454134a5d8533ef77 /lib/public/iusermanager.php
parent8653da6c16597959c7bd0f0b202747ff96204575 (diff)
downloadnextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.tar.gz
nextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.zip
Add @since tags to all methods in public namespace
* enhance the app development experience - you can look up the method introduction right inside the code without searching via git blame * easier to write apps for multiple versions
Diffstat (limited to 'lib/public/iusermanager.php')
-rw-r--r--lib/public/iusermanager.php11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/public/iusermanager.php b/lib/public/iusermanager.php
index df0975b70a0..23fb84e6ada 100644
--- a/lib/public/iusermanager.php
+++ b/lib/public/iusermanager.php
@@ -36,18 +36,21 @@ namespace OCP;
* - postCreateUser(\OC\User\User $user, string $password)
*
* @package OC\User
+ * @since 8.0.0
*/
interface IUserManager {
/**
* register a user backend
*
* @param \OCP\UserInterface $backend
+ * @since 8.0.0
*/
public function registerBackend($backend);
/**
* Get the active backends
* @return \OCP\UserInterface[]
+ * @since 8.0.0
*/
public function getBackends();
@@ -55,6 +58,7 @@ interface IUserManager {
* remove a user backend
*
* @param \OCP\UserInterface $backend
+ * @since 8.0.0
*/
public function removeBackend($backend);
@@ -68,6 +72,7 @@ interface IUserManager {
*
* @param string $uid
* @return \OCP\IUser|null Either the user or null if the specified user does not exist
+ * @since 8.0.0
*/
public function get($uid);
@@ -76,6 +81,7 @@ interface IUserManager {
*
* @param string $uid
* @return bool
+ * @since 8.0.0
*/
public function userExists($uid);
@@ -85,6 +91,7 @@ interface IUserManager {
* @param string $loginname
* @param string $password
* @return mixed the User object on success, false otherwise
+ * @since 8.0.0
*/
public function checkPassword($loginname, $password);
@@ -95,6 +102,7 @@ interface IUserManager {
* @param int $limit
* @param int $offset
* @return \OCP\IUser[]
+ * @since 8.0.0
*/
public function search($pattern, $limit = null, $offset = null);
@@ -105,6 +113,7 @@ interface IUserManager {
* @param int $limit
* @param int $offset
* @return \OCP\IUser[]
+ * @since 8.0.0
*/
public function searchDisplayName($pattern, $limit = null, $offset = null);
@@ -113,6 +122,7 @@ interface IUserManager {
* @param string $password
* @throws \Exception
* @return bool|\OCP\IUser the created user of false
+ * @since 8.0.0
*/
public function createUser($uid, $password);
@@ -120,6 +130,7 @@ interface IUserManager {
* returns how many users per backend exist (if supported by backend)
*
* @return array an array of backend class as key and count number as value
+ * @since 8.0.0
*/
public function countUsers();
}