chamilo / chamilo-lms

main/auth/openid/openid.lib.php

Doc Comments +7 added lines

@@ -242,6 +242,9 @@ 
     return $hmac;
 }
 
+/**
+ * @param string|false $text
+ */
 function _openid_sha1($text) {
     $hex = sha1($text);
     $raw = '';
@@ -404,6 +407,10 @@ 
  */
 if (!function_exists('bcpowmod')) {
 
+    /**
+     * @param string $exp
+     * @param string $mod
+     */
     function bcpowmod($base, $exp, $mod) {
         $square = bcmod($base, $mod);
         $result = 1;

src/Chamilo/CoreBundle/Entity/Language.php

Doc Comments +1 added lines, -1 removed lines

@@ -230,7 +230,7 @@
     /**
      * Get id
      *
-     * @return boolean
+     * @return integer
      */
     public function getId()
     {

src/Chamilo/CourseBundle/Component/CourseCopy/CourseBuilder.php

Doc Comments +1 added lines, -1 removed lines

@@ -91,7 +91,7 @@
     }
 
     /**
-     * @param array $array
+     * @param string[] $array
      */
     public function set_tools_to_build($array)
     {

main/forum/forumfunction.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -3054,7 +3054,7 @@
  * @param integer $thread_qualify
  * @param integer $qualify_time
  * @param integer $session_id
- * @return array optional
+ * @return string|null optional
  * @author Isaac Flores <isaac.flores@dokeos.com>, U.N.A.S University
  * @version October 2008, dokeos  1.8.6
  */

main/inc/lib/api.lib.php

Doc Comments +5 added lines, -2 removed lines

@@ -1244,6 +1244,7 @@ 
  * Gets the list of courses a specific user is subscribed to
  * @param int       User ID
  * @param boolean   $fetch_session Whether to get session courses or not - NOT YET IMPLEMENTED
+ * @param integer $userid
  * @return array    Array of courses in the form [0]=>('code'=>xxx,'db'=>xxx,'dir'=>xxx,'status'=>d)
  */
 function api_get_user_courses($userid, $fetch_session = true)
@@ -3036,7 +3037,7 @@ 
 * on the session visibility
 * @param bool $tutor  Whether to check if the user has the tutor role
 * @param bool  $coach Whether to check if the user has the coach role
-* @return boolean true: the user has the rights to edit, false: he does not
+* @return boolean|null true: the user has the rights to edit, false: he does not
 */
 function api_is_allowed_to_session_edit($tutor = false, $coach = false)
 {
@@ -6656,7 +6657,7 @@ 
 /**
  * Returns an array of global configuration settings which should be ignored
  * when printing the configuration settings screens
- * @return array Array of strings, each identifying one of the excluded settings
+ * @return string[] Array of strings, each identifying one of the excluded settings
  */
 function api_get_locked_settings() {
     return array(
@@ -6699,6 +6700,7 @@ 
  * false if he isn't. If the user ID is given and is an integer, then the same
  * ID is simply returned
  * @param  integer User ID
+ * @param integer $user_id
  * @return boolean Integer User ID is logged in, or false otherwise
  */
 function api_user_is_login($user_id = null) {
@@ -7143,6 +7145,7 @@ 
 /**
  * Gets memory limit in bytes
  * @param string The memory size (128M, 1G, 1000K, etc)
+ * @param string $mem
  * @return int
  * @assert (null) === false
  * @assert ('1t')  === 1099511627776

main/inc/lib/course_request.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
      * @param string $objetives
      * @param string $target_audience
      * @param int $user_id
-     * @return mixed The database id of the newly created course request or FALSE on failure.
+     * @return false|string The database id of the newly created course request or FALSE on failure.
      */
     public static function create_course_request(
         $wanted_code,

main/inc/lib/document.lib.php

Doc Comments +24 added lines, -19 removed lines

@@ -277,7 +277,7 @@ 
     /**
      *  @param string
      *  @param string
-     * 	@return true if the user is allowed to see the document, false otherwise
+     * 	@return boolean if the user is allowed to see the document, false otherwise
      * 	@author Sergio A Kessler, first version
      * 	@author Roan Embrechts, bugfix
      *  @todo not only check if a file is visible, but also check if the user is allowed to see the file??
@@ -1529,7 +1529,7 @@ 
      * Return true if the documentpath have visibility=1 as
      * item_property (you should use the is_visible_by_id)
      *
-     * @param string $document_path the relative complete path of the document
+     * @param string $doc_path the relative complete path of the document
      * @param array  $course the _course array info of the document's course
      * @param int
      * @param string
@@ -1614,6 +1614,8 @@ 
      * @param   int
      * @param   int
      * @param bool
+     * @param integer $session_id
+     * @param integer $user_id
      * @return  bool
      */
     public static function is_visible_by_id(
@@ -1965,7 +1967,7 @@ 
      * Remove default certificate
      * @param string $course_id The course code
      * @param int $default_certificate_id The document id of the default certificate
-     * @return void
+     * @return false|null
      */
     public static function remove_attach_certificate($course_id, $default_certificate_id)
     {
@@ -2100,6 +2102,7 @@ 
      * @param	bool  	is file or string html
      * @param	string	type (one of the app tools) - optional (otherwise takes the current item's type)
      * @param	int		level of recursivity we're in
+     * @param string $source_html
      * @return	array	List of file paths. An additional field containing 'local' or 'remote' helps determine
      * if the file should be copied into the zip or just linked
      */
@@ -2938,6 +2941,7 @@ 
 
     /**
      * Obtains the text inside the file with the right parser
+     * @param string $doc_path
      */
     public static function get_text_content($doc_path, $doc_mime)
     {
@@ -3188,6 +3192,7 @@ 
      * Shows a play icon next to the document title in the document list
      * @param int
      * @param string
+     * @param integer|null $i
      * @return string	html content
      */
     static function generate_media_preview($i, $type = 'simple')
@@ -3581,7 +3586,7 @@ 
      * @param bool $add_move_button
      * @param string $target
      * @param string $overwrite_url
-     * @return null|string
+     * @return string
      */
     private static function parseFile(
         $course_info,
@@ -4086,7 +4091,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_web_odf_extension_list()
     {
@@ -4095,10 +4100,10 @@ 
 
     /**
      * Set of extension allowed to use Jodconverter
-     * @param $mode 'from'
+     * @param string $mode 'from'
      *              'to'
      *              'all'
-     * @param $format   'text'
+     * @param string $format   'text'
      *                  'spreadsheet'
      *                  'presentation'
      *                  'drawing'
@@ -4302,7 +4307,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_system_folders()
     {
@@ -4320,7 +4325,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getProtectedFolderFromStudent()
     {
@@ -4476,7 +4481,7 @@ 
      * Requires the ffmpeg lib. In ubuntu: sudo apt-get install ffmpeg
      * @param string $wavFile
      * @param bool $removeWavFileIfSuccess
-     * @return bool
+     * @return string|false
      */
     public static function convertWavToMp3($wavFile, $removeWavFileIfSuccess = false)
     {
@@ -5051,6 +5056,8 @@ 
      * @param string	The current folder (path inside of the "document" directory, including the prefix "/")
      * @param string	Group directory, if empty, prevents documents to be uploaded (because group documents cannot be uploaded in root)
      * @param	boolean	Whether to change the renderer (this will add a template <span> to the QuickForm object displaying the form)
+     * @param string $document_id
+     * @param FormValidator $form
 
      * @return string html form
      */
@@ -5560,9 +5567,6 @@ 
     /**
      * Creates the row of edit icons for a file/folder
      *
-     * @param string $curdirpath current path (cfr open folder)
-     * @param string $type (file/folder)
-     * @param string $path dbase path of file/folder
      * @param int $visibility (1/0)
      * @param int $id dbase id of the document
      * @return string html img tags with hyperlinks
@@ -5894,7 +5898,7 @@ 
     /**
      * Gets the path translated with title of docs and folders
      * @param string $path the real path
-     * @return the path which should be displayed
+     * @return string path which should be displayed
      */
     public static function get_titles_of_path($path)
     {
@@ -5949,7 +5953,8 @@ 
 
     /**
      * Checks whether the user is in shared folder
-     * @return return bool Return true when user is into shared folder
+     * @param integer $current_session_id
+     * @return boolean bool Return true when user is into shared folder
      */
     public static function is_shared_folder($curdirpath, $current_session_id)
     {
@@ -5965,7 +5970,7 @@ 
 
     /**
      * Checks whether the user is into any user shared folder
-     * @return return bool Return true when user is in any user shared folder
+     * @return boolean bool Return true when user is in any user shared folder
      */
     public static function is_any_user_shared_folder($path, $current_session_id)
     {
@@ -6179,7 +6184,7 @@ 
      * @param int $id
      * @param array $courseInfo
      * @param int $sessionId
-     * @return bool
+     * @return boolean|null
      */
     public static function downloadDeletedDocument($id, $courseInfo, $sessionId)
     {
@@ -6198,7 +6203,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public static function downloadAllDeletedDocument($courseInfo, $sessionId)
     {
@@ -6237,7 +6242,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public function deleteDocumentsFromSession($courseInfo, $sessionId)
     {

main/inc/lib/fileManage.lib.php

Doc Comments +6 added lines, -4 removed lines

@@ -13,6 +13,8 @@ 
  * @param  - action (string) - action type require : 'delete' or 'update'
  * @param  - old_path (string) - old path info stored to change
  * @param  - new_path (string) - new path info to substitute
+ * @param string $action
+ * @param string $old_path
  * @desc Update the file or directory path in the document db document table
  *
  */
@@ -75,8 +77,8 @@ 
  * Deletes a file or a directory
  *
  * @author - Hugues Peeters
- * @param  $file (String) - the path of file or directory to delete
- * @return boolean - true if the delete succeed, false otherwise.
+ * @param  string $file (String) - the path of file or directory to delete
+ * @return boolean|null - true if the delete succeed, false otherwise.
  * @see    - delete() uses check_name_exist() and removeDir() functions
  */
 function my_delete($file)
@@ -163,7 +165,7 @@ 
  * @author Hugues Peeters <peeters@ipm.ucl.ac.be>
  * @param  string $file_path complete path of the file or the directory
  * @param  string $new_file_name new name for the file or the directory
- * @return boolean true if succeed, false otherwise
+ * @return string|false true if succeed, false otherwise
  * @see rename() uses the check_name_exist() and php2phps() functions
  */
 function my_rename($file_path, $new_file_name) {
@@ -209,7 +211,7 @@ 
  * @param  string $target the path of the new area
  * @param  bool $forceMove Whether to force a move or to make a copy (safer but slower) and then delete the original
  * @param	bool $moveContent In some cases (including migrations), we need to move the *content* and not the folder itself
- * @return bool true if the move succeed, false otherwise.
+ * @return boolean|null true if the move succeed, false otherwise.
  * @see move() uses check_name_exist() and copyDirTo() functions
  */
 function move($source, $target, $forceMove = false, $moveContent = false)

main/inc/lib/internationalization.lib.php

Doc Comments +20 added lines, -14 removed lines

@@ -422,6 +422,7 @@ 
  * If null, the timezone will be determined based on user preference,
  * or timezone chosen by the admin for the platform.
  * @param string The timezone to be converted from. If null, UTC will be assumed.
+ * @param string $to_timezone
  * @return string The converted time formatted as Y-m-d H:i:s
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -666,6 +667,7 @@ 
  * @param mixed The time to be converted
  * @param mixed Format to be used (TIME_NO_SEC_FORMAT, DATE_FORMAT_SHORT, DATE_FORMAT_LONG, DATE_TIME_FORMAT_LONG)
  * @param string Timezone to be converted from. If null, UTC will be assumed.
+ * @param string $from_timezone
  * @return string Converted and localized date
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -735,7 +737,7 @@ 
  * @param int|string $format (optional)	The person name format. It may be a pattern-string (for example '%t %l, %f' or '%T %F %L', ...) or some of the constants PERSON_NAME_COMMON_CONVENTION (default), PERSON_NAME_WESTERN_ORDER, PERSON_NAME_EASTERN_ORDER, PERSON_NAME_LIBRARY_ORDER.
  * @param string $language (optional)	The language id. If it is omitted, the current interface language is assumed. This parameter has meaning with the format PERSON_NAME_COMMON_CONVENTION only.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return bool							The result is sort of full name of the person.
+ * @return string							The result is sort of full name of the person.
  * Sample results:
  * Peter Ustinoff or Dr. Peter Ustinoff     - the Western order
  * Ustinoff Peter or Dr. Ustinoff Peter     - the Eastern order
@@ -1054,8 +1056,8 @@ 
 
 /**
  * This function returns a string or an array with all occurrences of search in subject (ignoring case) replaced with the given replace value.
- * @param mixed $search					String or array of strings to be found.
- * @param mixed $replace				String or array of strings used for replacement.
+ * @param string $search					String or array of strings to be found.
+ * @param string $replace				String or array of strings used for replacement.
  * @param mixed $subject				String or array of strings being searched.
  * @param int $count (optional)			The number of matched and replaced needles will be returned in count, which is passed by reference.
  * @param string $encoding (optional)	The used internally by this function character encoding.
@@ -1118,10 +1120,10 @@ 
 /**
  * Finds first occurrence of a string within another, case insensitive.
  * @param string $haystack					The string from which to get the first occurrence.
- * @param mixed $needle						The string to be found.
+ * @param string $needle						The string to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence of $needle.
@@ -1177,7 +1179,7 @@ 
  * @param mixed $needle						The string which first character is to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if the first character from $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if the first character from $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence.
@@ -1244,7 +1246,7 @@ 
  * @param mixed $needle						The string to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence of $needle.
@@ -1387,7 +1389,7 @@ 
  * 										Note that this changes the return value in an array where every element is an array consisting of the matched string at index 0 and its string offset into subject at index 1.
  * @param int $offset (optional)		Normally, the search starts from the beginning of the subject string. The optional parameter offset can be used to specify the alternate place from which to start the search.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return int|boolean					Returns the number of times pattern matches or FALSE if an error occurred.
+ * @return integer					Returns the number of times pattern matches or FALSE if an error occurred.
  * @link http://php.net/preg_match
  */
 function api_preg_match($pattern, $subject, &$matches = null, $flags = 0, $offset = 0, $encoding = null) {
@@ -1410,7 +1412,7 @@ 
  * If no order flag is given, PREG_PATTERN_ORDER is assumed.
  * @param int $offset (optional)		Normally, the search starts from the beginning of the subject string. The optional parameter offset can be used to specify the alternate place from which to start the search.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return int|boolean					Returns the number of full pattern matches (which might be zero), or FALSE if an error occurred.
+ * @return integer					Returns the number of full pattern matches (which might be zero), or FALSE if an error occurred.
  * @link http://php.net/preg_match_all
  */
 function api_preg_match_all($pattern, $subject, &$matches, $flags = PREG_PATTERN_ORDER, $offset = 0, $encoding = null) {
@@ -1425,8 +1427,8 @@ 
 
 /**
  * Performs a regular expression search and replace, UTF-8 aware when it is applicable.
- * @param string|array $pattern			The pattern to search for. It can be either a string or an array with strings.
- * @param string|array $replacement		The string or an array with strings to replace.
+ * @param string $pattern			The pattern to search for. It can be either a string or an array with strings.
+ * @param string $replacement		The string or an array with strings to replace.
  * @param string|array $subject			The string or an array with strings to search and replace.
  * @param int $limit					The maximum possible replacements for each pattern in each subject string. Defaults to -1 (no limit).
  * @param int &$count					If specified, this variable will be filled with the number of replacements done.
@@ -1574,7 +1576,7 @@ 
 
 /**
  * This function checks whether two $encoding are equal (same, equvalent).
- * @param string|array $encoding1		The first encoding
+ * @param string $encoding1		The first encoding
  * @param string|array $encoding2		The second encoding
  * @param bool $strict					When this parameter is TRUE the comparison ignores aliases of encodings.
  * When the parameter is FALSE, aliases are taken into account.
@@ -1678,6 +1680,7 @@ 
 /**
  * Checks a string for UTF-8 validity.
  *
+ * @param string $string
  */
 function api_is_valid_utf8(&$string)
 {
@@ -1820,7 +1823,7 @@ 
 /**
  * Replaces non-valid formats for person names with the default (English) format.
  * @param string $format	The input format to be verified.
- * @return bool				Returns the same format if is is valid, otherwise returns a valid English format.
+ * @return string				Returns the same format if is is valid, otherwise returns a valid English format.
  */
 function _api_validate_person_name_format($format) {
     if (empty($format) || stripos($format, '%f') === false || stripos($format, '%l') === false) {
@@ -1947,6 +1950,9 @@ 
 
 // This function checks whether the function _api_convert_encoding() (the php-
 // implementation) is able to convert from/to a given encoding.
+/**
+ * @param string $encoding
+ */
 function _api_convert_encoding_supports($encoding) {
     static $supports = array();
     if (!isset($supports[$encoding])) {
@@ -1957,7 +1963,7 @@ 
 
 /**
  * Given a date object, return a human or ISO format, with or without h:m:s
- * @param object $date The Date object
+ * @param DateTime $date The Date object
  * @param bool $showTime Whether to show the time and date (true) or only the date (false)
  * @param bool $humanForm Whether to show day-month-year (true) or year-month-day (false)
  * @return string Formatted date