chamilo / chamilo-lms

main/survey/survey.lib.php

Doc Comments +19 added lines, -16 removed lines

@@ -47,7 +47,7 @@ 
      * Deletes all survey invitations of a user
      * @param int $user_id
      *
-     * @return boolean
+     * @return false|null
      * @assert ('') === false
      */
     public static function delete_all_survey_invitations_by_user($user_id)
@@ -104,7 +104,7 @@ 
      * Retrieves all the survey information
      *
      * @param integer $survey_id the id of the survey
-     * @param boolean $shared this parameter determines if
+     * @param integer $shared this parameter determines if
      * we have to get the information of a survey from the central (shared) database or from the
      * 		  course database
      * @param string course code optional
@@ -571,7 +571,7 @@ 
      * This function deletes a survey (and also all the question in that survey
      *
      * @param int $survey_id id of the survey that has to be deleted
-     * @return true
+     * @return boolean
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @version January 2007
@@ -756,7 +756,7 @@ 
      *
      * @param int $survey_id id of the survey that has to be duplicated
      * @param int $courseId id of the course which survey has to be duplicated
-     * @return true
+     * @return boolean
      *
      * @author Eric Marguin <e.marguin@elixir-interactive.com>, Elixir Interactive
      * @version October 2007
@@ -796,7 +796,7 @@ 
     /**
      * This function recalculates the number of people who have taken the survey (=filled at least one question)
      *
-     * @param int $survey_id the id of the survey somebody
+     * @param int $survey_data the id of the survey somebody
      * @return true
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1367,7 +1367,7 @@ 
      * This function deletes a shared survey question from the main database and all its options
      *
      * @param int $question_id the id of the question
-     * @param int $shared
+     * @param integer $survey_id
      *
      * @todo delete all the options of this question
      *
@@ -1494,8 +1494,8 @@ 
      * This function deletes all the options of the questions of a given survey
      * This function is normally only called when a survey is deleted
      *
-     * @param $survey_id the id of the survey that has to be deleted
-     * @return true
+     * @param integer $survey_id the id of the survey that has to be deleted
+     * @return boolean
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @version January 2007
@@ -1562,8 +1562,8 @@ 
      * This function deletes all the answers anyone has given on this survey
      * This function is normally only called when a survey is deleted
      *
-     * @param $survey_id the id of the survey that has to be deleted
-     * @return true
+     * @param integer $survey_id the id of the survey that has to be deleted
+     * @return boolean
      *
      * @todo write the function
      *
@@ -1838,7 +1838,7 @@ 
     /**
      * This function checks the parameters that are used in this page
      *
-     * @return 	string 	The header, an error and the footer if any parameter fails, else it returns true
+     * @return 	null|boolean 	The header, an error and the footer if any parameter fails, else it returns true
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @version February 2007
      */
@@ -2392,6 +2392,7 @@ 
      * Display score data about a survey question
      * @param	array	Question info
      * @param	integer	The offset of results shown
+     * @param integer $offset
      * @return	void 	(direct output)
      */
     public static function display_question_report_score($survey_data, $question, $offset)
@@ -3032,7 +3033,7 @@ 
      * Quite similar to display_complete_report(), returns an HTML string
      * that can be used in a csv file
      * @todo consider merging this function with display_complete_report
-     * @return	string	The contents of a csv file
+     * @return	false|null	The contents of a csv file
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @version February 2007
      */
@@ -3254,7 +3255,7 @@ 
      * @param	array	User's answers
      * @param 	mixed	User ID or user details as string - Used as a string in the result string
      * @param	boolean	Whether to display user fields or not
-     * @return	string	One line of the csv file
+     * @return	string[]	One line of the csv file
      */
     public static function export_complete_report_row_xls(
         $survey_data,
@@ -3560,6 +3561,7 @@ 
      *
      * @param	integer	Survey ID
      * @param	integer	Question ID
+     * @param integer $survey_id
      * @return 	Array	Array containing all answers of all users, grouped by user
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -3854,7 +3856,7 @@ 
 
     /**
      * @param $params
-     * @return bool|int
+     * @return false|string
      */
     public static function save_invitation($params)
     {
@@ -3908,6 +3910,7 @@ 
      *
      * @param int invitedUser - the userId (course user) or emailaddress of additional user
      * $param string $invitation_code - the unique invitation code for the URL
+     * @param string|null $invitation_text
      * @return	void
      */
     public static function send_invitation_mail($invitedUser, $invitation_code, $invitation_title, $invitation_text)
@@ -4802,7 +4805,7 @@ 
      * @author Isaac Flores Paz <florespaz@bidsoftperu.com>
      * @param int $user_id - User ID
      * @param string $survey_code
-     * @param int $user_id_answer - User in survey answer table (user id or anonymus)
+     * @param int $user_answer - User in survey answer table (user id or anonymus)
      *
      * @return boolean
      */
@@ -4975,7 +4978,7 @@ 
     /**
      * Check if the current survey has answers
      *
-     * @param $surveyId
+     * @param integer $surveyId
      * @return boolean return true if the survey has answers, false otherwise
      */
     public static function checkIfSurveyHasAnswers($surveyId)

main/exercise/exercise.class.php

Doc Comments +9 added lines, -6 removed lines

@@ -353,7 +353,7 @@ 
     }
 
     /**
-     * @return int
+     * @return string
      */
     public function selectPassPercentage()
     {
@@ -462,7 +462,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()
     {
@@ -2838,7 +2838,7 @@ 
      * @param int  int lp id
      * @param int  int lp item id
      * @param int  int lp item_view id
-     * @param float $weight
+     * @param integer $weight
      * @param array question list
      */
     public function save_stat_track_exercise_info(
@@ -5246,7 +5246,7 @@ 
      * @param int $exe_id
      * @param float $score
      * @param float $weight
-     * @return bool
+     * @return false|null
      */
     public function send_mail_notification_for_exam($question_list_answers, $origin, $exe_id, $score, $weight)
     {
@@ -5445,6 +5445,9 @@ 
         }
     }
 
+    /**
+     * @param integer $exe_id
+     */
     function send_notification_for_oral_questions($question_list_answers, $origin, $exe_id)
     {
         if (api_get_course_setting('email_alert_manager_on_new_quiz') != 1 ) {
@@ -5596,7 +5599,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,
@@ -6931,7 +6934,7 @@ 
      * @param bool $show_comment
      * @param null $exercise_feedback
      * @param bool $show_answers
-     * @param null $modelType
+     * @param integer $modelType
      * @param bool $categoryMinusOne
      * @return bool|null|string
      */

main/forum/forumfunction.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -3132,7 +3132,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
  */
@@ -3952,7 +3952,7 @@ 
 
 /**
  * This function is used to find all the information about what's new in the forum tool
- * @return void
+ * @return false|null
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8

plugin/buycourses/src/buy_course_plugin.class.php

Doc Comments +14 added lines, -14 removed lines

@@ -49,7 +49,7 @@ 
 

     /**

      *

-     * @return StaticPlugin

+     * @return BuyCoursesPlugin

      */

     static function create()

     {

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

     {

@@ -690,7 +690,7 @@ 
     /**

      * Get session info

      * @param array $sessionId The session ID

-     * @return array

+     * @return Session

      */

     public function getSessionInfo($sessionId)

     {

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

     {

@@ -965,7 +965,7 @@ 
 

     /**

      * Get payment types

-     * @return array

+     * @return string[]

      */

     public function getPaymentTypes()

     {

@@ -1004,7 +1004,7 @@ 
 

     /**

      * Get the statuses for sales

-     * @return array

+     * @return string[]

      */

     public function getSaleStatuses()

     {

@@ -1017,7 +1017,7 @@ 
 

     /**

      * Get the statuses for Payouts

-     * @return array

+     * @return string[]

      */

     public function getPayoutStatuses()

     {

@@ -1030,7 +1030,7 @@ 
 

     /**

      * Get the list of product types

-     * @return array

+     * @return string[]

      */

     public function getProductTypes()

     {

@@ -1042,7 +1042,7 @@ 
 

     /**

      * Get the list of service types

-     * @return array

+     * @return string[]

      */

     public function getServiceTypes()

     {

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

     {

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

     {

@@ -1704,7 +1704,7 @@ 
     /**

      * Register addicional service

      * @param array params $service

-     * @return mixed response

+     * @return string|false response

      */

     public function storeService($service)

     {

@@ -1861,7 +1861,7 @@ 
 

     /**

      * Get the statuses for sales

-     * @return array

+     * @return string[]

      */

     public function getServiceSaleStatuses()

     {

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

     {

plugin/buycourses/src/Culqi/Client.php

Doc Comments +3 added lines

@@ -17,6 +17,9 @@
     const BASE_URL = "https://integ-pago.culqi.com/api/v1";
 
 
+    /**
+     * @param string $method
+     */
     public function request($method, $url, $api_key, $data = NULL, $headers= array("Content-Type" => "application/json", "Accept" => "application/json") ) {
         try {
             $options = array(

plugin/buycourses/src/Culqi/Resource.php

Doc Comments +3 added lines

@@ -3,6 +3,9 @@
 
 class Resource extends Client {
 
+    /**
+     * @param Culqi $culqi
+     */
     public function __construct($culqi)
     {
         $this->culqi = $culqi;

plugin/buycourses/src/Requests.php

Doc Comments +4 added lines

@@ -226,6 +226,7 @@ 
 	 */
 	/**
 	 * Send a GET request
+	 * @param string $url
 	 */
 	public static function get($url, $headers = array(), $options = array()) {
 		return self::request($url, $headers, null, self::GET, $options);
@@ -240,6 +241,7 @@ 
 
 	/**
 	 * Send a DELETE request
+	 * @param string $url
 	 */
 	public static function delete($url, $headers = array(), $options = array()) {
 		return self::request($url, $headers, null, self::DELETE, $options);
@@ -263,6 +265,7 @@ 
 	 */
 	/**
 	 * Send a POST request
+	 * @param string $url
 	 */
 	public static function post($url, $headers = array(), $data = array(), $options = array()) {
 		return self::request($url, $headers, $data, self::POST, $options);
@@ -288,6 +291,7 @@ 
 	 * specification recommends that should send an ETag
 	 *
 	 * @link https://tools.ietf.org/html/rfc5789
+	 * @param string $url
 	 */
 	public static function patch($url, $headers, $data = array(), $options = array()) {
 		return self::request($url, $headers, $data, self::PATCH, $options);

plugin/buycourses/src/Requests/Cookie.php

Doc Comments +2 added lines, -1 removed lines

@@ -62,7 +62,7 @@ 
 	 *
 	 * @param string $name
 	 * @param string $value
-	 * @param array|Requests_Utility_CaseInsensitiveDictionary $attributes Associative array of attribute data
+	 * @param Requests_Utility_CaseInsensitiveDictionary $attributes Associative array of attribute data
 	 */
 	public function __construct($name, $value, $attributes = array(), $flags = array(), $reference_time = null) {
 		$this->name = $name;
@@ -377,6 +377,7 @@ 
 	 * specifies some of this handling, but not in a thorough manner.
 	 *
 	 * @param string Cookie header value (from a Set-Cookie header)
+	 * @param integer $reference_time
 	 * @return Requests_Cookie Parsed cookie object
 	 */
 	public static function parse($string, $name = '', $reference_time = null) {

plugin/buycourses/src/Requests/IDNAEncoder.php

Doc Comments +1 added lines, -1 removed lines

@@ -357,7 +357,7 @@
 	 * @param int $delta
 	 * @param int $numpoints
 	 * @param bool $firsttime
-	 * @return int New bias
+	 * @return double New bias
 	 */
 	protected static function adapt($delta, $numpoints, $firsttime) {
 #	function adapt(delta,numpoints,firsttime):