Merge branch 'MDL-40245_master' of git://github.com/SWiT/moodle
[moodle.git] / blocks / tags / block_tags.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  * Tags block.
19  *
20  * @package   block_tags
21  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 class block_tags extends block_base {
26     public function init() {
27         $this->title = get_string('pluginname', 'block_tags');
28     }
30     public function instance_allow_multiple() {
31         return true;
32     }
34     public function has_config() {
35         return true;
36     }
38     public function applicable_formats() {
39         return array('all' => true);
40     }
42     public function instance_allow_config() {
43         return true;
44     }
46     public function specialization() {
48         // Load userdefined title and make sure it's never empty.
49         if (empty($this->config->title)) {
50             $this->title = get_string('pluginname', 'block_tags');
51         } else {
52             $this->title = $this->config->title;
53         }
54     }
56     public function get_content() {
58         global $CFG, $COURSE, $USER, $SCRIPT, $OUTPUT;
60         if (empty($CFG->usetags)) {
61             $this->content = new stdClass();
62             $this->content->text = '';
63             if ($this->page->user_is_editing()) {
64                 $this->content->text = get_string('disabledtags', 'block_tags');
65             }
66             return $this->content;
67         }
69         if (!isset($this->config)) {
70             $this->config = new stdClass();
71         }
73         if (empty($this->config->numberoftags)) {
74             $this->config->numberoftags = 80;
75         }
77         if (empty($this->config->tagtype)) {
78             $this->config->tagtype = '';
79         }
81         if ($this->content !== NULL) {
82             return $this->content;
83         }
85         if (empty($this->instance)) {
86             $this->content = '';
87             return $this->content;
88         }
90         $this->content = new stdClass;
91         $this->content->text = '';
92         $this->content->footer = '';
94         // Get a list of tags.
96         require_once($CFG->dirroot.'/tag/locallib.php');
98         $this->content->text = tag_print_cloud(null, $this->config->numberoftags, true);
100         return $this->content;
101     }