blocks/badges/block_badges.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/>.
  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 class block_badges extends block_base {
  26
  27     public function init() {
  28         global $CFG;
  29
  30         require_once($CFG->libdir . "/badgeslib.php");
  31
  32         $this->title = get_string('pluginname', 'block_badges');
  33     }
  34
  35     public function instance_allow_multiple() {
  36         return true;
  37     }
  38
  39     public function has_config() {
  40         return false;
  41     }
  42
  43     public function instance_allow_config() {
  44         return true;
  45     }
  46
  47     public function applicable_formats() {
  48         return array(
  49                 'admin' => false,
  50                 'site-index' => true,
  51                 'course-view' => true,
  52                 'mod' => false,
  53                 'my' => true
  54         );
  55     }
  56
  57     public function specialization() {
  58         if (empty($this->config->title)) {
  59             $this->title = get_string('pluginname', 'block_badges');
  60         } else {
  61             $this->title = $this->config->title;
  62         }
  63     }
  64
  65     public function get_content() {
  66         global $USER, $CFG;
  67
  68         if ($this->content !== null) {
  69             return $this->content;
  70         }
  71
  72         if (empty($this->config)) {
  73             $this->config = new stdClass();
  74         }
  75
  76         // Number of badges to display.
  77         if (!isset($this->config->numberofbadges)) {
  78             $this->config->numberofbadges = 10;
  79         }
  80
  81         // Create empty content.
  82         $this->content = new stdClass();
  83         $this->content->text = '';
  84
  85         if (empty($CFG->enablebadges)) {
  86             $this->content->text .= get_string('badgesdisabled', 'badges');
  87             return $this->content;
  88         }
  89
  90         $courseid = $this->page->course->id;
  91         if ($courseid == SITEID) {
  92             $courseid = null;
  93         }
  94
  95         if ($badges = badges_get_user_badges($USER->id, $courseid, 0, $this->config->numberofbadges)) {
  96             $output = $this->page->get_renderer('core', 'badges');
  97             $this->content->text = $output->print_badges_list($badges, $USER->id, true);
  98         } else {
  99             $this->content->text .= get_string('nothingtodisplay', 'block_badges');
 100         }
 101
 102         return $this->content;
 103     }
 104
 105     /**
 106      * This block shouldn't be added to a page if the badges advanced feature is disabled.
 107      *
 108      * @param moodle_page $page
 109      * @return bool
 110      */
 111     public function can_block_be_added(moodle_page $page): bool {
 112         global $CFG;
 113
 114         return $CFG->enablebadges;
 115     }
 116 }