2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Renderer for use with the badges output
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>
27 require_once($CFG->libdir
. '/badgeslib.php');
28 require_once($CFG->libdir
. '/tablelib.php');
31 * Standard HTML output renderer for badges
33 class core_badges_renderer
extends plugin_renderer_base
{
35 // Outputs badges list.
36 public function print_badges_list($badges, $userid, $profile = false, $external = false) {
38 foreach ($badges as $badge) {
40 $context = ($badge->type
== BADGE_TYPE_SITE
) ? context_system
::instance() : context_course
::instance($badge->courseid
);
41 $bname = $badge->name
;
42 $imageurl = moodle_url
::make_pluginfile_url($context->id
, 'badges', 'badgeimage', $badge->id
, '/', 'f1', false);
44 $bname = $badge->assertion
->badge
->name
;
45 $imageurl = $badge->imageUrl
;
48 $name = html_writer
::tag('span', $bname, array('class' => 'badge-name'));
50 $image = html_writer
::empty_tag('img', array('src' => $imageurl, 'class' => 'badge-image'));
51 if (!empty($badge->dateexpire
) && $badge->dateexpire
< time()) {
52 $image .= $this->output
->pix_icon('i/expired',
53 get_string('expireddate', 'badges', userdate($badge->dateexpire
)),
55 array('class' => 'expireimage'));
56 $name .= '(' . get_string('expired', 'badges') . ')';
59 $download = $status = $push = '';
60 if (($userid == $USER->id
) && !$profile) {
61 $url = new moodle_url('mybadges.php', array('download' => $badge->id
, 'hash' => $badge->uniquehash
, 'sesskey' => sesskey()));
62 $notexpiredbadge = (empty($badge->dateexpire
) ||
$badge->dateexpire
> time());
63 $backpackexists = badges_user_has_backpack($USER->id
);
64 if (!empty($CFG->badges_allowexternalbackpack
) && $notexpiredbadge && $backpackexists) {
65 $assertion = new moodle_url('/badges/assertion.php', array('b' => $badge->uniquehash
));
66 $action = new component_action('click', 'addtobackpack', array('assertion' => $assertion->out(false)));
67 $push = $this->output
->action_icon(new moodle_url('#'), new pix_icon('t/backpack', get_string('addtobackpack', 'badges')), $action);
70 $download = $this->output
->action_icon($url, new pix_icon('t/download', get_string('download')));
71 if ($badge->visible
) {
72 $url = new moodle_url('mybadges.php', array('hide' => $badge->issuedid
, 'sesskey' => sesskey()));
73 $status = $this->output
->action_icon($url, new pix_icon('t/hide', get_string('makeprivate', 'badges')));
75 $url = new moodle_url('mybadges.php', array('show' => $badge->issuedid
, 'sesskey' => sesskey()));
76 $status = $this->output
->action_icon($url, new pix_icon('t/show', get_string('makepublic', 'badges')));
81 $url = new moodle_url('badge.php', array('hash' => $badge->uniquehash
));
84 $url = new moodle_url('/badges/badge.php', array('hash' => $badge->uniquehash
));
86 $hash = hash('md5', $badge->hostedUrl
);
87 $url = new moodle_url('/badges/external.php', array('hash' => $hash, 'user' => $userid));
90 $actions = html_writer
::tag('div', $push . $download . $status, array('class' => 'badge-actions'));
91 $items[] = html_writer
::link($url, $image . $actions . $name, array('title' => $bname));
94 return html_writer
::alist($items, array('class' => 'badges'));
97 // Recipients selection form.
98 public function recipients_selection_form(user_selector_base
$existinguc, user_selector_base
$potentialuc) {
100 $formattributes = array();
101 $formattributes['id'] = 'recipientform';
102 $formattributes['action'] = $this->page
->url
;
103 $formattributes['method'] = 'post';
104 $output .= html_writer
::start_tag('form', $formattributes);
105 $output .= html_writer
::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
107 $existingcell = new html_table_cell();
108 $existingcell->text
= $existinguc->display(true);
109 $existingcell->attributes
['class'] = 'existing';
110 $actioncell = new html_table_cell();
111 $actioncell->text
= html_writer
::start_tag('div', array());
112 $actioncell->text
.= html_writer
::empty_tag('input', array(
115 'value' => $this->output
->larrow() . ' ' . get_string('award', 'badges'),
116 'class' => 'actionbutton')
118 $actioncell->text
.= html_writer
::end_tag('div', array());
119 $actioncell->attributes
['class'] = 'actions';
120 $potentialcell = new html_table_cell();
121 $potentialcell->text
= $potentialuc->display(true);
122 $potentialcell->attributes
['class'] = 'potential';
124 $table = new html_table();
125 $table->attributes
['class'] = 'recipienttable boxaligncenter';
126 $table->data
= array(new html_table_row(array($existingcell, $actioncell, $potentialcell)));
127 $output .= html_writer
::table($table);
129 $output .= html_writer
::end_tag('form');
133 // Prints a badge overview infomation.
134 public function print_badge_overview($badge, $context) {
138 $display .= html_writer
::start_tag('fieldset', array('class' => 'generalbox'));
139 $display .= html_writer
::tag('legend', get_string('badgedetails', 'badges'), array('class' => 'bold'));
141 $detailstable = new html_table();
142 $detailstable->attributes
= array('class' => 'clearfix', 'id' => 'badgedetails');
143 $detailstable->data
[] = array(get_string('name') . ":", $badge->name
);
144 $detailstable->data
[] = array(get_string('description', 'badges') . ":", $badge->description
);
145 $detailstable->data
[] = array(get_string('createdon', 'search') . ":", userdate($badge->timecreated
));
146 $detailstable->data
[] = array(get_string('badgeimage', 'badges') . ":",
147 print_badge_image($badge, $context, 'large'));
148 $display .= html_writer
::table($detailstable);
149 $display .= html_writer
::end_tag('fieldset');
152 $display .= html_writer
::start_tag('fieldset', array('class' => 'generalbox'));
153 $display .= html_writer
::tag('legend', get_string('issuerdetails', 'badges'), array('class' => 'bold'));
155 $issuertable = new html_table();
156 $issuertable->attributes
= array('class' => 'clearfix', 'id' => 'badgeissuer');
157 $issuertable->data
[] = array(get_string('issuername', 'badges') . ":", $badge->issuername
);
158 $issuertable->data
[] = array(get_string('contact', 'badges') . ":",
159 html_writer
::tag('a', $badge->issuercontact
, array('href' => 'mailto:' . $badge->issuercontact
)));
160 $display .= html_writer
::table($issuertable);
161 $display .= html_writer
::end_tag('fieldset');
163 // Issuance details if any.
164 $display .= html_writer
::start_tag('fieldset', array('class' => 'generalbox'));
165 $display .= html_writer
::tag('legend', get_string('issuancedetails', 'badges'), array('class' => 'bold'));
166 if ($badge->can_expire()) {
167 if ($badge->expiredate
) {
168 $display .= get_string('expiredate', 'badges', userdate($badge->expiredate
));
169 } else if ($badge->expireperiod
) {
170 if ($badge->expireperiod
< 60) {
171 $display .= get_string('expireperiods', 'badges', round($badge->expireperiod
, 2));
172 } else if ($badge->expireperiod
< 60 * 60) {
173 $display .= get_string('expireperiodm', 'badges', round($badge->expireperiod
/ 60, 2));
174 } else if ($badge->expireperiod
< 60 * 60 * 24) {
175 $display .= get_string('expireperiodh', 'badges', round($badge->expireperiod
/ 60 / 60, 2));
177 $display .= get_string('expireperiod', 'badges', round($badge->expireperiod
/ 60 / 60 / 24, 2));
181 $display .= get_string('noexpiry', 'badges');
183 $display .= html_writer
::end_tag('fieldset');
185 // Criteria details if any.
186 $display .= html_writer
::start_tag('fieldset', array('class' => 'generalbox'));
187 $display .= html_writer
::tag('legend', get_string('bcriteria', 'badges'), array('class' => 'bold'));
188 if ($badge->has_criteria()) {
189 $display .= self
::print_badge_criteria($badge);
191 $display .= get_string('nocriteria', 'badges');
192 if (has_capability('moodle/badges:configurecriteria', $context)) {
193 $display .= $this->output
->single_button(
194 new moodle_url('/badges/criteria.php', array('id' => $badge->id
)),
195 get_string('addcriteria', 'badges'), 'POST', array('class' => 'activatebadge'));
198 $display .= html_writer
::end_tag('fieldset');
200 // Awards details if any.
201 if (has_capability('moodle/badges:viewawarded', $context)) {
202 $display .= html_writer
::start_tag('fieldset', array('class' => 'generalbox'));
203 $display .= html_writer
::tag('legend', get_string('awards', 'badges'), array('class' => 'bold'));
204 if ($badge->has_awards()) {
205 $url = new moodle_url('/badges/recipients.php', array('id' => $badge->id
));
207 $a->link
= $url->out();
208 $a->count
= count($badge->get_awards());
209 $display .= get_string('numawards', 'badges', $a);
211 $display .= get_string('noawards', 'badges');
214 if (has_capability('moodle/badges:awardbadge', $context) &&
215 $badge->has_manual_award_criteria() &&
216 $badge->is_active()) {
217 $display .= $this->output
->single_button(
218 new moodle_url('/badges/award.php', array('id' => $badge->id
)),
219 get_string('award', 'badges'), 'POST', array('class' => 'activatebadge'));
221 $display .= html_writer
::end_tag('fieldset');
227 // Prints action icons for the badge.
228 public function print_badge_table_actions($badge, $context) {
231 if (has_capability('moodle/badges:configuredetails', $context) && $badge->has_criteria()) {
232 // Activate/deactivate badge.
233 if ($badge->status
== BADGE_STATUS_INACTIVE ||
$badge->status
== BADGE_STATUS_INACTIVE_LOCKED
) {
234 // "Activate" will go to another page and ask for confirmation.
235 $url = new moodle_url('/badges/action.php');
236 $url->param('id', $badge->id
);
237 $url->param('activate', true);
238 $url->param('sesskey', sesskey());
239 $return = new moodle_url(qualified_me());
240 $url->param('return', $return->out_as_local_url(false));
241 $actions .= $this->output
->action_icon($url, new pix_icon('t/show', get_string('activate', 'badges'))) . " ";
243 $url = new moodle_url(qualified_me());
244 $url->param('lock', $badge->id
);
245 $url->param('sesskey', sesskey());
246 $actions .= $this->output
->action_icon($url, new pix_icon('t/hide', get_string('deactivate', 'badges'))) . " ";
250 // Award badge manually.
251 if ($badge->has_manual_award_criteria() &&
252 has_capability('moodle/badges:awardbadge', $context) &&
253 $badge->is_active()) {
254 $url = new moodle_url('/badges/award.php', array('id' => $badge->id
));
255 $actions .= $this->output
->action_icon($url, new pix_icon('t/award', get_string('award', 'badges'))) . " ";
259 if (has_capability('moodle/badges:configuredetails', $context)) {
260 $url = new moodle_url('/badges/edit.php', array('id' => $badge->id
, 'action' => 'details'));
261 $actions .= $this->output
->action_icon($url, new pix_icon('t/edit', get_string('edit'))) . " ";
265 if (has_capability('moodle/badges:createbadge', $context)) {
266 $url = new moodle_url('/badges/action.php', array('copy' => '1', 'id' => $badge->id
, 'sesskey' => sesskey()));
267 $actions .= $this->output
->action_icon($url, new pix_icon('t/copy', get_string('copy'))) . " ";
271 if (has_capability('moodle/badges:deletebadge', $context)) {
272 $url = new moodle_url(qualified_me());
273 $url->param('delete', $badge->id
);
274 $actions .= $this->output
->action_icon($url, new pix_icon('t/delete', get_string('delete'))) . " ";
280 // Outputs issued badge with actions available.
281 protected function render_issued_badge(issued_badge
$ibadge) {
282 global $USER, $CFG, $DB, $SITE;
283 $issued = $ibadge->issued
;
284 $userinfo = $ibadge->recipient
;
285 $badgeclass = $ibadge->badgeclass
;
286 $badge = new badge($ibadge->badgeid
);
289 $table = new html_table();
290 $table->id
= 'issued-badge-table';
292 $imagetable = new html_table();
293 $imagetable->attributes
= array('class' => 'clearfix badgeissuedimage');
294 $imagetable->data
[] = array(html_writer
::empty_tag('img', array('src' => $badgeclass['image'])));
295 if ($USER->id
== $userinfo->id
&& !empty($CFG->enablebadges
)) {
296 $imagetable->data
[] = array($this->output
->single_button(
297 new moodle_url('/badges/badge.php', array('hash' => $issued['uid'], 'bake' => true)),
298 get_string('download'),
300 $expiration = isset($issued['expires']) ?
$issued['expires'] : $now +
86400;
301 if (!empty($CFG->badges_allowexternalbackpack
) && ($expiration > $now) && badges_user_has_backpack($USER->id
)) {
302 $assertion = new moodle_url('/badges/assertion.php', array('b' => $issued['uid']));
303 $action = new component_action('click', 'addtobackpack', array('assertion' => $assertion->out(false)));
307 'value' => get_string('addtobackpack', 'badges'));
308 $tobackpack = html_writer
::tag('input', '', $attributes);
309 $this->output
->add_action_handler($action, 'addbutton');
310 $imagetable->data
[] = array($tobackpack);
313 $datatable = new html_table();
314 $datatable->attributes
= array('class' => 'badgeissuedinfo');
315 $datatable->colclasses
= array('bfield', 'bvalue');
317 // Recipient information.
318 $datatable->data
[] = array($this->output
->heading(get_string('recipientdetails', 'badges'), 3), '');
319 if ($userinfo->deleted
) {
320 $strdata = new stdClass();
321 $strdata->user
= fullname($userinfo);
322 $strdata->site
= format_string($SITE->fullname
, true, array('context' => context_system
::instance()));
323 $datatable->data
[] = array(get_string('name'), get_string('error:userdeleted', 'badges', $strdata));
325 $datatable->data
[] = array(get_string('name'), fullname($userinfo));
326 if (empty($userinfo->backpackemail
)) {
327 $datatable->data
[] = array(get_string('email'), obfuscate_mailto($userinfo->accountemail
));
329 $datatable->data
[] = array(get_string('email'), obfuscate_mailto($userinfo->backpackemail
));
333 $datatable->data
[] = array($this->output
->heading(get_string('issuerdetails', 'badges'), 3), '');
334 $datatable->data
[] = array(get_string('issuername', 'badges'), $badge->issuername
);
335 if (isset($badge->issuercontact
) && !empty($badge->issuercontact
)) {
336 $datatable->data
[] = array(get_string('contact', 'badges'), obfuscate_mailto($badge->issuercontact
));
338 $datatable->data
[] = array($this->output
->heading(get_string('badgedetails', 'badges'), 3), '');
339 $datatable->data
[] = array(get_string('name'), $badge->name
);
340 $datatable->data
[] = array(get_string('description', 'badges'), $badge->description
);
342 if ($badge->type
== BADGE_TYPE_COURSE
&& isset($badge->courseid
)) {
343 $coursename = $DB->get_field('course', 'fullname', array('id' => $badge->courseid
));
344 $datatable->data
[] = array(get_string('course'), $coursename);
347 $datatable->data
[] = array(get_string('bcriteria', 'badges'), self
::print_badge_criteria($badge));
348 $datatable->data
[] = array($this->output
->heading(get_string('issuancedetails', 'badges'), 3), '');
349 $datatable->data
[] = array(get_string('dateawarded', 'badges'), userdate($issued['issuedOn']));
350 if (isset($issued['expires'])) {
351 if ($issued['expires'] < $now) {
352 $cell = new html_table_cell(userdate($issued['expires']) . get_string('warnexpired', 'badges'));
353 $cell->attributes
= array('class' => 'notifyproblem warning');
354 $datatable->data
[] = array(get_string('expirydate', 'badges'), $cell);
356 $image = html_writer
::start_tag('div', array('class' => 'badge'));
357 $image .= html_writer
::empty_tag('img', array('src' => $badgeclass['image']));
358 $image .= $this->output
->pix_icon('i/expired',
359 get_string('expireddate', 'badges', userdate($issued['expires'])),
361 array('class' => 'expireimage'));
362 $image .= html_writer
::end_tag('div');
363 $imagetable->data
[0] = array($image);
365 $datatable->data
[] = array(get_string('expirydate', 'badges'), userdate($issued['expires']));
370 $agg = $badge->get_aggregation_methods();
371 $evidence = $badge->get_criteria_completions($userinfo->id
);
372 $eids = array_map(create_function('$o', 'return $o->critid;'), $evidence);
373 unset($badge->criteria
[BADGE_CRITERIA_TYPE_OVERALL
]);
376 foreach ($badge->criteria
as $type => $c) {
377 if (in_array($c->id
, $eids)) {
378 if (count($c->params
) == 1) {
379 $items[] = get_string('criteria_descr_single_' . $type , 'badges') . $c->get_details();
381 $items[] = get_string('criteria_descr_' . $type , 'badges',
382 strtoupper($agg[$badge->get_aggregation_method($type)])) . $c->get_details();
387 $datatable->data
[] = array(get_string('evidence', 'badges'),
388 get_string('completioninfo', 'badges') .
389 html_writer
::alist($items, array(), 'ul'));
390 $table->attributes
= array('class' => 'generalbox boxaligncenter issuedbadgebox');
391 $table->data
[] = array(html_writer
::table($imagetable), html_writer
::table($datatable));
392 $htmlbadge = html_writer
::table($table);
397 // Outputs external badge.
398 protected function render_external_badge(external_badge
$ibadge) {
399 $issued = $ibadge->issued
;
400 $assertion = $issued->assertion
;
401 $issuer = $assertion->badge
->issuer
;
402 $userinfo = $ibadge->recipient
;
403 $table = new html_table();
405 $imagetable = new html_table();
406 $imagetable->attributes
= array('class' => 'clearfix badgeissuedimage');
407 $imagetable->data
[] = array(html_writer
::empty_tag('img', array('src' => $issued->imageUrl
, 'width' => '100px')));
409 $datatable = new html_table();
410 $datatable->attributes
= array('class' => 'badgeissuedinfo');
411 $datatable->colclasses
= array('bfield', 'bvalue');
413 // Recipient information.
414 $datatable->data
[] = array($this->output
->heading(get_string('recipientdetails', 'badges'), 3), '');
415 // Technically, we should alway have a user at this point, but added an extra check just in case.
417 $datatable->data
[] = array(get_string('name'), fullname($userinfo));
418 if (!$ibadge->valid
) {
419 $notify = $this->output
->notification(get_string('recipientvalidationproblem', 'badges'), 'notifynotice');
420 $datatable->data
[] = array(get_string('email'), obfuscate_mailto($userinfo->email
) . $notify);
422 $datatable->data
[] = array(get_string('email'), obfuscate_mailto($userinfo->email
));
425 $notify = $this->output
->notification(get_string('recipientidentificationproblem', 'badges'), 'notifynotice');
426 $datatable->data
[] = array(get_string('name'), $notify);
429 $datatable->data
[] = array($this->output
->heading(get_string('issuerdetails', 'badges'), 3), '');
430 $datatable->data
[] = array(get_string('issuername', 'badges'), $issuer->name
);
431 $datatable->data
[] = array(get_string('issuerurl', 'badges'),
432 html_writer
::tag('a', $issuer->origin
, array('href' => $issuer->origin
)));
433 if (isset($issuer->contact
)) {
434 $datatable->data
[] = array(get_string('contact', 'badges'), obfuscate_mailto($issuer->contact
));
436 $datatable->data
[] = array($this->output
->heading(get_string('badgedetails', 'badges'), 3), '');
437 $datatable->data
[] = array(get_string('name'), $assertion->badge
->name
);
438 $datatable->data
[] = array(get_string('description', 'badges'), $assertion->badge
->description
);
439 $datatable->data
[] = array(get_string('bcriteria', 'badges'),
440 html_writer
::tag('a', $assertion->badge
->criteria
, array('href' => $assertion->badge
->criteria
)));
441 $datatable->data
[] = array($this->output
->heading(get_string('issuancedetails', 'badges'), 3), '');
442 if (isset($assertion->issued_on
)) {
443 $datatable->data
[] = array(get_string('dateawarded', 'badges'), $assertion->issued_on
);
445 if (isset($assertion->badge
->expire
)) {
446 $today_date = date('Y-m-d');
447 $today = strtotime($today_date);
448 $expiration = strtotime($assertion->badge
->expire
);
449 if ($expiration < $today) {
450 $cell = new html_table_cell($assertion->badge
->expire
. get_string('warnexpired', 'badges'));
451 $cell->attributes
= array('class' => 'notifyproblem warning');
452 $datatable->data
[] = array(get_string('expirydate', 'badges'), $cell);
454 $image = html_writer
::start_tag('div', array('class' => 'badge'));
455 $image .= html_writer
::empty_tag('img', array('src' => $issued['badge']['image']));
456 $image .= html_writer
::start_tag('span', array('class' => 'expired'))
457 . $this->output
->pix_icon('i/expired',
458 get_string('expireddate', 'badges', $assertion->badge
->expire
),
460 array('class' => 'expireimage'))
461 . html_writer
::end_tag('span');
462 $image .= html_writer
::end_tag('div');
463 $imagetable->data
[0] = array($image);
465 $datatable->data
[] = array(get_string('expirydate', 'badges'), $assertion->badge
->expire
);
468 if (isset($assertion->evidence
)) {
469 $datatable->data
[] = array(get_string('evidence', 'badges'),
470 html_writer
::tag('a', $assertion->evidence
, array('href' => $assertion->evidence
)));
472 $table->attributes
= array('class' => 'generalbox boxaligncenter issuedbadgebox');
473 $table->data
[] = array(html_writer
::table($imagetable), html_writer
::table($datatable));
474 $htmlbadge = html_writer
::table($table);
479 // Outputs table of user badges.
480 protected function render_badge_user_collection(badge_user_collection
$badges) {
481 global $CFG, $USER, $SITE;
482 $backpack = $badges->backpack
;
483 $mybackpack = new moodle_url('/badges/mybackpack.php');
485 $paging = new paging_bar($badges->totalcount
, $badges->page
, $badges->perpage
, $this->page
->url
, 'page');
486 $htmlpagingbar = $this->render($paging);
488 // Set backpack connection string.
489 $backpackconnect = '';
490 if (!empty($CFG->badges_allowexternalbackpack
) && is_null($backpack)) {
491 $backpackconnect = $this->output
->box(get_string('localconnectto', 'badges', $mybackpack->out()), 'noticebox');
494 $searchform = $this->output
->box($this->helper_search_form($badges->search
), 'boxwidthwide boxaligncenter');
496 // Download all button.
497 $downloadall = $this->output
->single_button(
498 new moodle_url('/badges/mybadges.php', array('downloadall' => true, 'sesskey' => sesskey())),
499 get_string('downloadall'), 'POST', array('class' => 'activatebadge'));
502 $localhtml = html_writer
::start_tag('fieldset', array('id' => 'issued-badge-table', 'class' => 'generalbox'));
503 $heading = get_string('localbadges', 'badges', format_string($SITE->fullname
, true, array('context' => context_system
::instance())));
504 $localhtml .= html_writer
::tag('legend', $this->output
->heading_with_help($heading, 'localbadgesh', 'badges'));
505 if ($badges->badges
) {
506 $table = new html_table();
507 $table->attributes
['class'] = 'statustable';
508 $table->data
[] = array($this->output
->heading(get_string('badgesearned', 'badges', $badges->totalcount
), 4, 'activatebadge'), $downloadall);
509 $downloadbutton = html_writer
::table($table);
511 $htmllist = $this->print_badges_list($badges->badges
, $USER->id
);
512 $localhtml .= $backpackconnect . $downloadbutton . $searchform . $htmlpagingbar . $htmllist . $htmlpagingbar;
514 $localhtml .= $searchform . $this->output
->notification(get_string('nobadges', 'badges'));
516 $localhtml .= html_writer
::end_tag('fieldset');
520 if (!empty($CFG->badges_allowexternalbackpack
)) {
521 $externalhtml .= html_writer
::start_tag('fieldset', array('class' => 'generalbox'));
522 $externalhtml .= html_writer
::tag('legend', $this->output
->heading_with_help(get_string('externalbadges', 'badges'), 'externalbadges', 'badges'));
523 if (!is_null($backpack)) {
524 if ($backpack->totalcollections
== 0) {
525 $externalhtml .= get_string('nobackpackcollections', 'badges', $backpack);
527 if ($backpack->totalbadges
== 0) {
528 $externalhtml .= get_string('nobackpackbadges', 'badges', $backpack);
530 $externalhtml .= get_string('backpackbadges', 'badges', $backpack);
531 $externalhtml .= '<br/><br/>' . $this->print_badges_list($backpack->badges
, $USER->id
, true, true);
535 $externalhtml .= get_string('externalconnectto', 'badges', $mybackpack->out());
538 $externalhtml .= html_writer
::end_tag('fieldset');
541 return $localhtml . $externalhtml;
544 // Outputs table of available badges.
545 protected function render_badge_collection(badge_collection
$badges) {
546 $paging = new paging_bar($badges->totalcount
, $badges->page
, $badges->perpage
, $this->page
->url
, 'page');
547 $htmlpagingbar = $this->render($paging);
548 $table = new html_table();
549 $table->attributes
['class'] = 'collection';
551 $sortbyname = $this->helper_sortable_heading(get_string('name'),
552 'name', $badges->sort
, $badges->dir
);
553 $sortbyawarded = $this->helper_sortable_heading(get_string('awardedtoyou', 'badges'),
554 'dateissued', $badges->sort
, $badges->dir
);
555 $table->head
= array(
556 get_string('badgeimage', 'badges'),
558 get_string('description', 'badges'),
559 get_string('bcriteria', 'badges'),
562 $table->colclasses
= array('badgeimage', 'name', 'description', 'criteria', 'awards');
564 foreach ($badges->badges
as $badge) {
565 $badgeimage = print_badge_image($badge, $this->page
->context
, 'large');
566 $name = $badge->name
;
567 $description = $badge->description
;
568 $criteria = self
::print_badge_criteria($badge);
569 if ($badge->dateissued
) {
570 $icon = new pix_icon('i/valid',
571 get_string('dateearned', 'badges',
572 userdate($badge->dateissued
, get_string('strftimedatefullshort', 'core_langconfig'))));
573 $badgeurl = new moodle_url('/badges/badge.php', array('hash' => $badge->uniquehash
));
574 $awarded = $this->output
->action_icon($badgeurl, $icon, null, null, true);
578 $row = array($badgeimage, $name, $description, $criteria, $awarded);
579 $table->data
[] = $row;
582 $htmltable = html_writer
::table($table);
584 return $htmlpagingbar . $htmltable . $htmlpagingbar;
587 // Outputs table of badges with actions available.
588 protected function render_badge_management(badge_management
$badges) {
589 $paging = new paging_bar($badges->totalcount
, $badges->page
, $badges->perpage
, $this->page
->url
, 'page');
593 if (has_capability('moodle/badges:createbadge', $this->page
->context
)) {
594 $n['type'] = $this->page
->url
->get_param('type');
595 $n['id'] = $this->page
->url
->get_param('id');
596 $htmlnew = $this->output
->single_button(new moodle_url('newbadge.php', $n), get_string('newbadge', 'badges'));
599 $htmlpagingbar = $this->render($paging);
600 $table = new html_table();
601 $table->attributes
['class'] = 'collection';
603 $sortbyname = $this->helper_sortable_heading(get_string('name'),
604 'name', $badges->sort
, $badges->dir
);
605 $sortbystatus = $this->helper_sortable_heading(get_string('status', 'badges'),
606 'status', $badges->sort
, $badges->dir
);
607 $table->head
= array(
610 get_string('bcriteria', 'badges'),
611 get_string('awards', 'badges'),
612 get_string('actions')
614 $table->colclasses
= array('name', 'status', 'criteria', 'awards', 'actions');
616 foreach ($badges->badges
as $b) {
617 $style = !$b->is_active() ?
array('class' => 'dimmed') : array();
618 $forlink = print_badge_image($b, $this->page
->context
) . ' ' .
619 html_writer
::start_tag('span') . $b->name
. html_writer
::end_tag('span');
620 $name = html_writer
::link(new moodle_url('/badges/overview.php', array('id' => $b->id
)), $forlink, $style);
621 $status = $b->statstring
;
622 $criteria = self
::print_badge_criteria($b, 'short');
624 if (has_capability('moodle/badges:viewawarded', $this->page
->context
)) {
625 $awards = html_writer
::link(new moodle_url('/badges/recipients.php', array('id' => $b->id
)), $b->awards
);
627 $awards = $b->awards
;
630 $actions = self
::print_badge_table_actions($b, $this->page
->context
);
632 $row = array($name, $status, $criteria, $awards, $actions);
633 $table->data
[] = $row;
635 $htmltable = html_writer
::table($table);
637 return $htmlnew . $htmlpagingbar . $htmltable . $htmlpagingbar;
640 // Prints tabs for badge editing.
641 public function print_badge_tabs($badgeid, $context, $current = 'overview') {
646 $row[] = new tabobject('overview',
647 new moodle_url('/badges/overview.php', array('id' => $badgeid)),
648 get_string('boverview', 'badges')
651 if (has_capability('moodle/badges:configuredetails', $context)) {
652 $row[] = new tabobject('details',
653 new moodle_url('/badges/edit.php', array('id' => $badgeid, 'action' => 'details')),
654 get_string('bdetails', 'badges')
658 if (has_capability('moodle/badges:configurecriteria', $context)) {
659 $row[] = new tabobject('criteria',
660 new moodle_url('/badges/criteria.php', array('id' => $badgeid)),
661 get_string('bcriteria', 'badges')
665 if (has_capability('moodle/badges:configuremessages', $context)) {
666 $row[] = new tabobject('message',
667 new moodle_url('/badges/edit.php', array('id' => $badgeid, 'action' => 'message')),
668 get_string('bmessage', 'badges')
672 if (has_capability('moodle/badges:viewawarded', $context)) {
673 $awarded = $DB->count_records_sql('SELECT COUNT(b.userid)
674 FROM {badge_issued} b INNER JOIN {user} u ON b.userid = u.id
675 WHERE b.badgeid = :badgeid AND u.deleted = 0', array('badgeid' => $badgeid));
676 $row[] = new tabobject('awards',
677 new moodle_url('/badges/recipients.php', array('id' => $badgeid)),
678 get_string('bawards', 'badges', $awarded)
682 echo $this->tabtree($row, $current);
686 * Prints badge status box.
687 * @return Either the status box html as a string or null
689 public function print_badge_status_box(badge
$badge) {
690 if (has_capability('moodle/badges:configurecriteria', $badge->get_context())) {
691 $table = new html_table();
692 $table->attributes
['class'] = 'boxaligncenter statustable';
694 if (!$badge->has_criteria()) {
695 $criteriaurl = new moodle_url('/badges/criteria.php', array('id' => $badge->id
));
696 $status = get_string('nocriteria', 'badges');
697 if ($this->page
->url
!= $criteriaurl) {
698 $action = $this->output
->single_button(
700 get_string('addcriteria', 'badges'), 'POST', array('class' => 'activatebadge'));
704 $row = array($status, $action);
706 $status = get_string('statusmessage_' . $badge->status
, 'badges');
707 if ($badge->is_active()) {
708 $action = $this->output
->single_button(new moodle_url('/badges/action.php',
709 array('id' => $badge->id
, 'lock' => 1, 'sesskey' => sesskey(),
710 'return' => $this->page
->url
->out_as_local_url(false))),
711 get_string('deactivate', 'badges'), 'POST', array('class' => 'activatebadge'));
713 $action = $this->output
->single_button(new moodle_url('/badges/action.php',
714 array('id' => $badge->id
, 'activate' => 1, 'sesskey' => sesskey(),
715 'return' => $this->page
->url
->out_as_local_url(false))),
716 get_string('activate', 'badges'), 'POST', array('class' => 'activatebadge'));
718 $row = array($status . $this->output
->help_icon('status', 'badges'), $action);
720 $table->data
[] = $row;
722 $style = $badge->is_active() ?
'generalbox statusbox active' : 'generalbox statusbox inactive';
723 return $this->output
->box(html_writer
::table($table), $style);
729 // Prints badge criteria.
730 public function print_badge_criteria(badge
$badge, $short = '') {
732 $agg = $badge->get_aggregation_methods();
733 if (empty($badge->criteria
)) {
734 return get_string('nocriteria', 'badges');
735 } else if (count($badge->criteria
) == 2) {
737 $output .= get_string('criteria_descr', 'badges');
740 $output .= get_string('criteria_descr_' . $short . BADGE_CRITERIA_TYPE_OVERALL
, 'badges',
741 strtoupper($agg[$badge->get_aggregation_method()]));
744 unset($badge->criteria
[BADGE_CRITERIA_TYPE_OVERALL
]);
745 foreach ($badge->criteria
as $type => $c) {
746 if (count($c->params
) == 1) {
747 $items[] = get_string('criteria_descr_single_' . $short . $type , 'badges') . $c->get_details($short);
749 $items[] = get_string('criteria_descr_' . $short . $type , 'badges',
750 strtoupper($agg[$badge->get_aggregation_method($type)])) . $c->get_details($short);
753 $output .= html_writer
::alist($items, array(), 'ul');
757 // Prints criteria actions for badge editing.
758 public function print_criteria_actions(badge
$badge) {
759 $table = new html_table();
760 $table->attributes
= array('class' => 'boxaligncenter', 'id' => 'badgeactions');
761 $table->colclasses
= array('activatebadge');
764 if (!$badge->is_active() && !$badge->is_locked()) {
765 $accepted = $badge->get_accepted_criteria();
766 $potential = array_diff($accepted, array_keys($badge->criteria
));
768 if (!empty($potential)) {
769 foreach ($potential as $p) {
771 $select[$p] = get_string('criteria_' . $p, 'badges');
774 $actions[] = get_string('addbadgecriteria', 'badges');
775 $actions[] = $this->output
->single_select(new moodle_url('/badges/criteria_settings.php',
776 array('badgeid' => $badge->id
, 'add' => true)), 'type', $select);
778 $actions[] = $this->output
->box(get_string('nothingtoadd', 'badges'), 'clearfix');
782 $table->data
[] = $actions;
783 return html_writer
::table($table);
786 // Renders a table with users who have earned the badge.
787 // Based on stamps collection plugin.
788 protected function render_badge_recipients(badge_recipients
$recipients) {
789 $paging = new paging_bar($recipients->totalcount
, $recipients->page
, $recipients->perpage
, $this->page
->url
, 'page');
790 $htmlpagingbar = $this->render($paging);
791 $table = new html_table();
792 $table->attributes
['class'] = 'generaltable boxaligncenter boxwidthwide';
794 $sortbyfirstname = $this->helper_sortable_heading(get_string('firstname'),
795 'firstname', $recipients->sort
, $recipients->dir
);
796 $sortbylastname = $this->helper_sortable_heading(get_string('lastname'),
797 'lastname', $recipients->sort
, $recipients->dir
);
798 if ($this->helper_fullname_format() == 'lf') {
799 $sortbyname = $sortbylastname . ' / ' . $sortbyfirstname;
801 $sortbyname = $sortbyfirstname . ' / ' . $sortbylastname;
804 $sortbydate = $this->helper_sortable_heading(get_string('dateawarded', 'badges'),
805 'dateissued', $recipients->sort
, $recipients->dir
);
807 $table->head
= array($sortbyname, $sortbydate, '');
809 foreach ($recipients->userids
as $holder) {
810 $fullname = fullname($holder);
811 $fullname = html_writer
::link(
812 new moodle_url('/user/profile.php', array('id' => $holder->userid
)),
815 $awarded = userdate($holder->dateissued
);
816 $badgeurl = html_writer
::link(
817 new moodle_url('/badges/badge.php', array('hash' => $holder->uniquehash
)),
818 get_string('viewbadge', 'badges')
821 $row = array($fullname, $awarded, $badgeurl);
822 $table->data
[] = $row;
825 $htmltable = html_writer
::table($table);
827 return $htmlpagingbar . $htmltable . $htmlpagingbar;
830 ////////////////////////////////////////////////////////////////////////////
832 // Reused from stamps collection plugin
833 ////////////////////////////////////////////////////////////////////////////
836 * Renders a text with icons to sort by the given column
838 * This is intended for table headings.
840 * @param string $text The heading text
841 * @param string $sortid The column id used for sorting
842 * @param string $sortby Currently sorted by (column id)
843 * @param string $sorthow Currently sorted how (ASC|DESC)
847 protected function helper_sortable_heading($text, $sortid = null, $sortby = null, $sorthow = null) {
848 $out = html_writer
::tag('span', $text, array('class' => 'text'));
850 if (!is_null($sortid)) {
851 if ($sortby !== $sortid ||
$sorthow !== 'ASC') {
852 $url = new moodle_url($this->page
->url
);
853 $url->params(array('sort' => $sortid, 'dir' => 'ASC'));
854 $out .= $this->output
->action_icon($url,
855 new pix_icon('t/sort_asc', get_string('sortbyx', 'core', s($text)), null, array('class' => 'iconsort')));
857 if ($sortby !== $sortid ||
$sorthow !== 'DESC') {
858 $url = new moodle_url($this->page
->url
);
859 $url->params(array('sort' => $sortid, 'dir' => 'DESC'));
860 $out .= $this->output
->action_icon($url,
861 new pix_icon('t/sort_desc', get_string('sortbyxreverse', 'core', s($text)), null, array('class' => 'iconsort')));
867 * Tries to guess the fullname format set at the site
869 * @return string fl|lf
871 protected function helper_fullname_format() {
872 $fake = new stdClass();
873 $fake->lastname
= 'LLLL';
874 $fake->firstname
= 'FFFF';
875 $fullname = get_string('fullnamedisplay', '', $fake);
876 if (strpos($fullname, 'LLLL') < strpos($fullname, 'FFFF')) {
883 * Renders a search form
885 * @param string $search Search string
886 * @return string HTML
888 protected function helper_search_form($search) {
890 require_once($CFG->libdir
. '/formslib.php');
892 $mform = new MoodleQuickForm('searchform', 'POST', $this->page
->url
);
894 $mform->addElement('hidden', 'sesskey', sesskey());
896 $el[] = $mform->createElement('text', 'search', get_string('search'), array('size' => 20));
897 $mform->setDefault('search', $search);
898 $el[] = $mform->createElement('submit', 'submitsearch', get_string('search'));
899 $el[] = $mform->createElement('submit', 'clearsearch', get_string('clear'));
900 $mform->addGroup($el, 'searchgroup', get_string('searchname', 'badges'), ' ', false);
904 $out = ob_get_clean();
911 * An issued badges for badge.php page
913 class issued_badge
implements renderable
{
914 /** @var issued badge */
917 /** @var badge recipient */
920 /** @var badge class */
923 /** @var badge visibility to others */
926 /** @var badge class */
930 * Initializes the badge to display
932 * @param string $hash Issued badge hash
934 public function __construct($hash) {
937 $assertion = new core_badges_assertion($hash);
938 $this->issued
= $assertion->get_badge_assertion();
939 $this->badgeclass
= $assertion->get_badge_class();
941 $rec = $DB->get_record_sql('SELECT userid, visible, badgeid
943 WHERE ' . $DB->sql_compare_text('uniquehash', 40) . ' = ' . $DB->sql_compare_text(':hash', 40),
944 array('hash' => $hash), IGNORE_MISSING
);
946 // Get a recipient from database.
947 $namefields = get_all_user_name_fields(true, 'u');
948 $user = $DB->get_record_sql("SELECT u.id, $namefields, u.deleted,
949 u.email AS accountemail, b.email AS backpackemail
950 FROM {user} u LEFT JOIN {badge_backpack} b ON u.id = b.userid
951 WHERE u.id = :userid", array('userid' => $rec->userid
));
952 $this->recipient
= $user;
953 $this->visible
= $rec->visible
;
954 $this->badgeid
= $rec->badgeid
;
960 * An external badges for external.php page
962 class external_badge
implements renderable
{
963 /** @var issued badge */
969 /** @var validation of external badge */
970 public $valid = true;
973 * Initializes the badge to display
975 * @param object $badge External badge information.
976 * @param int $recipient User id.
978 public function __construct($badge, $recipient) {
980 // At this point a user has connected a backpack. So, we are going to get
981 // their backpack email rather than their account email.
982 $user = $DB->get_record_sql('SELECT u.lastname, u.firstname, b.email
983 FROM {user} u INNER JOIN {badge_backpack} b ON u.id = b.userid
984 WHERE userid = :userid', array('userid' => $recipient), IGNORE_MISSING
);
986 $this->issued
= $badge;
987 $this->recipient
= $user;
989 // Check if recipient is valid.
990 // There is no way to be 100% sure that a badge belongs to a user.
991 // Backpack does not return any recipient information.
992 // All we can do is compare that backpack email hashed using salt
993 // provided in the assertion matches a badge recipient from the assertion.
995 if (validate_email($badge->assertion
->recipient
) && $badge->assertion
->recipient
== $user->email
) {
996 // If we have email, compare emails.
998 } else if ($badge->assertion
->recipient
== 'sha256$' . hash('sha256', $user->email
)) {
999 // If recipient is hashed, but no salt, compare hashes without salt.
1000 $this->valid
= true;
1001 } else if ($badge->assertion
->recipient
== 'sha256$' . hash('sha256', $user->email
. $badge->assertion
->salt
)) {
1002 // If recipient is hashed, compare hashes.
1003 $this->valid
= true;
1005 // Otherwise, we cannot be sure that this user is a recipient.
1006 $this->valid
= false;
1009 $this->valid
= false;
1015 * Badge recipients rendering class
1017 class badge_recipients
implements renderable
{
1018 /** @var string how are the data sorted */
1019 public $sort = 'lastname';
1021 /** @var string how are the data sorted */
1022 public $dir = 'ASC';
1024 /** @var int page number to display */
1027 /** @var int number of badge recipients to display per page */
1028 public $perpage = 30;
1030 /** @var int the total number or badge recipients to display */
1031 public $totalcount = null;
1033 /** @var array internal list of badge recipients ids */
1034 public $userids = array();
1036 * Initializes the list of users to display
1038 * @param array $holders List of badge holders
1040 public function __construct($holders) {
1041 $this->userids
= $holders;
1046 * Collection of all badges for view.php page
1048 class badge_collection
implements renderable
{
1050 /** @var string how are the data sorted */
1051 public $sort = 'name';
1053 /** @var string how are the data sorted */
1054 public $dir = 'ASC';
1056 /** @var int page number to display */
1059 /** @var int number of badges to display per page */
1060 public $perpage = BADGE_PERPAGE
;
1062 /** @var int the total number of badges to display */
1063 public $totalcount = null;
1065 /** @var array list of badges */
1066 public $badges = array();
1069 * Initializes the list of badges to display
1071 * @param array $badges Badges to render
1073 public function __construct($badges) {
1074 $this->badges
= $badges;
1079 * Collection of badges used at the index.php page
1081 class badge_management
extends badge_collection
implements renderable
{
1085 * Collection of user badges used at the mybadges.php page
1087 class badge_user_collection
extends badge_collection
implements renderable
{
1088 /** @var array backpack settings */
1089 public $backpack = null;
1091 /** @var string search */
1092 public $search = '';
1095 * Initializes user badge collection.
1097 * @param array $badges Badges to render
1098 * @param int $userid Badges owner
1100 public function __construct($badges, $userid) {
1102 parent
::__construct($badges);
1104 if (!empty($CFG->badges_allowexternalbackpack
)) {
1105 $this->backpack
= get_backpack_settings($userid, true);