From b224d959e29014f00a08b3b745c9dace88b4a7a7 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Tue, 23 Jan 2024 15:56:31 +0100 Subject: [PATCH] Doc --- htdocs/core/class/html.form.class.php | 27 ++++++++++++++------------- htdocs/user/class/user.class.php | 3 ++- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/htdocs/core/class/html.form.class.php b/htdocs/core/class/html.form.class.php index 5671cd1584e..772faafa2bb 100644 --- a/htdocs/core/class/html.form.class.php +++ b/htdocs/core/class/html.form.class.php @@ -9821,20 +9821,21 @@ class Form } /** - * Return HTML code to output a photo + * Return HTML code to output a photo * - * @param string $modulepart Key to define module concerned ('societe', 'userphoto', 'memberphoto') - * @param object $object Object containing data to retrieve file name - * @param int $width Width of photo - * @param int $height Height of photo (auto if 0) - * @param int $caneditfield Add edit fields - * @param string $cssclass CSS name to use on img for photo - * @param string $imagesize 'mini', 'small' or '' (original) - * @param int $addlinktofullsize Add link to fullsize image - * @param int $cache 1=Accept to use image in cache - * @param string $forcecapture '', 'user' or 'environment'. Force parameter capture on HTML input file element to ask a smartphone to allow to open camera to take photo. Auto if ''. - * @param int $noexternsourceoverwrite No overwrite image with extern source (like 'gravatar' or other module) - * @return string HTML code to output photo + * @param string $modulepart Key to define module concerned ('societe', 'userphoto', 'memberphoto') + * @param object $object Object containing data to retrieve file name + * @param int $width Width of photo + * @param int $height Height of photo (auto if 0) + * @param int $caneditfield Add edit fields + * @param string $cssclass CSS name to use on img for photo + * @param string $imagesize 'mini', 'small' or '' (original) + * @param int $addlinktofullsize Add link to fullsize image + * @param int $cache 1=Accept to use image in cache + * @param string $forcecapture '', 'user' or 'environment'. Force parameter capture on HTML input file element to ask a smartphone to allow to open camera to take photo. Auto if ''. + * @param int $noexternsourceoverwrite No overwrite image with extern source (like 'gravatar' or other module) + * @return string HTML code to output photo + * @see getImagePublicURLOfObject() */ public static function showphoto($modulepart, $object, $width = 100, $height = 0, $caneditfield = 0, $cssclass = 'photowithmargin', $imagesize = '', $addlinktofullsize = 1, $cache = 0, $forcecapture = '', $noexternsourceoverwrite = 0) { diff --git a/htdocs/user/class/user.class.php b/htdocs/user/class/user.class.php index 34e9735ca8a..c2c4d80235f 100644 --- a/htdocs/user/class/user.class.php +++ b/htdocs/user/class/user.class.php @@ -2810,6 +2810,7 @@ class User extends CommonObject * @param string $cssclass Force a css class * @param string $imagesize 'mini', 'small' or '' (original) * @return string String with URL link + * @see getImagePublicURLOfObject() */ public function getPhotoUrl($width, $height, $cssclass = '', $imagesize = '') { @@ -2823,7 +2824,7 @@ class User extends CommonObject /** * Return array of data to show into tooltips * - * @param array $params ex option, infologin + * @param array $params Array with options, infologin * @since v18 * @return array */