Merge branch 'MDL-58490-master' of git://github.com/lameze/moodle
[moodle.git] / blocks / badges / block_badges.php
CommitLineData
27806552
YB
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/>.
16
17/**
18 * Block for displaying earned local badges to users
19 *
20 * @package block_badges
21 * @copyright 2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 * @author Yuliya Bozhko <yuliya.bozhko@totaralms.com>
24 */
25
26defined('MOODLE_INTERNAL') || die();
27
28require_once($CFG->libdir . "/badgeslib.php");
29
30/**
31 * Displays recent badges
32 */
33class block_badges extends block_base {
34
35 public function init() {
36 $this->title = get_string('pluginname', 'block_badges');
37 }
38
39 public function instance_allow_multiple() {
40 return true;
41 }
42
43 public function has_config() {
44 return false;
45 }
46
47 public function instance_allow_config() {
48 return true;
49 }
50
51 public function applicable_formats() {
52 return array(
53 'admin' => false,
54 'site-index' => true,
33a43a33 55 'course-view' => true,
27806552
YB
56 'mod' => false,
57 'my' => true
58 );
59 }
60
61 public function specialization() {
62 if (empty($this->config->title)) {
63 $this->title = get_string('pluginname', 'block_badges');
64 } else {
65 $this->title = $this->config->title;
66 }
67 }
68
69 public function get_content() {
70 global $USER, $PAGE, $CFG;
71
72 if ($this->content !== null) {
73 return $this->content;
74 }
75
76 if (empty($this->config)) {
77 $this->config = new stdClass();
78 }
79
80 // Number of badges to display.
2ffbf207 81 if (!isset($this->config->numberofbadges)) {
27806552
YB
82 $this->config->numberofbadges = 10;
83 }
84
85 // Create empty content.
86 $this->content = new stdClass();
87 $this->content->text = '';
88
89 if (empty($CFG->enablebadges)) {
90 $this->content->text .= get_string('badgesdisabled', 'badges');
33a43a33
YB
91 return $this->content;
92 }
93
94 $courseid = $this->page->course->id;
95 if ($courseid == SITEID) {
96 $courseid = null;
97 }
98
99 if ($badges = badges_get_user_badges($USER->id, $courseid, 0, $this->config->numberofbadges)) {
100 $output = $this->page->get_renderer('core', 'badges');
27806552
YB
101 $this->content->text = $output->print_badges_list($badges, $USER->id, true);
102 } else {
103 $this->content->text .= get_string('nothingtodisplay', 'block_badges');
104 }
105
106 return $this->content;
107 }
108}