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

Материал из MoodleDocs
Перейти к:навигация, поиск
Строка 57: Строка 57:
'''<code>auth_get_users($filter='*')</code>'''
'''<code>auth_get_users($filter='*')</code>'''
Запрашивает информацию об определенных пользователях в виде объектов.
Запрашивает информацию об определенных пользователях в виде объектов.
''Возвращает:'' Массив объектов пользователей.
''Возвращает:'' Массив объектов пользователей.



Версия от 20:53, 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 () Запрашивает список пользователей.

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


auth_get_users($filter='*') Запрашивает информацию об определенных пользователях в виде объектов.

Возвращает: Массив объектов пользователей.