chamilo / chamilo-lms

main/inc/lib/dashboard.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -496,7 +496,7 @@
      * @param int        User id
      * @param string    plugin path
      * @param integer $user_id
-     * @return bool
+     * @return false|string
      */
     public static function close_user_block($user_id, $path)
     {

main/inc/lib/fileUpload.lib.php

Doc Comments +6 added lines, -5 removed lines

@@ -53,7 +53,7 @@ 
  * Returns the name without extension, used for the title
  *
  * @param string $name
- * @return name without the extension
+ * @return string without the extension
  */
 function get_document_title($name)
 {
@@ -67,7 +67,7 @@ 
  * This function checks if the upload succeeded
  *
  * @param array $uploaded_file ($_FILES)
- * @return true if upload succeeded
+ * @return boolean if upload succeeded
  */
 function process_uploaded_file($uploaded_file, $show_output = true)
 {
@@ -1227,7 +1227,7 @@ 
  * @param int $session_id Session ID, if any
  * @param int $userId creator id
  *
- * @return int id if inserted document
+ * @return string|false id if inserted document
  */
 function add_document(
     $_course,
@@ -1368,7 +1368,7 @@ 
  *
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path+filename eg: /main/document/document.php
- * @return	The directory depth
+ * @return	integer directory depth
  */
 function get_levels($filename)
 {
@@ -1386,6 +1386,8 @@ 
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path,filename
  * action:	Adds an entry to the document table with the default settings.
+ * @param string $upload_path
+ * @param string $filename
  */
 function set_default_settings($upload_path, $filename, $filetype = 'file')
 {
@@ -1844,7 +1846,6 @@ 
  * @param int $groupId group.id
  * @param bool $output
  * @param array $parent
- * @param string $uploadPath
  *
  */
 function add_all_documents_in_folder_to_database(

main/inc/lib/usergroup.lib.php

Doc Comments +13 added lines, -7 removed lines

@@ -1067,7 +1067,7 @@ 
      * @param int    $groupId
      * @param string $picture
      *
-     * @return bool|string
+     * @return false|string
      */
     public function manageFileUpload($groupId, $picture)
     {
@@ -1096,7 +1096,7 @@ 
      * If an empty name is provided, then old user photos are deleted only,
      * @see UserManager::delete_user_picture() as the prefered way for deletion.
      * @param    string $source_file The full system name of the image from which user photos will be created.
-     * @return   mixed    Returns the resulting common file name of created images which usually should be stored in database.
+     * @return   false|string    Returns the resulting common file name of created images which usually should be stored in database.
      * When an image is removed the function returns an empty string. In case of internal error or negative validation it returns FALSE.
      */
     public function update_group_picture($group_id, $file = null, $source_file = null)
@@ -1209,7 +1209,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return integer
      */
     public function getGroupType()
     {
@@ -1408,6 +1408,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(
@@ -1475,7 +1477,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)
     {
@@ -1525,7 +1527,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getAllowedPictureExtensions()
     {
@@ -1716,7 +1718,7 @@ 
      * @author Julio Montoya
      * @param  int  $user_id
      * @param  int $group_id
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement true if success
      * */
     public function delete_user_rel_group($user_id, $group_id)
     {
@@ -1927,6 +1929,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(
@@ -2025,6 +2029,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
      * @return string
      */
     public function show_group_column_information($group_id, $user_id, $show = '')
@@ -2353,7 +2359,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
      **/
     public static function set_parent_group($group_id, $parent_group_id, $relation_type = 1)
     {

main/webservices/registration.soap.php

Doc Comments +3 added lines

@@ -2617,6 +2617,9 @@
     )
 );
 
+/**
+ * @param string $type
+ */
 function WSHelperActionOnUsers($params, $type)
 {
     if (!WSHelperVerifyKey($params)) {

main/exercise/exercise.class.php

Doc Comments +8 added lines, -6 removed lines

@@ -361,7 +361,7 @@ 
     }
 
     /**
-     * @return int
+     * @return string
      */
     public function selectPassPercentage()
     {
@@ -464,7 +464,7 @@ 
      * tells if questions are selected randomly, and if so returns the draws
      *
      * @author Olivier Brouckaert
-     * @return integer - 0 if not random, otherwise the draws
+     * @return boolean - 0 if not random, otherwise the draws
      */
     public function isRandom()
     {
@@ -2853,9 +2853,9 @@ 
      * @param int  int lp item id
      * @param int  int lp item_view id
      * @param array $questionList
-     * @param float $weight
+     * @param integer $weight
      *
-     * @return int
+     * @return false|string
      */
     public function save_stat_track_exercise_info(
         $clock_expired_time = 0,
@@ -5361,7 +5361,7 @@ 
      * @param int $exe_id
      * @param float $score
      * @param float $weight
-     * @return bool
+     * @return false|null
      */
     public function send_mail_notification_for_exam(
         $type = 'end',
@@ -5536,6 +5536,7 @@ 
      * @param array $question_list_answers
      * @param string $origin
      * @param int $exe_id
+     * @param string $url_email
      * @return null
      */
     private function send_notification_for_open_questions(
@@ -5626,6 +5627,7 @@ 
      * @param array $question_list_answers
      * @param string $origin
      * @param int $exe_id
+     * @param string $url_email
      * @return null
      */
     private function send_notification_for_oral_questions(
@@ -5776,7 +5778,7 @@ 
      * @param int     Maximum number of attempts (0 if no limit)
      * @param int     Feedback type
      * @todo this was function was added due the import exercise via CSV
-     * @return    int New exercise ID
+     * @return    string New exercise ID
      */
     public function createExercise(
         $title,

main/exercise/question.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -493,7 +493,7 @@
      * in this version, a question can only have 1 category
      * if category is 0, then question has no category then delete the category entry
      * @param int $categoryId
-     * @return bool
+     * @return null|boolean
      *
      * @author Hubert Borderiou 12-10-2011
      */

src/Chamilo/PageBundle/Entity/User.php

Doc Comments +5 added lines, -5 removed lines

@@ -828,7 +828,7 @@ 
     /**
      * Get status
      *
-     * @return boolean
+     * @return integer
      */
     public function getStatus()
     {
@@ -897,7 +897,7 @@ 
     /**
      * Get pictureUri
      *
-     * @return Media
+     * @return string
      */
     public function getPictureUri()
     {
@@ -1128,7 +1128,7 @@ 
     /**
      * Get active
      *
-     * @return boolean
+     * @return integer
      */
     public function getActive()
     {
@@ -1205,7 +1205,7 @@ 
     }
 
     /**
-     * @return Media
+     * @return string
      */
     public function getAvatar()
     {
@@ -1972,7 +1972,7 @@ 
     /**
      * Returns the user roles
      *
-     * @return array The roles
+     * @return string[] The roles
      */
     public function getRoles()
     {

src/Chamilo/CoreBundle/Component/Editor/Driver/DropBoxDriver.php

Doc Comments +3 added lines, -3 removed lines

@@ -136,7 +136,7 @@ 
     /**
      * Close connection
      *
-     * @return void
+     * @return boolean
      * @author Dmitry (dio) Levashov
      **/
     public function umount()
@@ -498,7 +498,7 @@ 
      * Close opened file
      *
      * @param  resource  $fp  file pointer
-     * @return bool
+     * @return boolean|null
      * @author Dmitry (dio) Levashov
      **/
     protected function _fclose($fp, $path = '')
@@ -516,7 +516,7 @@ 
      *
      * @param  string  $path  parent dir path
      * @param string  $name  new directory name
-     * @return string|bool
+     * @return string|false
      * @author Dmitry (dio) Levashov
      **/
     protected function _mkdir($path, $name)

plugin/buycourses/src/buy_course_plugin.class.php

Doc Comments +13 added lines, -13 removed lines

@@ -295,7 +295,7 @@ 
     /**
      * Save a transfer account information
      * @param array $params The transfer account
-     * @return int Rows affected. Otherwise return false
+     * @return false|string Rows affected. Otherwise return false
      */
     public function saveTransferAccount($params)
     {
@@ -732,7 +732,7 @@ 
     /**
      * Get session info
      * @param array $sessionId The session ID
-     * @return array
+     * @return Session
      */
     public function getSessionInfo($sessionId)
     {
@@ -825,7 +825,7 @@ 
      * Register a sale
      * @param int $itemId The product ID
      * @param int $paymentType The payment type
-     * @return boolean
+     * @return false|string
      */
     public function registerSale($itemId, $paymentType)
     {
@@ -1005,7 +1005,7 @@ 
 
     /**
      * Get payment types
-     * @return array
+     * @return string[]
      */
     public function getPaymentTypes()
     {
@@ -1044,7 +1044,7 @@ 
 
     /**
      * Get the statuses for sales
-     * @return array
+     * @return string[]
      */
     public function getSaleStatuses()
     {
@@ -1057,7 +1057,7 @@ 
 
     /**
      * Get the statuses for Payouts
-     * @return array
+     * @return string[]
      */
     public function getPayoutStatuses()
     {
@@ -1070,7 +1070,7 @@ 
 
     /**
      * Get the list of product types
-     * @return array
+     * @return string[]
      */
     public function getProductTypes()
     {
@@ -1082,7 +1082,7 @@ 
 
     /**
      * Get the list of service types
-     * @return array
+     * @return string[]
      */
     public function getServiceTypes()
     {
@@ -1470,7 +1470,7 @@ 
     /**
      * Register a item
      * @param array $itemData The item data
-     * @return int The item ID. Otherwise return false
+     * @return false|string The item ID. Otherwise return false
      */
     public function registerItem(array $itemData)
     {
@@ -1625,7 +1625,7 @@ 
     /**
      * Verify if the beneficiary have a paypal account
      * @param int $userId
-     * @return true if the user have a paypal account, false if not
+     * @return boolean if the user have a paypal account, false if not
      */
     public function verifyPaypalAccountByBeneficiary($userId)
     {
@@ -1746,7 +1746,7 @@ 
      * Register additional service
      * @param array $service params
      *
-     * @return mixed response
+     * @return false|string response
      */
     public function storeService($service)
     {
@@ -1909,7 +1909,7 @@ 
 
     /**
      * Get the statuses for sales
-     * @return array
+     * @return string[]
      */
     public function getServiceSaleStatuses()
     {
@@ -2177,7 +2177,7 @@ 
      * @param int $paymentType The payment type
      * @param int $infoSelect The ID for Service Type
      * @param int $trial trial mode
-     * @return boolean
+     * @return false|string
      */
     public function registerServiceSale($serviceId, $paymentType, $infoSelect, $trial = null)
     {