chamilo / chamilo-lms

main/inc/lib/career.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 
     /**
      * Available driver list.
-     * @return array
+     * @return string[]
      */
     private function getDefaultDriverList()
     {

main/inc/lib/message.lib.php

Doc Comments +7 added lines, -5 removed lines

@@ -639,6 +639,8 @@ 
      * @param  int	message id
      * @param  int	message user id (receiver user id or sender user id)
      * @param  int	group id (optional)
+     * @param integer $message_id
+     * @param integer $message_uid
      * @return void
      */
     public static function delete_message_attachment_file($message_id, $message_uid, $group_id = 0)
@@ -683,7 +685,7 @@ 
      * update messages by user id and message id
      * @param  int		$user_id
      * @param  int		$message_id
-     * @return resource
+     * @return false|null
      */
     public static function update_message($user_id, $message_id)
     {
@@ -703,7 +705,7 @@ 
      * @param int $user_id
      * @param int $message_id
      * @param string $type
-     * @return bool
+     * @return false|null
      */
     public static function update_message_status($user_id, $message_id,$type)
     {
@@ -740,6 +742,7 @@ 
     /**
      * get messages by group id
      * @param  int		group id
+     * @param integer $group_id
      * @return array
      */
     public static function get_messages_by_group($group_id)
@@ -1477,7 +1480,7 @@ 
      * Sort date by desc from a multi-dimensional array
      * @param array $array1  first array to compare
      * @param array $array2  second array to compare
-     * @return bool
+     * @return integer
      */
     public function order_desc_date($array1, $array2)
     {
@@ -1555,7 +1558,6 @@ 
     /**
      * @param $id
      * @param array $params
-     * @param string $display
      * @return string
      */
     public static function generate_invitation_form($id, $params = array())
@@ -1644,7 +1646,7 @@ 
 
     /**
      * @param string $keyword
-     * @return null|string
+     * @return string
      */
     public static function outbox_display($keyword = '')
     {

main/inc/lib/sessionmanager.lib.php

Doc Comments +24 added lines, -19 removed lines

@@ -1336,9 +1336,9 @@ 
      * @param integer   $sessionCategoryId
      * @param int       $visibility
      * @param string    $description
-     * @param bool      $showDescription
+     * @param integer      $showDescription
      * @param int       $duration
-     * @param array     $extraFields
+     * @param boolean|null     $extraFields
      * @param int       $sessionAdminId
      * @param boolean $sendSubscriptionNotification Optional.
      *          Whether send a mail notification to users being subscribed
@@ -1558,7 +1558,7 @@ 
      * @param array $user_list
      * @param int $session_visibility
      * @param bool $empty_users
-     * @return bool
+     * @return false|null
      */
     public static function suscribe_users_to_session(
         $id_session,
@@ -1830,7 +1830,7 @@ 
      * @param array $courseInfo
      * @param int $status
      * @param bool $updateTotal
-     * @return bool
+     * @return false|null
      */
     public static function removeUsersFromCourseSession(
         $userList,
@@ -1896,7 +1896,7 @@ 
      * @param string $course_code
      * @param int $session_visibility
      * @param bool $removeUsersNotInList
-     * @return bool
+     * @return false|null
      */
     public static function subscribe_users_to_session_course(
         $user_list,
@@ -2079,7 +2079,7 @@ 
      * @param	bool	$removeExistingCoursesWithUsers Whether to unsubscribe
      * existing courses and users (true, default) or not (false)
      * @param $copyEvaluation from base course to session course
-     * @return	void	Nothing, or false on error
+     * @return	false|null	Nothing, or false on error
      * */
     public static function add_courses_to_session(
         $sessionId,
@@ -2275,6 +2275,8 @@ 
      *
      * @param int Session id
      * @param int Course id
+     * @param integer $session_id
+     * @param integer $course_id
      * @return bool True in case of success, false otherwise
      */
     public static function unsubscribe_course_from_session($session_id, $course_id)
@@ -2330,7 +2332,7 @@ 
      * @param	string	$variable Field's internal variable name
      * @param	int		$fieldType Field's type
      * @param	string	$displayText Field's language var name
-     * @return int     new extra field id
+     * @return boolean     new extra field id
      */
     public static function create_session_extra_field($variable, $fieldType, $displayText)
     {
@@ -2349,7 +2351,7 @@ 
      * @param	integer	Course ID
      * @param	string	Field variable name
      * @param	string	Field value
-     * @return	boolean	true if field updated, false otherwise
+     * @return	boolean|null	true if field updated, false otherwise
      */
     public static function update_session_extra_field_value($sessionId, $variable, $value = '')
     {
@@ -2554,7 +2556,7 @@ 
      * @param	array	id_checked
      * @param	bool	include delete session
      * @param	bool	optional, true if the function is called by a webservice, false otherwise.
-     * @return	void	Nothing, or false on error
+     * @return	boolean	Nothing, or false on error
      * The parameters is a array to delete sessions
      * */
     public static function delete_session_category($id_checked, $delete_session = false, $from_ws = false)
@@ -3049,6 +3051,7 @@ 
      * @param string $orderCondition
      * @param string $keyword
      * @param string $description
+     * @param integer $status
      * @return array sessions
      */
     public static function getSessionsFollowedByUser(
@@ -3261,8 +3264,8 @@ 
     /**
      * Gets the list of courses by session filtered by access_url
      *
-     * @param $userId
-     * @param $sessionId
+     * @param integer $userId
+     * @param null|integer $sessionId
      * @param null $from
      * @param null $limit
      * @param null $column
@@ -3387,6 +3390,7 @@ 
     /**
      * Gets the count of courses by session filtered by access_url
      * @param int session id
+     * @param integer $session_id
      * @return array list of courses
      */
     public static function getCourseCountBySessionId($session_id, $keyword = null)
@@ -3638,6 +3642,7 @@ 
      * Updates a session status
      * @param	int 	session id
      * @param	int 	status
+     * @param integer $status
      */
     public static function set_session_status($session_id, $status)
     {
@@ -3949,7 +3954,7 @@ 
 
     /**
      * @param $id
-     * @return bool
+     * @return null|boolean
      */
     public static function protect_teacher_session_edit($id)
     {
@@ -4013,7 +4018,7 @@ 
      *  true: if the session exists it will be updated.
      *  false: if session exists a new session will be created adding a counter session1, session2, etc
      * @param int $defaultUserId
-     * @param mixed $logger
+     * @param Logger $logger
      * @param array $extraFields convert a file row to an extra field. Example in CSV file there's a SessionID then it will
      * converted to extra_external_session_id if you set this: array('SessionId' => 'extra_external_session_id')
      * @param string $extraFieldId
@@ -5255,7 +5260,6 @@ 
      * @param string $lastConnectionDate
      * @param array $sessionIdList
      * @param array $studentIdList
-     * @param int $userStatus STUDENT|COURSEMANAGER constants
      *
      * @return array|int
      */
@@ -5407,7 +5411,7 @@ 
     /**
      * Get the list of course tools that have to be dealt with in case of
      * registering any course to a session
-     * @return array The list of tools to be dealt with (literal names)
+     * @return string[] The list of tools to be dealt with (literal names)
      */
     public static function getCourseToolToBeManaged()
     {
@@ -5421,7 +5425,7 @@ 
      * Calls the methods bound to each tool when a course is registered into a session
      * @param int $sessionId
      * @param int $courseId
-     * @return void
+     * @return boolean|null
      */
     public static function installCourse($sessionId, $courseId)
     {
@@ -6061,6 +6065,7 @@ 
      * @param int $categoryId The internal ID of the session category
      * @param string $target Value to search for in the session field values
      * @param array $extraFields A list of fields to be scanned and returned
+     * @param DateTime $publicationDate
      * @return mixed
      */
     public static function getShortSessionListAndExtraByCategory($categoryId, $target, $extraFields = null, $publicationDate = null)
@@ -7390,7 +7395,7 @@ 
     /**
      * Get link to the admin page for this session
      * @param   int $id Session ID
-     * @return mixed    URL to the admin page to manage the session, or false on error
+     * @return false|string    URL to the admin page to manage the session, or false on error
      */
     public static function getAdminPath($id)
     {
@@ -7407,7 +7412,7 @@ 
      * If a course is provided, build the link to the course
      * @param   int $id Session ID
      * @param   int $courseId Course ID (optional) in case the link has to send straight to the course
-     * @return mixed    URL to the page to use the session, or false on error
+     * @return false|string    URL to the page to use the session, or false on error
      */
     public static function getPath($id, $courseId = 0)
     {
@@ -7505,7 +7510,7 @@ 
     /**
      * Return true if coach is allowed to access this session
      * @param int $sessionId
-     * @return bool
+     * @return integer
      */
     public static function isSessionDateOkForCoach($sessionId)
     {

main/inc/lib/pear/PEAR.php

Doc Comments +2 added lines, -1 removed lines

@@ -490,7 +490,7 @@ 
      *                  PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE,
      *                  PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION.
      *
-     * @param mixed $options If $mode is PEAR_ERROR_TRIGGER, this parameter
+     * @param integer|null $options If $mode is PEAR_ERROR_TRIGGER, this parameter
      *                  specifies the PHP-internal error level (one of
      *                  E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
      *                  If $mode is PEAR_ERROR_CALLBACK, this
@@ -581,6 +581,7 @@ 
      * message, code and userinfo are enough.
      *
      * @param string $message
+     * @param integer $code
      *
      */
     function &throwError($message = null,

main/survey/survey.lib.php

Doc Comments +17 added lines, -15 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
@@ -1561,8 +1561,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
      *
@@ -1804,7 +1804,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
      */
@@ -2371,6 +2371,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)
@@ -3208,7 +3209,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,
@@ -3801,7 +3802,7 @@ 
 
     /**
      * @param $params
-     * @return bool|int
+     * @return false|string
      */
     public static function save_invitation($params)
     {
@@ -3855,6 +3856,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)
@@ -4783,7 +4785,7 @@ 
     /**
      * @author Isaac Flores Paz <florespaz@bidsoftperu.com>
      * @param int $user_id - User ID
-     * @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
      */
     static function show_link_available($user_id, $survey_code, $user_answer)
@@ -4829,7 +4831,7 @@ 
      * Display survey question chart
      * @param	array	Chart data
      * @param	boolean	Tells if the chart has a serie. False by default
-     * @return	void 	(direct output)
+     * @return	string 	(direct output)
      */
     public static function drawChart($chartData, $hasSerie = false, $chartContainerId = 'chartContainer')
     {

main/newscorm/learnpath.class.php

Doc Comments +30 added lines, -26 removed lines

@@ -84,7 +84,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)
     {
@@ -485,7 +485,7 @@ 
      * @param int $max_time_allowed
      * @param int $userId
      *
-     * @return int
+     * @return false|string
      */
     public function add_item(
         $parent,
@@ -1036,7 +1036,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')
     {
@@ -1170,7 +1170,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')
@@ -1252,7 +1252,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,
@@ -1775,7 +1775,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()
     {
@@ -2291,6 +2291,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(
@@ -2590,7 +2591,7 @@ 
 
     /**
      * Gets the learnpath session id
-     * @return	string	Learnpath theme
+     * @return	integer	Learnpath theme
      */
     public function get_lp_session_id()
     {
@@ -2623,7 +2624,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')
     {
@@ -2769,6 +2770,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)
@@ -3016,7 +3019,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()
     {
@@ -3152,7 +3155,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getChapterTypes()
     {
@@ -4054,7 +4057,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)
     {
@@ -4183,7 +4186,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')
     {
@@ -4268,7 +4271,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()
     {
@@ -4346,6 +4349,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)
@@ -4843,7 +4847,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)
@@ -5244,6 +5248,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>
      **/
@@ -5286,7 +5291,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()
@@ -5477,7 +5482,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()
@@ -5852,7 +5856,7 @@ 
     /**
      * This function builds the action menu
      * @param bool $returnContent
-     * @return void
+     * @return string|null
      */
     public function build_action_menu($returnContent = false)
     {
@@ -6371,7 +6375,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()
     {
@@ -8875,7 +8879,7 @@ 
 
     /**
      * Creates a list with all the student publications in it
-     * @return unknown
+     * @return string
      */
     public function get_student_publications()
     {
@@ -9827,7 +9831,7 @@ 
 
     /**
      * @param int $lp_id
-     * @return bool
+     * @return false|null
      */
     public function scorm_export_to_pdf($lp_id)
     {
@@ -10344,6 +10348,7 @@ 
     }
 
     /**
+     * @param string $courseCode
      * @return \learnpath
      */
     public static function getLpFromSession($courseCode, $lp_id, $user_id)
@@ -10363,7 +10368,7 @@ 
 
     /**
      * @param int $itemId
-     * @return learnpathItem|false
+     * @return string
      */
     public function getItem($itemId)
     {
@@ -10413,7 +10418,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)
     {
@@ -10538,7 +10542,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()
     {
@@ -10762,7 +10766,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)
     {
@@ -10811,7 +10815,7 @@ 
     /**
      * Get the LP Final Item Template
      *
-     * @return html
+     * @return string
      */
     private function getFinalItemTemplate()
     {
@@ -10834,7 +10838,7 @@ 
     /**
      * Get the LP Final Item form
      *
-     * @return html
+     * @return string
      */
     public function getFinalItemForm()
     {

main/inc/lib/events.lib.php

Doc Comments +19 added lines, -10 removed lines

@@ -239,7 +239,7 @@ 
     }
 
     /**
-     * @param doc_id id of document (id in mainDb.document table)
+     * @param doc_id string of document (id in mainDb.document table)
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @desc Record information for upload event
      * used in the works tool to record informations when
@@ -311,6 +311,8 @@ 
      * @param   int     session_id
      * @param   int     learnpath_id (id of the learnpath)
      * @param   int     learnpath_item_id (id of the learnpath_item)
+     * @param integer $weighting
+     * @param integer $session_id
      *
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @author Julio Montoya Armas <gugli100@gmail.com> Reworked 2010
@@ -412,7 +414,9 @@ 
      * @param	integer	Session ID (from the session table). Default value of null means "get from context".
      * @param	integer	Learnpath ID (from c_lp table). Default value of null means "get from context".
      * @param	integer	Learnpath item ID (from the c_lp_item table). Default value of null means "get from context".
-     * @return	boolean	Result of the insert query
+     * @param integer $exe_id
+     * @param integer $position
+     * @return	false|string	Result of the insert query
      */
     public static function saveQuestionAttempt(
         $score,
@@ -582,6 +586,7 @@ 
      * @param	int		Whether this answer is correct (1) or not (0)
      * @param	string	Coordinates of this point (e.g. 123;324)
      * @param	bool update results?
+     * @param integer $exe_id
      * @return	boolean	Result of the insert query
      * @uses Course code and user_id from global scope $_cid and $_user
      */
@@ -714,7 +719,6 @@ 
     /**
      * Get every email stored in the database
      *
-     * @param int $etId
      * @return type
      * @assert () !== false
      */
@@ -782,11 +786,11 @@ 
     /**
      * Save the new message for one event and for one language
      *
-     * @param string $eventName
+     * @param string $event_name
      * @param array $users
      * @param string $message
      * @param string $subject
-     * @param string $eventMessageLanguage
+     * @param string $event_message_language
      * @param int $activated
      */
     public static function save_event_type_message($event_name, $users, $message, $subject, $event_message_language, $activated)
@@ -920,10 +924,10 @@ 
     }
 
     /**
-     * @param $user_id
+     * @param integer $user_id
      * @param $exerciseId
-     * @param $lp_id
-     * @param $lp_item_id
+     * @param integer $lp_id
+     * @param integer $lp_item_id
      * @return int
      */
     public static function get_attempt_count_not_finished($user_id, $exerciseId, $lp_id, $lp_item_id)
@@ -1100,6 +1104,7 @@ 
      * @param   int     exercise id
      * @param   int $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1195,6 +1200,7 @@ 
      * @param   int     exercise id
      * @param   int  $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1235,6 +1241,7 @@ 
      * @param   int     exercise id
      * @param   string  course code
      * @param   int     session id
+     * @param integer $exe_id
      * @return  array   with the results
      *
      */
@@ -1284,6 +1291,8 @@ 
      * @param   int     lp id
      * @param   int     lp item id
      * @param   string 	order asc or desc
+     * @param integer $courseId
+     * @param string $order
      * @return  array   with the results
      *
      */
@@ -1343,7 +1352,7 @@ 
      * @param   int     exercise id
      * @param   int     $courseId
      * @param   int     session id
-     * @return  array   with the results
+     * @return  string   with the results
      *
      */
     public static function count_exercise_attempts_by_user($user_id, $exercise_id, $courseId, $session_id = 0)
@@ -1519,7 +1528,7 @@ 
      * @param   int     exercise id
      * @param   int   course id
      * @param   int     session id
-     * @return  array   with the results
+     * @return  integer   with the results
      *
      */
     public static function get_count_exercises_attempted_by_course($courseId, $session_id = 0)

main/newscorm/lp_final_item.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
  * @param int $sessionId
  * @param string $downloadCertificateLink
  * @param string $badgeLink
- * @return mixed|string
+ * @return string
  */
 function generateLPFinalItemTemplate($lpItemId, $courseCode, $sessionId=0, $downloadCertificateLink='', $badgeLink='')
 {

main/inc/lib/userportal.lib.php

Doc Comments +8 added lines, -7 removed lines

@@ -657,6 +657,7 @@ 
     * retrieves all the courses that the user has already subscribed to
     * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
     * @param int $user_id: the id of the user
+    * @param integer $user_id
     * @return array an array containing all the information of the courses of the given user
     */
     public function get_courses_of_user($user_id)
@@ -707,13 +708,13 @@ 
 
     /**
      * @todo use the template system
-     * @param $title
-     * @param $content
+     * @param string|null $title
+     * @param string $content
      * @param string $id
      * @param array $params
      * @param string $idAccordion
      * @param string $idCollapse
-     * @return null|string
+     * @return string
      */
     public function show_right_block(
         $title,
@@ -937,7 +938,7 @@ 
     }
 
     /**
-     * @return null|string
+     * @return string
      */
     public function return_course_block()
     {
@@ -1590,8 +1591,8 @@ 
 
     /**
      * Return HTML code for personal user course category
-     * @param $id
-     * @param $title
+     * @param integer $id
+     * @param string $title
      * @return string
      */
     private static function getHtmlForUserCategory($id, $title)
@@ -1612,7 +1613,7 @@ 
     /**
      * return HTML code for course display in session view
      * @param array $courseInfo
-     * @param $userCategoryId
+     * @param integer $userCategoryId
      * @param bool $displayButton
      * @param $loadDirs
      * @return string