update documentation of oc_user::checkpassword

diff --git a/lib/user.php b/lib/user.php
index e409fe4e501865806029b2cc99e4658b0372c3dc..056d1307543c408093541138ed9e1f3d00eb2202 100644 (file)
--- a/lib/user.php
+++ b/lib/user.php
@@ -304,9 +304,10 @@ class OC_User {
         * @brief Check if the password is correct
         * @param $uid The username
         * @param $password The password
-        * @returns true/false
+        * @returns string
         *
         * Check if the password is correct without logging in the user
+        * returns the user id or false
         */
        public static function checkPassword( $uid, $password ){
                foreach(self::$_usedBackends as $backend){

diff --git a/lib/user/database.php b/lib/user/database.php
index 4738a8948cb65fd28a0580e19b6535cf9b84e6f7..894ccffb79107c482751818bf859c2bc06e4db90 100644 (file)
--- a/lib/user/database.php
+++ b/lib/user/database.php
@@ -117,9 +117,10 @@ class OC_User_Database extends OC_User_Backend {
         * @brief Check if the password is correct
         * @param $uid The username
         * @param $password The password
-        * @returns true/false
+        * @returns string
         *
         * Check if the password is correct without logging in the user
+        * returns the user id or false
         */
        public function checkPassword( $uid, $password ){
                $query = OC_DB::prepare( "SELECT uid, password FROM *PREFIX*users WHERE uid = ?" );

diff --git a/lib/user/dummy.php b/lib/user/dummy.php
index cfc96c5c52de0dbe074dbcf993487e5d79a713dc..03d5c3256dace86d4a8093b4f97523f464b6ae37 100644 (file)
--- a/lib/user/dummy.php
+++ b/lib/user/dummy.php
@@ -81,9 +81,10 @@ class OC_User_Dummy extends OC_User_Backend {
                * @brief Check if the password is correct
                * @param $uid The username
                * @param $password The password
-               * @returns true/false
+               * @returns string
                *
                * Check if the password is correct without logging in the user
+               * returns the user id or false
                */
        public function checkPassword($uid, $password){
                if(isset($this->users[$uid])){

diff --git a/lib/user/example.php b/lib/user/example.php
index 7481014de77c5fb54ff8183abfdd529886e10573..b6a2091b68583291d1cb57335861e97116a70ac2 100644 (file)
--- a/lib/user/example.php
+++ b/lib/user/example.php
@@ -66,9 +66,10 @@ abstract class OC_User_Example extends OC_User_Backend {
                * @brief Check if the password is correct
                * @param $uid The username
                * @param $password The password
-               * @returns true/false
+               * @returns string
                *
                * Check if the password is correct without logging in the user
+               * returns the user id or false
                */
        public function checkPassword($uid, $password){
                return OC_USER_BACKEND_NOT_IMPLEMENTED;