mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-31 04:33:13 +01:00
Code Issues Projects Releases Wiki Activity

weblib: finish documenting print_user_picture.

Browse Source
This commit is contained in:
tjhunt 2009-02-16 04:16:10 +00:00
parent e47d5adef3
commit e4e5ba8c6f
1 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
lib/weblib.php
View File

@ -4414,19 +4414,18 @@ function print_file_picture($path, $courseid=0, $height='', $width='', $link='',
/**
* Print the specified user's avatar.
*
* If you pass a $user object that has id, picture, imagealt, firstname, lastname
* you save a DB query.
*
* @param int $user takes a userid, or a userobj
* @param int $courseid The course we are in. Only needed if $link is true.
* @param boolean $picture Print the user picture?
* @param int $size Size in pixels. Special values are (true/1 = 100px) and (false/0 = 35px) for backward compatability
* @param mixed $user Should be a $user object with at least fields id, picture, imagealt, firstname, lastname
* If any of these are missing, or if a userid is passed, the the database is queried. Avoid this
* if at all possible, particularly for reports. It is very bad for performance.
* @param int $courseid The course id. Used when constructing the link to the user's profile.
* @param boolean $picture The picture to print. By default (or if NULL is passed) $user->picture is used.
* @param int $size Size in pixels. Special values are (true/1 = 100px) and (false/0 = 35px) for backward compatability
* @param boolean $return If false print picture to current page, otherwise return the output as string
* @param boolean $link Enclose printed image in a link to view specified course?
* @param string $target link target attribute
* @param boolean $alttext use username or userspecified text in image alt attribute
* return string
* @todo Finish documenting this function
* @param boolean $link enclose printed image in a link the user's profile (default true).
* @param string $target link target attribute. Makes the profile open in a popup window.
* @param boolean $alttext add non-blank alt-text to the image. (Default true, set to false for purely
* decorative images, or where the username will be printed anyway.)
* @return string or nothing, depending on $return.
*/
function print_user_picture($user, $courseid, $picture=NULL, $size=0, $return=false, $link=true, $target='', $alttext=true) {
global $CFG, $DB;