chamilo / chamilo-lms

main/inc/lib/message.lib.php

Doc Comments +5 added lines, -3 removed lines

@@ -700,6 +700,8 @@ 
      * @param  int    message id
      * @param  int    message user id (receiver user id or sender user id)
      * @param  int    group id (optional)
+     * @param integer $message_id
+     * @param integer $message_uid
      */
     public static function delete_message_attachment_file(
         $message_id,
@@ -747,7 +749,7 @@ 
      * update messages by user id and message id
      * @param  int $user_id
      * @param  int $message_id
-     * @return resource
+     * @return false|null
      */
     public static function update_message($user_id, $message_id)
     {
@@ -768,7 +770,7 @@ 
      * @param int $user_id
      * @param int $message_id
      * @param string $type
-     * @return bool
+     * @return false|null
      */
     public static function update_message_status($user_id, $message_id, $type)
     {
@@ -1592,7 +1594,7 @@ 
      * Sort date by desc from a multi-dimensional array
      * @param array $array1 first array to compare
      * @param array $array2 second array to compare
-     * @return bool
+     * @return integer
      */
     public function order_desc_date($array1, $array2)
     {

main/inc/lib/system/web/request.class.php

Doc Comments +7 added lines

@@ -9,6 +9,9 @@ 
 class Request
 {
 
+    /**
+     * @param string $key
+     */
     public static function get($key, $default = null)
     {
         return isset($_REQUEST[$key]) ? $_REQUEST[$key] : $default;
@@ -30,6 +33,10 @@ 
         return $method == 'GET';
     }
 
+    /**
+     * @param string $key
+     * @param string $default
+     */
     public static function post($key, $default = null)
     {
         return isset($_POST[$key]) ? $_POST[$key] : $default;

main/inc/lib/search/ChamiloIndexer.class.php

Doc Comments +4 added lines

@@ -80,6 +80,10 @@
 
     /**
      * Get the terms stored at database
+     * @param string $prefix
+     * @param string $course_code
+     * @param string $tool_id
+     * @param integer $ref_id
      * @return  array Array of terms
      */
     public function get_terms_on_db($prefix, $course_code, $tool_id, $ref_id)

main/inc/lib/search/xapian/XapianIndexer.class.php

Doc Comments +3 added lines, -2 removed lines

@@ -100,7 +100,7 @@ 
 
     /**
      * Simple getter for the db attribute
-     * @return  object  The db attribute
+     * @return  null|XapianWritableDatabase  The db attribute
      */
     public function getDb()
     {
@@ -110,6 +110,7 @@ 
     /**
      * Add this chunk to the chunk array attribute
      * @param  string  Chunk of text
+     * @param IndexableChunk $chunk
      * @return  void
      */
     public function addChunk($chunk)
@@ -181,7 +182,7 @@ 
      * Get document data on a xapian document
      *
      * @param XapianDocument $doc xapian document to push into the db
-     * @return mixed xapian document data or FALSE if error
+     * @return string xapian document data or FALSE if error
      */
     public function get_document_data($doc)
     {

main/exercise/hotpotatoes_exercise_result.class.php

Doc Comments +1 added lines

@@ -19,6 +19,7 @@
      * @param    string        The document path (for HotPotatoes retrieval)
      * @param    integer        User ID. Optional. If no user ID is provided, we take all the results. Defauts to null
      * @param string $document_path
+     * @param string|null $hotpotato_name
      * @return bool
      */
     public function getExercisesReporting($document_path, $hotpotato_name)

main/inc/lib/tracking.lib.php

Doc Comments +5 added lines, -5 removed lines

@@ -1635,7 +1635,7 @@ 
      * Get first connection date for a student
      * @param int $student_id
      *
-     * @return string|bool Date format long without day or false if there are no connections
+     * @return string|false Date format long without day or false if there are no connections
      */
     public static function get_first_connection_date($student_id)
     {
@@ -1665,7 +1665,7 @@ 
      * @param int $student_id
      * @param bool $warning_message Show a warning message (optional)
      * @param bool $return_timestamp True for returning results in timestamp (optional)
-     * @return string|int|bool Date format long without day, false if there are no connections or
+     * @return string Date format long without day, false if there are no connections or
      * timestamp if parameter $return_timestamp is true
      */
     public static function get_last_connection_date(
@@ -3045,7 +3045,7 @@ 
 
     /**
      * This function gets time spent in learning path for a student inside a course
-     * @param int|array $student_id Student id(s)
+     * @param integer $student_id Student id(s)
      * @param string $course_code Course code
      * @param array $lp_ids Limit average to listed lp ids
      * @param int $session_id Session id (optional), if param $session_id is null(default)
@@ -3113,7 +3113,7 @@ 
 
     /**
      * This function gets last connection time to one learning path
-     * @param int|array $student_id Student id(s)
+     * @param integer $student_id Student id(s)
      * @param string $course_code      Course code
      * @param int $lp_id    Learning path id
      * @param int $session_id
@@ -6014,7 +6014,7 @@ 
 
     /**
     * @param FormValidator $form
-    * @return mixed
+    * @return FormValidator
     */
     public static function setUserSearchForm($form)
     {

main/inc/lib/skill.visualizer.lib.php

Doc Comments +3 added lines

@@ -35,6 +35,9 @@
         $this->center_x = intval($this->offset_x + $this->canvas_x / 2 - $this->block_size / 2);
     }
 
+    /**
+     * @param string $class
+     */
     public function prepare_skill_box($skill, $position, $class)
     {
         $block_id = $skill['id'];

main/inc/lib/pdf.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -574,7 +574,7 @@
      * @param	string	$filename filename
      * @param	string	$source_file path of the file
      * @param	string	$course_code
-     * @return 	mixed	web path of the file if sucess, false otherwise
+     * @return 	string|boolean	web path of the file if sucess, false otherwise
      */
     public function upload_watermark($filename, $source_file, $course_code = null)
     {

main/install/install.lib.php

Doc Comments +15 added lines, -6 removed lines

@@ -123,7 +123,7 @@ 
  * This function return the value of a php.ini setting if not "" or if exists,
  * otherwise return false
  * @param   string  $phpSetting The name of a PHP setting
- * @return  mixed   The value of the setting, or false if not found
+ * @return  string|false   The value of the setting, or false if not found
  */
 function checkPhpSettingExists($phpSetting)
 {
@@ -154,7 +154,7 @@ 
  * Returns a textual value ('ON' or 'OFF') based on a requester 2-state ini- configuration setting.
  *
  * @param string $val a php ini value
- * @return bool ON or OFF
+ * @return string ON or OFF
  * @author Joomla <http://www.joomla.org>
  */
 function getPhpSetting($val)
@@ -1358,6 +1358,10 @@ 
  * @param   string  Extra notice (to show on the right side)
  * @param   boolean Whether to display in update mode
  * @param   string  Additional attribute for the <tr> element
+ * @param string $installType
+ * @param string $parameterName
+ * @param string $formFieldName
+ * @param string $extra_notice
  * @return  void    Direct output
  */
 function displayDatabaseParameter(
@@ -1561,6 +1565,11 @@ 
     <?php
 }
 
+/**
+ * @param string $content
+ * @param string $title
+ * @param string $id
+ */
 function panel($content = null, $title = null, $id = null, $style = null)
 {
     $html = '';
@@ -1924,8 +1933,8 @@ 
 }
 
 /**
- * @param $current_value
- * @param $wanted_value
+ * @param string $current_value
+ * @param string $wanted_value
  * @return string
  */
 function compare_setting_values($current_value, $wanted_value)
@@ -1942,8 +1951,8 @@ 
 }
 
 /**
- * @param $course_dir
- * @param $course_attempt_name
+ * @param string $course_dir
+ * @param string $course_attempt_name
  * @param string $file
  * @return bool
  */