chamilo / chamilo-lms

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/tracking.lib.php

Doc Comments +13 added lines, -6 removed lines

@@ -1333,6 +1333,8 @@ 
      * @param   string type of time filter: 'last_week' or 'custom'
      * @param   string  start date date('Y-m-d H:i:s')
      * @param   string  end date date('Y-m-d H:i:s')
+     * @param string $start_date
+     * @param string $end_date
      * @return timestamp $nb_seconds
      */
     public static function get_time_spent_on_the_platform(
@@ -1435,7 +1437,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)
     {
@@ -1465,7 +1467,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($student_id, $warning_message = false, $return_timestamp = false)
@@ -2762,6 +2764,9 @@ 
      * @param     array         Limit average to listed lp ids
      * @param     int            Session id (optional), if param $session_id is
      * null(default) it'll return results including sessions, 0 = session is not filtered
+     * @param integer $student_id
+     * @param string $course_code
+     * @param integer $session_id
      * @return     int         Total time
      */
     public static function get_time_spent_in_lp($student_id, $course_code, $lp_ids = array(), $session_id = null)
@@ -2831,6 +2836,8 @@ 
      * @param     int|array    Student id(s)
      * @param     string         Course code
      * @param     int         Learning path id
+     * @param integer $student_id
+     * @param string $course_code
      * @return     int         Total time
      */
     public static function get_last_connection_time_in_lp($student_id, $course_code, $lp_id, $session_id = 0)
@@ -5504,7 +5511,7 @@ 
 
     /**
     * @param FormValidator $form
-    * @return mixed
+    * @return FormValidator
     */
     public static function setUserSearchForm($form)
     {
@@ -6985,7 +6992,7 @@ 
      * @param int $user_id
      * @param int $course_id
      * @param int $session_id
-     * @return array
+     * @return string[]
      */
     public function display_login_tracking_info($view, $user_id, $course_id, $session_id = 0)
     {
@@ -7031,9 +7038,9 @@ 
     /**
      * Displays the exercise results for a specific user in a specific course.
      * @param   string $view
-     * @param   int $user_id    User ID
+     * @param   int $userId    User ID
      * @param   string  $courseCode Course code
-     * @return array
+     * @return string[]
      * @todo remove globals
      */
     public function display_exercise_tracking_info($view, $userId, $courseCode)

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

Doc Comments -2 removed lines

@@ -25,8 +25,6 @@
      * 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.
      */
     static function get_allowed_tags($mode)
     {

main/inc/lib/pdf.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -192,7 +192,7 @@ 
      * @param   string  pdf name
      * @param   string  course code (if you are using html that are located in the document tool you must provide this)
      * @param bool Whether to print the header, footer and watermark (true) or just the content (false)
-     * @return bool
+     * @return false|null
      */
     public function html_to_pdf(
         $html_file_array,
@@ -766,7 +766,7 @@ 
     }
 
     /**
-     * @param array $header html content
+     * @param string $header html content
      */
     public function set_custom_header($header)
     {
@@ -774,7 +774,7 @@ 
     }
 
     /**
-     * @param array $footer html content
+     * @param string $footer html content
      */
     public function set_custom_footer($footer)
     {

main/exercise/export/qti2/qti2_classes.php

Doc Comments +5 added lines

@@ -72,6 +72,7 @@ 
     /**
      * Return the XML flow for the possible answers.
      *
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -147,6 +148,7 @@ 
      * Export the text with missing words.
      *
      *
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -204,6 +206,7 @@ 
 {
     /**
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -295,6 +298,7 @@ 
     /**
      * TODO update this to match hot spots instead of copying matching
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment, $questionDesc='', $questionMedia='')
     {
@@ -382,6 +386,7 @@ 
     /**
      * TODO implement
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment, $questionDesc='', $questionMedia='')
 	{

main/exercise/hotpotatoes.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -259,7 +259,7 @@ 
  * @param    reference    Reference to the array to search
  * @param    string       Node we are looking for in the array
  * @param string $node
- * @return   mixed        Node name or false if not found
+ * @return   false|string        Node name or false if not found
  */
 function myarraysearch(&$array, $node)
 {
@@ -280,7 +280,7 @@ 
  * Searches an image name into an array.
  * @param    reference        Reference to an array to search
  * @param    string           String to look for
- * @return   mixed            String given if found, false otherwise
+ * @return   false|string            String given if found, false otherwise
  * @uses     myarraysearch    This function is just an additional layer on the myarraysearch() function
  */
 function CheckImageName(&$imgparams, $string)

main/lp/aicc.class.php

Doc Comments +5 added lines, -3 removed lines

@@ -216,7 +216,7 @@ 
     /**
      * Import the aicc object (as a result from the parse_config_files function) into the database structure
      * @param	string	$course_code
-     * @return	bool	Returns -1 on error
+     * @return	false|null	Returns -1 on error
      */
     public function import_aicc($course_code)
     {
@@ -780,7 +780,8 @@ 
      * Static function to parse AICC ini files.
      * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
      * @param	string	File path
-     * @return	array	Structured array
+     * @param string $f
+     * @return	string	Structured array
      */
     function parse_ini_file_quotes_safe($f) {
         $null = '';
@@ -831,7 +832,7 @@ 
      * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
      * @param		string	INI File string
      * @param		array	List of names of sections that should be considered as containing only hard string data (no variables), provided in lower case
-     * @return	array	Structured array
+     * @return	string	Structured array
      */
     function parse_ini_string_quotes_safe($s, $pure_strings = array()) {
         $null = '';
@@ -894,6 +895,7 @@ 
      * @param	string	CSV delimiter
      * @param	string	CSV enclosure
      * @param	boolean	Might one field name happen more than once on the same line? (then split by comma in the values)
+     * @param string $f
      * @return array	Simple structured array
      */
     function parse_csv_file($f, $delim = ',', $enclosure = '"', $multiples = false) {

main/lp/learnpathList.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
      * @param   int     $categoryId
      * @param bool $ignoreCategoryFilter
      *
-     * @return	void
+     * @return	false|null
      */
     public function __construct(
         $user_id,

main/lp/lp_ajax_save_item.php

Doc Comments +3 added lines, -3 removed lines

@@ -20,9 +20,9 @@
  * @param   int $user_id User ID
  * @param   int $view_id View ID
  * @param   int $item_id Item ID
- * @param   float  $score Current score
- * @param   float  $max Maximum score
- * @param   float  $min Minimum score
+ * @param   integer  $score Current score
+ * @param   integer  $max Maximum score
+ * @param   integer  $min Minimum score
  * @param   string  $status Lesson status
  * @param   int  $time Session time
  * @param   string  $suspend Suspend data