chamilo / chamilo-lms

main/inc/lib/extra_field_value.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -43,7 +43,7 @@ 
     }
 
     /**
-     * @return ExtraField
+     * @return string
      */
     public function getExtraField()
     {
@@ -72,7 +72,7 @@ 
      * This function is used with $extraField->addElements()
      * @param array $params array for the insertion into the *_field_values table
      *
-     * @return mixed false on empty params, void otherwise
+     * @return false|null false on empty params, void otherwise
      * @assert (array()) === false
      */
     public function saveFieldValues($params)
@@ -500,7 +500,7 @@ 
      * @param int $item_id Item ID (It could be a session_id, course_id or user_id)
      * @param int $field_id Field ID (the ID from the *_field table)
      * @param bool $transform Whether to transform the result to a human readable strings
-     * @return mixed A structured array with the field_id and field_value, or false on error
+     * @return string A structured array with the field_id and field_value, or false on error
      * @assert (-1,-1) === false
      */
     public function get_values_by_handler_and_field_id($item_id, $field_id, $transform = false)
@@ -593,7 +593,7 @@ 
      * @param int $item_id Item ID from the original table
      * @param string $field_variable The name of the field we are looking for
      * @param bool $transform
-     * @param bool $allVisibility
+     * @param bool $visibility
      *
      * @return mixed Array of results, or false on error or not found
      * @assert (-1,'') === false

main/inc/lib/fileManage.lib.php

Doc Comments +7 added lines, -6 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
  *
  */
@@ -76,8 +78,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)
@@ -162,9 +164,9 @@ 
  * Renames a file or a directory
  *
  * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
- * @param  - $file_path (string) - complete path of the file or the directory
- * @param  - $new_file_name (string) - new name for the file or the directory
- * @return - boolean - true if succeed
+ * @param  string $file_path (string) - complete path of the file or the directory
+ * @param  string $new_file_name (string) - new name for the file or the directory
+ * @return string boolean - true if succeed
  *         - boolean - false otherwise
  * @see    - rename() uses the check_name_exist() and php2phps() functions
  */
@@ -327,7 +329,6 @@ 
  * Calculation size of a directory
  *
  * @returns integer size
