Auth: Documentation update to reflect changes in signature of user_update_password...

diff --git a/auth/README b/auth/README
index 3caa42f3b0ff05f5ccbaa792e07b513b42d495f8..72944542ee71c8c2c992c197122b49eccca5170c 100644 (file)
--- a/auth/README
+++ b/auth/README
@@ -177,8 +177,10 @@ change_password_url()
    Returns the URL for changing the users' passwords, or false if the default
    URL can be used.
 
-user_update_password($username, $newpassword)
-   Updates the user's password.
+user_update_password($user, $newpassword)
+   Updates the user's password. In previous versions of Moodle, the function
+   auth_user_update_password accepted a username as the first parameter. The
+   revised function expects a user object.
 
 config_form()
    Displays the configuration form for the auth plugin, for use in the admin

diff --git a/auth/db/auth.php b/auth/db/auth.php
index 1bd81d96feb5fc50ce04a1d32bd41cbf4916e71d..47ee43febb996c79bbd165d15a3dbc1ed556b8bf 100644 (file)
--- a/auth/db/auth.php
+++ b/auth/db/auth.php
@@ -153,6 +153,13 @@ class auth_plugin_db {
     }
 
 
+    /**
+     * Change a user's password
+     *
+     * @param  object  $user         The user to update
+     * @param  string  $newpassword  The new password
+     * @return bool                  True on success
+     */
     function user_update_password($user, $newpassword) {
 
         global $CFG;

diff --git a/auth/email/auth.php b/auth/email/auth.php
index f91eb35ad5c24a6399c6d51d4024a999be919356..78d3882d9d20e168d576be8b698e2f00c3f5da51 100644 (file)
--- a/auth/email/auth.php
+++ b/auth/email/auth.php
@@ -58,13 +58,13 @@ class auth_plugin_email {
         return false;
     }
 
-    /*
+    /**
      * Updates the user's password.
      *
      * called when the user password is updated.
      *
-     * @param mixed $username    Username
-     * @param mixed $newpassword Plaintext password
+     * @param  object  $user        User
+     * @param  string  $newpassword Plaintext password
      * @return boolean result
      *
      */

diff --git a/auth/ldap/auth.php b/auth/ldap/auth.php
index f2f7e9c791d2f15989f086bb1a2bb0d3e4f88794..4587d8840922053ab2355c1d5afc89c99b5e42ea 100644 (file)
--- a/auth/ldap/auth.php
+++ b/auth/ldap/auth.php
@@ -954,7 +954,7 @@ class auth_plugin_ldap {
 
     }
 
-    /*
+    /**
      * changes userpassword in external db
      *
      * called when the user password is updated.
@@ -962,7 +962,6 @@ class auth_plugin_ldap {
      *
      * @param  object  $user        User table object
      * @param  mixed   $newpassword Plaintext password
-     * @param  mixed   $oldpassword Plaintext old password to bind ldap with
      * @return boolean result
      *
      */

diff --git a/auth/manual/auth.php b/auth/manual/auth.php
index 25b862392b598c359c2db1808e0f8e3eb036f488..82dcd0f66b7412419c527c5689d6105efda418ac 100644 (file)
--- a/auth/manual/auth.php
+++ b/auth/manual/auth.php
@@ -50,13 +50,13 @@ class auth_plugin_manual
         return false;
     }
 
-    /*
+    /**
      * Updates the user's password.
      *
      * called when the user password is updated.
      *
-     * @param mixed $username    Username
-     * @param mixed $newpassword Plaintext password
+     * @param  object  $user        User
+     * @param  string  $newpassword Plaintext password
      * @return boolean result
      *
      */

diff --git a/auth/none/auth.php b/auth/none/auth.php
index b41fea5e90328645af58f499d0b107426857a723..00d7976a72115a0919290923086ac349de94527e 100644 (file)
--- a/auth/none/auth.php
+++ b/auth/none/auth.php
@@ -51,13 +51,13 @@ class auth_plugin_none {
         return false;
     }
 
-    /*
+    /**
      * Updates the user's password.
      *
      * called when the user password is updated.
      *
-     * @param mixed $username    Username
-     * @param mixed $newpassword Plaintext password
+     * @param  object  $user        User
+     * @param  string  $newpassword Plaintext password
      * @return boolean result
      *
      */