Enrolment API

由于Moodle 2.0有一个用户注册的新概念，它们完全独立于角色和功能。能力通常与注册状态结合使用。

什么是注册？

登记的用户可以完全参加一门课程。活跃用户注册允许用户输入课程。只有注册的用户可能是小组成员。成绩仅存储在注册用户的名下。

Unenrolment

清除选课（注册）是不可逆转的操作，清除用户的参与信息。只有在您不需要保留包括用户成绩在内的所有课程参与信息的情况下，完全取消注册才是合适的。

注册状态

而不是完全不注册，通常只是暂停用户注册。如果还有其他途径进入课程（如访客访问），建议同时删除用户角色。

活动参与

活动开发者决定模块的注册相关行为。

有一些一般的指导方针：

• 只有拥有有效注册的用户才能收到通知。
• 活动应显示注册用户作为参与者的一些功能。
• 默认情况下，只有具有活动注册的用户才能显示在报告中。
• 应该有显示所有注册用户的选项，包括暂停注册。
• 出于性能原因，不可见的参与数据应该在未注册的情况下被清除
• 其他参与者可见的贡献应在取消注册之后保存（如论坛帖子）。

API函数

enrol_send_welcome_email_options（）

有些注册方法支持向用户发送欢迎邮件。此方法返回用户注册课程时发送欢迎电子邮件的所有可能选项的列表，并且每个选项都具有在enrollib.php上定义的相应常量：

define （'ENROL_DO_NOT_SEND_EMAIL' ， 0 ）;  //不要发送欢迎邮件
define （'ENROL_SEND_EMAIL_FROM_COURSE_CONTACT' ， 1 ）;  //从课程联系人发送欢迎电子邮件。
define （'ENROL_SEND_EMAIL_FROM_KEY_HOLDER' ， 2 ）;  //从课程密钥持有者发送欢迎电子邮件。
define （'ENROL_SEND_EMAIL_FROM_NOREPLY' ， 3 ）;  //从没有回复发送欢迎电子邮件。

主要想法是使发送电子邮件选项在支持此功能的注册方法中保持一致。看下面的例子：

$sendoptions = enrol_send_welcome_email_options();
print_object($sendoptions);

上面的例子会输出：

Array
(
       [1] => 'No'
       [2] => 'From the course contact'
       [3] => 'From the key holder'
       [4] => 'From the no-reply address'
)

is_enrolled（）

用户是否参加课程？对于学生和教师，返回true，对于管理员和其他管理者是false。用户注册可以是活动的，也可以是暂停的，被暂停的用户不能进入课程（除非允许某种访客访问）或具有moodle / course：view功能，通常隐藏在UI中。

函数 is_enrolled （ context $ context ， $ user  =  null ， $ withcapability  =  '' ， $ onlyactive  =  false ）

很好的例子是选择模块，每个参与者有一个插槽，没有注册的人不被允许投票

is_enrolled（$ context，$ USER，'mod / choice：选择'）

。另一个例子是用户需要注册并有能力提交分配的分配

is_enrolled（$ this-> context，$ USER，'mod / assignment：submit'）

。

get_enrolled_users（）

有时你需要知道可以参与某些活动的用户列表。

功能 get_enrolled_sql （上下文$上下文， $ withcapability  =  '' ， $ GROUPID  =  0 ， $ onlyactive  =  假）
函数 get_enrolled_users （上下文$上下文， $ withcapability  =  '' ， $ GROUPID  =  0 ， $ userfields  =  'U。*' ， $ orderby  =  '' ， $ limitfrom  =  0 ， $ limitnum  =  0 ）
函数 count_enrolled_users （ context $ context ， $ withcapability  =  '' ， $ groupid  =  0 ）

比如你想知道谁现在可以登顶任务：

$ submissioncandidates  = get_enrolled_users （$ modcontext ， 'mod / assignment：submit' ）;

分配模块需要为注册的所有用户保存数据，包括具有暂停注册且没有任何角色的用户。当用户完全取消注册时，模块开发人员可以决定清除所有的用户数据。

从get_enrolled_sql（）中选择SQL常常用于性能方面的原因 - 您可以在连接中使用它，以仅为注册用户获取特定信息。