From: Thomas Mueller <thomas.mueller@tmit.eu>
Date: Fri, 31 May 2013 22:49:06 +0000 (+0200)
Subject: adding PHPDoc comment to getManager()
X-Git-Tag: v6.0.0alpha2~688^2~7
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=3e00a3603cadf4e9e4b3c87bba0ef604077146fd;p=nextcloud-server.git

adding PHPDoc comment to getManager()
adding PHPDoc comment for $user within the hooks callbacks
fixing PHPDoc comment on isLoggedIn()
---

diff --git a/lib/user.php b/lib/user.php
index 5f8a4cbfce2..a8b642a1630 100644
--- a/lib/user.php
+++ b/lib/user.php
@@ -47,24 +47,30 @@ class OC_User {
 				\OC_Hook::emit('OC_User', 'pre_createUser', array('run' => true, 'uid' => $uid, 'password' => $password));
 			});
 			self::$userSession->listen('\OC\User', 'postCreateUser', function ($user, $password) {
+				/** @var $user \OC\User\User */
 				\OC_Hook::emit('OC_User', 'post_createUser', array('uid' => $user->getUID(), 'password' => $password));
 			});
 			self::$userSession->listen('\OC\User', 'preDelete', function ($user) {
+				/** @var $user \OC\User\User */
 				\OC_Hook::emit('OC_User', 'pre_deleteUser', array('run' => true, 'uid' => $user->getUID()));
 			});
 			self::$userSession->listen('\OC\User', 'postDelete', function ($user) {
+				/** @var $user \OC\User\User */
 				\OC_Hook::emit('OC_User', 'post_deleteUser', array('uid' => $user->getUID()));
 			});
 			self::$userSession->listen('\OC\User', 'preSetPassword', function ($user, $password, $recoveryPassword) {
+				/** @var $user \OC\User\User */
 				OC_Hook::emit('OC_User', 'pre_setPassword', array('run' => true, 'uid' => $user->getUID(), 'password' => $password, 'recoveryPassword' => $recoveryPassword));
 			});
 			self::$userSession->listen('\OC\User', 'postSetPassword', function ($user, $password, $recoveryPassword) {
+				/** @var $user \OC\User\User */
 				OC_Hook::emit('OC_User', 'post_setPassword', array('run' => true, 'uid' => $user->getUID(), 'password' => $password, 'recoveryPassword' => $recoveryPassword));
 			});
 			self::$userSession->listen('\OC\User', 'preLogin', function ($uid, $password) {
 				\OC_Hook::emit('OC_User', 'pre_login', array('run' => true, 'uid' => $uid, 'password' => $password));
 			});
 			self::$userSession->listen('\OC\User', 'postLogin', function ($user, $password) {
+				/** @var $user \OC\User\User */
 				\OC_Hook::emit('OC_User', 'post_login', array('run' => true, 'uid' => $user->getUID(), 'password' => $password));
 			});
 			self::$userSession->listen('\OC\User', 'logout', function () {
@@ -74,6 +80,9 @@ class OC_User {
 		return self::$userSession;
 	}
 
+	/**
+	 * @return \OC\User\Manager
+	 */
 	private static function getManager() {
 		return self::getUserSession()->getManager();
 	}
@@ -292,7 +301,7 @@ class OC_User {
 
 	/**
 	 * @brief Check if the user is logged in
-	 * @returns true/false
+	 * @returns bool
 	 *
 	 * Checks if the user is logged in
 	 */