blocks/blog_tags/block_blog_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/>.
  16
  17 /**
  18  * Blog tags block.
  19  *
  20  * @package    block
  21  * @subpackage blog_tags
  22  * @copyright  2006 Shane Elliott
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 define('BLOCK_BLOG_TAGS_DEFAULTTIMEWITHIN', 90);
  29 define('BLOCK_BLOG_TAGS_DEFAULTNUMBEROFTAGS', 20);
  30 define('BLOCK_BLOG_TAGS_DEFAULTSORT', 'name');
  31
  32 class block_blog_tags extends block_base {
  33     function init() {
  34         $this->title = get_string('pluginname', 'block_blog_tags');
  35     }
  36
  37     function instance_allow_multiple() {
  38         return true;
  39     }
  40
  41     function has_config() {
  42         return false;
  43     }
  44
  45     function applicable_formats() {
  46         return array('all' => true, 'my' => false, 'tag' => false);
  47     }
  48
  49     function instance_allow_config() {
  50         return true;
  51     }
  52
  53     function specialization() {
  54
  55         // load userdefined title and make sure it's never empty
  56         if (empty($this->config->title)) {
  57             $this->title = get_string('pluginname', 'block_blog_tags');
  58         } else {
  59             $this->title = $this->config->title;
  60         }
  61     }
  62
  63     function get_content() {
  64         global $CFG, $SITE, $USER, $DB, $OUTPUT;
  65
  66         if ($this->content !== NULL) {
  67             return $this->content;
  68         }
  69
  70         // make sure blog and tags are actually enabled
  71         if (empty($CFG->bloglevel)) {
  72             $this->content = new stdClass();
  73             $this->content->text = '';
  74             if ($this->page->user_is_editing()) {
  75                 $this->content->text = get_string('blogdisable', 'blog');
  76             }
  77             return $this->content;
  78
  79         } else if (empty($CFG->usetags)) {
  80             $this->content = new stdClass();
  81             $this->content->text = '';
  82             if ($this->page->user_is_editing()) {
  83                 $this->content->text = get_string('tagsaredisabled', 'tag');
  84             }
  85             return $this->content;
  86
  87         } else if ($CFG->bloglevel < BLOG_GLOBAL_LEVEL and (!isloggedin() or isguestuser())) {
  88             $this->content = new stdClass();
  89             $this->content->text = '';
  90             return $this->content;
  91         }
  92
  93         // require the libs and do the work
  94         require_once($CFG->dirroot .'/blog/lib.php');
  95
  96         if (empty($this->config)) {
  97             $this->config = new stdClass();
  98         }
  99
 100         if (empty($this->config->timewithin)) {
 101             $this->config->timewithin = BLOCK_BLOG_TAGS_DEFAULTTIMEWITHIN;
 102         }
 103         if (empty($this->config->numberoftags)) {
 104             $this->config->numberoftags = BLOCK_BLOG_TAGS_DEFAULTNUMBEROFTAGS;
 105         }
 106         if (empty($this->config->sort)) {
 107             $this->config->sort = BLOCK_BLOG_TAGS_DEFAULTSORT;
 108         }
 109
 110         $this->content = new stdClass();
 111         $this->content->text = '';
 112         $this->content->footer = '';
 113
 114         /// Get a list of tags
 115         $timewithin = time() - $this->config->timewithin * 24 * 60 * 60; /// convert to seconds
 116
 117         $context = $this->page->context;
 118
 119         // admins should be able to read all tags
 120         $type = '';
 121         if (!has_capability('moodle/user:readuserblogs', context_system::instance())) {
 122             $type = " AND (p.publishstate = 'site' or p.publishstate='public')";
 123         }
 124
 125         $sql  = "SELECT t.id, t.tagtype, t.rawname, t.name, COUNT(DISTINCT ti.id) AS ct
 126                    FROM {tag} t, {tag_instance} ti, {post} p, {blog_association} ba
 127                   WHERE t.id = ti.tagid AND p.id = ti.itemid
 128                         $type
 129                         AND ti.itemtype = 'post'
 130                         AND ti.timemodified > $timewithin";
 131
 132         if ($context->contextlevel == CONTEXT_MODULE) {
 133             $sql .= " AND ba.contextid = $context->id AND p.id = ba.blogid ";
 134         } else if ($context->contextlevel == CONTEXT_COURSE) {
 135             $sql .= " AND ba.contextid = $context->id AND p.id = ba.blogid ";
 136         }
 137
 138         $sql .= "
 139                GROUP BY t.id, t.tagtype, t.name, t.rawname
 140                ORDER BY ct DESC, t.name ASC";
 141
 142         if ($tags = $DB->get_records_sql($sql, null, 0, $this->config->numberoftags)) {
 143
 144         /// There are 2 things to do:
 145         /// 1. tags with the same count should have the same size class
 146         /// 2. however many tags we have should be spread evenly over the
 147         ///    20 size classes
 148
 149             $totaltags  = count($tags);
 150             $currenttag = 0;
 151
 152             $size = 20;
 153             $lasttagct = -1;
 154
 155             $etags = array();
 156             foreach ($tags as $tag) {
 157
 158                 $currenttag++;
 159
 160                 if ($currenttag == 1) {
 161                     $lasttagct = $tag->ct;
 162                     $size = 20;
 163                 } else if ($tag->ct != $lasttagct) {
 164                     $lasttagct = $tag->ct;
 165                     $size = 20 - ( (int)((($currenttag - 1) / $totaltags) * 20) );
 166                 }
 167
 168                 $tag->class = "$tag->tagtype s$size";
 169                 $etags[] = $tag;
 170
 171             }
 172
 173         /// Now we sort the tag display order
 174             $CFG->tagsort = $this->config->sort;
 175             usort($etags, "block_blog_tags_sort");
 176
 177         /// Finally we create the output
 178         /// Accessibility: markup as a list.
 179             $this->content->text .= "\n<ul class='inline-list'>\n";
 180             foreach ($etags as $tag) {
 181                 $blogurl = new moodle_url('/blog/index.php');
 182
 183                 switch ($CFG->bloglevel) {
 184                     case BLOG_USER_LEVEL:
 185                         $blogurl->param('userid', $USER->id);
 186                     break;
 187
 188                     default:
 189                         if ($context->contextlevel == CONTEXT_MODULE) {
 190                             $blogurl->param('modid', $context->instanceid);
 191                         } else if ($context->contextlevel == CONTEXT_COURSE) {
 192                             $blogurl->param('courseid', $context->instanceid);
 193                         }
 194
 195                     break;
 196                 }
 197
 198                 $blogurl->param('tagid', $tag->id);
 199                 $link = html_writer::link($blogurl, tag_display_name($tag), array('class'=>$tag->class, 'title'=>get_string('numberofentries','blog',$tag->ct)));
 200                 $this->content->text .= '<li>' . $link . '</li> ';
 201             }
 202             $this->content->text .= "\n</ul>\n";
 203
 204         }
 205         return $this->content;
 206     }
 207 }
 208
 209 function block_blog_tags_sort($a, $b) {
 210     global $CFG;
 211
 212     if (empty($CFG->tagsort)) {
 213         return 0;
 214     } else {
 215         $tagsort = $CFG->tagsort;
 216     }
 217
 218     if (is_numeric($a->$tagsort)) {
 219         return ($a->$tagsort == $b->$tagsort) ? 0 : ($a->$tagsort > $b->$tagsort) ? 1 : -1;
 220     } elseif (is_string($a->$tagsort)) {
 221         return strcmp($a->$tagsort, $b->$tagsort); //TODO: this is not compatible with UTF-8!!
 222     } else {
 223         return 0;
 224     }
 225 }
 226
 227