tag/classes/manage_table.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  * Contains class core_tag_manage_table
  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  */
  24
  25 defined('MOODLE_INTERNAL') || die();
  26
  27 require_once($CFG->libdir . '/tablelib.php');
  28
  29 /**
  30  * Class core_tag_manage_table
  31  *
  32  * @package   core
  33  * @copyright 2015 Marina Glancy
  34  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35  */
  36 class core_tag_manage_table extends table_sql {
  37
  38     /** @var int stores the total number of found tags */
  39     public $totalcount = null;
  40
  41     /**
  42      * Constructor
  43      */
  44     public function __construct() {
  45         global $USER, $CFG, $PAGE;
  46         parent::__construct('tag-management-list-'.$USER->id);
  47
  48         $perpage = optional_param('perpage', DEFAULT_PAGE_SIZE, PARAM_INT);
  49         $page = optional_param('page', 0, PARAM_INT);
  50         $baseurl = new moodle_url('/tag/manage.php', array('perpage' => $perpage, 'page' => $page));
  51
  52         $tablecolumns = array('select', 'name', 'fullname', 'count', 'flag', 'timemodified', 'tagtype', 'controls');
  53         $tableheaders = array(get_string('select', 'tag'),
  54                               get_string('name', 'tag'),
  55                               get_string('owner', 'tag'),
  56                               get_string('count', 'tag'),
  57                               get_string('flag', 'tag'),
  58                               get_string('timemodified', 'tag'),
  59                               get_string('officialtag', 'tag'),
  60                               '');
  61
  62         $this->define_columns($tablecolumns);
  63         $this->define_headers($tableheaders);
  64         $this->define_baseurl($baseurl);
  65
  66         $this->column_class('select', 'mdl-align col-select');
  67         $this->column_class('name', 'col-name');
  68         $this->column_class('owner', 'col-owner');
  69         $this->column_class('count', 'mdl-align col-count');
  70         $this->column_class('flag', 'mdl-align col-flag');
  71         $this->column_class('timemodified', 'col-timemodified');
  72         $this->column_class('tagtype', 'mdl-align col-tagtype');
  73         $this->column_class('controls', 'mdl-align col-controls');
  74
  75         $this->sortable(true, 'flag', SORT_DESC);
  76         $this->no_sorting('select');
  77         $this->no_sorting('controls');
  78
  79         $this->set_attribute('cellspacing', '0');
  80         $this->set_attribute('id', 'tag-management-list');
  81         $this->set_attribute('class', 'admintable generaltable tag-management-table');
  82
  83         $totalcount = "SELECT COUNT(id) FROM {tag}";
  84         $params = array();
  85
  86         $this->set_count_sql($totalcount, $params);
  87
  88         $this->set_sql('', '', '', $params);
  89
  90         $this->collapsible(true);
  91
  92         $PAGE->requires->js_call_amd('core/tag', 'init_manage_page', array());
  93
  94     }
  95
  96     /**
  97      * Query the db. Store results in the table object for use by build_table.
  98      *
  99      * @param int $pagesize size of page for paginated displayed table.
 100      * @param bool $useinitialsbar do you want to use the initials bar. Bar
 101      * will only be used if there is a fullname column defined for the table.
 102      */
 103     public function query_db($pagesize, $useinitialsbar = true) {
 104         global $DB;
 105         $where = '';
 106         if (!$this->is_downloading()) {
 107             $grandtotal = $DB->count_records_sql($this->countsql, $this->countparams);
 108
 109             list($wsql, $wparams) = $this->get_sql_where();
 110             if ($wsql) {
 111                 $this->countsql .= ' AND '.$wsql;
 112                 $this->countparams = array_merge($this->countparams, $wparams);
 113
 114                 $where .= ' AND '.$wsql;
 115                 $this->sql->params = array_merge($this->sql->params, $wparams);
 116
 117                 $total  = $DB->count_records_sql($this->countsql, $this->countparams);
 118             } else {
 119                 $total = $grandtotal;
 120             }
 121
 122             $this->pagesize(min($pagesize, $total), $total);
 123             $this->totalcount = $total;
 124         }
 125
 126         // Fetch the attempts.
 127         $sort = $this->get_sql_sort();
 128         if ($sort) {
 129             $sort .= ", tg.name";
 130         } else {
 131             $sort = "tg.name";
 132         }
 133
 134         $allusernames = get_all_user_name_fields(true, 'u');
 135         $sql = "
 136             SELECT tg.id, tg.name, tg.rawname, tg.tagtype, tg.flag, tg.timemodified,
 137                        u.id AS owner, $allusernames,
 138                        COUNT(ti.id) AS count
 139             FROM {tag} tg
 140             LEFT JOIN {tag_instance} ti ON ti.tagid = tg.id
 141             LEFT JOIN {user} u ON u.id = tg.userid
 142                        WHERE 1 = 1 $where
 143             GROUP BY tg.id, tg.name, tg.rawname, tg.tagtype, tg.flag, tg.timemodified,
 144                        u.id, $allusernames
 145             ORDER BY $sort";
 146
 147         if (!$this->is_downloading()) {
 148             $this->rawdata = $DB->get_records_sql($sql, $this->sql->params, $this->get_page_start(), $this->get_page_size());
 149         } else {
 150             $this->rawdata = $DB->get_records_sql($sql, $this->sql->params);
 151         }
 152     }
 153
 154     /**
 155      * Get any extra classes names to add to this row in the HTML
 156      *
 157      * @param stdClass $row array the data for this row.
 158      * @return string added to the class="" attribute of the tr.
 159      */
 160     public function get_row_class($row) {
 161         return $row->flag ? 'flagged-tag' : '';
 162     }
 163
 164     /**
 165      * Column name
 166      *
 167      * @param stdClass $tag
 168      * @return string
 169      */
 170     public function col_name($tag) {
 171         global $OUTPUT;
 172         $tagoutput = new core_tag\output\tag($tag);
 173         return $OUTPUT->render_from_template('core_tag/tagname', $tagoutput->export_for_template($OUTPUT));
 174     }
 175
 176     /**
 177      * Column flag
 178      *
 179      * @param stdClass $tag
 180      * @return string
 181      */
 182     public function col_flag($tag) {
 183         global $OUTPUT;
 184         $tagoutput = new core_tag\output\tag($tag);
 185         return $OUTPUT->render_from_template('core_tag/tagflag', $tagoutput->export_for_template($OUTPUT));
 186     }
 187
 188     /**
 189      * Column fullname (user name)
 190      *
 191      * @param stdClass $tag
 192      * @return string
 193      */
 194     public function col_fullname($tag) {
 195         $params         = array('id' => $tag->owner);
 196         $ownerlink      = new moodle_url('/user/view.php', $params);
 197         $owner          = html_writer::link($ownerlink, fullname($tag));
 198         return $owner;
 199     }
 200
 201     /**
 202      * Column time modified
 203      *
 204      * @param stdClass $tag
 205      * @return string
 206      */
 207     public function col_timemodified($tag) {
 208         return format_time(time() - $tag->timemodified);
 209     }
 210
 211     /**
 212      * Column tag type
 213      *
 214      * @param stdClass $tag
 215      * @return string
 216      */
 217     public function col_tagtype($tag) {
 218         global $OUTPUT;
 219         $tagoutput = new core_tag\output\tag($tag);
 220         return $OUTPUT->render_from_template('core_tag/tagtype', $tagoutput->export_for_template($OUTPUT));
 221     }
 222
 223     /**
 224      * Column select
 225      *
 226      * @param stdClass $tag
 227      * @return string
 228      */
 229     public function col_select($tag) {
 230         $id = "tagselect" . $tag->id;
 231         return html_writer::label(get_string('selecttag', 'tag', $tag->rawname), $id,
 232                 false, array('class' => 'accesshide')).
 233                 html_writer::empty_tag('input', array('type' => 'checkbox',
 234                 'name' => 'tagschecked[]', 'value' => $tag->id, 'id' => $id));
 235     }
 236
 237     /**
 238      * Column controls
 239      *
 240      * @param stdClass $tag
 241      * @return string
 242      */
 243     public function col_controls($tag) {
 244         global $OUTPUT, $PAGE;
 245         $o = '';
 246         // Edit.
 247         $url = new moodle_url('/tag/edit.php', array('id' => $tag->id, 'returnurl' => $PAGE->url->out_as_local_url()));
 248         $o .= $OUTPUT->action_icon($url, new pix_icon('t/edit', get_string('edittag', 'tag')));
 249         // Delete.
 250         $url = new moodle_url($this->baseurl, array('action' => 'delete',
 251             'tagid' => $tag->id, 'sesskey' => sesskey()));
 252         $o .= $OUTPUT->action_icon($url, new pix_icon('t/delete', get_string('delete', 'tag')),
 253                 null, array('class' => 'action-icon tagdelete'));
 254         return $o;
 255     }
 256 }