Add a way for packagers to override some installation details

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

diff --git a/includes/AuthPlugin.php b/includes/AuthPlugin.php
index 7dc9925..e550473 100644 (file)
--- a/includes/AuthPlugin.php
+++ b/includes/AuthPlugin.php
@@ -67,7 +67,7 @@ class AuthPlugin {
         * Modify options in the login template.
         *
         * @param $template UserLoginTemplate object.
-        * @param $type String 'signup' or 'login'.
+        * @param $type String 'signup' or 'login'. Added in 1.16.
         */
        public function modifyUITemplate( &$template, &$type ) {
                # Override this!
@@ -103,6 +103,7 @@ class AuthPlugin {
         * forget the & on your function declaration.
         *
         * @param $user User object
+        * @return bool
         */
        public function updateUser( &$user ) {
                # Override this and do something
@@ -131,6 +132,8 @@ class AuthPlugin {
         * and use the same keys. 'Realname' 'Emailaddress' and 'Nickname'
         * all reference this.
         *
+        * @param $prop string
+        *
         * @return Boolean
         */
        public function allowPropChange( $prop = '' ) {
@@ -245,6 +248,8 @@ class AuthPlugin {
        /**
         * If you want to munge the case of an account name before the final
         * check, now is your chance.
+        * @param $username string
+        * @return string
         */
        public function getCanonicalName( $username ) {
                return $username;
@@ -254,10 +259,21 @@ class AuthPlugin {
         * Get an instance of a User object
         *
         * @param $user User
+        *
+        * @return AuthPluginUser
         */
        public function getUserInstance( User &$user ) {
                return new AuthPluginUser( $user );
        }
+
+       /**
+        * Get a list of domains (in HTMLForm options format) used.
+        *
+        * @return array
+        */
+       public function domainList() {
+               return array();
+       }
 }
 
 class AuthPluginUser {