MDL-50851 core_tag: introduce tag collections
[moodle.git] / tag / classes / output / tag.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  * Contains class core_tag\output\tag
19  *
20  * @package   core_tag
21  * @copyright 2015 Marina Glancy
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_tag\output;
27 use renderable;
28 use templatable;
29 use renderer_base;
30 use stdClass;
31 use moodle_url;
33 /**
34  * Class to help display tag
35  *
36  * @package   core_tag
37  * @copyright 2015 Marina Glancy
38  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class tag implements renderable, templatable {
42     /** @var \core_tag_tag|stdClass */
43     protected $record;
45     /**
46      * Constructor
47      *
48      * @param \core_tag_tag|stdClass $tag
49      */
50     public function __construct($tag) {
51         if ($tag instanceof \core_tag_tag) {
52             $this->record = $tag;
53             return;
54         }
55         $tag = (array)$tag +
56             array(
57                 'name' => '',
58                 'rawname' => '',
59                 'description' => '',
60                 'descriptionformat' => FORMAT_HTML,
61                 'flag' => 0,
62                 'tagtype' => 'default',
63                 'id' => 0,
64                 'tagcollid' => 0,
65             );
66         $this->record = (object)$tag;
67     }
69     /**
70      * Export this data so it can be used as the context for a mustache template.
71      *
72      * @param renderer_base $output
73      * @return stdClass
74      */
75     public function export_for_template(renderer_base $output) {
76         global $CFG;
77         require_once($CFG->libdir . '/externallib.php');
79         $r = new stdClass();
80         $r->id = (int)$this->record->id;
81         $r->tagcollid = clean_param($this->record->tagcollid, PARAM_INT);
82         $r->rawname = clean_param($this->record->rawname, PARAM_TAG);
83         $r->name = clean_param($this->record->name, PARAM_TAG);
84         $format = clean_param($this->record->descriptionformat, PARAM_INT);
85         list($r->description, $r->descriptionformat) = external_format_text($this->record->description,
86             $format, \context_system::instance()->id, 'core', 'tag', $r->id);
87         $r->flag = clean_param($this->record->flag, PARAM_INT);
88         if (isset($this->record->official)) {
89             $r->official = clean_param($this->record->official, PARAM_INT);
90         } else {
91             $r->official = ($this->record->tagtype === 'official') ? 1 : 0;
92         }
94         $url = \core_tag_tag::make_url($r->tagcollid, $r->rawname);
95         $r->viewurl = $url->out(false);
97         $manageurl = new moodle_url('/tag/manage.php', array('sesskey' => sesskey(),
98             'tagid' => $this->record->id));
99         $url = new moodle_url($manageurl);
100         $url->param('action', 'changetype');
101         $url->param('tagtype', $r->official ? 'default' : 'official');
102         $r->changetypeurl = $url->out(false);
104         $url = new moodle_url($manageurl);
105         $url->param('action', $this->record->flag ? 'resetflag' : 'setflag');
106         $r->changeflagurl = $url->out(false);
108         return $r;
109     }