tag/locallib.php

   1 <?php
   2
   3 require_once($CFG->dirroot.'/tag/lib.php');
   4 require_once($CFG->libdir.'/filelib.php');
   5
   6 /**
   7  * locallib.php - moodle tag local library - output functions
   8  *
   9  * @licence http://www.gnu.org/copyleft/gpl.html GNU Public License
  10  * @package moodlecore
  11  *
  12  */
  13
  14 /**
  15  * Prints a tag cloud
  16  *
  17  * @param array $tagcloud array of tag objects (fields: id, name, rawname, count and flag)
  18  * @param $return if true return html string
  19  */
  20 function tag_print_cloud($nr_of_tags=150, $return=false) {
  21     global $CFG, $DB;
  22
  23     $can_manage_tags = has_capability('moodle/tag:manage', get_context_instance(CONTEXT_SYSTEM));
  24
  25     if ( !$tagsincloud = $DB->get_records_sql('SELECT tg.rawname, tg.id, tg.name, tg.tagtype, COUNT(ti.id) AS count, tg.flag
  26                                                  FROM {tag_instance} ti JOIN {tag} tg ON tg.id = ti.tagid
  27                                                 WHERE ti.itemtype <> \'tag\'
  28                                              GROUP BY tg.id, tg.rawname, tg.name, tg.flag, tg.tagtype
  29                                              ORDER BY count DESC, tg.name ASC', null, 0, $nr_of_tags) ) {
  30         $tagsincloud = array();
  31     }
  32
  33     $tagkeys = array_keys($tagsincloud);
  34     if (!empty($tagkeys)) {
  35         $firsttagkey = $tagkeys[0];
  36         $maxcount = $tagsincloud[$firsttagkey]->count;
  37     }
  38
  39     $etags = array();
  40
  41     foreach ($tagsincloud as $tag) {
  42         $size = (int) (( $tag->count / $maxcount) * 20);
  43         $tag->class = "$tag->tagtype s$size";
  44         $etags[] = $tag;
  45     }
  46
  47     usort($etags, "tag_cloud_sort");
  48     $output = '';
  49     $output .= "\n<ul class='tag_cloud inline-list'>\n";
  50     foreach ($etags as $tag) {
  51         if ($tag->flag > 0 && $can_manage_tags) {
  52             $tagname = '<span class="flagged-tag">'. tag_display_name($tag) .'</span>';
  53         } else {
  54             $tagname = tag_display_name($tag);
  55         }
  56
  57         $link = $CFG->wwwroot .'/tag/index.php?tag='. rawurlencode($tag->name);
  58         $output .= '<li><a href="'. $link .'" class="'. $tag->class .'" '.
  59             'title="'. get_string('numberofentries', 'blog', $tag->count) .'">'.
  60             $tagname .'</a></li> ';
  61     }
  62     $output .= "\n</ul>\n";
  63
  64     if ($return) {
  65         return $output;
  66     } else {
  67         echo $output;
  68     }
  69 }
  70
  71 /**
  72  * This function is used by print_tag_cloud, to usort() the tags in the cloud.
  73  * See php.net/usort for the parameters documentation. This was originally in
  74  * blocks/blog_tags/block_blog_tags.php, named blog_tags_sort().
  75  */
  76 function tag_cloud_sort($a, $b) {
  77     global $CFG;
  78
  79     if (empty($CFG->tagsort)) {
  80         $tagsort = 'name'; // by default, sort by name
  81     } else {
  82         $tagsort = $CFG->tagsort;
  83     }
  84
  85     if (is_numeric($a->$tagsort)) {
  86         return ($a->$tagsort == $b->$tagsort) ? 0 : ($a->$tagsort > $b->$tagsort) ? 1 : -1;
  87     } elseif (is_string($a->$tagsort)) {
  88         return strcmp($a->$tagsort, $b->$tagsort);
  89     } else {
  90         return 0;
  91     }
  92 }
  93
  94 /**
  95  * Prints a box with the description of a tag and its related tags
  96  *
  97  * @param stdClass $tag_object
  98  * @param $return if true return html string
  99  */
 100 function tag_print_description_box($tag_object, $return=false) {
 101
 102     global $USER, $CFG, $OUTPUT;
 103
 104     $max_tags_displayed = 10; // todo: turn this into a system setting
 105
 106     $tagname  = tag_display_name($tag_object);
 107     $related_tags = tag_get_related_tags($tag_object->id, TAG_RELATED_ALL, $max_tags_displayed+1); // this gets one more than we want
 108
 109     $content = !empty($tag_object->description) || $related_tags;
 110     $output = '';
 111
 112     if ($content) {
 113         $output .= $OUTPUT->box_start('generalbox', 'tag-description');
 114     }
 115
 116     if (!empty($tag_object->description)) {
 117         $options = new stdClass();
 118         $options->para = false;
 119         $options->overflowdiv = true;
 120         $tag_object->description = file_rewrite_pluginfile_urls($tag_object->description, 'pluginfile.php', get_context_instance(CONTEXT_SYSTEM)->id, 'tag', 'description', $tag_object->id);
 121         $output .= format_text($tag_object->description, $tag_object->descriptionformat, $options);
 122     }
 123
 124     if ($related_tags) {
 125         $more_links = false;
 126         if (count($related_tags) > $max_tags_displayed) {
 127             array_pop($related_tags);
 128             $more_links = true;
 129         }
 130         $output .= '<br /><br /><strong>'. get_string('relatedtags', 'tag') .': </strong>'. tag_get_related_tags_csv($related_tags);
 131         if ($more_links) {
 132             $output .= ' ...';
 133         }
 134     }
 135
 136     if ($content) {
 137         $output .= $OUTPUT->box_end();
 138     }
 139
 140     if ($return) {
 141         return $output;
 142     } else {
 143         echo $output;
 144     }
 145 }
 146
 147 /**
 148  * Prints a box that contains the management links of a tag
 149  *
 150  * @param $tagid
 151  * @param $return if true return html string
 152  */
 153 function tag_print_management_box($tag_object, $return=false) {
 154
 155     global $USER, $CFG, $OUTPUT;
 156
 157     $tagname  = tag_display_name($tag_object);
 158     $output = '';
 159
 160     if (!isguestuser()) {
 161         $output .= $OUTPUT->box_start('box','tag-management-box');
 162         $systemcontext   = get_context_instance(CONTEXT_SYSTEM);
 163         $links = array();
 164
 165         // Add a link for users to add/remove this from their interests
 166         if (tag_record_tagged_with('user', $USER->id, $tag_object->name)) {
 167             $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=removeinterest&amp;sesskey='. sesskey() .'&amp;tag='. rawurlencode($tag_object->name) .'">'. get_string('removetagfrommyinterests', 'tag', $tagname) .'</a>';
 168         } else {
 169             $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=addinterest&amp;sesskey='. sesskey() .'&amp;tag='. rawurlencode($tag_object->name) .'">'. get_string('addtagtomyinterests', 'tag', $tagname) .'</a>';
 170         }
 171
 172         // flag as inappropriate link
 173         $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=flaginappropriate&amp;sesskey='. sesskey() .'&amp;tag='. rawurlencode($tag_object->name) .'">'. get_string('flagasinappropriate', 'tag', rawurlencode($tagname)) .'</a>';
 174
 175         // Edit tag: Only people with moodle/tag:edit capability who either have it as an interest or can manage tags
 176         if (has_capability('moodle/tag:edit', $systemcontext) ||
 177             has_capability('moodle/tag:manage', $systemcontext)) {
 178             $links[] = '<a href="'. $CFG->wwwroot .'/tag/edit.php?tag='. rawurlencode($tag_object->name) .'">'. get_string('edittag', 'tag') .'</a>';
 179         }
 180
 181         $output .= implode(' | ', $links);
 182         $output .= $OUTPUT->box_end();
 183     }
 184
 185     if ($return) {
 186         return $output;
 187     } else {
 188         echo $output;
 189     }
 190 }
 191
 192 /**
 193  * Prints the tag search box
 194  *
 195  * @param bool $return if true return html string
 196  */
 197 function tag_print_search_box($return=false) {
 198     global $CFG, $OUTPUT;
 199
 200     $output = $OUTPUT->box_start('','tag-search-box');
 201     $output .= '<form action="'.$CFG->wwwroot.'/tag/search.php" style="display:inline">';
 202     $output .= '<div>';
 203     $output .= '<input id="searchform_search" name="query" type="text" size="40" />';
 204     $output .= '<button id="searchform_button" type="submit">'. get_string('search', 'tag') .'</button><br />';
 205     $output .= '</div>';
 206     $output .= '</form>';
 207     $output .= $OUTPUT->box_end();
 208
 209     if ($return) {
 210         return $output;
 211     }
 212     else {
 213         echo $output;
 214     }
 215 }
 216
 217 /**
 218  * Prints the tag search results
 219  *
 220  * @param string $query text that tag names will be matched against
 221  * @param int $page current page
 222  * @param int $perpage nr of users displayed per page
 223  * @param $return if true return html string
 224  */
 225 function tag_print_search_results($query,  $page, $perpage, $return=false) {
 226
 227     global $CFG, $USER, $OUTPUT;
 228
 229     $query = array_shift(tag_normalize($query, TAG_CASE_ORIGINAL));
 230
 231     $count = sizeof(tag_find_tags($query, false));
 232     $tags = array();
 233
 234     if ( $found_tags = tag_find_tags($query, true,  $page * $perpage, $perpage) ) {
 235         $tags = array_values($found_tags);
 236     }
 237
 238     $baseurl = $CFG->wwwroot.'/tag/search.php?query='. rawurlencode($query);
 239     $output = '';
 240
 241     // link "Add $query to my interests"
 242     $addtaglink = '';
 243     if( !tag_record_tagged_with('user', $USER->id, $query) ) {
 244         $addtaglink = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=addinterest&amp;sesskey='. sesskey() .'&amp;tag='. rawurlencode($query) .'">';
 245         $addtaglink .= get_string('addtagtomyinterests', 'tag', htmlspecialchars($query)) .'</a>';
 246     }
 247
 248     if ( !empty($tags) ) { // there are results to display!!
 249         $output .= $OUTPUT->heading(get_string('searchresultsfor', 'tag', htmlspecialchars($query)) ." : {$count}", 3, 'main');
 250
 251         //print a link "Add $query to my interests"
 252         if (!empty($addtaglink)) {
 253             $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
 254         }
 255
 256         $nr_of_lis_per_ul = 6;
 257         $nr_of_uls = ceil( sizeof($tags) / $nr_of_lis_per_ul );
 258
 259         $output .= '<ul id="tag-search-results">';
 260         for($i = 0; $i < $nr_of_uls; $i++) {
 261             $output .= '<li>';
 262             foreach (array_slice($tags, $i * $nr_of_lis_per_ul, $nr_of_lis_per_ul) as $tag) {
 263                 $tag_link = ' <a href="'. $CFG->wwwroot .'/tag/index.php?id='. $tag->id .'">'. tag_display_name($tag) .'</a>';
 264                 $output .= '&#8226;'. $tag_link .'<br/>';
 265             }
 266             $output .= '</li>';
 267         }
 268         $output .= '</ul>';
 269         $output .= '<div>&nbsp;</div>'; // <-- small layout hack in order to look good in Firefox
 270
 271         $output .= $OUTPUT->paging_bar($count, $page, $perpage, $baseurl);
 272     }
 273     else { //no results were found!!
 274         $output .= $OUTPUT->heading(get_string('noresultsfor', 'tag', htmlspecialchars($query)), 3, 'main');
 275
 276         //print a link "Add $query to my interests"
 277         if (!empty($addtaglink)) {
 278             $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
 279         }
 280     }
 281
 282     if ($return) {
 283         return $output;
 284     }
 285     else {
 286         echo $output;
 287     }
 288 }
 289
 290 /**
 291  * Prints a table of the users tagged with the tag passed as argument
 292  *
 293  * @param $tag_object
 294  * @param int $users_per_row number of users per row to display
 295  * @param int $limitfrom prints users starting at this point (optional, required if $limitnum is set).
 296  * @param int $limitnum prints this many users (optional, required if $limitfrom is set).
 297  * @param $return if true return html string
 298  */
 299 function tag_print_tagged_users_table($tag_object, $limitfrom='' , $limitnum='', $return=false) {
 300
 301     //List of users with this tag
 302     $userlist = tag_find_records($tag_object->name, 'user', $limitfrom, $limitnum);
 303
 304     $output = tag_print_user_list($userlist, true);
 305
 306     if ($return) {
 307         return $output;
 308     }
 309     else {
 310         echo $output;
 311     }
 312 }
 313
 314 /**
 315  * Prints an individual user box
 316  *
 317  * @param $user user object (contains the following fields: id, firstname, lastname and picture)
 318  * @param $return if true return html string
 319  */
 320 function tag_print_user_box($user, $return=false) {
 321     global $CFG, $OUTPUT;
 322
 323     $textlib = textlib_get_instance();
 324     $usercontext = get_context_instance(CONTEXT_USER, $user->id);
 325     $profilelink = '';
 326
 327     if ($usercontext and (has_capability('moodle/user:viewdetails', $usercontext) || has_coursecontact_role($user->id))) {
 328         $profilelink = $CFG->wwwroot .'/user/view.php?id='. $user->id;
 329     }
 330
 331     $output = $OUTPUT->box_start('user-box', 'user'. $user->id);
 332     $fullname = fullname($user);
 333     $alt = '';
 334
 335     if (!empty($profilelink)) {
 336         $output .= '<a href="'. $profilelink .'">';
 337         $alt = $fullname;
 338     }
 339
 340     $output .= $OUTPUT->user_picture($user, array('size'=>100));
 341     $output .= '<br />';
 342
 343     if (!empty($profilelink)) {
 344         $output .= '</a>';
 345     }
 346
 347     //truncate name if it's too big
 348     if ($textlib->strlen($fullname) > 26) {
 349         $fullname = $textlib->substr($fullname, 0, 26) .'...';
 350     }
 351
 352     $output .= '<strong>'. $fullname .'</strong>';
 353     $output .= $OUTPUT->box_end();
 354
 355     if ($return) {
 356         return $output;
 357     }
 358     else {
 359         echo $output;
 360     }
 361 }
 362 /**
 363  * Prints a list of users
 364  *
 365  * @param array $userlist an array of user objects
 366  * @param $return if true return html string
 367  */
 368 function tag_print_user_list($userlist, $return=false) {
 369
 370     $output = '<ul class="inline-list">';
 371
 372     foreach ($userlist as $user){
 373         $output .= '<li>'. tag_print_user_box($user, true) ."</li>\n";
 374     }
 375     $output .= "</ul>\n";
 376
 377     if ($return) {
 378         return $output;
 379     }
 380     else {
 381         echo $output;
 382     }
 383 }