chamilo / chamilo-lms

main/inc/lib/course.lib.php

Doc Comments +3 added lines, -2 removed lines

@@ -748,7 +748,7 @@ 
      * @param  string $courseCode the course code
      * @param  int $visible (optional) The course visibility in the catalogue to the user (1=visible, 0=invisible)
      *
-     * @return boolean true if added succesfully, false otherwise.
+     * @return boolean|string true if added succesfully, false otherwise.
      */
     public static function addUserVisibilityToCourseInCatalogue($userId, $courseCode, $visible = 1)
     {
@@ -2620,7 +2620,7 @@ 
      * then the courses that the user is allowed or not to see in catalogue
      *
      * @param boolean $allowed Either if the courses have some users that are or are not allowed to see in catalogue
-     * @param boolean $byUserId if the courses are or are not allowed to see to the user
+     * @param integer $byUserId if the courses are or are not allowed to see to the user
      * @return array Course codes allowed or not to see in catalogue by some user or the user
      */
     public static function getCatalogueCourseList($allowed = true, $byUserId = -1)
@@ -3164,6 +3164,7 @@ 
      * @param int $limit
      * @param string $column
      * @param string $direction
+     * @param integer $status
      * @return array    courses
      */
     public static function get_courses_followed_by_drh(

plugin/buycourses/src/buy_course_plugin.class.php

Doc Comments +14 added lines, -14 removed lines

@@ -50,7 +50,7 @@ 
 

     /**

      *

-     * @return StaticPlugin

+     * @return BuyCoursesPlugin

      */

     static function create()

     {

@@ -278,7 +278,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)

     {

@@ -691,7 +691,7 @@ 
     /**

      * Get session info

      * @param array $sessionId The session ID

-     * @return array

+     * @return Session

      */

     public function getSessionInfo($sessionId)

     {

@@ -784,7 +784,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)

     {

@@ -966,7 +966,7 @@ 
 

     /**

      * Get payment types

-     * @return array

+     * @return string[]

      */

     public function getPaymentTypes()

     {

@@ -1005,7 +1005,7 @@ 
 

     /**

      * Get the statuses for sales

-     * @return array

+     * @return string[]

      */

     public function getSaleStatuses()

     {

@@ -1018,7 +1018,7 @@ 
 

     /**

      * Get the statuses for Payouts

-     * @return array

+     * @return string[]

      */

     public function getPayoutStatuses()

     {

@@ -1031,7 +1031,7 @@ 
 

     /**

      * Get the list of product types

-     * @return array

+     * @return string[]

      */

     public function getProductTypes()

     {

@@ -1043,7 +1043,7 @@ 
 

     /**

      * Get the list of service types

-     * @return array

+     * @return string[]

      */

     public function getServiceTypes()

     {

@@ -1426,7 +1426,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)

     {

@@ -1584,7 +1584,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)

     {

@@ -1706,7 +1706,7 @@ 
     /**

      * Register addicional service

      * @param array params $service

-     * @return mixed response

+     * @return false|string response

      */

     public function storeService($service)

     {

@@ -1862,7 +1862,7 @@ 
 

     /**

      * Get the statuses for sales

-     * @return array

+     * @return string[]

      */

     public function getServiceSaleStatuses()

     {

@@ -2123,7 +2123,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)

     {

main/inc/lib/agenda.lib.php

Doc Comments +2 added lines, -1 removed lines

@@ -681,7 +681,7 @@ 
      * @param bool $addAnnouncement
      * @param bool $updateContent
      *
-     * @return null|false
+     * @return null|boolean
      */
     public function editEvent(
         $id,
@@ -1382,6 +1382,7 @@ 
      * Gets a single event
      *
      * @param int event id
+     * @param integer $id
      * @return array
      */
     public function get_event($id)

main/exercise/exercise_result.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
      * @param int $user_id User ID. Optional. If no user ID is provided, we take all the results. Defauts to null
      * @param int $filter
      * @param int $exercise_id
-     * @param null $hotpotato_name
+     * @param string|null $hotpotato_name
      * @return bool
      */
     public function getExercisesReporting(

main/work/work.lib.php

Doc Comments +14 added lines, -12 removed lines

@@ -728,7 +728,7 @@ 
  * @author Bert Vanderkimpen
  * @author Yannick Warnier <ywarnier@beeznest.org> Adaptation for work tool
  * @param   string $base_work_dir Base work dir (.../work)
- * @param   string $desiredDirName complete path of the desired name
+ * @param   string $desired_dir_name complete path of the desired name
  *
  * @return  string actual directory name if it succeeds, boolean false otherwise
  */
@@ -750,7 +750,7 @@ 
 /**
  * Delete a work-tool directory
  * @param   int  $id work directory id to delete
- * @return  integer -1 on error
+ * @return  boolean|null -1 on error
  */
 function deleteDirWork($id)
 {
@@ -907,7 +907,7 @@ 
  * Update the url of a dir in the student_publication table
  * @param  array $work_data work original data
  * @param  string $newPath Example: "folder1"
- * @return bool
+ * @return boolean|null
  */
 function updateDirName($work_data, $newPath)
 {
@@ -966,6 +966,7 @@ 
 /**
  * Transform an all directory structure (only directories) in an array
  * @param   string path of the directory
+ * @param string $directory
  * @return  array the directory structure into an array
  * @author  Julio Montoya
  * @version April 2008
@@ -1040,7 +1041,7 @@ 
  * @param   string the path of the directory
  * @param   boolean true if we want the total quantity of files
  * include in others child directories, false only  files in the directory
- * @return  array the first element is an integer with the number of files
+ * @return  integer[] the first element is an integer with the number of files
  * in the folder, the second element is the number of directories
  * @author  Julio Montoya
  * @version April 2008
@@ -2804,7 +2805,7 @@ 
  * @param int $userId
  * @param int $workId
  * @param int $courseId
- * @return bool
+ * @return boolean|null
  */
 function allowOnlySubscribedUser($userId, $workId, $courseId)
 {
@@ -3081,6 +3082,7 @@ 
  * @param array $parentInfo
  * @param array $courseInfo
  * @param int $sessionId
+ * @param integer $userId
  * @return int
  */
 function getLastWorkStudentFromParentByUser(
@@ -3226,7 +3228,7 @@ 
  * @param int $userId
  * @param array $work
  * @param array $data
- * @return int
+ * @return false|null
  */
 function addWorkComment($courseInfo, $userId, $parentWork, $work, $data)
 {
@@ -4409,7 +4411,7 @@ 
 }
 
 /**
- * @return array
+ * @return string[]
  */
 function getUploadDocumentType()
 {
@@ -4797,7 +4799,7 @@ 
  * @param int Session ID
  * @param $correction
  *
- * @return array|bool
+ * @return boolean
  */
 function getFileContents($id, $course_info, $sessionId = 0, $correction = false)
 {
@@ -4915,7 +4917,7 @@ 
  * @param int $userId
  * @param array $courseInfo
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllWork($userId, $courseInfo, $format = 'pdf')
 {
@@ -4961,7 +4963,7 @@ 
  * @param array $courseInfo
  * @param int $sessionId
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllStudentWorkFromPublication(
     $workId,
@@ -5096,7 +5098,7 @@ 
  * Downloads all user files per user
  * @param int $userId
  * @param array $courseInfo
- * @return bool
+ * @return false|null
  */
 function downloadAllFilesPerUser($userId, $courseInfo)
 {
@@ -5210,7 +5212,7 @@ 
 /**
  * @param array $courseInfo
  * @param int $workId
- * @return bool
+ * @return boolean|null
  */
 function protectWork($courseInfo, $workId)
 {