b388e36e3e5d1113b16d199e3c1c651f75a43df7
[moodle.git] / badges / award.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Handle manual badge award.
19  *
20  * @package    core
21  * @subpackage badges
22  * @copyright  2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @author     Yuliya Bozhko <yuliya.bozhko@totaralms.com>
25  */
27 require_once(dirname(dirname(__FILE__)) . '/config.php');
28 require_once($CFG->libdir . '/badgeslib.php');
29 require_once($CFG->dirroot . '/badges/lib/awardlib.php');
31 $badgeid = required_param('id', PARAM_INT);
32 $role = optional_param('role', 0, PARAM_INT);
34 require_login();
36 if (empty($CFG->enablebadges)) {
37     print_error('badgesdisabled', 'badges');
38 }
40 $badge = new badge($badgeid);
41 $context = $badge->get_context();
42 $isadmin = is_siteadmin($USER);
44 $navurl = new moodle_url('/badges/index.php', array('type' => $badge->type));
46 if ($badge->type == BADGE_TYPE_COURSE) {
47     require_login($badge->courseid);
48     $navurl = new moodle_url('/badges/index.php', array('type' => $badge->type, 'id' => $badge->courseid));
49 }
51 require_capability('moodle/badges:awardbadge', $context);
53 $url = new moodle_url('/badges/award.php', array('id' => $badgeid));
54 $PAGE->set_url($url);
55 $PAGE->set_context($context);
57 // Set up navigation and breadcrumbs.
58 $strrecipients = get_string('recipients', 'badges');
59 navigation_node::override_active_url($navurl);
60 $PAGE->navbar->add($badge->name, new moodle_url('overview.php', array('id' => $badge->id)))->add($strrecipients);
61 $PAGE->set_title($strrecipients);
62 $PAGE->set_heading($badge->name);
63 $PAGE->set_pagelayout('standard');
65 if (!$badge->is_active()) {
66     echo $OUTPUT->header();
67     echo $OUTPUT->notification(get_string('donotaward', 'badges'));
68     echo $OUTPUT->footer();
69     die();
70 }
72 $output = $PAGE->get_renderer('core', 'badges');
74 // Roles that can award this badge.
75 $accepted_roles = array_keys($badge->criteria[BADGE_CRITERIA_TYPE_MANUAL]->params);
77 // If site admin, select a role to award a badge.
78 if ($isadmin) {
79     list($usertest, $userparams) = $DB->get_in_or_equal($accepted_roles, SQL_PARAMS_NAMED, 'existing', true);
80     $options = $DB->get_records_sql('SELECT * FROM {role} WHERE id ' . $usertest, $userparams);
81     foreach ($options as $p) {
82         $select[$p->id] = role_get_name($p);
83     }
84     if (!$role) {
85         echo $OUTPUT->header();
86         echo $OUTPUT->box(get_string('adminaward', 'badges') . $OUTPUT->single_select(new moodle_url($PAGE->url), 'role', $select));
87         echo $OUTPUT->footer();
88         die();
89     } else {
90         $issuerrole = new stdClass();
91         $issuerrole->roleid = $role;
92         $roleselect = get_string('adminaward', 'badges') . $OUTPUT->single_select(new moodle_url($PAGE->url), 'role', $select, $role);
93     }
94 } else {
95     // Current user's role.
96     $issuerrole = array_shift(get_user_roles($context, $USER->id));
97     if (!isset($issuerrole->roleid) || !in_array($issuerrole->roleid, $accepted_roles)) {
98         echo $OUTPUT->header();
99         $rlink = html_writer::link(new moodle_url('recipients.php', array('id' => $badge->id)), get_string('recipients', 'badges'));
100         echo $OUTPUT->notification(get_string('notacceptedrole', 'badges', $rlink));
101         echo $OUTPUT->footer();
102         die();
103     }
105 $options = array(
106         'badgeid' => $badge->id,
107         'context' => $context,
108         'issuerid' => $USER->id,
109         'issuerrole' => $issuerrole->roleid
110         );
111 $existingselector = new badge_existing_users_selector('existingrecipients', $options);
112 $recipientselector = new badge_potential_users_selector('potentialrecipients', $options);
113 $recipientselector->set_existing_recipients($existingselector->find_users(''));
115 if (optional_param('award', false, PARAM_BOOL) && data_submitted() && has_capability('moodle/badges:awardbadge', $context)) {
116     require_sesskey();
117     $users = $recipientselector->get_selected_users();
118     foreach ($users as $user) {
119         if (process_manual_award($user->id, $USER->id, $issuerrole->roleid, $badgeid)) {
120             // If badge was successfully awarded, review manual badge criteria.
121             $data = new stdClass();
122             $data->crit = $badge->criteria[BADGE_CRITERIA_TYPE_MANUAL];
123             $data->userid = $user->id;
124             badges_award_handle_manual_criteria_review($data);
125         } else {
126             echo $OUTPUT->error_text(get_string('error:cannotawardbadge', 'badges'));
127         }
128     }
130     $recipientselector->invalidate_selected_users();
131     $existingselector->invalidate_selected_users();
132     $recipientselector->set_existing_recipients($existingselector->find_users(''));
135 echo $OUTPUT->header();
136 echo $OUTPUT->heading($strrecipients);
138 if ($isadmin) {
139     echo $OUTPUT->box($roleselect);
142 echo $output->recipients_selection_form($existingselector, $recipientselector);
143 echo $OUTPUT->footer();