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 $ufields = user_picture
::fields('u', array('lastaccess', 'email'));
203 $sql = "SELECT DISTINCT $ufields, ul.timeaccess AS lastseen
205 JOIN {user_enrolments} ue ON (ue.userid = u.id AND ue.enrolid $instancessql)
206 JOIN {enrol} e ON (e.id = ue.enrolid)
207 LEFT JOIN {user_lastaccess} ul ON (ul.courseid = e.courseid AND ul.userid = u.id)";
208 if ($sort === 'firstname') {
209 $sql .= " ORDER BY u.firstname $direction, u.lastname $direction";
210 } else if ($sort === 'lastname') {
211 $sql .= " ORDER BY u.lastname $direction, u.firstname $direction";
212 } else if ($sort === 'email') {
213 $sql .= " ORDER BY u.email $direction, u.lastname $direction, u.firstname $direction";
214 } else if ($sort === 'lastseen') {
215 $sql .= " ORDER BY ul.timeaccess $direction, u.lastname $direction, u.firstname $direction";
217 $this->users
[$key] = $DB->get_records_sql($sql, $params, $page*$perpage, $perpage);
219 return $this->users
[$key];
223 * Gets and array of other users.
225 * Other users are users who have been assigned roles or inherited roles
226 * within this course but who have not been enrolled in the course
228 * @global moodle_database $DB
229 * @param string $sort
230 * @param string $direction
232 * @param int $perpage
235 public function get_other_users($sort, $direction='ASC', $page=0, $perpage=25) {
237 if ($direction !== 'ASC') {
240 $key = md5("$sort-$direction-$page-$perpage");
241 if (!array_key_exists($key, $this->otherusers
)) {
242 list($ctxcondition, $params) = $DB->get_in_or_equal(get_parent_contexts($this->context
, true), SQL_PARAMS_NAMED
, 'ctx');
243 $params['courseid'] = $this->course
->id
;
244 $params['cid'] = $this->course
->id
;
245 $sql = "SELECT ra.id as raid, ra.contextid, ra.component, ctx.contextlevel, ra.roleid, u.*, ue.lastseen
246 FROM {role_assignments} ra
247 JOIN {user} u ON u.id = ra.userid
248 JOIN {context} ctx ON ra.contextid = ctx.id
250 SELECT ue.id, ue.userid, ul.timeaccess AS lastseen
251 FROM {user_enrolments} ue
252 LEFT JOIN {enrol} e ON e.id=ue.enrolid
253 LEFT JOIN {user_lastaccess} ul ON (ul.courseid = e.courseid AND ul.userid = ue.userid)
254 WHERE e.courseid = :courseid
255 ) ue ON ue.userid=u.id
256 WHERE ctx.id $ctxcondition AND
258 ORDER BY u.$sort $direction, ctx.depth DESC";
259 $this->otherusers
[$key] = $DB->get_records_sql($sql, $params, $page*$perpage, $perpage);
261 return $this->otherusers
[$key];
265 * Gets an array of the users that can be enrolled in this course.
267 * @global moodle_database $DB
268 * @param int $enrolid
269 * @param string $search
270 * @param bool $searchanywhere
271 * @param int $page Defaults to 0
272 * @param int $perpage Defaults to 25
273 * @return array Array(totalusers => int, users => array)
275 public function get_potential_users($enrolid, $search='', $searchanywhere=false, $page=0, $perpage=25) {
278 // Add some additional sensible conditions
279 $tests = array("id <> :guestid", 'u.deleted = 0', 'u.confirmed = 1');
280 $params = array('guestid' => $CFG->siteguest
);
281 if (!empty($search)) {
283 $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 $ufields = user_picture
::fields('u', array('username', 'lastaccess'));
303 $fields = 'SELECT '.$ufields;
304 $countfields = 'SELECT COUNT(1)';
305 $sql = " FROM {user} u
306 WHERE $wherecondition
307 AND u.id NOT IN (SELECT ue.userid
308 FROM {user_enrolments} ue
309 JOIN {enrol} e ON (e.id = ue.enrolid AND e.id = :enrolid))";
310 $order = ' ORDER BY u.lastname ASC, u.firstname ASC';
311 $params['enrolid'] = $enrolid;
312 $totalusers = $DB->count_records_sql($countfields . $sql, $params);
313 $availableusers = $DB->get_records_sql($fields . $sql . $order, $params, $page*$perpage, $perpage);
314 return array('totalusers'=>$totalusers, 'users'=>$availableusers);
318 * Searches other users and returns paginated results
320 * @global moodle_database $DB
321 * @param string $search
322 * @param bool $searchanywhere
323 * @param int $page Starting at 0
324 * @param int $perpage
327 public function search_other_users($search='', $searchanywhere=false, $page=0, $perpage=25) {
330 // Add some additional sensible conditions
331 $tests = array("u.id <> :guestid", 'u.deleted = 0', 'u.confirmed = 1');
332 $params = array('guestid'=>$CFG->siteguest
);
333 if (!empty($search)) {
334 $conditions = array('u.firstname','u.lastname');
335 if ($searchanywhere) {
336 $searchparam = '%' . $search . '%';
338 $searchparam = $search . '%';
341 foreach ($conditions as $key=>$condition) {
342 $conditions[$key] = $DB->sql_like($condition, ":con{$i}00", false);
343 $params["con{$i}00"] = $searchparam;
346 $tests[] = '(' . implode(' OR ', $conditions) . ')';
348 $wherecondition = implode(' AND ', $tests);
350 $fields = 'SELECT '.user_picture
::fields('u', array('username','lastaccess'));
351 $countfields = 'SELECT COUNT(u.id)';
352 $sql = " FROM {user} u
353 WHERE $wherecondition
356 FROM {role_assignments} r, {user} u
357 WHERE r.contextid = :contextid AND
359 $order = ' ORDER BY lastname ASC, firstname ASC';
361 $params['contextid'] = $this->context
->id
;
362 $totalusers = $DB->count_records_sql($countfields . $sql, $params);
363 $availableusers = $DB->get_records_sql($fields . $sql . $order, $params, $page*$perpage, $perpage);
364 return array('totalusers'=>$totalusers, 'users'=>$availableusers);
368 * Gets an array containing some SQL to user for when selecting, params for
369 * that SQL, and the filter that was used in constructing the sql.
371 * @global moodle_database $DB
374 protected function get_instance_sql() {
376 if ($this->_instancessql
=== null) {
377 $instances = $this->get_enrolment_instances();
378 $filter = $this->get_enrolment_filter();
379 if ($filter && array_key_exists($filter, $instances)) {
380 $sql = " = :ifilter";
381 $params = array('ifilter'=>$filter);
385 list($sql, $params) = $DB->get_in_or_equal(array_keys($this->get_enrolment_instances()), SQL_PARAMS_NAMED
);
387 // no enabled instances, oops, we should probably say something
389 $params = array('never'=>-1);
392 $this->instancefilter
= $filter;
393 $this->_instancessql
= array($sql, $params, $filter);
395 return $this->_instancessql
;
399 * Returns all of the enrolment instances for this course.
403 public function get_enrolment_instances() {
404 if ($this->_instances
=== null) {
405 $this->_instances
= enrol_get_instances($this->course
->id
, true);
407 return $this->_instances
;
411 * Returns the names for all of the enrolment instances for this course.
415 public function get_enrolment_instance_names() {
416 if ($this->_inames
=== null) {
417 $instances = $this->get_enrolment_instances();
418 $plugins = $this->get_enrolment_plugins();
419 foreach ($instances as $key=>$instance) {
420 if (!isset($plugins[$instance->enrol
])) {
421 // weird, some broken stuff in plugin
422 unset($instances[$key]);
425 $this->_inames
[$key] = $plugins[$instance->enrol
]->get_instance_name($instance);
428 return $this->_inames
;
432 * Gets all of the enrolment plugins that are active for this course.
436 public function get_enrolment_plugins() {
437 if ($this->_plugins
=== null) {
438 $this->_plugins
= enrol_get_plugins(true);
440 return $this->_plugins
;
444 * Gets all of the roles this course can contain.
448 public function get_all_roles() {
449 if ($this->_roles
=== null) {
450 $this->_roles
= role_fix_names(get_all_roles(), $this->context
);
452 return $this->_roles
;
456 * Gets all of the assignable roles for this course.
460 public function get_assignable_roles($otherusers = false) {
461 if ($this->_assignableroles
=== null) {
462 $this->_assignableroles
= get_assignable_roles($this->context
, ROLENAME_ALIAS
, false); // verifies unassign access control too
466 if (!is_array($this->_assignablerolesothers
)) {
467 $this->_assignablerolesothers
= array();
468 list($courseviewroles, $ignored) = get_roles_with_cap_in_context($this->context
, 'moodle/course:view');
469 foreach ($this->_assignableroles
as $roleid=>$role) {
470 if (isset($courseviewroles[$roleid])) {
471 $this->_assignablerolesothers
[$roleid] = $role;
475 return $this->_assignablerolesothers
;
477 return $this->_assignableroles
;
482 * Gets all of the groups for this course.
486 public function get_all_groups() {
487 if ($this->_groups
=== null) {
488 $this->_groups
= groups_get_all_groups($this->course
->id
);
489 foreach ($this->_groups
as $gid=>$group) {
490 $this->_groups
[$gid]->name
= format_string($group->name
);
493 return $this->_groups
;
497 * Unenrols a user from the course given the users ue entry
499 * @global moodle_database $DB
500 * @param stdClass $ue
503 public function unenrol_user($ue) {
505 list ($instance, $plugin) = $this->get_user_enrolment_components($ue);
506 if ($instance && $plugin && $plugin->allow_unenrol($instance) && has_capability("enrol/$instance->enrol:unenrol", $this->context
)) {
507 $plugin->unenrol_user($instance, $ue->userid
);
514 * Given a user enrolment record this method returns the plugin and enrolment
515 * instance that relate to it.
517 * @param stdClass|int $userenrolment
518 * @return array array($instance, $plugin)
520 public function get_user_enrolment_components($userenrolment) {
522 if (is_numeric($userenrolment)) {
523 $userenrolment = $DB->get_record('user_enrolments', array('id'=>(int)$userenrolment));
525 $instances = $this->get_enrolment_instances();
526 $plugins = $this->get_enrolment_plugins();
527 if (!$userenrolment ||
!isset($instances[$userenrolment->enrolid
])) {
528 return array(false, false);
530 $instance = $instances[$userenrolment->enrolid
];
531 $plugin = $plugins[$instance->enrol
];
532 return array($instance, $plugin);
536 * Removes an assigned role from a user.
538 * @global moodle_database $DB
543 public function unassign_role_from_user($userid, $roleid) {
545 require_capability('moodle/role:assign', $this->context
);
546 $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST
);
548 role_unassign($roleid, $user->id
, $this->context
->id
, '', NULL);
549 } catch (Exception
$e) {
550 if (defined('AJAX_SCRIPT')) {
559 * Assigns a role to a user.
565 public function assign_role_to_user($roleid, $userid) {
566 require_capability('moodle/role:assign', $this->context
);
567 if (!array_key_exists($roleid, $this->get_assignable_roles())) {
568 if (defined('AJAX_SCRIPT')) {
569 throw new moodle_exception('invalidrole');
573 return role_assign($roleid, $userid, $this->context
->id
, '', NULL);
577 * Adds a user to a group
579 * @param stdClass $user
580 * @param int $groupid
583 public function add_user_to_group($user, $groupid) {
584 require_capability('moodle/course:managegroups', $this->context
);
585 $group = $this->get_group($groupid);
589 return groups_add_member($group->id
, $user->id
);
593 * Removes a user from a group
595 * @global moodle_database $DB
596 * @param StdClass $user
597 * @param int $groupid
600 public function remove_user_from_group($user, $groupid) {
602 require_capability('moodle/course:managegroups', $this->context
);
603 $group = $this->get_group($groupid);
607 return groups_remove_member($group, $user);
611 * Gets the requested group
613 * @param int $groupid
614 * @return stdClass|int
616 public function get_group($groupid) {
617 $groups = $this->get_all_groups();
618 if (!array_key_exists($groupid, $groups)) {
621 return $groups[$groupid];
627 * @param stdClass $userenrolment
628 * @param stdClass $data
631 public function edit_enrolment($userenrolment, $data) {
632 //Only allow editing if the user has the appropriate capability
633 //Already checked in /enrol/users.php but checking again in case this function is called from elsewhere
634 list($instance, $plugin) = $this->get_user_enrolment_components($userenrolment);
635 if ($instance && $plugin && $plugin->allow_manage($instance) && has_capability("enrol/$instance->enrol:manage", $this->context
)) {
636 if (!isset($data->status
)) {
637 $data->status
= $userenrolment->status
;
639 $plugin->update_user_enrol($instance, $userenrolment->userid
, $data->status
, $data->timestart
, $data->timeend
);
646 * Returns the current enrolment filter that is being applied by this class
649 public function get_enrolment_filter() {
650 return $this->instancefilter
;
654 * Gets the roles assigned to this user that are applicable for this course.
659 public function get_user_roles($userid) {
661 $ras = get_user_roles($this->context
, $userid, true, 'c.contextlevel DESC, r.sortorder ASC');
662 foreach ($ras as $ra) {
663 if ($ra->contextid
!= $this->context
->id
) {
664 if (!array_key_exists($ra->roleid
, $roles)) {
665 $roles[$ra->roleid
] = null;
667 // higher ras, course always takes precedence
670 if (array_key_exists($ra->roleid
, $roles) && $roles[$ra->roleid
] === false) {
673 $roles[$ra->roleid
] = ($ra->itemid
== 0 and $ra->component
=== '');
679 * Gets the enrolments this user has in the course
681 * @global moodle_database $DB
685 public function get_user_enrolments($userid) {
687 list($instancessql, $params, $filter) = $this->get_instance_sql();
688 $params['userid'] = $userid;
689 $userenrolments = $DB->get_records_select('user_enrolments', "enrolid $instancessql AND userid = :userid", $params);
690 $instances = $this->get_enrolment_instances();
691 $plugins = $this->get_enrolment_plugins();
692 $inames = $this->get_enrolment_instance_names();
693 foreach ($userenrolments as &$ue) {
694 $ue->enrolmentinstance
= $instances[$ue->enrolid
];
695 $ue->enrolmentplugin
= $plugins[$ue->enrolmentinstance
->enrol
];
696 $ue->enrolmentinstancename
= $inames[$ue->enrolmentinstance
->id
];
698 return $userenrolments;
702 * Gets the groups this user belongs to
707 public function get_user_groups($userid) {
708 return groups_get_all_groups($this->course
->id
, $userid, 0, 'g.id');
712 * Retursn an array of params that would go into the URL to return to this
717 public function get_url_params() {
719 'id' => $this->course
->id
721 if (!empty($this->instancefilter
)) {
722 $args['ifilter'] = $this->instancefilter
;
728 * Returns the course this object is managing enrolments for
732 public function get_course() {
733 return $this->course
;
737 * Returns the course context
741 public function get_context() {
742 return $this->context
;
746 * Gets an array of other users in this course ready for display.
748 * Other users are users who have been assigned or inherited roles within this
749 * course but have not been enrolled.
751 * @param core_enrol_renderer $renderer
752 * @param moodle_url $pageurl
753 * @param string $sort
754 * @param string $direction ASC | DESC
755 * @param int $page Starting from 0
756 * @param int $perpage
759 public function get_other_users_for_display(core_enrol_renderer
$renderer, moodle_url
$pageurl, $sort, $direction, $page, $perpage) {
761 $userroles = $this->get_other_users($sort, $direction, $page, $perpage);
762 $roles = $this->get_all_roles();
764 $courseid = $this->get_course()->id
;
765 $context = $this->get_context();
768 foreach ($userroles as $userrole) {
769 if (!array_key_exists($userrole->id
, $users)) {
770 $users[$userrole->id
] = array(
771 'userid' => $userrole->id
,
772 'courseid' => $courseid,
773 'picture' => new user_picture($userrole),
774 'firstname' => fullname($userrole, true),
775 'email' => $userrole->email
,
780 $a->role
= $roles[$userrole->roleid
]->localname
;
781 $changeable = ($userrole->component
== '');
782 if ($userrole->contextid
== $this->context
->id
) {
783 $roletext = get_string('rolefromthiscourse', 'enrol', $a);
786 switch ($userrole->contextlevel
) {
787 case CONTEXT_COURSE
:
789 $roletext = get_string('rolefrommetacourse', 'enrol', $a);
791 case CONTEXT_COURSECAT
:
792 $roletext = get_string('rolefromcategory', 'enrol', $a);
796 $roletext = get_string('rolefromsystem', 'enrol', $a);
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 $strnever = get_string('never');
826 $straddgroup = get_string('addgroup', 'group');
827 $strunenrol = get_string('unenrol', 'enrol');
828 $stredit = get_string('edit');
830 $allroles = $this->get_all_roles();
831 $assignable = $this->get_assignable_roles();
832 $allgroups = $this->get_all_groups();
833 $courseid = $this->get_course()->id
;
834 $context = $this->get_context();
835 $canmanagegroups = has_capability('moodle/course:managegroups', $context);
837 $url = new moodle_url($pageurl, $this->get_url_params());
839 $userdetails = array();
840 foreach ($users as $user) {
842 'userid' => $user->id
,
843 'courseid' => $courseid,
844 'picture' => new user_picture($user),
845 'firstname' => fullname($user, true),
846 'email' => $user->email
,
847 'lastseen' => $strnever,
850 'enrolments' => array()
853 if ($user->lastaccess
) {
854 $details['lastseen'] = format_time($now - $user->lastaccess
);
858 foreach ($this->get_user_roles($user->id
) as $rid=>$rassignable) {
859 $details['roles'][$rid] = array('text'=>$allroles[$rid]->localname
, 'unchangeable'=>(!$rassignable ||
!isset($assignable[$rid])));
863 $usergroups = $this->get_user_groups($user->id
);
864 foreach($usergroups as $gid=>$unused) {
865 $details['groups'][$gid] = $allgroups[$gid]->name
;
869 foreach ($this->get_user_enrolments($user->id
) as $ue) {
870 if ($ue->timestart
and $ue->timeend
) {
871 $period = get_string('periodstartend', 'enrol', array('start'=>userdate($ue->timestart
), 'end'=>userdate($ue->timeend
)));
872 $periodoutside = ($ue->timestart
&& $ue->timeend
&& $now < $ue->timestart
&& $now > $ue->timeend
);
873 } else if ($ue->timestart
) {
874 $period = get_string('periodstart', 'enrol', userdate($ue->timestart
));
875 $periodoutside = ($ue->timestart
&& $now < $ue->timestart
);
876 } else if ($ue->timeend
) {
877 $period = get_string('periodend', 'enrol', userdate($ue->timeend
));
878 $periodoutside = ($ue->timeend
&& $now > $ue->timeend
);
881 $periodoutside = false;
883 $details['enrolments'][$ue->id
] = array(
884 'text' => $ue->enrolmentinstancename
,
886 'dimmed' => ($periodoutside ||
$ue->status
!= ENROL_USER_ACTIVE
),
887 'actions' => $ue->enrolmentplugin
->get_user_enrolment_actions($manager, $ue)
890 $userdetails[$user->id
] = $details;
895 public function get_manual_enrol_buttons() {
896 $plugins = $this->get_enrolment_plugins();
898 foreach ($plugins as $plugin) {
899 $newbutton = $plugin->get_manual_enrol_button($this);
900 if (is_array($newbutton)) {
901 $buttons +
= $newbutton;
902 } else if ($newbutton instanceof enrol_user_button
) {
903 $buttons[] = $newbutton;
909 public function has_instance($enrolpluginname) {
910 // Make sure manual enrolments instance exists
911 foreach ($this->get_enrolment_instances() as $instance) {
912 if ($instance->enrol
== $enrolpluginname) {
920 * Returns the enrolment plugin that the course manager was being filtered to.
922 * If no filter was being applied then this function returns false.
924 * @return enrol_plugin
926 public function get_filtered_enrolment_plugin() {
927 $instances = $this->get_enrolment_instances();
928 $plugins = $this->get_enrolment_plugins();
930 if (empty($this->instancefilter
) ||
!array_key_exists($this->instancefilter
, $instances)) {
934 $instance = $instances[$this->instancefilter
];
935 return $plugins[$instance->enrol
];
939 * Returns and array of users + enrolment details.
941 * Given an array of user id's this function returns and array of user enrolments for those users
942 * as well as enough user information to display the users name and picture for each enrolment.
944 * @global moodle_database $DB
945 * @param array $userids
948 public function get_users_enrolments(array $userids) {
951 $instances = $this->get_enrolment_instances();
952 $plugins = $this->get_enrolment_plugins();
954 if (!empty($this->instancefilter
)) {
955 $instancesql = ' = :instanceid';
956 $instanceparams = array('instanceid' => $this->instancefilter
);
958 list($instancesql, $instanceparams) = $DB->get_in_or_equal(array_keys($instances), SQL_PARAMS_NAMED
, 'instanceid0000');
961 $userfields = user_picture
::fields('u');
962 list($idsql, $idparams) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED
, 'userid0000');
964 $sql = "SELECT ue.id AS ueid, ue.status, ue.enrolid, ue.userid, ue.timestart, ue.timeend, ue.modifierid, ue.timecreated, ue.timemodified, $userfields
965 FROM {user_enrolments} ue
966 LEFT JOIN {user} u ON u.id = ue.userid
967 WHERE ue.enrolid $instancesql AND
969 ORDER BY u.firstname ASC, u.lastname ASC";
971 $rs = $DB->get_recordset_sql($sql, $idparams +
$instanceparams);
973 foreach ($rs as $ue) {
974 $user = user_picture
::unalias($ue);
977 if (!array_key_exists($user->id
, $users)) {
978 $user->enrolments
= array();
979 $users[$user->id
] = $user;
981 $ue->enrolmentinstance
= $instances[$ue->enrolid
];
982 $ue->enrolmentplugin
= $plugins[$ue->enrolmentinstance
->enrol
];
983 $users[$user->id
]->enrolments
[$ue->id
] = $ue;
991 * A button that is used to enrol users in a course
993 * @copyright 2010 Sam Hemelryk
994 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
996 class enrol_user_button
extends single_button
{
999 * An array containing JS YUI modules required by this button
1002 protected $jsyuimodules = array();
1005 * An array containing JS initialisation calls required by this button
1008 protected $jsinitcalls = array();
1011 * An array strings required by JS for this button
1014 protected $jsstrings = array();
1017 * Initialises the new enrol_user_button
1019 * @staticvar int $count The number of enrol user buttons already created
1020 * @param moodle_url $url
1021 * @param string $label The text to display in the button
1022 * @param string $method Either post or get
1024 public function __construct(moodle_url
$url, $label, $method = 'post') {
1027 parent
::__construct($url, $label, $method);
1028 $this->class = 'singlebutton enrolusersbutton';
1029 $this->formid
= 'enrolusersbutton-'.$count;
1033 * Adds a YUI module call that will be added to the page when the button is used.
1035 * @param string|array $modules One or more modules to require
1036 * @param string $function The JS function to call
1037 * @param array $arguments An array of arguments to pass to the function
1038 * @param string $galleryversion The YUI gallery version of any modules required
1039 * @param bool $ondomready If true the call is postponed until the DOM is finished loading
1041 public function require_yui_module($modules, $function, array $arguments = null, $galleryversion = '2010.04.08-12-35', $ondomready = false) {
1043 $js->modules
= (array)$modules;
1044 $js->function = $function;
1045 $js->arguments
= $arguments;
1046 $js->galleryversion
= $galleryversion;
1047 $js->ondomready
= $ondomready;
1048 $this->jsyuimodules
[] = $js;
1052 * Adds a JS initialisation call to the page when the button is used.
1054 * @param string $function The function to call
1055 * @param array $extraarguments An array of arguments to pass to the function
1056 * @param bool $ondomready If true the call is postponed until the DOM is finished loading
1057 * @param array $module A module definition
1059 public function require_js_init_call($function, array $extraarguments = null, $ondomready = false, array $module = null) {
1061 $js->function = $function;
1062 $js->extraarguments
= $extraarguments;
1063 $js->ondomready
= $ondomready;
1064 $js->module
= $module;
1065 $this->jsinitcalls
[] = $js;
1069 * Requires strings for JS that will be loaded when the button is used.
1071 * @param type $identifiers
1072 * @param string $component
1075 public function strings_for_js($identifiers, $component = 'moodle', $a = null) {
1076 $string = new stdClass
;
1077 $string->identifiers
= (array)$identifiers;
1078 $string->component
= $component;
1080 $this->jsstrings
[] = $string;
1084 * Initialises the JS that is required by this button
1086 * @param moodle_page $page
1088 public function initialise_js(moodle_page
$page) {
1089 foreach ($this->jsyuimodules
as $js) {
1090 $page->requires
->yui_module($js->modules
, $js->function, $js->arguments
, $js->galleryversion
, $js->ondomready
);
1092 foreach ($this->jsinitcalls
as $js) {
1093 $page->requires
->js_init_call($js->function, $js->extraarguments
, $js->ondomready
, $js->module
);
1095 foreach ($this->jsstrings
as $string) {
1096 $page->requires
->strings_for_js($string->identifiers
, $string->component
, $string->a
);
1102 * User enrolment action
1104 * This class is used to manage a renderable ue action such as editing an user enrolment or deleting
1107 * @copyright 2011 Sam Hemelryk
1108 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1110 class user_enrolment_action
implements renderable
{
1113 * The icon to display for the action
1119 * The title for the action
1125 * The URL to the action
1131 * An array of HTML attributes
1134 protected $attributes = array();
1138 * @param pix_icon $icon
1139 * @param string $title
1140 * @param moodle_url $url
1141 * @param array $attributes
1143 public function __construct(pix_icon
$icon, $title, $url, array $attributes = null) {
1144 $this->icon
= $icon;
1145 $this->title
= $title;
1146 $this->url
= new moodle_url($url);
1147 if (!empty($attributes)) {
1148 $this->attributes
= $attributes;
1150 $this->attributes
['title'] = $title;
1154 * Returns the icon for this action
1157 public function get_icon() {
1162 * Returns the title for this action
1165 public function get_title() {
1166 return $this->title
;
1170 * Returns the URL for this action
1171 * @return moodle_url
1173 public function get_url() {
1178 * Returns the attributes to use for this action
1181 public function get_attributes() {
1182 return $this->attributes
;
1186 class enrol_ajax_exception
extends moodle_exception
{
1189 * @param string $errorcode The name of the string from error.php to print
1190 * @param string $module name of module
1191 * @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.
1192 * @param object $a Extra words and phrases that might be required in the error string
1193 * @param string $debuginfo optional debugging information
1195 public function __construct($errorcode, $link = '', $a = NULL, $debuginfo = null) {
1196 parent
::__construct($errorcode, 'enrol', $link, $a, $debuginfo);
1201 * This class is used to manage a bulk operations for enrolment plugins.
1203 * @copyright 2011 Sam Hemelryk
1204 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1206 abstract class enrol_bulk_enrolment_operation
{
1209 * The course enrolment manager
1210 * @var course_enrolment_manager
1215 * The enrolment plugin to which this operation belongs
1222 * @param course_enrolment_manager $manager
1223 * @param stdClass $plugin
1225 public function __construct(course_enrolment_manager
$manager, enrol_plugin
$plugin = null) {
1226 $this->manager
= $manager;
1227 $this->plugin
= $plugin;
1231 * Returns a moodleform used for this operation, or false if no form is required and the action
1232 * should be immediatly processed.
1234 * @param moodle_url|string $defaultaction
1235 * @param mixed $defaultcustomdata
1236 * @return enrol_bulk_enrolment_change_form|moodleform|false
1238 public function get_form($defaultaction = null, $defaultcustomdata = null) {
1243 * Returns the title to use for this bulk operation
1247 abstract public function get_title();
1250 * Returns the identifier for this bulk operation.
1251 * This should be the same identifier used by the plugins function when returning
1252 * all of its bulk operations.
1256 abstract public function get_identifier();
1259 * Processes the bulk operation on the given users
1261 * @param course_enrolment_manager $manager
1262 * @param array $users
1263 * @param stdClass $properties
1265 abstract public function process(course_enrolment_manager
$manager, array $users, stdClass
$properties);