tag/locallib.php

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