[ Index ]

PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008]

title

Body

[close]

/tag/ -> locallib.php (summary)

locallib.php - moodle tag local library - output functions

Version: : $Id: locallib.php,v 1.1.2.18 2008/09/24 08:04:01 scyrma Exp $
File Size: 387 lines (13 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 9 functions

  tag_print_cloud()
  tag_cloud_sort()
  tag_print_description_box()
  tag_print_management_box()
  tag_print_search_box()
  tag_print_search_results()
  tag_print_tagged_users_table()
  tag_print_user_box()
  tag_print_user_list()

Functions
Functions that are not part of a class:

tag_print_cloud($nr_of_tags=150, $return=false)   X-Ref
Prints a tag cloud

param: array $tagcloud array of tag objects (fields: id, name, rawname, count and flag)
param: $return if true return html string

tag_cloud_sort($a, $b)   X-Ref
This function is used by print_tag_cloud, to usort() the tags in the cloud.
See php.net/usort for the parameters documentation. This was originally in
blocks/blog_tags/block_blog_tags.php, named blog_tags_sort().


tag_print_description_box($tag_object, $return=false)   X-Ref
Prints a box with the description of a tag and its related tags

param: unknown_type $tag_object
param: $return if true return html string

tag_print_management_box($tag_object, $return=false)   X-Ref
Prints a box that contains the management links of a tag

param: $tagid
param: $return if true return html string

tag_print_search_box($return=false)   X-Ref
Prints the tag search box

param: bool $return if true return html string

tag_print_search_results($query, $page, $perpage, $return=false)   X-Ref
Prints the tag search results

param: string $query text that tag names will be matched against
param: int $page current page
param: int $perpage nr of users displayed per page
param: $return if true return html string

tag_print_tagged_users_table($tag_object, $limitfrom='' , $limitnum='', $return=false)   X-Ref
Prints a table of the users tagged with the tag passed as argument

param: $tag_object
param: int $users_per_row number of users per row to display
param: int $limitfrom prints users starting at this point (optional, required if $limitnum is set).
param: int $limitnum prints this many users (optional, required if $limitfrom is set).
param: $return if true return html string

tag_print_user_box($user, $return=false)   X-Ref
Prints an individual user box

param: $user user object (contains the following fields: id, firstname, lastname and picture)
param: $return if true return html string

tag_print_user_list($userlist, $return=false)   X-Ref
Prints a list of users

param: array $userlist an array of user objects
param: $return if true return html string



Generated: Wed Jan 14 11:33:29 2009 Cross-referenced by PHPXref 0.7