From: moodler <moodler>
Date: Fri, 24 Sep 2004 04:45:19 +0000 (+0000)
Subject: Moved info into README
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=5b06bef18cd7d7a5f44f3789cc892522c7a897b2;p=moodle.git

Moved info into README
---

diff --git a/auth/README b/auth/README
index 2eda1f668f..fb71829ad7 100644
--- a/auth/README
+++ b/auth/README
@@ -82,3 +82,109 @@ db  - Uses an external database to check username/password
     - if correct, user is logged in
     - if the username doesn't already exist then
       a new Moodle account is created
+
+
+------------------------------------------------------------------------------------
+
+Authentication API
+
+This file describes Moodle interface functions to authentication modules.
+
+Most of functions are from ldap-authentication module and are not implemented (yet?)
+on other modules. Please feel free to extend other modules to support same features
+or roll your own module.
+
+Some of new function are still tested and are not documented here yet.
+
+
+
+AUTHENTICATION
+Basic fuctions to authenticate users with external db
+
+Mandatory: 
+    
+    auth_user_login ($username, $password) 
+    
+    Authenticate username, password with userdatabase.
+
+    Returns:
+    true if the username and password work
+    and false if they don't
+
+Optional:
+    
+    auth_get_userinfo($username)
+    
+    Query other userinformation from database.
+
+    Returns:
+    Userinformation in array ( name => value, .... 
+    or false in case of error
+
+COURSE CREATING
+
+    auth_iscreator($username)
+
+    should user have rights to create courses
+
+    Returns:
+    True if user have rights to crete cources otherwise false
+
+
+USER CREATION
+
+Functions that enable usercreation, activation and deactivation
+from moodle to external database
+  
+  
+    auth_user_exists ($username) 
+   
+    Checks if given username exist on external db
+
+    Returns:
+    true if given usernname exist or false
+ 
+    auth_user_create ($userobject,$plainpass) 
+ 
+    Creates new user to external db. User should be created
+    in inactive stage until confirmed by email.
+
+    Returns:
+    True on success otherwise false
+
+
+    auth_user_activate ($username) 
+    
+    activate new user after email-address is confirmed
+
+    Returns:
+    True on success otherwise false
+
+
+    auth_user_disable ($username) {
+    
+    deactivate  user in external db.
+    
+    Returns:
+    True on success otherwise false
+
+
+
+USER INFORMATION AND SYNCRONIZATION
+
+    auth_get_userlist () 
+
+    Get list of usernames in external db.
+
+    Returns:
+    All usernames in array or false on error.
+    
+
+    auth_get_users($filter='*') 
+    
+    Get ALL USEROBJECTS FROM EXTERNAL DB.
+
+    Returns:
+    Array of all users as objects from external db
+
+
diff --git a/auth/authhentication_interface.txt b/auth/authhentication_interface.txt
deleted file mode 100644
index 2c16f2553a..0000000000
--- a/auth/authhentication_interface.txt
+++ /dev/null
@@ -1,109 +0,0 @@
-
-
-Moodles authentication interface 
-
-This file describes moodles interfacefunctions to authentication modules.
-
-Most of functions are from ldap-authentication module and are not implemented (yet?)
-on other modules. Please feel free to extend other modules to support same features
-or roll your own module.
-
-Some of new function are still tested and are not documented here yet.
-
-
-
-AUTHENTICATION
-Basic fuctions to authenticate users with external db
-
-Mandatory: 
-    
-    auth_user_login ($username, $password) 
-    
-    Authenticate username, password with userdatabase.
-
-    Returns:
-    true if the username and password work
-    and false if they don't
-
-Optional:
-    
-    auth_get_userinfo($username)
-    
-    Query other userinformation from database.
-
-    Returns:
-    Userinformation in array ( name => value, .... 
-    or false in case of error
-
-COURSE CREATING
-
-    auth_iscreator($username)
-
-    should user have rights to create courses
-
-    Returns:
-    True if user have rights to crete cources otherwise false
-
-
-USER CREATION
-
-Functions that enable usercreation, activation and deactivation
-from moodle to external database
-  
-  
-    auth_user_exists ($username) 
-   
-    Checks if given username exist on external db
-
-    Returns:
-    true if given usernname exist or false
- 
-    auth_user_create ($userobject,$plainpass) 
- 
-    Creates new user to external db. User should be created
-    in inactive stage until confirmed by email.
-
-    Returns:
-    True on success otherwise false
-
-
-    auth_user_activate ($username) 
-    
-    activate new user after email-address is confirmed
-
-    Returns:
-    True on success otherwise false
-
-
-    auth_user_disable ($username) {
-    
-    deactivate  user in external db.
-    
-    Returns:
-    True on success otherwise false
-
-
-
-USER INFORMATION AND SYNCRONIZATION
-
-    auth_get_userlist () 
-
-    Get list of usernames in external db.
-
-    Returns:
-    All usernames in array or false on error.
-    
-
-    auth_get_users($filter='*') 
-    
-    Get ALL USEROBJECTS FROM EXTERNAL DB.
-
-    Returns:
-    Array of all users as objects from external db
-
-
-
-  
-
-
-