* Add exception hooks to output pretty messages

[lhc/web/wiklou.git] / includes / AuthPlugin.php

diff --git a/includes/AuthPlugin.php b/includes/AuthPlugin.php
index cf06e42..a3d0837 100644 (file)
--- a/includes/AuthPlugin.php
+++ b/includes/AuthPlugin.php
@@ -1,6 +1,5 @@
 <?php
 /**
- * @package MediaWiki
  */
 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
 # http://www.mediawiki.org/
@@ -33,7 +32,6 @@
  * This interface is new, and might change a bit before 1.4.0 final is
  * done...
  *
- * @package MediaWiki
  */
 class AuthPlugin {
        /**
@@ -146,6 +144,10 @@ class AuthPlugin {
 
        /**
         * Set the given password in the authentication database.
+        * As a special case, the password may be set to null to request
+        * locking the password to an unusable value, with the expectation
+        * that it will be set later through a mail reset or other method.
+        *
         * Return true if successful.
         *
         * @param $user User object.
@@ -183,12 +185,14 @@ class AuthPlugin {
         * Add a user to the external authentication database.
         * Return true if successful.
         *
-        * @param User $user
+        * @param User $user - only the name should be assumed valid at this point
         * @param string $password
+        * @param string $email
+        * @param string $realname
         * @return bool
         * @public
         */
-       function addUser( $user, $password ) {
+       function addUser( $user, $password, $email='', $realname='' ) {
                return true;
        }
 
@@ -206,6 +210,18 @@ class AuthPlugin {
                return false;
        }
 
+       /**
+        * Check if a user should authenticate locally if the global authentication fails.
+        * If either this or strict() returns true, local authentication is not used.
+        *
+        * @param $username String: username.
+        * @return bool
+        * @public
+        */
+       function strictUserAuth( $username ) {
+               return false;
+       }
+
        /**
         * When creating a user account, optionally fill in preferences and such.
         * For instance, you might pull the email address or real name from the
@@ -215,9 +231,10 @@ class AuthPlugin {
         * forget the & on your function declaration.
         *
         * @param $user User object.
+        * @param $autocreate bool True if user is being autocreated on login
         * @public
         */
-       function initUser( &$user ) {
+       function initUser( $user, $autocreate=false ) {
                # Override this to do something.
        }
 
@@ -230,4 +247,4 @@ class AuthPlugin {
        }
 }
 
-?>
+