Development:API Аутентификации: различия между версиями
| (не показаны 3 промежуточные версии этого же участника) | |||
| Строка 27: | Строка 27: | ||
Проверяет существует ли пользователь с таким именем. | Проверяет существует ли пользователь с таким именем. | ||
''Возвращает:'' ''true'' если существует, иначе ''false'' | ''Возвращает:'' ''true'' если существует, иначе ''false''. | ||
'''<code>auth_user_create ($userobject,$plainpass)</code>''' | '''<code>auth_user_create ($userobject,$plainpass)</code>''' | ||
| Строка 33: | Строка 34: | ||
''Возвращает:'' ''true'' если создание прошло успешно в противном случае ''false''. | ''Возвращает:'' ''true'' если создание прошло успешно в противном случае ''false''. | ||
'''<code>auth_user_activate ($username)</code>''' | '''<code>auth_user_activate ($username)</code>''' | ||
| Строка 38: | Строка 40: | ||
''Возвращает:'' ''true'' если создание прошло успешно в противном случае ''false''. | ''Возвращает:'' ''true'' если создание прошло успешно в противном случае ''false''. | ||
'''<code>auth_user_disable ($username)</code>''' | '''<code>auth_user_disable ($username)</code>''' | ||
| Строка 47: | Строка 50: | ||
'''<code>auth_get_userlist ()</code>''' | '''<code>auth_get_userlist ()</code>''' | ||
Запрашивает список пользователей. | |||
''Возвращает:'' | |||
''Возвращает:'' Все имена пользователей в виде массива или ''false'' в случае ошибки. | |||
'''<code>auth_get_users($filter='*')</code>''' | '''<code>auth_get_users($filter='*')</code>''' | ||
Запрашивает информацию об определенных пользователях в виде объектов. | |||
''Возвращает:'' | |||
''Возвращает:'' Массив объектов пользователей. | |||
<br clear="both" /> | <br clear="both" /> | ||
{{tiny-subst}} | |||
[[Category:Разработчику]] | [[Category:Разработчику]] | ||
[[en:Development:Authentication_API]] | [[en:Development:Authentication_API]] | ||
Текущая версия от 18:21, 21 апреля 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='*')
Запрашивает информацию об определенных пользователях в виде объектов.
Возвращает: Массив объектов пользователей.
