chamilo / chamilo-lms

src/Chamilo/CourseBundle/Component/CourseCopy/Resources/DummyCourseCreator.php

Doc Comments +1 added lines

@@ -25,6 +25,7 @@
 
     /**
      * Useful finder - experimental akelos like only use in notification.lib.php send function
+     * @param string $type
      */
     public function find($type, $options = null)
     {

plugin/buycourses/src/buy_course_plugin.class.php

Doc Comments +10 added lines, -10 removed lines

@@ -36,7 +36,7 @@ 
 

     /**

      *

-     * @return StaticPlugin

+     * @return BuyCoursesPlugin

      */

     static function create()

     {

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

     {

@@ -664,7 +664,7 @@ 
     /**

      * Get session info

      * @param array $sessionId The session ID

-     * @return array

+     * @return Session

      */

     public function getSessionInfo($sessionId)

     {

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

     {

@@ -939,7 +939,7 @@ 
 

     /**

      * Get payment types

-     * @return array

+     * @return string[]

      */

     public function getPaymentTypes()

     {

@@ -977,7 +977,7 @@ 
 

     /**

      * Get the statuses for sales

-     * @return array

+     * @return string[]

      */

     public function getSaleStatuses()

     {

@@ -990,7 +990,7 @@ 
 

     /**

      * Get the statuses for Payouts

-     * @return array

+     * @return string[]

      */

     public function getPayoutStatuses()

     {

@@ -1003,7 +1003,7 @@ 
 

     /**

      * Get the list of product types

-     * @return array

+     * @return string[]

      */

     public function getProductTypes()

     {

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

     {

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

     {

main/auth/openid/openid.lib.php

Doc Comments +7 added lines

@@ -242,6 +242,9 @@ 
     return $hmac;
 }
 
+/**
+ * @param string|false $text
+ */
 function _openid_sha1($text) {
     $hex = sha1($text);
     $raw = '';
@@ -404,6 +407,10 @@ 
  */
 if (!function_exists('bcpowmod')) {
 
+    /**
+     * @param string $exp
+     * @param string $mod
+     */
     function bcpowmod($base, $exp, $mod) {
         $square = bcmod($base, $mod);
         $result = 1;

src/Chamilo/CoreBundle/Entity/Language.php

Doc Comments +1 added lines, -1 removed lines

@@ -230,7 +230,7 @@
     /**
      * Get id
      *
-     * @return boolean
+     * @return integer
      */
     public function getId()
     {

src/Chamilo/CourseBundle/Component/CourseCopy/CourseBuilder.php

Doc Comments +1 added lines, -1 removed lines

@@ -91,7 +91,7 @@
     }
 
     /**
-     * @param array $array
+     * @param string[] $array
      */
     public function set_tools_to_build($array)
     {

main/forum/forumfunction.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -3054,7 +3054,7 @@
  * @param integer $thread_qualify
  * @param integer $qualify_time
  * @param integer $session_id
- * @return array optional
+ * @return string|null optional
  * @author Isaac Flores <isaac.flores@dokeos.com>, U.N.A.S University
  * @version October 2008, dokeos  1.8.6
  */

main/inc/lib/api.lib.php

Doc Comments +5 added lines, -2 removed lines

@@ -1244,6 +1244,7 @@ 
  * Gets the list of courses a specific user is subscribed to
  * @param int       User ID
  * @param boolean   $fetch_session Whether to get session courses or not - NOT YET IMPLEMENTED
+ * @param integer $userid
  * @return array    Array of courses in the form [0]=>('code'=>xxx,'db'=>xxx,'dir'=>xxx,'status'=>d)
  */
 function api_get_user_courses($userid, $fetch_session = true)
@@ -3036,7 +3037,7 @@ 
 * on the session visibility
 * @param bool $tutor  Whether to check if the user has the tutor role
 * @param bool  $coach Whether to check if the user has the coach role
-* @return boolean true: the user has the rights to edit, false: he does not
+* @return boolean|null true: the user has the rights to edit, false: he does not
 */
 function api_is_allowed_to_session_edit($tutor = false, $coach = false)
 {
@@ -6656,7 +6657,7 @@ 
 /**
  * Returns an array of global configuration settings which should be ignored
  * when printing the configuration settings screens
- * @return array Array of strings, each identifying one of the excluded settings
+ * @return string[] Array of strings, each identifying one of the excluded settings
  */
 function api_get_locked_settings() {
     return array(
@@ -6699,6 +6700,7 @@ 
  * false if he isn't. If the user ID is given and is an integer, then the same
  * ID is simply returned
  * @param  integer User ID
+ * @param integer $user_id
  * @return boolean Integer User ID is logged in, or false otherwise
  */
 function api_user_is_login($user_id = null) {
@@ -7143,6 +7145,7 @@ 
 /**
  * Gets memory limit in bytes
  * @param string The memory size (128M, 1G, 1000K, etc)
+ * @param string $mem
  * @return int
  * @assert (null) === false
  * @assert ('1t')  === 1099511627776

main/inc/lib/course_request.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
      * @param string $objetives
      * @param string $target_audience
      * @param int $user_id
-     * @return mixed The database id of the newly created course request or FALSE on failure.
+     * @return false|string The database id of the newly created course request or FALSE on failure.
      */
     public static function create_course_request(
         $wanted_code,

main/inc/lib/tracking.lib.php

Doc Comments +13 added lines, -6 removed lines

@@ -1333,6 +1333,8 @@ 
      * @param   string type of time filter: 'last_week' or 'custom'
      * @param   string  start date date('Y-m-d H:i:s')
      * @param   string  end date date('Y-m-d H:i:s')
+     * @param string $start_date
+     * @param string $end_date
      * @return timestamp $nb_seconds
      */
     public static function get_time_spent_on_the_platform(
@@ -1435,7 +1437,7 @@ 
      * Get first connection date for a student
      * @param    int $student_id
      *
-     * @return    string|bool Date format long without day or false if there are no connections
+     * @return    string|false Date format long without day or false if there are no connections
      */
     public static function get_first_connection_date($student_id)
     {
@@ -1465,7 +1467,7 @@ 
      * @param int $student_id
      * @param bool $warning_message Show a warning message (optional)
      * @param bool $return_timestamp True for returning results in timestamp (optional)
-     * @return string|int|bool Date format long without day, false if there are no connections or
+     * @return string Date format long without day, false if there are no connections or
      * timestamp if parameter $return_timestamp is true
      */
     public static function get_last_connection_date($student_id, $warning_message = false, $return_timestamp = false)
@@ -2762,6 +2764,9 @@ 
      * @param     array         Limit average to listed lp ids
      * @param     int            Session id (optional), if param $session_id is
      * null(default) it'll return results including sessions, 0 = session is not filtered
+     * @param integer $student_id
+     * @param string $course_code
+     * @param integer $session_id
      * @return     int         Total time
      */
     public static function get_time_spent_in_lp($student_id, $course_code, $lp_ids = array(), $session_id = null)
@@ -2831,6 +2836,8 @@ 
      * @param     int|array    Student id(s)
      * @param     string         Course code
      * @param     int         Learning path id
+     * @param integer $student_id
+     * @param string $course_code
      * @return     int         Total time
      */
     public static function get_last_connection_time_in_lp($student_id, $course_code, $lp_id, $session_id = 0)
@@ -5504,7 +5511,7 @@ 
 
     /**
     * @param FormValidator $form
-    * @return mixed
+    * @return FormValidator
     */
     public static function setUserSearchForm($form)
     {
@@ -6985,7 +6992,7 @@ 
      * @param int $user_id
      * @param int $course_id
      * @param int $session_id
-     * @return array
+     * @return string[]
      */
     public function display_login_tracking_info($view, $user_id, $course_id, $session_id = 0)
     {
@@ -7031,9 +7038,9 @@ 
     /**
      * Displays the exercise results for a specific user in a specific course.
      * @param   string $view
-     * @param   int $user_id    User ID
+     * @param   int $userId    User ID
      * @param   string  $courseCode Course code
-     * @return array
+     * @return string[]
      * @todo remove globals
      */
     public function display_exercise_tracking_info($view, $userId, $courseCode)