chamilo / chamilo-lms

main/inc/lib/exercise_show_functions.lib.php

Doc Comments +30 added lines, -6 removed lines

@@ -72,6 +72,11 @@ 
      * @param string    Answer text
      * @param int       Exercise ID
      * @param int       Question ID
+     * @param integer $feedback_type
+     * @param string $answer
+     * @param integer $id
+     * @param integer $questionId
+     * @param boolean|string $showTotalScoreAndUserChoices
      * @return void
      */
     public static function display_calculated_answer(
@@ -111,6 +116,9 @@ 
      * @param string    Answer text
      * @param int       Exercise ID
      * @param int       Question ID
+     * @param integer $feedback_type
+     * @param integer $exe_id
+     * @param integer $questionId
      * @return void
      */
     public static function display_free_answer(
@@ -140,10 +148,10 @@ 
     }
 
     /**
-     * @param $feedback_type
+     * @param integer $feedback_type
      * @param $answer
-     * @param $id
-     * @param $questionId
+     * @param integer $id
+     * @param integer $questionId
      * @param null $fileUrl
      * @param int $results_disabled
      * @param int $questionScore
@@ -385,6 +393,14 @@ 
      * @param integer Exercise ID
      * @param integer Question ID
      * @param boolean Whether to show the answer comment or not
+     * @param integer $feedback_type
+     * @param integer $answerType
+     * @param string $answer
+     * @param string $answerComment
+     * @param integer $answerCorrect
+     * @param integer $id
+     * @param integer $questionId
+     * @param boolean $showTotalScoreAndUserChoices
      * @return void
      */
     public static function display_multiple_answer_true_false(
@@ -489,6 +505,14 @@ 
      * @param integer Exercise ID
      * @param integer Question ID
      * @param boolean Whether to show the answer comment or not
+     * @param integer $feedback_type
+     * @param integer $answerType
+     * @param string $answer
+     * @param string $answerComment
+     * @param integer $answerCorrect
+     * @param integer $id
+     * @param integer $questionId
+     * @param boolean $showTotalScoreAndUserChoices
      * @return void
      */
     public static function display_multiple_answer_combination_true_false(
@@ -578,9 +602,9 @@ 
     }
 
     /**
-    * @param $feedback_type
-    * @param $exe_id
-    * @param $questionId
+    * @param integer $feedback_type
+    * @param integer $exe_id
+    * @param integer $questionId
     * @param null $questionScore
     * @param int $results_disabled
     */

main/inc/lib/CourseChatUtils.php

Doc Comments +3 added lines, -3 removed lines

@@ -217,7 +217,7 @@ 
 
     /**
      * Disconnect a user from course chats
-     * @param $userId
+     * @param integer $userId
      */
     public static function exitChat($userId)
     {
@@ -1388,7 +1388,7 @@ 
 
     /**
      * Get the emoji list to include in chat
-     * @return array
+     * @return string[]
      */
     public static function getEmojisToInclude()
     {
@@ -1693,7 +1693,7 @@ 
 
     /**
      * Get the number of users connected in chat
-     * @return mixed
+     * @return integer
      */
     public function countUsersOnline()
     {

main/lp/learnpath.class.php

Doc Comments +23 added lines, -19 removed lines

@@ -447,7 +447,7 @@ 
     }
 
     /**
-     * @param $course_id
+     * @param integer $course_id
      * @return int
      */
     public function set_course_int_id($course_id)
@@ -487,7 +487,7 @@ 
      * @param int $max_time_allowed
      * @param int $userId
      *
-     * @return int
+     * @return false|string
      */
     public function add_item(
         $parent,
@@ -1034,7 +1034,7 @@ 
      * @param array $courseInfo
      * @param integer $id    Learnpath ID
      * @param string $delete 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')
     {
@@ -1181,7 +1181,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')
@@ -1263,7 +1263,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,
@@ -1788,7 +1788,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()
     {
@@ -2334,6 +2334,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(
@@ -2662,7 +2663,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')
     {
@@ -2809,6 +2810,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)
@@ -2994,7 +2997,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()
     {
@@ -3126,7 +3129,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getChapterTypes()
     {
@@ -4030,7 +4033,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)
     {
@@ -4199,7 +4202,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 null|false
      */
     public static function toggle_publish($lp_id, $set_visibility = 'v')
     {
@@ -4464,7 +4467,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()
     {
@@ -5041,7 +5044,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)
@@ -5462,6 +5465,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>
      **/
@@ -5504,7 +5508,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()
@@ -6829,7 +6833,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()
     {
@@ -10588,7 +10592,7 @@ 
 
     /**
      * @param int $lp_id
-     * @return bool
+     * @return false|null
      */
     public function scorm_export_to_pdf($lp_id)
     {
@@ -11138,7 +11142,7 @@ 
 
     /**
      * @param int $itemId
-     * @return learnpathItem|false
+     * @return string
      */
     public function getItem($itemId)
     {
@@ -11313,7 +11317,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()
     {
@@ -11530,7 +11534,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)
     {

main/inc/lib/groupmanager.lib.php

Doc Comments +8 added lines, -6 removed lines

@@ -158,7 +158,7 @@ 
      * @param int $tutor The user-id of the group's tutor
      * @param int $places How many people can subscribe to the new group
      *
-     * @return int
+     * @return string
      */
     public static function create_group($name, $category_id, $tutor, $places)
     {
@@ -386,7 +386,7 @@ 
      * @author Bart Mollet
      * @param  array  $groupInfo iid
      * @param string $course_code Default is current course
-     * @return integer              - number of groups deleted.
+     * @return boolean              - number of groups deleted.
      */
     public static function delete_groups($groupInfo, $course_code = null)
     {
@@ -579,7 +579,7 @@ 
      * @param bool Whether self registration is allowed or not
      * @param bool Whether self unregistration is allowed or not
      * @param int $categoryId
-     * @return bool TRUE if properties are successfully changed, false otherwise
+     * @return Statement TRUE if properties are successfully changed, false otherwise
      */
     public static function set_group_properties(
         $group_id,
@@ -732,7 +732,7 @@ 
      * @param int $group_id The iid of the group
      * @param string $course_code The course in which the group is (default =
      * current course)
-     * @return array The category
+     * @return integer The category
      */
     public static function get_category_from_group($group_id, $course_code = '')
     {
@@ -816,7 +816,7 @@ 
      * @param int $self_unregistration_allowed
      * @param int $maximum_number_of_students
      * @param int $groups_per_user
-     * @return mixed
+     * @return false|string
      */
     public static function create_category(
         $title,
@@ -1021,6 +1021,8 @@ 
      * @param int $limit
      * @param bool $getCount
      * @param int $courseId
+     * @param string $column
+     * @param string $direction
      * @return array list of user id
      */
     public static function get_users(
@@ -1700,7 +1702,7 @@ 
      * Unsubscribe user(s) from a specified group in current course
      * @param mixed $user_ids Can be an array with user-id's or a single user-id
      * @param array $groupInfo
-     * @return bool TRUE if successful
+     * @return boolean|null TRUE if successful
      */
     public static function unsubscribe_users($user_ids, $groupInfo)
     {

main/inc/lib/text.lib.php

Doc Comments +9 added lines, -4 removed lines

@@ -54,6 +54,7 @@ 
  * Converts the text of a html-document to a given encoding, the meta-tag is changed accordingly.
  * @param string $string                The input full-html document.
  * @param string                        The new encoding value to be set.
+ * @param string $encoding
  */
 function api_set_encoding_html(&$string, $encoding)
 {
@@ -463,7 +464,7 @@ 
  * @since wordpress  2.8.1
  * @access private
  *
- * @param string|array $search The value being searched for, otherwise known as the needle. An array may be used to designate multiple needles.
+ * @param string[] $search The value being searched for, otherwise known as the needle. An array may be used to designate multiple needles.
  * @param string $subject The string being searched and replaced on, otherwise known as the haystack.
  * @return string The string with the replaced svalues.
  */
@@ -660,6 +661,7 @@ 
  * @param string    The text to "cut"
  * @param int       Count of chars
  * @param bool      Whether to embed in a <span title="...">...</span>
+ * @param integer $maxchar
  * @return string
  * */
 function cut($text, $maxchar, $embed = false)
@@ -678,7 +680,7 @@ 
  *
  * @param mixed     Number to convert
  * @param int       Decimal points 0=never, 1=if needed, 2=always
- * @return mixed    An integer or a float depends on the parameter
+ * @return string|null    An integer or a float depends on the parameter
  */
 function float_format($number, $flag = 1)
 {
@@ -723,7 +725,7 @@ 
 /**
  * Gets the week from a day
  * @param   string   Date in UTC (2010-01-01 12:12:12)
- * @return  int      Returns an integer with the week number of the year
+ * @return  string      Returns an integer with the week number of the year
  */
 function get_week_from_day($date)
 {
@@ -770,6 +772,9 @@ 
     return $output.$end;
 }
 
+/**
+ * @param string $glue
+ */
 function implode_with_key($glue, $array)
 {
     if (!empty($array)) {
@@ -849,7 +854,7 @@ 
 /**
  * @param string $string
  * @param bool $capitalizeFirstCharacter
- * @return mixed
+ * @return string
  */
 function underScoreToCamelCase($string, $capitalizeFirstCharacter = true)
 {

plugin/sepe/ws/Sepe.php

Doc Comments +3 added lines

@@ -680,6 +680,9 @@
         return $result;
     }
 
+    /**
+     * @param stdClass $obtenerAccionInput
+     */
     public function obtenerAccion($obtenerAccionInput)
     {
         /* Tracking Log */

plugin/sepe/ws/service.php

Doc Comments +4 added lines

@@ -35,6 +35,10 @@
         $this->setReturnResponse(true);
     }
 
+    /**
+     * @param string $tag
+     * @param string $namespace
+     */
     private function addNamespaceToTag($response, $tag, $namespace)
     {
         return str_replace(

main/inc/lib/myspace.lib.php

Doc Comments +4 added lines

@@ -2272,6 +2272,7 @@ 
 
     /**
      * Adds missing user-information (which isn't required, like password, etc).
+     * @return integer
      */
     function complete_missing_data($user)
     {
@@ -2872,6 +2873,9 @@ 
     return $result;
 }
 
+/**
+ * @param string|null $end_date
+ */
 function add_day_to($end_date)
 {
     $foo_date = strtotime($end_date);

main/lp/openoffice_text_document.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -42,7 +42,7 @@ 
     /**
      * Gets html pages and compose them into a learning path
      * @param	array	The files that will compose the generated learning path. Unused so far.
-     * @return	boolean	False if file does not exit. Nothing otherwise.
+     * @return	false|null	False if file does not exit. Nothing otherwise.
      */
     public function make_lp($files = array())
     {
@@ -100,6 +100,7 @@ 
      * Manages dir/chapter splitting
      * @param	string	Chapter header
      * @param	string	Content
+     * @param string $content
      * @return	void
      */
     public function dealPerChapter($header, $content)
@@ -191,6 +192,7 @@ 
      * Manages page splitting
      * @param	string	Page header
      * @param	string	Page body
+     * @param string $body
      * @return	void
      */
     public function dealPerPage($header, $body)