- * @param 	string	$path path to size
  * @param 	boolean $recursive if true , include subdir in total
  */
 function dirsize($root, $recursive = true) {

main/inc/lib/fileUpload.lib.php

Doc Comments +10 added lines, -6 removed lines

@@ -17,6 +17,7 @@ 
  *
  * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
  * @param  - file_name (string) name of a file
+ * @param string $file_name
  * @return - the filenam phps'ized
  */
 function php2phps($file_name) {
@@ -73,7 +74,7 @@ 
  * Returns the name without extension, used for the title
  *
  * @param string $name
- * @return name without the extension
+ * @return string without the extension
  */
 function get_document_title($name) {
     // If they upload .htaccess...
@@ -86,7 +87,7 @@ 
  * This function checks if the upload succeeded
  *
  * @param array $uploaded_file ($_FILES)
- * @return true if upload succeeded
+ * @return boolean if upload succeeded
  */
 function process_uploaded_file($uploaded_file, $show_output = true)
 {
@@ -698,6 +699,8 @@ 
  * @param  - dir (string) - Path of the directory
  *           whe the file should be added
  * @param  - max_dir_space (int) - maximum size of the diretory in byte
+ * @param string $dir
+ * @param integer $max_dir_space
  * @return - boolean true if there is enough space,
  *				boolean false otherwise
  *
@@ -1022,7 +1025,7 @@ 
  * @param array  $courseInfo
  * @param array  $userInfo
  * @param array  $uploaded_file - follows the $_FILES Structure
- * @param string $upload_path   - destination of the upload.
+ * @param string $uploadPath   - destination of the upload.
  *                               This path is to append to $base_work_dir
  * @param string $base_work_dir  - base working directory of the module
  * @param int    $maxFilledSpace  - amount of bytes to not exceed in the base
@@ -1201,7 +1204,7 @@ 
  * @param bool $save_visibility
  * @param int $group_id
  * @param int $session_id Session ID, if any
- * @return int id if inserted document
+ * @return string|false id if inserted document
  */
 function add_document(
     $_course,
@@ -1337,7 +1340,7 @@ 
  *
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path+filename eg: /main/document/document.php
- * @return	The directory depth
+ * @return	integer directory depth
  */
 function get_levels($filename) {
     $levels = explode('/', $filename);
@@ -1354,6 +1357,7 @@ 
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path,filename
  * action:	Adds an entry to the document table with the default settings.
+ * @param string $upload_path
  */
 function set_default_settings($upload_path, $filename, $filetype = 'file')
 {
@@ -1778,6 +1782,7 @@ 
 
 @author Roan Embrechts
 @version 0.6
+ * @param string $buffer
  */
 function api_replace_links_in_string($upload_path, $buffer) {
     // Search for hyperlinks
@@ -2013,7 +2018,6 @@ 
  * @param int $groupId
  * @param bool $output
  * @param array $parent
- * @param string $uploadPath
  *
  */
 function add_all_documents_in_folder_to_database(

main/inc/lib/formvalidator/Element/DateRangePicker.php

Doc Comments +1 added lines

@@ -145,6 +145,7 @@
 
     /**
     * @param array $dates result of parseDateRange()
+    * @param string $format
     *
     * @return bool
     */

main/inc/lib/formvalidator/FormValidator.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -213,7 +213,7 @@ 
      * @param string $label
      * @param array $attributes
      *
-     * @return mixed
+     * @return HTML_QuickForm_element
      */
     public function addDatePicker($name, $label, $attributes = [])
     {
@@ -225,7 +225,7 @@ 
      * @param string $label
      * @param array $attributes
      *
-     * @return mixed
+     * @return HTML_QuickForm_element
      */
     public function addDateTimePicker($name, $label, $attributes = [])
     {
@@ -688,7 +688,7 @@ 
      * @param array  $options
      * @param array  $attributes
      *
-     * @return HTML_QuickForm_radio
+     * @return HTML_QuickForm_group
      */
     public function addRadio($name, $label, $options = array(), $attributes = array())
     {
@@ -817,7 +817,7 @@ 
      * @param string $name
      * @param string $label
      *
-     * @return mixed
+     * @return HTML_QuickForm_element
      */
     public function addButtonAdvancedSettings($name, $label = '')
     {
@@ -914,7 +914,7 @@ 
     /**
      * This function has been created for avoiding changes directly within QuickForm class.
      * When we use it, the element is threated as 'required' to be dealt during validation.
-     * @param array $element					The array of elements
+     * @param array $elements					The array of elements
      * @param string $message					The message displayed
      */
     public function add_multiple_required_rule($elements, $message)

main/inc/lib/formvalidator/Rule/HTML.php

Doc Comments +1 added lines, -2 removed lines

@@ -25,8 +25,7 @@
      * Get allowed tags
      * @param int $mode NO_HTML, STUDENT_HTML, TEACHER_HTML,
      * STUDENT_HTML_FULLPAGE or TEACHER_HTML_FULLPAGE
-     * @param boolean $fullpage If true, the allowed tags for full-page editing
-     * are returned.
+     * @return string
      */
     static function get_allowed_tags($mode)
     {

main/inc/lib/formvalidator/Rule/MaxFileSize.php

Doc Comments -1 removed lines

@@ -9,7 +9,6 @@
 {
 	/**
 	 * @param $value array     Uploaded file info (from $_FILES)
-	 * @param null $options
 	 * @return bool
 	 */
 	public function validate($elementValue, $maxSize)

main/inc/lib/formvalidator/Rule/MobilePhoneNumber.php

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
      *
      * @param string Mobile phone number to be validated
      * @param string Not using it. Just to respect the declaration
-     * @return boolean Returns true if valid, false otherwise.
+     * @return integer Returns true if valid, false otherwise.
      */
     function validate($mobilePhoneNumber, $options = null)
     {

main/inc/lib/getid3/getid3.php

Doc Comments +22 added lines

@@ -456,6 +456,10 @@ 
 
 
     // Add warning(s) to $this->warnings[]
+
+    /**
+     * @param string $message
+     */
     public function warning($message) {
 
         if (is_array($message)) {
@@ -482,6 +486,11 @@ 
 
 
     // Convert string between charsets -- iconv() wrapper
+
+    /**
+     * @param string $out_charset
+     * @param string $string
+     */
     public function iconv($in_charset, $out_charset, $string, $drop01 = false) {
 
         if ($drop01 && ($string === "\x00" || $string === "\x01")) {
@@ -509,6 +518,9 @@ 
 
 
 
+    /**
+     * @param string $name
+     */
     public function include_module($name) {
 
         if (!file_exists($this->include_path.'module.'.$name.'.php')) {
@@ -1342,6 +1354,10 @@ 
 
 
     // Convert Big Endian byte string to int - max 32 bits
+
+    /**
+     * @param string $byte_word
+     */
     public static function BigEndian2Int($byte_word, $signed = false) {
 
         $int_value = 0;
@@ -1391,6 +1407,9 @@ 
 
 
 
+    /**
+     * @param string $byte_word
+     */
     public static function BigEndian2Float($byte_word) {
 
 		// ANSI/IEEE Standard 754-1985, Standard for Binary Floating Point Arithmetic
@@ -1478,6 +1497,9 @@ 
 
 
 
+	/**
+	 * @param string $binary_numerator
+	 */
 	public static function DecimalBinary2Float($binary_numerator) {
 		$numerator   = bindec($binary_numerator);
 		$denominator = bindec('1'.str_repeat('0', strlen($binary_numerator)));