Merge "jquery.makeCollapsible: fix jQuery memory leak"
[lhc/web/wiklou.git] / includes / AuthPlugin.php
index e550473..a465817 100644 (file)
  * someone logs in who can be authenticated externally.
  */
 class AuthPlugin {
+
+       /**
+        * @var string
+        */
+       protected $domain;
+
        /**
         * Check whether there exists a user account with the given name.
         * The name will be normalized to MediaWiki's requirements, so
         * you might need to munge it (for instance, for lowercase initial
         * letters).
         *
-        * @param $username String: username.
+        * @param string $username username.
         * @return bool
         */
        public function userExists( $username ) {
@@ -54,8 +60,8 @@ class AuthPlugin {
         * you might need to munge it (for instance, for lowercase initial
         * letters).
         *
-        * @param $username String: username.
-        * @param $password String: user password.
+        * @param string $username username.
+        * @param string $password user password.
         * @return bool
         */
        public function authenticate( $username, $password ) {
@@ -67,7 +73,7 @@ class AuthPlugin {
         * Modify options in the login template.
         *
         * @param $template UserLoginTemplate object.
-        * @param $type String 'signup' or 'login'. Added in 1.16.
+        * @param string $type 'signup' or 'login'. Added in 1.16.
         */
        public function modifyUITemplate( &$template, &$type ) {
                # Override this!
@@ -77,16 +83,29 @@ class AuthPlugin {
        /**
         * Set the domain this plugin is supposed to use when authenticating.
         *
-        * @param $domain String: authentication domain.
+        * @param string $domain authentication domain.
         */
        public function setDomain( $domain ) {
                $this->domain = $domain;
        }
 
+       /**
+        * Get the user's domain
+        *
+        * @return string
+        */
+       public function getDomain() {
+               if ( isset( $this->domain ) ) {
+                       return $this->domain;
+               } else {
+                       return 'invaliddomain';
+               }
+       }
+
        /**
         * Check to see if the specific domain is a valid domain.
         *
-        * @param $domain String: authentication domain.
+        * @param string $domain authentication domain.
         * @return bool
         */
        public function validDomain( $domain ) {
@@ -157,6 +176,15 @@ class AuthPlugin {
                return true;
        }
 
+       /**
+        * Should MediaWiki store passwords in its local database?
+        *
+        * @return bool
+        */
+       public function allowSetLocalPassword() {
+               return true;
+       }
+
        /**
         * Set the given password in the authentication database.
         * As a special case, the password may be set to null to request
@@ -166,7 +194,7 @@ class AuthPlugin {
         * Return true if successful.
         *
         * @param $user User object.
-        * @param $password String: password.
+        * @param string $password password.
         * @return bool
         */
        public function setPassword( $user, $password ) {
@@ -223,7 +251,7 @@ class AuthPlugin {
         * 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.
+        * @param string $username username.
         * @return Boolean
         */
        public function strictUserAuth( $username ) {