Development:API Аутентификации: различия между версиями

Материал из MoodleDocs
Перейти к:навигация, поиск
Строка 21: Строка 21:


=== Создание пользователей ===
=== Создание пользователей ===
Functions that enable user creation, activation and deactivation from moodle to external database
 
Функции для создания, активирования и деактивирования пользователей.


'''<code>auth_user_exists ($username)</code>'''
'''<code>auth_user_exists ($username)</code>'''
Checks if given username exists on external db
Проверяет существует ли пользователь с таким именем.
''Возвращает:'' true if given usernname exist or false
 
''Возвращает:'' ''true'' если существует, иначе ''false''


'''<code>auth_user_create ($userobject,$plainpass)</code>'''
'''<code>auth_user_create ($userobject,$plainpass)</code>'''
Creates new user to external db. User should be created in inactive stage until confirmed by email.
Создает нового пользователя, который не активирован.
''Возвращает:'' True on success otherwise false
 
''Возвращает:'' ''true'' если создание прошло успешно в противном случае ''false''.


'''<code>auth_user_activate ($username)</code>'''
'''<code>auth_user_activate ($username)</code>'''
activate new user after email-address is confirmed
Активирует пользователя в случае подтвержденного e-mail адреса.
''Возвращает:'' True on success otherwise false
 
''Возвращает:'' ''true'' если создание прошло успешно в противном случае ''false''.


'''<code>auth_user_disable ($username)</code>'''
'''<code>auth_user_disable ($username)</code>'''
deactivate user in external db.
Деактивирует пользователя.
''Возвращает:'' True on success otherwise false
 
''Возвращает:'' ''true'' если создание прошло успешно в противном случае ''false''.


=== Информация и синхронизация ===
=== Информация и синхронизация ===

Версия от 20:49, 10 апреля 2010

Функции аутентификации Moodle

Обязательные:

auth_user_login ($username, $password) Аутентифицирует пользователя с именем $username и паролем $password.

Возвращает: true если аутентификация для пользователя возможна и false если нет.

Опциональные:

auth_get_userinfo($username) Запрашивает информацию из БД

Возвращает: Информацию о пользователе в виде массива (name => value, ...) или false в случае ошибки чтения. Функция проверяет флаги, поэтому если флаг $CFG->auth_user_(atribute)_updatelocal присутствует, функция сработает только при значении флага true.

Создатели курсов

auth_iscreator($username) Проверяет может ли пользователь создавать курсы

Возвращает: true если пользователь может создавать курсы, иначе false

Создание пользователей

Функции для создания, активирования и деактивирования пользователей.

auth_user_exists ($username) Проверяет существует ли пользователь с таким именем.

Возвращает: true если существует, иначе false

auth_user_create ($userobject,$plainpass) Создает нового пользователя, который не активирован.

Возвращает: true если создание прошло успешно в противном случае false.

auth_user_activate ($username) Активирует пользователя в случае подтвержденного e-mail адреса.

Возвращает: true если создание прошло успешно в противном случае false.

auth_user_disable ($username) Деактивирует пользователя.

Возвращает: true если создание прошло успешно в противном случае false.

Информация и синхронизация

auth_get_userlist () Get list of usernames in external db. Возвращает: All usernames in array or false on error.

auth_get_users($filter='*') Get ALL USEROBJECTS FROM EXTERNAL DB. Возвращает: Array of all users as objects from external db