chamilo / chamilo-lms

main/inc/lib/userportal.lib.php

Doc Comments +10 added lines, -4 removed lines

@@ -642,6 +642,7 @@ 
     * retrieves all the courses that the user has already subscribed to
     * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
     * @param int $user_id: the id of the user
+    * @param integer $user_id
     * @return array an array containing all the information of the courses of the given user
     */
     public function get_courses_of_user($user_id)
@@ -692,6 +693,11 @@ 
 
     /**
      * @todo use the template system
+     * @param string|null $title
+     * @param string $content
+     * @param string $id
+     * @param string $idAccordion
+     * @param string $idCollpase
      */
     function show_right_block($title, $content, $id = null, $params = null, $idAccordion = null, $idCollpase = null)
     {
@@ -909,7 +915,7 @@ 
     }
 
     /**
-     * @return null|string
+     * @return string
      */
     public function return_course_block()
     {
@@ -1558,8 +1564,8 @@ 
 
     /**
      * Return HTML code for personal user course category
-     * @param $id
-     * @param $title
+     * @param integer $id
+     * @param string $title
      * @return string
      */
     private static function getHtmlForUserCategory($id, $title)
@@ -1580,7 +1586,7 @@ 
     /**
      * return HTML code for course display in session view
      * @param array $courseInfo
-     * @param $userCategoryId
+     * @param integer $userCategoryId
      * @param bool $displayButton
      * @param $loadDirs
      * @return string

main/inc/lib/VideoChat.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
      * Create a video chat
      * @param int $fromUser The sender user
      * @param int $toUser The receiver user
-     * @return int The created video chat id. Otherwise return false
+     * @return false|string The created video chat id. Otherwise return false
      */
     public static function createRoom($fromUser, $toUser)
     {

main/inc/lib/xajax/xajax.inc.php

Doc Comments +2 added lines, -1 removed lines

@@ -500,7 +500,7 @@ 
 	 * Returns the current request mode (XAJAX_GET or XAJAX_POST), or -1 if
 	 * there is none.
 	 *
-	 * @return mixed
+	 * @return integer
 	 */
 	function getRequestMode()
 	{
@@ -1018,6 +1018,7 @@ 
 	 *
 	 * @param string the root tag of the XML
 	 * @param string XML to convert
+	 * @param string $rootTag
 	 * @access private
 	 * @return array
 	 */

main/inc/lib/xajax/xajaxCompress.php

Doc Comments +1 added lines

@@ -39,6 +39,7 @@
  * (used internally)
  *
  * @param string contains the Javascript code to compress
+ * @param string $sJS
  */
 function xajaxCompressJavascript($sJS)
 {

main/inc/lib/xajax/xajaxResponse.inc.php

Doc Comments +4 added lines, -2 removed lines

@@ -97,6 +97,7 @@ 
 	 * @param string  contains the character encoding string to use
 	 * @param boolean lets you set if you want special characters in the output
 	 *                converted to HTML entities
+	 * @param string $sEncoding
 	 *
 	 */
 	function xajaxResponse($sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities=false)
@@ -223,6 +224,8 @@ 
 	 * @param string contains the id of an HTML element
 	 * @param string the part of the element you wish to clear ("innerHTML",
 	 *               "value", etc.)
+	 * @param string $sTarget
+	 * @param string $sAttribute
 	 */
 	function addClear($sTarget,$sAttribute)
 	{
@@ -279,6 +282,7 @@ 
 	 * <i>Usage:</i> <kbd>$objResponse->addScript("var x = prompt('get some text');");</kbd>
 	 *
 	 * @param string contains Javascript code to be executed
+	 * @param string $sJS
 	 */
 	function addScript($sJS)
 	{
@@ -290,8 +294,6 @@ 
 	 *
 	 * <i>Usage:</i> <kbd>$objResponse->addScriptCall("myJSFunction", "arg 1", "arg 2", 12345);</kbd>
 	 *
-	 * @param string $sFunc the name of a Javascript function
-	 * @param mixed $args,... optional arguments to pass to the Javascript function
 	 */
 	function addScriptCall() {
 		$arguments = func_get_args();

main/inc/lib/zombie/zombie_report.class.php

Doc Comments +3 added lines

@@ -121,6 +121,9 @@
         return $form->isSubmitted() == false || $form->validate();
     }
 
+    /**
+     * @param string $format
+     */
     function get_ceiling($format = null)
     {
         $result = Request::get('ceiling');

main/install/install.lib.php

Doc Comments +14 added lines, -5 removed lines

@@ -97,7 +97,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)
 {
@@ -1268,6 +1268,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(
@@ -1481,6 +1485,11 @@ 
 
     <?php
 }
+/**
+ * @param string $content
+ * @param string $title
+ * @param string $id
+ */
 function panel($content = null, $title = null, $id = null, $style = null) {
     $html = '';
     if (empty($style)) {
@@ -1837,8 +1846,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)
@@ -1855,8 +1864,8 @@ 
 }
 
 /**
- * @param $course_dir
- * @param $course_attempt_name
+ * @param string $course_dir
+ * @param string $course_attempt_name
  * @param string $file
  * @return bool
  */

main/newscorm/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/newscorm/learnpath.class.php

Doc Comments +29 added lines, -24 removed lines

@@ -84,7 +84,7 @@ 
      * @param	string	$course Course code
      * @param	integer	$lp_id
      * @param	integer	$user_id
-     * @return mixed True on success, false on error
+     * @return boolean True on success, false on error
      */
     public function __construct($course, $lp_id, $user_id)
     {
@@ -482,7 +482,8 @@ 
      * @param string $description
      * @param int $prerequisites
      * @param int $max_time_allowed
-     * @return int
+     * @param string $id
+     * @return false|string
      */
     public function add_item(
         $parent,
@@ -1021,7 +1022,7 @@ 
      * @param	array $courseInfo
      * @param	integer	Learnpath ID
      * @param	string	Whether to delete data or keep it (default: 'keep', others: 'remove')
-     * @return	boolean	True on success, false on failure (might change that to return number of elements deleted)
+     * @return	false|null	True on success, false on failure (might change that to return number of elements deleted)
      */
     public function delete($courseInfo = null, $id = null, $delete = 'keep')
     {
@@ -1155,7 +1156,7 @@ 
      * @param	integer	$id Elem ID (0 if first)
      * @param	integer	$remove Whether to remove the resource/data from the
      * system or leave it (default: 'keep', others 'remove')
-     * @return	integer	Number of elements moved
+     * @return	false|null	Number of elements moved
      * @todo implement resource removal
      */
     public function delete_item($id, $remove = 'keep')
@@ -1237,7 +1238,7 @@ 
      * @param   array   $audio The array resulting of the $_FILES[mp3] element
      * @param   int     $max_time_allowed
      * @param   string  $url
-     * @return  boolean True on success, false on error
+     * @return  false|null True on success, false on error
      */
     public function edit_item(
         $id,
@@ -1760,7 +1761,7 @@ 
 
     /**
      * Gets the first element URL.
-     * @return	string	URL to load into the viewer
+     * @return	false|null	URL to load into the viewer
      */
     public function first()
     {
@@ -2276,6 +2277,7 @@ 
      * @param int $student_id
      * @param string Course code (optional)
      * @param int $sessionId
+     * @param string $courseCode
      * @return	bool
      */
     public static function is_lp_visible_for_student(
@@ -2575,7 +2577,7 @@ 
 
     /**
      * Gets the learnpath session id
-     * @return	string	Learnpath theme
+     * @return	integer	Learnpath theme
      */
     public function get_lp_session_id()
     {
@@ -2608,7 +2610,7 @@ 
     /**
      * @param string $size
      * @param string $path_type
-     * @return bool|string
+     * @return string|false
      */
     public function get_preview_image_path($size = null, $path_type = 'web')
     {
@@ -2754,6 +2756,8 @@ 
      * Returns the XML DOM document's node
      * @param	resource	Reference to a list of objects to search for the given ITEM_*
      * @param	string		The identifier to look for
+     * @param DOMNodeList $children
+     * @param string $id
      * @return	mixed		The reference to the element found with that identifier. False if not found
      */
     public function get_scorm_xml_node(& $children, $id)
@@ -3001,7 +3005,7 @@ 
     /**
      * Generate and return the table of contents for this learnpath. The (flat) table returned can be
      * used by get_html_toc() to be ready to display
-     * @return	array	TOC as a table with 4 elements per row: title, link, status and level
+     * @return	boolean	TOC as a table with 4 elements per row: title, link, status and level
      */
     public function get_toc()
     {
@@ -3137,7 +3141,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getChapterTypes()
     {
@@ -4050,7 +4054,7 @@ 
      * Open a resource = initialise all local variables relative to this resource. Depending on the child
      * class, this might be redefined to allow several behaviours depending on the document type.
      * @param integer Resource ID
-     * @return boolean True on success, false otherwise
+     * @return boolean|null True on success, false otherwise
      */
     public function open($id)
     {
@@ -4179,7 +4183,7 @@ 
      * Can be used as abstract
      * @param	integer	$lp_id Learnpath id
      * @param	string	$set_visibility New visibility (v/i - visible/invisible)
-     * @return bool
+     * @return false|null
      */
     public static function toggle_publish($lp_id, $set_visibility = 'v')
     {
@@ -4264,7 +4268,7 @@ 
      * Make sure the results are saved with anoter method. This method should probably be
      * redefined in children classes.
      * To use a similar method  statically, use the create_new_attempt() method
-     * @return string URL to load in the viewer
+     * @return boolean URL to load in the viewer
      */
     public function restart()
     {
@@ -4342,6 +4346,7 @@ 
      * Saves the given item
      * @param	integer	$item_id. Optional (will take from $_REQUEST if null)
      * @param	boolean	$from_outside Save from url params (true) or from current attributes (false). Optional. Defaults to true
+     * @param integer $item_id
      * @return	boolean
      */
     public function save_item($item_id = null, $from_outside = true)
@@ -4839,7 +4844,7 @@ 
 
     /**
      * Sets use_max_score
-     * @param   string  $use_max_score Optional string giving the new location of this learnpath
+     * @param   integer  $use_max_score Optional string giving the new location of this learnpath
      * @return  boolean True on success / False on error
      */
     public function set_use_max_score($use_max_score = 1)
@@ -5240,6 +5245,7 @@ 
      * Register the attempt mode into db thanks to flags prevent_reinit and seriousgame_mode flags
      *
      * @param string 'seriousgame', 'single' or 'multiple'
+     * @param string $mode
      * @return boolean
      * @author ndiechburg <noel@cblue.be>
      **/
@@ -5282,7 +5288,7 @@ 
     /**
      * Switch between multiple attempt, single attempt or serious_game mode (only for scorm)
      *
-     * @return boolean
+     * @return boolean|null
      * @author ndiechburg <noel@cblue.be>
      **/
     public function switch_attempt_mode()
@@ -5473,7 +5479,6 @@ 
     /**
      * Function that creates a html list of learning path items so that we can add audio files to them
      * @author Kevin Van Den Haute
-     * @param int $lp_id
      * @return string
      */
     public function overview()
@@ -5844,7 +5849,7 @@ 
     /**
      * This function builds the action menu
      * @param bool $returnContent
-     * @return void
+     * @return string|null
      */
     public function build_action_menu($returnContent = false)
     {
@@ -6335,7 +6340,7 @@ 
     /**
      * Function that displays a list with al the resources that
      * could be added to the learning path
-     * @return string
+     * @return boolean
      */
     public function display_resources()
     {
@@ -8770,7 +8775,7 @@ 
 
     /**
      * Creates a list with all the student publications in it
-     * @return unknown
+     * @return string
      */
     public function get_student_publications()
     {
@@ -9715,7 +9720,7 @@ 
 
     /**
      * @param int $lp_id
-     * @return bool
+     * @return false|null
      */
     public function scorm_export_to_pdf($lp_id)
     {
@@ -10232,6 +10237,7 @@ 
     }
 
     /**
+     * @param string $courseCode
      * @return \learnpath
      */
     public static function getLpFromSession($courseCode, $lp_id, $user_id)
@@ -10251,7 +10257,7 @@ 
 
     /**
      * @param int $itemId
-     * @return learnpathItem|false
+     * @return string
      */
     public function getItem($itemId)
     {
@@ -10301,7 +10307,6 @@ 
     /**
      * Set whether this is a learning path with the possibility to subscribe
      * users or not
-     * @param int $subscribeUsers (0 = false, 1 = true)
      */
     public function setSubscribeUsers($value)
     {
@@ -10426,7 +10431,7 @@ 
 
     /**
      * Get the item of exercise type (evaluation type)
-     * @return array The final evaluation. Otherwise return false
+     * @return integer The final evaluation. Otherwise return false
      */
     public function getFinalEvaluationItem()
     {
@@ -10650,7 +10655,7 @@ 
     /**
      * Create a forum for this learning path
      * @param type $forumCategoryId
-     * @return int The forum ID if was created. Otherwise return false
+     * @return false|string The forum ID if was created. Otherwise return false
      */
     public function createForum($forumCategoryId)
     {