chamilo / chamilo-lms

main/inc/lib/myspace.lib.php

Doc Comments +4 added lines, -3 removed lines

@@ -679,7 +679,6 @@ 
      * @param   int $sessionId  The session ID
      * @param   int $courseId   The course ID
      * @param   int $exerciseId The quiz ID
-     * @param   int $answer Answer status (0 = incorrect, 1 = correct, 2 = both)
      * @return  string  HTML array of results formatted for gridJS
      * @author César Perales <cesar.perales@beeznest.com>, Beeznest Team
      */
@@ -898,6 +897,7 @@ 
      * @param int Number of items to select
      * @param string Column to order on
      * @param string Order direction
+     * @param integer $number_of_items
      * @return array Results
      */
     public static function get_course_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1235,6 +1235,7 @@ 
      * @param int Number of items to select
      * @param string Column to order on
      * @param string Order direction
+     * @param integer $number_of_items
      * @return array Results
      */
     public static function get_session_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1255,7 +1256,6 @@ 
     /**
      * Fills in session reporting data
      *
-     * @param integer $user_id the id of the user
      * @param array $url_params additonal url parameters
      * @param array $row the row information (the other columns)
      * @return string html code
@@ -1888,6 +1888,7 @@ 
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
      * @version Dokeos 1.8.6
      * @since October 2008
+     * @param integer $number_of_items
      */
     public static function get_user_data_tracking_overview($from, $number_of_items, $column, $direction)
     {
@@ -1990,7 +1991,6 @@ 
     /**
      * Checks if there are repeted users in a given array
      * @param  array $usernames list of the usernames in the uploaded file
-     * @param  array $user_array['username'] and $user_array['sufix'] where sufix is the number part in a login i.e -> jmontoya2
      * @return array with the $usernames array and the $user_array array
      * @author Julio Montoya
      */
@@ -2165,6 +2165,7 @@ 
 
     /**
      * Adds missing user-information (which isn't required, like password, etc).
+     * @return integer
      */
     function complete_missing_data($user) {
         // 1. Generate a password if it is necessary.

main/inc/lib/nusoap/class.soap_fault.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
     * @param string $faultcode (SOAP-ENV:Client | SOAP-ENV:Server)

     * @param string $faultactor only used when msg routed between multiple actors

     * @param string $faultstring human readable error message

-    * @param mixed $faultdetail detail, typically a string or array of string

+    * @param string $faultdetail detail, typically a string or array of string

 	*/

 	public function __construct($faultcode,$faultactor='',$faultstring='',$faultdetail=''){

 		parent::__construct();

main/inc/lib/nusoap/class.soap_parser.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
 	* @param    string $encoding character encoding scheme of message

 	* @param    string $method method for which XML is parsed (unused?)

 	* @param    bool $decode_utf8 whether to decode UTF-8 to ISO-8859-1

-	* @return void|bool

+	* @return false|null

 	* @access   public

 	*/

 	function __construct($xml,$encoding='UTF-8',$method='',$decode_utf8=true)

main/inc/lib/security.lib.php

Doc Comments +4 added lines, -1 removed lines

@@ -46,6 +46,8 @@ 
      * @param	string	Absolute path to be checked (with trailing slash)
      * @param	string	Checker path under which the path
      * should be (absolute path, with trailing slash, get it from api_get_path(SYS_COURSE_PATH))
+     * @param string $abs_path
+     * @param string $checker_path
      * @return	bool	True if the path is under the checker, false otherwise
      */
     public static function check_abs_path($abs_path, $checker_path)
@@ -257,6 +259,7 @@ 
      * @param string	The variable to filter for XSS, this params can be a string or an array (example : array(x,y))
      * @param int The user status,constant allowed (STUDENT, COURSEMANAGER, ANONYMOUS, COURSEMANAGERLOWSECURITY)
      * @param bool $filter_terms
+     * @param integer $user_status
      * @return	mixed	Filtered string or array
      */
     public static function remove_XSS($var, $user_status = null, $filter_terms = false)
@@ -393,7 +396,7 @@ 
      * This method provides specific protection (against XSS and other kinds of attacks) for static images (icons) used by the system.
      * Image paths are supposed to be given by programmers - people who know what they do, anyway, this method encourages
      * a safe practice for generating icon paths, without using heavy solutions based on HTMLPurifier for example.
-     * @param string $img_path          The input path of the image, it could be relative or absolute URL.
+     * @param string $image_path          The input path of the image, it could be relative or absolute URL.
      * @return string                   Returns sanitized image path or an empty string when the image path is not secure.
      * @author Ivan Tcholakov, March 2011
      */

main/inc/lib/skill.lib.php

Doc Comments +4 added lines, -3 removed lines

@@ -348,6 +348,7 @@ 
 
     /**
      * Gets an element
+     * @param integer $gradebook_id
      */
     public function get_skill_info($skill_id, $gradebook_id)
     {
@@ -577,7 +578,7 @@ 
      * Gets an element
      * @param int $id
      *
-     * @return array|mixed
+     * @return integer
      */
     public function get($id)
     {
@@ -923,7 +924,7 @@ 
     /**
      * Get user's skills
      *
-     * @param int $userId User's id
+     * @param integer $user_id User's id
      * @param bool $get_skill_data
      */
     public function get_user_skills($user_id, $get_skill_data = false)
@@ -1133,7 +1134,7 @@ 
      * @param int skill id
      * @param bool return a flat array or not
      * @param int depth of the skills
-     * @return json
+     * @return string
      */
     public function get_skills_tree_json(
         $user_id = null,

main/inc/lib/sub_language.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -41,6 +41,7 @@ 
      * Get all files of lang folder (forum.inc.php,gradebook.inc.php,notebook.inc.php)
      * @param string The lang path folder  (/var/www/my_lms/main/lang/spanish)
      * @param bool true if we only want the "subname" trad4all instead of  trad4all.inc.php
+     * @param string $path
      *
      * @return array All file of lang folder
      */
@@ -91,6 +92,7 @@ 
     /**
      * Get all information of language
      * @param Integer The parent id(Language father id)
+     * @param integer $parent_id
      * @return array All information about language
      */
     public static function get_all_information_of_language($parent_id)
@@ -109,6 +111,7 @@ 
     /**
      * Get all information of chamilo file
      * @param string The chamilo path file (/var/www/chamilo/main/lang/spanish/gradebook.inc.php)
+     * @param string $system_path_file
      * @patam Bool Whether we want to remove the '$' prefix in the results or not
      * @return array Contains all information of chamilo file
      */
@@ -369,7 +372,7 @@ 
     /**
      * Make available the language
      * @param int The language id
-     * @return void
+     * @return boolean
      */
     public static function make_available_language($language_id)
     {

main/inc/lib/system_announcements.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -306,7 +306,7 @@
      * @param bool  $add_to_calendar
      * @param bool  $sendEmailTest
      *
-     * @return mixed  insert_id on success, false on failure
+     * @return false|string  insert_id on success, false on failure
      */
     public static function add_announcement(
         $title,

main/lp/lp_ajax_start_timer.php

Doc Comments +1 added lines, -1 removed lines

@@ -9,7 +9,7 @@
 /**
  * Start a timer and hand it back to the JS by assigning the current time (of start) to
  * var asset_timer
- * @return string JavaScript time intializer
+ * @return integer JavaScript time intializer
  */
 function start_timer()
 {

main/lp/lp_final_item.php

Doc Comments +1 added lines, -1 removed lines

@@ -129,7 +129,7 @@
  * @param int $sessionId
  * @param string $downloadCertificateLink
  * @param string $badgeLink
- * @return mixed|string
+ * @return string
  */
 function generateLPFinalItemTemplate($lpItemId, $courseCode, $sessionId = 0, $downloadCertificateLink = '', $badgeLink = '')
 {