3 // This file is part of Moodle - http://moodle.org/
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
19 * This file contains the course_enrolment_manager class which is used to interface
20 * with the functions that exist in enrollib.php in relation to a single course.
24 * @copyright 2010 Sam Hemelryk
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28 defined('MOODLE_INTERNAL') ||
die();
31 * This class provides a targeted tied together means of interfacing the enrolment
32 * tasks together with a course.
34 * It is provided as a convenience more than anything else.
36 * @copyright 2010 Sam Hemelryk
37 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39 class course_enrolment_manager
{
47 * The course we are managing enrolments for
50 protected $course = null;
52 * Limits the focus of the manager to one enrolment plugin instance
55 protected $instancefilter = null;
58 * The total number of users enrolled in the course
59 * Populated by course_enrolment_manager::get_total_users
62 protected $totalusers = null;
64 * An array of users currently enrolled in the course
65 * Populated by course_enrolment_manager::get_users
68 protected $users = array();
71 * An array of users who have roles within this course but who have not
72 * been enrolled in the course
75 protected $otherusers = array();
78 * The total number of users who hold a role within the course but who
82 protected $totalotherusers = null;
85 * The current moodle_page object
88 protected $moodlepage = null;
91 * These variables are used to cache the information this class uses
92 * please never use these directly instead use their get_ counterparts.
96 private $_instancessql = null;
97 private $_instances = null;
98 private $_inames = null;
99 private $_plugins = null;
100 private $_roles = null;
101 private $_assignableroles = null;
102 private $_assignablerolesothers = null;
103 private $_groups = null;
107 * Constructs the course enrolment manager
109 * @param moodle_page $moodlepage
110 * @param stdClass $course
111 * @param string $instancefilter
113 public function __construct(moodle_page
$moodlepage, $course, $instancefilter = null) {
114 $this->moodlepage
= $moodlepage;
115 $this->context
= get_context_instance(CONTEXT_COURSE
, $course->id
);
116 $this->course
= $course;
117 $this->instancefilter
= $instancefilter;
121 * Returns the current moodle page
122 * @return moodle_page
124 public function get_moodlepage() {
125 return $this->moodlepage
;
129 * Returns the total number of enrolled users in the course.
131 * If a filter was specificed this will be the total number of users enrolled
132 * in this course by means of that instance.
134 * @global moodle_database $DB
137 public function get_total_users() {
139 if ($this->totalusers
=== null) {
140 list($instancessql, $params, $filter) = $this->get_instance_sql();
141 $sqltotal = "SELECT COUNT(DISTINCT u.id)
143 JOIN {user_enrolments} ue ON (ue.userid = u.id AND ue.enrolid $instancessql)
144 JOIN {enrol} e ON (e.id = ue.enrolid)";
145 $this->totalusers
= (int)$DB->count_records_sql($sqltotal, $params);
147 return $this->totalusers
;
151 * Returns the total number of enrolled users in the course.
153 * If a filter was specificed this will be the total number of users enrolled
154 * in this course by means of that instance.
156 * @global moodle_database $DB
159 public function get_total_other_users() {
161 if ($this->totalotherusers
=== null) {
162 list($ctxcondition, $params) = $DB->get_in_or_equal(get_parent_contexts($this->context
, true), SQL_PARAMS_NAMED
, 'ctx');
163 $params['courseid'] = $this->course
->id
;
164 $sql = "SELECT COUNT(DISTINCT u.id)
165 FROM {role_assignments} ra
166 JOIN {user} u ON u.id = ra.userid
167 JOIN {context} ctx ON ra.contextid = ctx.id
169 SELECT ue.id, ue.userid
170 FROM {user_enrolments} ue
171 LEFT JOIN {enrol} e ON e.id=ue.enrolid
172 WHERE e.courseid = :courseid
173 ) ue ON ue.userid=u.id
174 WHERE ctx.id $ctxcondition AND
176 $this->totalotherusers
= (int)$DB->count_records_sql($sql, $params);
178 return $this->totalotherusers
;
182 * Gets all of the users enrolled in this course.
184 * If a filter was specified this will be the users who were enrolled
185 * in this course by means of that instance.
187 * @global moodle_database $DB
188 * @param string $sort
189 * @param string $direction ASC or DESC
190 * @param int $page First page should be 0
191 * @param int $perpage Defaults to 25
194 public function get_users($sort, $direction='ASC', $page=0, $perpage=25) {
196 if ($direction !== 'ASC') {
199 $key = md5("$sort-$direction-$page-$perpage");
200 if (!array_key_exists($key, $this->users
)) {
201 list($instancessql, $params, $filter) = $this->get_instance_sql();
202 $extrafields = get_extra_user_fields($this->get_context());
203 $extrafields[] = 'lastaccess';
204 $ufields = user_picture
::fields('u', $extrafields);
205 $sql = "SELECT DISTINCT $ufields, ul.timeaccess AS lastseen
207 JOIN {user_enrolments} ue ON (ue.userid = u.id AND ue.enrolid $instancessql)
208 JOIN {enrol} e ON (e.id = ue.enrolid)
209 LEFT JOIN {user_lastaccess} ul ON (ul.courseid = e.courseid AND ul.userid = u.id)";
210 if ($sort === 'firstname') {
211 $sql .= " ORDER BY u.firstname $direction, u.lastname $direction";
212 } else if ($sort === 'lastname') {
213 $sql .= " ORDER BY u.lastname $direction, u.firstname $direction";
214 } else if ($sort === 'email') {
215 $sql .= " ORDER BY u.email $direction, u.lastname $direction, u.firstname $direction";
216 } else if ($sort === 'lastseen') {
217 $sql .= " ORDER BY ul.timeaccess $direction, u.lastname $direction, u.firstname $direction";
219 $this->users
[$key] = $DB->get_records_sql($sql, $params, $page*$perpage, $perpage);
221 return $this->users
[$key];
225 * Gets and array of other users.
227 * Other users are users who have been assigned roles or inherited roles
228 * within this course but who have not been enrolled in the course
230 * @global moodle_database $DB
231 * @param string $sort
232 * @param string $direction
234 * @param int $perpage
237 public function get_other_users($sort, $direction='ASC', $page=0, $perpage=25) {
239 if ($direction !== 'ASC') {
242 $key = md5("$sort-$direction-$page-$perpage");
243 if (!array_key_exists($key, $this->otherusers
)) {
244 list($ctxcondition, $params) = $DB->get_in_or_equal(get_parent_contexts($this->context
, true), SQL_PARAMS_NAMED
, 'ctx');
245 $params['courseid'] = $this->course
->id
;
246 $params['cid'] = $this->course
->id
;
247 $sql = "SELECT ra.id as raid, ra.contextid, ra.component, ctx.contextlevel, ra.roleid, u.*, ue.lastseen
248 FROM {role_assignments} ra
249 JOIN {user} u ON u.id = ra.userid
250 JOIN {context} ctx ON ra.contextid = ctx.id
252 SELECT ue.id, ue.userid, ul.timeaccess AS lastseen
253 FROM {user_enrolments} ue
254 LEFT JOIN {enrol} e ON e.id=ue.enrolid
255 LEFT JOIN {user_lastaccess} ul ON (ul.courseid = e.courseid AND ul.userid = ue.userid)
256 WHERE e.courseid = :courseid
257 ) ue ON ue.userid=u.id
258 WHERE ctx.id $ctxcondition AND
260 ORDER BY u.$sort $direction, ctx.depth DESC";
261 $this->otherusers
[$key] = $DB->get_records_sql($sql, $params, $page*$perpage, $perpage);
263 return $this->otherusers
[$key];
267 * Gets an array of the users that can be enrolled in this course.
269 * @global moodle_database $DB
270 * @param int $enrolid
271 * @param string $search
272 * @param bool $searchanywhere
273 * @param int $page Defaults to 0
274 * @param int $perpage Defaults to 25
275 * @return array Array(totalusers => int, users => array)
277 public function get_potential_users($enrolid, $search='', $searchanywhere=false, $page=0, $perpage=25) {
280 // Add some additional sensible conditions
281 $tests = array("id <> :guestid", 'u.deleted = 0', 'u.confirmed = 1');
282 $params = array('guestid' => $CFG->siteguest
);
283 if (!empty($search)) {
284 $conditions = get_extra_user_fields($this->get_context());
285 $conditions[] = $DB->sql_concat('u.firstname', "' '", 'u.lastname');
286 if ($searchanywhere) {
287 $searchparam = '%' . $search . '%';
289 $searchparam = $search . '%';
292 foreach ($conditions as $key=>$condition) {
293 $conditions[$key] = $DB->sql_like($condition,":con{$i}00", false);
294 $params["con{$i}00"] = $searchparam;
297 $tests[] = '(' . implode(' OR ', $conditions) . ')';
299 $wherecondition = implode(' AND ', $tests);
301 $extrafields = get_extra_user_fields($this->get_context(), array('username', 'lastaccess'));
302 $extrafields[] = 'username';
303 $extrafields[] = 'lastaccess';
304 $ufields = user_picture
::fields('u', $extrafields);
306 $fields = 'SELECT '.$ufields;
307 $countfields = 'SELECT COUNT(1)';
308 $sql = " FROM {user} u
309 WHERE $wherecondition
310 AND u.id NOT IN (SELECT ue.userid
311 FROM {user_enrolments} ue
312 JOIN {enrol} e ON (e.id = ue.enrolid AND e.id = :enrolid))";
313 $order = ' ORDER BY u.lastname ASC, u.firstname ASC';
314 $params['enrolid'] = $enrolid;
315 $totalusers = $DB->count_records_sql($countfields . $sql, $params);
316 $availableusers = $DB->get_records_sql($fields . $sql . $order, $params, $page*$perpage, $perpage);
317 return array('totalusers'=>$totalusers, 'users'=>$availableusers);
321 * Searches other users and returns paginated results
323 * @global moodle_database $DB
324 * @param string $search
325 * @param bool $searchanywhere
326 * @param int $page Starting at 0
327 * @param int $perpage
330 public function search_other_users($search='', $searchanywhere=false, $page=0, $perpage=25) {
333 // Add some additional sensible conditions
334 $tests = array("u.id <> :guestid", 'u.deleted = 0', 'u.confirmed = 1');
335 $params = array('guestid'=>$CFG->siteguest
);
336 if (!empty($search)) {
337 $conditions = array('u.firstname','u.lastname');
338 if ($searchanywhere) {
339 $searchparam = '%' . $search . '%';
341 $searchparam = $search . '%';
344 foreach ($conditions as $key=>$condition) {
345 $conditions[$key] = $DB->sql_like($condition, ":con{$i}00", false);
346 $params["con{$i}00"] = $searchparam;
349 $tests[] = '(' . implode(' OR ', $conditions) . ')';
351 $wherecondition = implode(' AND ', $tests);
353 $fields = 'SELECT '.user_picture
::fields('u', array('username','lastaccess'));
354 $countfields = 'SELECT COUNT(u.id)';
355 $sql = " FROM {user} u
356 WHERE $wherecondition
359 FROM {role_assignments} r, {user} u
360 WHERE r.contextid = :contextid AND
362 $order = ' ORDER BY lastname ASC, firstname ASC';
364 $params['contextid'] = $this->context
->id
;
365 $totalusers = $DB->count_records_sql($countfields . $sql, $params);
366 $availableusers = $DB->get_records_sql($fields . $sql . $order, $params, $page*$perpage, $perpage);
367 return array('totalusers'=>$totalusers, 'users'=>$availableusers);
371 * Gets an array containing some SQL to user for when selecting, params for
372 * that SQL, and the filter that was used in constructing the sql.
374 * @global moodle_database $DB
377 protected function get_instance_sql() {
379 if ($this->_instancessql
=== null) {
380 $instances = $this->get_enrolment_instances();
381 $filter = $this->get_enrolment_filter();
382 if ($filter && array_key_exists($filter, $instances)) {
383 $sql = " = :ifilter";
384 $params = array('ifilter'=>$filter);
388 list($sql, $params) = $DB->get_in_or_equal(array_keys($this->get_enrolment_instances()), SQL_PARAMS_NAMED
);
390 // no enabled instances, oops, we should probably say something
392 $params = array('never'=>-1);
395 $this->instancefilter
= $filter;
396 $this->_instancessql
= array($sql, $params, $filter);
398 return $this->_instancessql
;
402 * Returns all of the enrolment instances for this course.
406 public function get_enrolment_instances() {
407 if ($this->_instances
=== null) {
408 $this->_instances
= enrol_get_instances($this->course
->id
, true);
410 return $this->_instances
;
414 * Returns the names for all of the enrolment instances for this course.
418 public function get_enrolment_instance_names() {
419 if ($this->_inames
=== null) {
420 $instances = $this->get_enrolment_instances();
421 $plugins = $this->get_enrolment_plugins();
422 foreach ($instances as $key=>$instance) {
423 if (!isset($plugins[$instance->enrol
])) {
424 // weird, some broken stuff in plugin
425 unset($instances[$key]);
428 $this->_inames
[$key] = $plugins[$instance->enrol
]->get_instance_name($instance);
431 return $this->_inames
;
435 * Gets all of the enrolment plugins that are active for this course.
439 public function get_enrolment_plugins() {
440 if ($this->_plugins
=== null) {
441 $this->_plugins
= enrol_get_plugins(true);
443 return $this->_plugins
;
447 * Gets all of the roles this course can contain.
451 public function get_all_roles() {
452 if ($this->_roles
=== null) {
453 $this->_roles
= role_fix_names(get_all_roles(), $this->context
);
455 return $this->_roles
;
459 * Gets all of the assignable roles for this course.
463 public function get_assignable_roles($otherusers = false) {
464 if ($this->_assignableroles
=== null) {
465 $this->_assignableroles
= get_assignable_roles($this->context
, ROLENAME_ALIAS
, false); // verifies unassign access control too
469 if (!is_array($this->_assignablerolesothers
)) {
470 $this->_assignablerolesothers
= array();
471 list($courseviewroles, $ignored) = get_roles_with_cap_in_context($this->context
, 'moodle/course:view');
472 foreach ($this->_assignableroles
as $roleid=>$role) {
473 if (isset($courseviewroles[$roleid])) {
474 $this->_assignablerolesothers
[$roleid] = $role;
478 return $this->_assignablerolesothers
;
480 return $this->_assignableroles
;
485 * Gets all of the groups for this course.
489 public function get_all_groups() {
490 if ($this->_groups
=== null) {
491 $this->_groups
= groups_get_all_groups($this->course
->id
);
492 foreach ($this->_groups
as $gid=>$group) {
493 $this->_groups
[$gid]->name
= format_string($group->name
);
496 return $this->_groups
;
500 * Unenrols a user from the course given the users ue entry
502 * @global moodle_database $DB
503 * @param stdClass $ue
506 public function unenrol_user($ue) {
508 list ($instance, $plugin) = $this->get_user_enrolment_components($ue);
509 if ($instance && $plugin && $plugin->allow_unenrol_user($instance, $ue) && has_capability("enrol/$instance->enrol:unenrol", $this->context
)) {
510 $plugin->unenrol_user($instance, $ue->userid
);
517 * Given a user enrolment record this method returns the plugin and enrolment
518 * instance that relate to it.
520 * @param stdClass|int $userenrolment
521 * @return array array($instance, $plugin)
523 public function get_user_enrolment_components($userenrolment) {
525 if (is_numeric($userenrolment)) {
526 $userenrolment = $DB->get_record('user_enrolments', array('id'=>(int)$userenrolment));
528 $instances = $this->get_enrolment_instances();
529 $plugins = $this->get_enrolment_plugins();
530 if (!$userenrolment ||
!isset($instances[$userenrolment->enrolid
])) {
531 return array(false, false);
533 $instance = $instances[$userenrolment->enrolid
];
534 $plugin = $plugins[$instance->enrol
];
535 return array($instance, $plugin);
539 * Removes an assigned role from a user.
541 * @global moodle_database $DB
546 public function unassign_role_from_user($userid, $roleid) {
548 require_capability('moodle/role:assign', $this->context
);
549 $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST
);
551 role_unassign($roleid, $user->id
, $this->context
->id
, '', NULL);
552 } catch (Exception
$e) {
553 if (defined('AJAX_SCRIPT')) {
562 * Assigns a role to a user.
568 public function assign_role_to_user($roleid, $userid) {
569 require_capability('moodle/role:assign', $this->context
);
570 if (!array_key_exists($roleid, $this->get_assignable_roles())) {
571 if (defined('AJAX_SCRIPT')) {
572 throw new moodle_exception('invalidrole');
576 return role_assign($roleid, $userid, $this->context
->id
, '', NULL);
580 * Adds a user to a group
582 * @param stdClass $user
583 * @param int $groupid
586 public function add_user_to_group($user, $groupid) {
587 require_capability('moodle/course:managegroups', $this->context
);
588 $group = $this->get_group($groupid);
592 return groups_add_member($group->id
, $user->id
);
596 * Removes a user from a group
598 * @global moodle_database $DB
599 * @param StdClass $user
600 * @param int $groupid
603 public function remove_user_from_group($user, $groupid) {
605 require_capability('moodle/course:managegroups', $this->context
);
606 $group = $this->get_group($groupid);
610 return groups_remove_member($group, $user);
614 * Gets the requested group
616 * @param int $groupid
617 * @return stdClass|int
619 public function get_group($groupid) {
620 $groups = $this->get_all_groups();
621 if (!array_key_exists($groupid, $groups)) {
624 return $groups[$groupid];
630 * @param stdClass $userenrolment
631 * @param stdClass $data
634 public function edit_enrolment($userenrolment, $data) {
635 //Only allow editing if the user has the appropriate capability
636 //Already checked in /enrol/users.php but checking again in case this function is called from elsewhere
637 list($instance, $plugin) = $this->get_user_enrolment_components($userenrolment);
638 if ($instance && $plugin && $plugin->allow_manage($instance) && has_capability("enrol/$instance->enrol:manage", $this->context
)) {
639 if (!isset($data->status
)) {
640 $data->status
= $userenrolment->status
;
642 $plugin->update_user_enrol($instance, $userenrolment->userid
, $data->status
, $data->timestart
, $data->timeend
);
649 * Returns the current enrolment filter that is being applied by this class
652 public function get_enrolment_filter() {
653 return $this->instancefilter
;
657 * Gets the roles assigned to this user that are applicable for this course.
662 public function get_user_roles($userid) {
664 $ras = get_user_roles($this->context
, $userid, true, 'c.contextlevel DESC, r.sortorder ASC');
665 foreach ($ras as $ra) {
666 if ($ra->contextid
!= $this->context
->id
) {
667 if (!array_key_exists($ra->roleid
, $roles)) {
668 $roles[$ra->roleid
] = null;
670 // higher ras, course always takes precedence
673 if (array_key_exists($ra->roleid
, $roles) && $roles[$ra->roleid
] === false) {
676 $roles[$ra->roleid
] = ($ra->itemid
== 0 and $ra->component
=== '');
682 * Gets the enrolments this user has in the course
684 * @global moodle_database $DB
688 public function get_user_enrolments($userid) {
690 list($instancessql, $params, $filter) = $this->get_instance_sql();
691 $params['userid'] = $userid;
692 $userenrolments = $DB->get_records_select('user_enrolments', "enrolid $instancessql AND userid = :userid", $params);
693 $instances = $this->get_enrolment_instances();
694 $plugins = $this->get_enrolment_plugins();
695 $inames = $this->get_enrolment_instance_names();
696 foreach ($userenrolments as &$ue) {
697 $ue->enrolmentinstance
= $instances[$ue->enrolid
];
698 $ue->enrolmentplugin
= $plugins[$ue->enrolmentinstance
->enrol
];
699 $ue->enrolmentinstancename
= $inames[$ue->enrolmentinstance
->id
];
701 return $userenrolments;
705 * Gets the groups this user belongs to
710 public function get_user_groups($userid) {
711 return groups_get_all_groups($this->course
->id
, $userid, 0, 'g.id');
715 * Retursn an array of params that would go into the URL to return to this
720 public function get_url_params() {
722 'id' => $this->course
->id
724 if (!empty($this->instancefilter
)) {
725 $args['ifilter'] = $this->instancefilter
;
731 * Returns the course this object is managing enrolments for
735 public function get_course() {
736 return $this->course
;
740 * Returns the course context
744 public function get_context() {
745 return $this->context
;
749 * Gets an array of other users in this course ready for display.
751 * Other users are users who have been assigned or inherited roles within this
752 * course but have not been enrolled.
754 * @param core_enrol_renderer $renderer
755 * @param moodle_url $pageurl
756 * @param string $sort
757 * @param string $direction ASC | DESC
758 * @param int $page Starting from 0
759 * @param int $perpage
762 public function get_other_users_for_display(core_enrol_renderer
$renderer, moodle_url
$pageurl, $sort, $direction, $page, $perpage) {
764 $userroles = $this->get_other_users($sort, $direction, $page, $perpage);
765 $roles = $this->get_all_roles();
767 $context = $this->get_context();
769 $extrafields = get_extra_user_fields($context);
772 foreach ($userroles as $userrole) {
773 $contextid = $userrole->contextid
;
774 unset($userrole->contextid
); // This would collide with user avatar.
775 if (!array_key_exists($userrole->id
, $users)) {
776 $users[$userrole->id
] = $this->prepare_user_for_display($userrole, $extrafields, $now);
779 $a->role
= $roles[$userrole->roleid
]->localname
;
780 $changeable = ($userrole->component
== '');
781 if ($contextid == $this->context
->id
) {
782 $roletext = get_string('rolefromthiscourse', 'enrol', $a);
785 switch ($userrole->contextlevel
) {
786 case CONTEXT_COURSE
:
788 $roletext = get_string('rolefrommetacourse', 'enrol', $a);
790 case CONTEXT_COURSECAT
:
791 $roletext = get_string('rolefromcategory', 'enrol', $a);
795 $roletext = get_string('rolefromsystem', 'enrol', $a);
799 $users[$userrole->id
]['roles'] = array();
800 $users[$userrole->id
]['roles'][$userrole->roleid
] = array(
802 'unchangeable' => !$changeable
809 * Gets an array of users for display, this includes minimal user information
810 * as well as minimal information on the users roles, groups, and enrolments.
812 * @param core_enrol_renderer $renderer
813 * @param moodle_url $pageurl
815 * @param string $direction ASC or DESC
817 * @param int $perpage
820 public function get_users_for_display(course_enrolment_manager
$manager, $sort, $direction, $page, $perpage) {
821 $pageurl = $manager->get_moodlepage()->url
;
822 $users = $this->get_users($sort, $direction, $page, $perpage);
825 $straddgroup = get_string('addgroup', 'group');
826 $strunenrol = get_string('unenrol', 'enrol');
827 $stredit = get_string('edit');
829 $allroles = $this->get_all_roles();
830 $assignable = $this->get_assignable_roles();
831 $allgroups = $this->get_all_groups();
832 $context = $this->get_context();
833 $canmanagegroups = has_capability('moodle/course:managegroups', $context);
835 $url = new moodle_url($pageurl, $this->get_url_params());
836 $extrafields = get_extra_user_fields($context);
838 $userdetails = array();
839 foreach ($users as $user) {
840 $details = $this->prepare_user_for_display($user, $extrafields, $now);
843 $details['roles'] = array();
844 foreach ($this->get_user_roles($user->id
) as $rid=>$rassignable) {
845 $details['roles'][$rid] = array('text'=>$allroles[$rid]->localname
, 'unchangeable'=>(!$rassignable ||
!isset($assignable[$rid])));
849 $usergroups = $this->get_user_groups($user->id
);
850 $details['groups'] = array();
851 foreach($usergroups as $gid=>$unused) {
852 $details['groups'][$gid] = $allgroups[$gid]->name
;
856 $details['enrolments'] = array();
857 foreach ($this->get_user_enrolments($user->id
) as $ue) {
858 if ($ue->timestart
and $ue->timeend
) {
859 $period = get_string('periodstartend', 'enrol', array('start'=>userdate($ue->timestart
), 'end'=>userdate($ue->timeend
)));
860 $periodoutside = ($ue->timestart
&& $ue->timeend
&& $now < $ue->timestart
&& $now > $ue->timeend
);
861 } else if ($ue->timestart
) {
862 $period = get_string('periodstart', 'enrol', userdate($ue->timestart
));
863 $periodoutside = ($ue->timestart
&& $now < $ue->timestart
);
864 } else if ($ue->timeend
) {
865 $period = get_string('periodend', 'enrol', userdate($ue->timeend
));
866 $periodoutside = ($ue->timeend
&& $now > $ue->timeend
);
869 $periodoutside = false;
871 $details['enrolments'][$ue->id
] = array(
872 'text' => $ue->enrolmentinstancename
,
874 'dimmed' => ($periodoutside ||
$ue->status
!= ENROL_USER_ACTIVE
),
875 'actions' => $ue->enrolmentplugin
->get_user_enrolment_actions($manager, $ue)
878 $userdetails[$user->id
] = $details;
884 * Prepare a user record for display
886 * This function is called by both {@link get_users_for_display} and {@link get_other_users_for_display} to correctly
887 * prepare user fields for display
889 * Please note that this function does not check capability for moodle/coures:viewhiddenuserfields
891 * @param object $user The user record
892 * @param array $extrafields The list of fields as returned from get_extra_user_fields used to determine which
893 * additional fields may be displayed
894 * @param int $now The time used for lastaccess calculation
895 * @return array The fields to be displayed including userid, courseid, picture, firstname, lastseen and any
896 * additional fields from $extrafields
898 private function prepare_user_for_display($user, $extrafields, $now) {
900 'userid' => $user->id
,
901 'courseid' => $this->get_course()->id
,
902 'picture' => new user_picture($user),
903 'firstname' => fullname($user, has_capability('moodle/site:viewfullnames', $this->get_context())),
904 'lastseen' => get_string('never'),
906 foreach ($extrafields as $field) {
907 $details[$field] = $user->{$field};
910 if ($user->lastaccess
) {
911 $details['lastseen'] = format_time($now - $user->lastaccess
);
916 public function get_manual_enrol_buttons() {
917 $plugins = $this->get_enrolment_plugins();
919 foreach ($plugins as $plugin) {
920 $newbutton = $plugin->get_manual_enrol_button($this);
921 if (is_array($newbutton)) {
922 $buttons +
= $newbutton;
923 } else if ($newbutton instanceof enrol_user_button
) {
924 $buttons[] = $newbutton;
930 public function has_instance($enrolpluginname) {
931 // Make sure manual enrolments instance exists
932 foreach ($this->get_enrolment_instances() as $instance) {
933 if ($instance->enrol
== $enrolpluginname) {
941 * Returns the enrolment plugin that the course manager was being filtered to.
943 * If no filter was being applied then this function returns false.
945 * @return enrol_plugin
947 public function get_filtered_enrolment_plugin() {
948 $instances = $this->get_enrolment_instances();
949 $plugins = $this->get_enrolment_plugins();
951 if (empty($this->instancefilter
) ||
!array_key_exists($this->instancefilter
, $instances)) {
955 $instance = $instances[$this->instancefilter
];
956 return $plugins[$instance->enrol
];
960 * Returns and array of users + enrolment details.
962 * Given an array of user id's this function returns and array of user enrolments for those users
963 * as well as enough user information to display the users name and picture for each enrolment.
965 * @global moodle_database $DB
966 * @param array $userids
969 public function get_users_enrolments(array $userids) {
972 $instances = $this->get_enrolment_instances();
973 $plugins = $this->get_enrolment_plugins();
975 if (!empty($this->instancefilter
)) {
976 $instancesql = ' = :instanceid';
977 $instanceparams = array('instanceid' => $this->instancefilter
);
979 list($instancesql, $instanceparams) = $DB->get_in_or_equal(array_keys($instances), SQL_PARAMS_NAMED
, 'instanceid0000');
982 $userfields = user_picture
::fields('u');
983 list($idsql, $idparams) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED
, 'userid0000');
985 $sql = "SELECT ue.id AS ueid, ue.status, ue.enrolid, ue.userid, ue.timestart, ue.timeend, ue.modifierid, ue.timecreated, ue.timemodified, $userfields
986 FROM {user_enrolments} ue
987 LEFT JOIN {user} u ON u.id = ue.userid
988 WHERE ue.enrolid $instancesql AND
990 ORDER BY u.firstname ASC, u.lastname ASC";
992 $rs = $DB->get_recordset_sql($sql, $idparams +
$instanceparams);
994 foreach ($rs as $ue) {
995 $user = user_picture
::unalias($ue);
998 if (!array_key_exists($user->id
, $users)) {
999 $user->enrolments
= array();
1000 $users[$user->id
] = $user;
1002 $ue->enrolmentinstance
= $instances[$ue->enrolid
];
1003 $ue->enrolmentplugin
= $plugins[$ue->enrolmentinstance
->enrol
];
1004 $users[$user->id
]->enrolments
[$ue->id
] = $ue;
1012 * A button that is used to enrol users in a course
1014 * @copyright 2010 Sam Hemelryk
1015 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1017 class enrol_user_button
extends single_button
{
1020 * An array containing JS YUI modules required by this button
1023 protected $jsyuimodules = array();
1026 * An array containing JS initialisation calls required by this button
1029 protected $jsinitcalls = array();
1032 * An array strings required by JS for this button
1035 protected $jsstrings = array();
1038 * Initialises the new enrol_user_button
1040 * @staticvar int $count The number of enrol user buttons already created
1041 * @param moodle_url $url
1042 * @param string $label The text to display in the button
1043 * @param string $method Either post or get
1045 public function __construct(moodle_url
$url, $label, $method = 'post') {
1048 parent
::__construct($url, $label, $method);
1049 $this->class = 'singlebutton enrolusersbutton';
1050 $this->formid
= 'enrolusersbutton-'.$count;
1054 * Adds a YUI module call that will be added to the page when the button is used.
1056 * @param string|array $modules One or more modules to require
1057 * @param string $function The JS function to call
1058 * @param array $arguments An array of arguments to pass to the function
1059 * @param string $galleryversion The YUI gallery version of any modules required
1060 * @param bool $ondomready If true the call is postponed until the DOM is finished loading
1062 public function require_yui_module($modules, $function, array $arguments = null, $galleryversion = '2010.04.08-12-35', $ondomready = false) {
1064 $js->modules
= (array)$modules;
1065 $js->function = $function;
1066 $js->arguments
= $arguments;
1067 $js->galleryversion
= $galleryversion;
1068 $js->ondomready
= $ondomready;
1069 $this->jsyuimodules
[] = $js;
1073 * Adds a JS initialisation call to the page when the button is used.
1075 * @param string $function The function to call
1076 * @param array $extraarguments An array of arguments to pass to the function
1077 * @param bool $ondomready If true the call is postponed until the DOM is finished loading
1078 * @param array $module A module definition
1080 public function require_js_init_call($function, array $extraarguments = null, $ondomready = false, array $module = null) {
1082 $js->function = $function;
1083 $js->extraarguments
= $extraarguments;
1084 $js->ondomready
= $ondomready;
1085 $js->module
= $module;
1086 $this->jsinitcalls
[] = $js;
1090 * Requires strings for JS that will be loaded when the button is used.
1092 * @param type $identifiers
1093 * @param string $component
1096 public function strings_for_js($identifiers, $component = 'moodle', $a = null) {
1097 $string = new stdClass
;
1098 $string->identifiers
= (array)$identifiers;
1099 $string->component
= $component;
1101 $this->jsstrings
[] = $string;
1105 * Initialises the JS that is required by this button
1107 * @param moodle_page $page
1109 public function initialise_js(moodle_page
$page) {
1110 foreach ($this->jsyuimodules
as $js) {
1111 $page->requires
->yui_module($js->modules
, $js->function, $js->arguments
, $js->galleryversion
, $js->ondomready
);
1113 foreach ($this->jsinitcalls
as $js) {
1114 $page->requires
->js_init_call($js->function, $js->extraarguments
, $js->ondomready
, $js->module
);
1116 foreach ($this->jsstrings
as $string) {
1117 $page->requires
->strings_for_js($string->identifiers
, $string->component
, $string->a
);
1123 * User enrolment action
1125 * This class is used to manage a renderable ue action such as editing an user enrolment or deleting
1128 * @copyright 2011 Sam Hemelryk
1129 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1131 class user_enrolment_action
implements renderable
{
1134 * The icon to display for the action
1140 * The title for the action
1146 * The URL to the action
1152 * An array of HTML attributes
1155 protected $attributes = array();
1159 * @param pix_icon $icon
1160 * @param string $title
1161 * @param moodle_url $url
1162 * @param array $attributes
1164 public function __construct(pix_icon
$icon, $title, $url, array $attributes = null) {
1165 $this->icon
= $icon;
1166 $this->title
= $title;
1167 $this->url
= new moodle_url($url);
1168 if (!empty($attributes)) {
1169 $this->attributes
= $attributes;
1171 $this->attributes
['title'] = $title;
1175 * Returns the icon for this action
1178 public function get_icon() {
1183 * Returns the title for this action
1186 public function get_title() {
1187 return $this->title
;
1191 * Returns the URL for this action
1192 * @return moodle_url
1194 public function get_url() {
1199 * Returns the attributes to use for this action
1202 public function get_attributes() {
1203 return $this->attributes
;
1207 class enrol_ajax_exception
extends moodle_exception
{
1210 * @param string $errorcode The name of the string from error.php to print
1211 * @param string $module name of module
1212 * @param string $link The url where the user will be prompted to continue. If no url is provided the user will be directed to the site index page.
1213 * @param object $a Extra words and phrases that might be required in the error string
1214 * @param string $debuginfo optional debugging information
1216 public function __construct($errorcode, $link = '', $a = NULL, $debuginfo = null) {
1217 parent
::__construct($errorcode, 'enrol', $link, $a, $debuginfo);
1222 * This class is used to manage a bulk operations for enrolment plugins.
1224 * @copyright 2011 Sam Hemelryk
1225 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1227 abstract class enrol_bulk_enrolment_operation
{
1230 * The course enrolment manager
1231 * @var course_enrolment_manager
1236 * The enrolment plugin to which this operation belongs
1243 * @param course_enrolment_manager $manager
1244 * @param stdClass $plugin
1246 public function __construct(course_enrolment_manager
$manager, enrol_plugin
$plugin = null) {
1247 $this->manager
= $manager;
1248 $this->plugin
= $plugin;
1252 * Returns a moodleform used for this operation, or false if no form is required and the action
1253 * should be immediatly processed.
1255 * @param moodle_url|string $defaultaction
1256 * @param mixed $defaultcustomdata
1257 * @return enrol_bulk_enrolment_change_form|moodleform|false
1259 public function get_form($defaultaction = null, $defaultcustomdata = null) {
1264 * Returns the title to use for this bulk operation
1268 abstract public function get_title();
1271 * Returns the identifier for this bulk operation.
1272 * This should be the same identifier used by the plugins function when returning
1273 * all of its bulk operations.
1277 abstract public function get_identifier();
1280 * Processes the bulk operation on the given users
1282 * @param course_enrolment_manager $manager
1283 * @param array $users
1284 * @param stdClass $properties
1286 abstract public function process(course_enrolment_manager
$manager, array $users, stdClass
$properties);