chamilo / chamilo-lms

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

main/inc/lib/agenda.lib.php

Doc Comments +3 added lines, -2 removed lines

@@ -572,14 +572,14 @@ 
      * @param int $allDay is all day 'true' or 'false'
      * @param string $title
      * @param string $content
-     * @param array $usersToSend
+     * @param string[] $usersToSend
      * @param array $attachmentArray
      * @param array $attachmentCommentList
      * @param string $comment
      * @param string $color
      * @param bool $addAnnouncement
      *
-     * @return null|false
+     * @return null|boolean
      */
     public function editEvent(
         $id,
@@ -1210,6 +1210,7 @@ 
      * Gets a single event
      *
      * @param int event id
+     * @param integer $id
      * @return array
      */
     public function get_event($id)

main/lp/learnpath.class.php

Doc Comments +27 added lines, -23 removed lines

@@ -89,7 +89,7 @@ 
      * @param   string $course Course code
      * @param   integer $lp_id
      * @param   integer $user_id
-     * @return  mixed True on success, false on error
+     * @return  boolean True on success, false on error
      */
     public function __construct($course, $lp_id, $user_id)
     {
@@ -492,7 +492,7 @@ 
      * @param int $max_time_allowed
      * @param int $userId
      *
-     * @return int
+     * @return false|string
      */
     public function add_item(
         $parent,
@@ -1042,7 +1042,7 @@ 
      * @param	array $courseInfo
      * @param	integer	Learnpath ID
      * @param	string	Whether to delete data or keep it (default: 'keep', others: 'remove')
-     * @return	boolean	True on success, false on failure (might change that to return number of elements deleted)
+     * @return	false|null	True on success, false on failure (might change that to return number of elements deleted)
      */
     public function delete($courseInfo = null, $id = null, $delete = 'keep')
     {
@@ -1182,7 +1182,7 @@ 
      * @param	integer	$id Elem ID (0 if first)
      * @param	integer	$remove Whether to remove the resource/data from the
      * system or leave it (default: 'keep', others 'remove')
-     * @return	integer	Number of elements moved
+     * @return	false|null	Number of elements moved
      * @todo implement resource removal
      */
     public function delete_item($id, $remove = 'keep')
@@ -1264,7 +1264,7 @@ 
      * @param   array   $audio The array resulting of the $_FILES[mp3] element
      * @param   int     $max_time_allowed
      * @param   string  $url
-     * @return  boolean True on success, false on error
+     * @return  false|null True on success, false on error
      */
     public function edit_item(
         $id,
@@ -1783,7 +1783,7 @@ 
 
     /**
      * Gets the first element URL.
-     * @return	string	URL to load into the viewer
+     * @return	false|null	URL to load into the viewer
      */
     public function first()
     {
@@ -2283,8 +2283,9 @@ 
     }
 
     /**
-     * @param int $lpId
      * @param array $courseInfo
+     * @param integer $student_id
+     * @param integer $sessionId
      * @return bool
      *
      */
@@ -2316,6 +2317,7 @@ 
      * @param int $student_id
      * @param string Course code (optional)
      * @param int $sessionId
+     * @param string $courseCode
      * @return	bool
      */
     public static function is_lp_visible_for_student(
@@ -2607,7 +2609,7 @@ 
 
     /**
      * Gets the learnpath session id
-     * @return	string	Learnpath theme
+     * @return	integer	Learnpath theme
      */
     public function get_lp_session_id()
     {
@@ -2640,7 +2642,7 @@ 
     /**
      * @param string $size
      * @param string $path_type
-     * @return bool|string
+     * @return string|false
      */
     public function get_preview_image_path($size = null, $path_type = 'web')
     {
@@ -2786,6 +2788,8 @@ 
      * Returns the XML DOM document's node
      * @param	resource	Reference to a list of objects to search for the given ITEM_*
      * @param	string		The identifier to look for
+     * @param DOMNodeList $children
+     * @param string $id
      * @return	mixed		The reference to the element found with that identifier. False if not found
      */
     public function get_scorm_xml_node(& $children, $id)
@@ -2971,7 +2975,7 @@ 
     /**
      * Generate and return the table of contents for this learnpath. The (flat) table returned can be
      * used by get_html_toc() to be ready to display
-     * @return	array	TOC as a table with 4 elements per row: title, link, status and level
+     * @return	boolean	TOC as a table with 4 elements per row: title, link, status and level
      */
     public function get_toc()
     {
@@ -3107,7 +3111,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getChapterTypes()
     {
@@ -3996,7 +4000,7 @@ 
      * Open a resource = initialise all local variables relative to this resource. Depending on the child
      * class, this might be redefined to allow several behaviours depending on the document type.
      * @param integer Resource ID
-     * @return boolean True on success, false otherwise
+     * @return boolean|null True on success, false otherwise
      */
     public function open($id)
     {
@@ -4125,7 +4129,7 @@ 
      * Can be used as abstract
      * @param	integer	$lp_id Learnpath id
      * @param	string	$set_visibility New visibility (v/i - visible/invisible)
-     * @return bool
+     * @return false|null
      */
     public static function toggle_publish($lp_id, $set_visibility = 'v')
     {
@@ -4208,7 +4212,7 @@ 
      * Make sure the results are saved with anoter method. This method should probably be
      * redefined in children classes.
      * To use a similar method  statically, use the create_new_attempt() method
-     * @return string URL to load in the viewer
+     * @return boolean URL to load in the viewer
      */
     public function restart()
     {
@@ -4284,6 +4288,7 @@ 
      * Saves the given item
      * @param	integer	$item_id. Optional (will take from $_REQUEST if null)
      * @param	boolean	$from_outside Save from url params (true) or from current attributes (false). Optional. Defaults to true
+     * @param integer $item_id
      * @return	boolean
      */
     public function save_item($item_id = null, $from_outside = true)
@@ -4783,7 +4788,7 @@ 
 
     /**
      * Sets use_max_score
-     * @param   string  $use_max_score Optional string giving the new location of this learnpath
+     * @param   integer  $use_max_score Optional string giving the new location of this learnpath
      * @return  boolean True on success / False on error
      */
     public function set_use_max_score($use_max_score = 1)
@@ -5186,6 +5191,7 @@ 
      * Register the attempt mode into db thanks to flags prevent_reinit and seriousgame_mode flags
      *
      * @param string 'seriousgame', 'single' or 'multiple'
+     * @param string $mode
      * @return boolean
      * @author ndiechburg <noel@cblue.be>
      **/
@@ -5228,7 +5234,7 @@ 
     /**
      * Switch between multiple attempt, single attempt or serious_game mode (only for scorm)
      *
-     * @return boolean
+     * @return boolean|null
      * @author ndiechburg <noel@cblue.be>
      **/
     public function switch_attempt_mode()
@@ -5419,7 +5425,6 @@ 
     /**
      * Function that creates a html list of learning path items so that we can add audio files to them
      * @author Kevin Van Den Haute
-     * @param int $lp_id
      * @return string
      */
     public function overview()
@@ -6440,7 +6445,7 @@ 
     /**
      * Function that displays a list with al the resources that
      * could be added to the learning path
-     * @return string
+     * @return boolean
      */
     public function display_resources()
     {
@@ -10049,7 +10054,7 @@ 
 
     /**
      * @param int $lp_id
-     * @return bool
+     * @return false|null
      */
     public function scorm_export_to_pdf($lp_id)
     {
@@ -10580,7 +10585,7 @@ 
 
     /**
      * @param int $itemId
-     * @return learnpathItem|false
+     * @return string
      */
     public function getItem($itemId)
     {
@@ -10630,7 +10635,6 @@ 
     /**
      * Set whether this is a learning path with the possibility to subscribe
      * users or not
-     * @param int $subscribeUsers (0 = false, 1 = true)
      */
     public function setSubscribeUsers($value)
     {
@@ -10755,7 +10759,7 @@ 
 
     /**
      * Get the item of exercise type (evaluation type)
-     * @return array The final evaluation. Otherwise return false
+     * @return integer The final evaluation. Otherwise return false
      */
     public function getFinalEvaluationItem()
     {
@@ -10976,7 +10980,7 @@ 
     /**
      * Create a forum for this learning path
      * @param type $forumCategoryId
-     * @return int The forum ID if was created. Otherwise return false
+     * @return false|string The forum ID if was created. Otherwise return false
      */
     public function createForum($forumCategoryId)
     {

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) {