Олег Давидович: 1 версия импортирована

2024-10-21T08:50:59Z

1 версия импортирована

← Предыдущая версия	Версия от 08:50, 21 октября 2024
(нет различий)

1>Wmasterj в 07:18, 12 апреля 2011

2011-04-12T07:18:49Z

Новая страница

The '''Authentication API''' describes Moodle's interface functions to authentication plugins.
(This page is incomplete , I'll update it after I have phpdoc commented auth/ldap/lib.php)

Most of the functions are from the [[LDAP_authentication|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 functions==

Basic functions to authenticate users with external db

===Mandatory:===

<code>auth_user_login ($username, $password)</code>

Authenticate username, password with userdatabase.

;Returns:true if the username and password work and false if they don't

===Optional:===

The following functions are optional , but if present they extend module usability with Moodle.

<code>auth_get_userinfo($username)</code>

Query other userinformation from database.

;Returns:User information in array ''(name => value, ...)'' or ''false'' in case of error. Function honors update-flags so if <code>$CFG->auth_user_(atribute)_updatelocal</code> is present, it will return value only if flag is true.

===COURSE CREATING===

<code>auth_iscreator($username)</code>

should user have rights to create courses

;Returns:<code>true</code> if user has rights to create cources otherwise false

===USER CREATION===

Functions that enable user creation, activation and deactivation from moodle to external database

<code>auth_user_exists ($username)</code>

Checks if given username exists on external db

;Returns:<code>true</code> if given usernname exist or false

<code>auth_user_create ($userobject,$plainpass)</code>

Creates new user to external db. User should be created in inactive stage until confirmed by email.

;Returns:<code>true</code> on success otherwise <code>false</code>

<code>auth_user_activate ($username)</code>

activate new user after email-address is confirmed

;Returns:<code>true</code> on success otherwise <code>false</code>

<code>auth_user_disable ($username)</code>

deactivate user in external db.

;Returns:<code>true</code> on success otherwise <code>false</code>

=== USER INFORMATION AND SYNCRONIZATION ===

<code>auth_get_userlist ()</code>

Get list of usernames in external db.

;Returns:All usernames in array or <code>false</code> on error.

<code>auth_get_users($filter='*')</code>

Get ALL USEROBJECTS FROM EXTERNAL DB.

;Returns:Array of all users as objects from external db

== See also ==

* [[Development:Authentication plugins]]
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=102070 Overview of entire authentication code flow] forum discussion
* Using Moodle [http://moodle.org/mod/forum/view.php?id=42 User authentication forum]
* Moodle Docs [[Manage authentication]]
* [[Authentication FAQ]]

[[Category:Developer|Authentication API]]
[[Category:Authentication]]

[[ru:Development:API Аутентификации]]

Development:Authentication API - История изменений

Олег Давидович: 1 версия импортирована

1>Wmasterj в 07:18, 12 апреля 2011