開発:認証API

認証APIからリダイレクト)

認証APIは認証プラグインに対するMoodleのインターフェース機能を記述します。 (このページは不完全です。phpdocがauth / ldap / lib.phpにコメントした後に更新します)

ほとんどの機能はldap-authenticationモジュールによるもので 、他のモジュールには実装されていません(まだ?)。同じ機能をサポートするために他のモジュールを拡張するか、あなた自身のモジュールを転がしてください。

新機能のいくつかはまだテストされており、まだここでは文書化されていません。

認証機能

外部データベースでユーザーを認証するための基本機能


必須:

 auth_user_login($ユーザー名、$パスワード) 

username、passwordをuserdatabaseで認証します。

返品
ユーザー名とパスワードが機能する場合はtrue、そうでない場合はfalse


オプション:

以下の機能はオプションですが、もし存在すればそれらはMoodleでモジュールのユーザビリティを拡張します。


 auth_get_userinfo($ username) 

データベースから他のユーザー情報を照会します。

返品
配列内のユーザー情報(name => value、...)、またはエラーの場合はfalse 。関数はupdate-flagsを尊重します。
 $ CFG-> auth_user_(属性)_updatelocal 
が存在する場合、flagがtrueの場合にのみ値を返します。

コース作成

 auth_iscreator($ username) 

ユーザーがコースを作成する権限を持っている必要があります

返品
本当の
ユーザーがソースを作成する権限を持っている場合はそれ以外の場合はfalse

ユーザー作成

Moodleから外部データベースへのユーザ作成、有効化および無効化を可能にする機能


 auth_user_exists($ username) 

指定されたユーザー名が外部データベースに存在するかどうかを確認します。

返品
本当の
与えられたusernnameが存在するかfalseの場合


 auth_user_create($ userobject、$ plainpass) 

外部データベースに新しいユーザーを作成します。電子メールで確認されるまで、ユーザーは非アクティブな段階で作成されます。

返品
本当の
それ以外の場合は成功した場合


 auth_user_activate($ username) 

Eメールアドレスが確認された後に新しいユーザーをアクティブにする

返品
本当の
それ以外の場合は成功した場合


 auth_user_disable($ username) 

外部データベースのユーザーを無効にします。

返品
本当の
それ以外の場合は成功した場合

ユーザー情報と同期

 auth_get_userlist() 

外部データベース内のユーザー名のリストを取得します。

返品
配列内のすべてのユーザー名または
エラー時


 auth_get_users($ filter = '*') 

外部DBからすべてのUSEROBJECTSを取得します。

返品
外部データベースからのオブジェクトとしての全ユーザの配列


関連情報