chamilo / chamilo-lms

main/inc/lib/urlmanager.lib.php

Doc Comments +16 added lines, -14 removed lines

@@ -18,7 +18,7 @@ 
     * @param	string	$url The URL of the site
     * @param	string  $description The description of the site
     * @param	int		$active is active or not
-    * @return boolean if success
+    * @return Doctrine\DBAL\Driver\Statement|null if success
     */
     public static function add($url, $description, $active)
     {
@@ -43,7 +43,7 @@ 
     * @param	string 	$url
     * @param	string  $description The description of the site
     * @param	int		$active is active or not
-    * @return 	boolean if success
+    * @return 	Doctrine\DBAL\Driver\Statement|null if success
     */
     public static function update($url_id, $url, $description, $active)
     {
@@ -67,7 +67,7 @@ 
     * @author Julio Montoya
     * @param int $id url id
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete($id)
     {
@@ -366,7 +366,7 @@ 
     * @author Julio Montoya
     * @param int user id
     * @param int url id
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_user_exist($user_id, $url_id)
     {
@@ -384,7 +384,7 @@ 
     * @author Julio Montoya
     * @param int $courseId
     * @param int $urlId
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_course_exist($courseId, $urlId)
     {
@@ -405,7 +405,7 @@ 
      * @author Julio Montoya
      * @param int $userGroupId
      * @param int $urlId
-     * @return boolean true if success
+     * @return integer true if success
      * */
     public static function relationUrlUsergroupExist($userGroupId, $urlId)
     {
@@ -424,7 +424,7 @@ 
     * @author Julio Montoya
     * @param int user id
     * @param int url id
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_session_exist($session_id, $url_id)
     {
@@ -545,6 +545,8 @@ 
      * @author Julio Montoya
      * @param  array of course ids
      * @param  array of url_ids
+     * @param integer[] $courseCategoryList
+     * @param integer[] $urlList
      * @return array
      **/
     public static function addCourseCategoryListToUrl($courseCategoryList, $urlList)
@@ -575,7 +577,7 @@ 
      * @author Julio Montoya
      * @param int $categoryCourseId
      * @param int $urlId
-     * @return boolean true if success
+     * @return integer true if success
      * */
     public static function relationUrlCourseCategoryExist($categoryCourseId, $urlId)
     {
@@ -592,7 +594,7 @@ 
     /**
      * @param int $userGroupId
      * @param int $urlId
-     * @return int
+     * @return string
      */
     public static function addUserGroupToUrl($userGroupId, $urlId)
     {
@@ -692,7 +694,7 @@ 
      * @param int $courseId
      * @param int $url_id
      *
-     * @return resource
+     * @return boolean
      */
     public static function add_course_to_url($courseId, $url_id = 1)
     {
@@ -763,7 +765,7 @@ 
     * @param  int  $courseId
     * @param  int  $urlId
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete_url_rel_course($courseId, $urlId)
     {
@@ -781,7 +783,7 @@ 
      * @param  int $userGroupId
      * @param  int $urlId
      *
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public static function delete_url_rel_usergroup($userGroupId, $urlId)
     {
@@ -800,7 +802,7 @@ 
      * @param  int $userGroupId
      * @param  int $urlId
      *
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public static function deleteUrlRelCourseCategory($userGroupId, $urlId)
     {
@@ -819,7 +821,7 @@ 
     * @param  char  course code
     * @param  int url id
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete_url_rel_session($session_id, $url_id)
     {

main/inc/lib/usergroup.lib.php

Doc Comments +12 added lines, -6 removed lines

@@ -1013,7 +1013,7 @@ 
      * @param int    $groupId
      * @param string $picture
      *
-     * @return bool|string
+     * @return false|string
      */
     public function manageFileUpload($groupId, $picture)
     {
@@ -1155,7 +1155,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return integer
      */
     public function getGroupType()
     {
@@ -1359,6 +1359,8 @@ 
      * @param string height
      * @param string picture size it can be small_,  medium_  or  big_
      * @param string style css
+     * @param integer $height
+     * @param integer $size_picture
      * @return array with the file and the style of an image i.e $array['file'] $array['style']
      */
     public function get_picture_group($id, $picture_file, $height, $size_picture = GROUP_IMAGE_SIZE_MEDIUM , $style = '')
@@ -1420,7 +1422,7 @@ 
      * @param	string	Type of path to return (can be 'none', 'system', 'rel', 'web')
      * @param	bool	Whether we want to have the directory name returned 'as if' there was a file or not (in the case we want to know which directory to create - otherwise no file means no split subdir)
      * @param	bool	If we want that the function returns the /main/img/unknown.jpg image set it at true
-     * @return	array 	Array of 2 elements: 'dir' and 'file' which contain the dir and file as the name implies if image does not exist it will return the unknow image if anonymous parameter is true if not it returns an empty er's
+     * @return	integer 	Array of 2 elements: 'dir' and 'file' which contain the dir and file as the name implies if image does not exist it will return the unknow image if anonymous parameter is true if not it returns an empty er's
      */
     public function get_group_picture_path_by_id($id, $type = 'none', $preview = false, $anonymous = false)
     {
@@ -1470,7 +1472,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getAllowedPictureExtensions()
     {
@@ -1660,7 +1662,7 @@ 
      * @author Julio Montoya
      * @param  int  $user_id
      * @param  int $group_id
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public function delete_user_rel_group($user_id, $group_id)
     {
@@ -1872,6 +1874,8 @@ 
      * @param int from value
      * @param int limit
      * @param array image configuration, i.e array('height'=>'20px', 'size'=> '20px')
+     * @param integer $from
+     * @param integer $limit
      * @return array list of users in a group
      */
     public function get_users_by_group(
@@ -1970,6 +1974,8 @@ 
      * Shows the left column of the group page
      * @param int group id
      * @param int user id
+     * @param integer $group_id
+     * @param integer $user_id
      *
      */
     public function show_group_column_information($group_id, $user_id, $show = '')
@@ -2323,7 +2329,7 @@ 
      * @param int $group_id
      * @param int $parent_group_id if 0, we delete the parent_group association
      * @param int $relation_type
-     * @return resource
+     * @return Doctrine\DBAL\Driver\Statement|null
      **/
     public static function set_parent_group($group_id, $parent_group_id, $relation_type = 1)
     {

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/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_functions.inc.php

Doc Comments +1 added lines

@@ -60,6 +60,7 @@
 /**
  * This function deletes an entire directory
  * @param	string	The directory path
+ * @param string $dir
  * @return boolean	True on success, false on failure
  */
 function deldir($dir) {