chamilo / chamilo-lms

plugin/vchamilo/lib/Virtual.php

Doc Comments +9 added lines, -7 removed lines

@@ -184,7 +184,7 @@ 
     * provides a side connection to a vchamilo database
     * @param array $_configuration
      *
-    * @return \Doctrine\DBAL\Driver\Connection
+    * @return string
     */
     public static function bootConnection(&$_configuration)
     {
@@ -372,7 +372,7 @@ 
 
     /**
     * get a proper SQLdump command
-    * @param object $vchamilodata the complete new host information
+    * @param stdClass $vchamilodata the complete new host information
     * @return string the shell command
     */
     public static function getDatabaseDumpCmd($vchamilodata)
@@ -456,8 +456,8 @@ 
 
     /**
      * Backups a database for having a snapshot.
-     * @param        $vchamilo    object        The Vchamilo object.
-     * @param        $outputfilerad    string        The output SQL file radical.
+     * @param        stdClass $vchamilo    object        The Vchamilo object.
+     * @param        string $outputfilerad    string        The output SQL file radical.
      * @return        bool    If TRUE, dumping database was a success, otherwise FALSE.
      */
     public static function backupDatabase($vchamilo, $outputfilerad)
@@ -619,6 +619,8 @@ 
     * this function set will map standard moodle API calls to chamilo
     * internal primitives. This avoids too many changes to do in imported
     * code
+    * @param string $module
+    * @param string $key
     */
     public static function getConfig($module, $key, $isplugin = true)
     {
@@ -698,7 +700,7 @@ 
     /**
      * @param string $path
      *
-     * @return mixed
+     * @return string
      */
     public static function chopLastSlash($path)
     {
@@ -852,7 +854,7 @@ 
 
     /**
      * @param object $instance
-     * @return bool|\Doctrine\DBAL\Connection
+     * @return Doctrine\ORM\EntityManagerInterface
      */
     public static function getConnectionFromInstance($instance, $getManager = false)
     {
@@ -1297,7 +1299,7 @@ 
     /**
      * @param stdClass $instance
      *
-     * @return bool|string returns the original version of the app
+     * @return string|false returns the original version of the app
      */
     public static function canBeUpgraded($instance)
     {

plugin/google_maps/src/GoogleMapsPlugin.php

Doc Comments +2 added lines, -2 removed lines

@@ -43,7 +43,7 @@ 
 
     /**
      * Install the plugin
-     * @return void
+     * @return boolean
      */
     public function install()
     {
@@ -52,7 +52,7 @@ 
 
     /**
      * Uninstall the plugin
-     * @return void
+     * @return boolean
      */
     public function uninstall()
     {

main/inc/lib/sessionmanager.lib.php

Doc Comments +19 added lines, -17 removed lines

@@ -1532,7 +1532,7 @@ 
      * @param	array	$id_checked an array to delete sessions
      * @param   boolean  $from_ws 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
      * */
     public static function delete($id_checked, $from_ws = false)
     {
@@ -1669,7 +1669,7 @@ 
      * @param array $user_list
      * @param int $session_visibility
      * @param bool $empty_users
-     * @return bool
+     * @return false|null
      */
     public static function subscribe_users_to_session(
         $id_session,
@@ -1942,7 +1942,7 @@ 
      * @param array $courseInfo
      * @param int $status
      * @param bool $updateTotal
-     * @return bool
+     * @return false|null
      */
     public static function removeUsersFromCourseSession(
         $userList,
@@ -2008,7 +2008,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,
@@ -2192,7 +2192,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,
@@ -2441,7 +2441,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)
     {
@@ -2670,7 +2670,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)
@@ -3436,8 +3436,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
@@ -3562,6 +3562,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)
@@ -3820,6 +3821,7 @@ 
      * Updates a session status
      * @param	int 	session id
      * @param	int 	status
+     * @param integer $status
      */
     public static function set_session_status($session_id, $status)
     {
@@ -4028,7 +4030,7 @@ 
      * Protect a session to be edited.
      * @param int $id
      * @param bool $checkSession
-     * @return mixed | bool true if pass the check, api_not_allowed otherwise
+     * @return boolean|null | bool true if pass the check, api_not_allowed otherwise
      */
     public static function protectSession($id, $checkSession = true)
     {
@@ -4136,7 +4138,7 @@ 
 
     /**
      * @param $id
-     * @return bool
+     * @return null|boolean
      */
     public static function protect_teacher_session_edit($id)
     {
@@ -4201,7 +4203,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
@@ -5504,7 +5506,6 @@ 
      * @param string $lastConnectionDate
      * @param array $sessionIdList
      * @param array $studentIdList
-     * @param int $userStatus STUDENT|COURSEMANAGER constants
      *
      * @return array|int
      */
@@ -5656,7 +5657,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()
     {
@@ -5670,7 +5671,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)
     {
@@ -6320,6 +6321,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(
@@ -7656,7 +7658,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)
     {
@@ -7673,7 +7675,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)
     {

src/Chamilo/CoreBundle/Entity/Repository/SequenceRepository.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
      *
      * @param int $resourceId
      * @param int $type
-     * @return boolean
+     * @return boolean|null
      */
     public function deleteResource($resourceId, $type)
     {

src/Chamilo/CoreBundle/Component/Editor/CkEditor/Toolbar/Basic.php

Doc Comments +3 added lines, -1 removed lines

@@ -71,6 +71,8 @@ 
 
     /**
      * @inheritdoc
+     * @param string $toolbar
+     * @param string $prefix
      */
     public function __construct(
         $toolbar = null,
@@ -253,7 +255,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getNewPageBlock()
     {

main/inc/lib/attendance.lib.php

Doc Comments +24 added lines, -6 removed lines

@@ -277,7 +277,7 @@ 
      * Add attendances sheet inside table. This is the *list of* dates, not
      * a specific date in itself.
      * @param  bool   true for adding link in gradebook or false otherwise (optional)
-     * @return int    last attendance id
+     * @return false|string    last attendance id
      */
     public function attendance_add($link_to_gradebook = false)
     {
@@ -354,6 +354,7 @@ 
      * edit attendances inside table
      * @param 	int	   attendance id
      * @param  	bool   true for adding link in gradebook or false otherwise (optional)
+     * @param integer $attendance_id
      * @return 	int    last id
      */
     public function attendance_edit($attendance_id, $link_to_gradebook = false)
@@ -429,6 +430,7 @@ 
     /**
      * Restore attendance
      * @param 	int|array	   one or many attendances id
+     * @param integer $attendance_id
      * @return 	int    		   affected rows
      */
     public function attendance_restore($attendance_id)
@@ -478,7 +480,7 @@ 
 
     /**
      * Delete attendances
-     * @param 	int|array	$attendance_id   one or many attendances id
+     * @param 	integer	$attendance_id   one or many attendances id
      * @return 	int    		   affected rows
      */
     public function attendance_delete($attendance_id)
@@ -530,7 +532,7 @@ 
 
     /**
      * Changes visibility
-     * @param int|array	$attendanceId   one or many attendances id
+     * @param integer	$attendanceId   one or many attendances id
      * @param int status
      *
      * @return 	int affected rows
@@ -585,6 +587,7 @@ 
      * Lock or unlock an attendance
      * @param   int     attendance id
      * @param   bool    True to lock or false otherwise
+     * @param integer $attendance_id
      */
     public function lock_attendance($attendance_id, $lock = true)
     {
@@ -918,7 +921,11 @@ 
      * @param   string  Event type ('locked_attendance', 'done_attendance_sheet' ...)
      * @param   int     Last edit user id
      * @param   string  Calendar datetime value (optional, when event type is 'done_attendance_sheet')
-     * @return  int     Affected rows
+     * @param integer $attendance_id
+     * @param string $lastedit_date
+     * @param string $lastedit_type
+     * @param integer $lastedit_user_id
+     * @return  false|string     Affected rows
      */
     public function save_attendance_sheet_log(
         $attendance_id,
@@ -963,6 +970,7 @@ 
     /**
      * Get number of done attendances inside current sheet
      * @param	int	   attendance id
+     * @param integer $attendance_id
      * @return 	int	   number of done attendances
      */
     public static function get_done_attendance_calendar($attendance_id)
@@ -1198,6 +1206,7 @@ 
     /**
      * Get next attendance calendar without presences (done attendances)
      * @param	int	attendance id
+     * @param integer $attendance_id
      * @return 	int attendance calendar id
      */
     public function get_next_attendance_calendar_id($attendance_id)
@@ -1226,6 +1235,7 @@ 
     /**
      * Get next attendance calendar datetime without presences (done attendances)
      * @param	int	attendance id
+     * @param integer $attendance_id
      * @return 	int UNIX time format datetime
      */
     public function get_next_attendance_calendar_datetime($attendance_id)
@@ -1254,6 +1264,7 @@ 
      * Get user' score from current attendance
      * @param	int	$user_id
      * @param	int $attendance_id
+     * @param integer $groupId
      * @return	int score
      */
     public function get_user_score($user_id, $attendance_id, $groupId = null)
@@ -1301,6 +1312,7 @@ 
     /**
      * Get attendance calendar data by id
      * @param	int	attendance calendar id
+     * @param integer $calendar_id
      * @return	array attendance calendar data
      */
     public function get_attendance_calendar_by_id($calendar_id)
@@ -1423,6 +1435,7 @@ 
      * Get number of attendance calendar inside current attendance
      * @param	int	$attendance_id
      * @param	int	$groupId
+     * @param boolean $done_attendance
      * @return	int number of dates in attendance calendar
      */
     public static function get_number_of_attendance_calendar($attendance_id, $groupId = 0, $done_attendance = NULL, $userId = 0)
@@ -1648,7 +1661,6 @@ 
     /**
      * @param int $calendarId
      * @param int $courseId
-     * @param int $groupId
      * @return array
      */
     public function getGroupListByAttendanceCalendar($calendarId, $courseId)
@@ -1688,7 +1700,6 @@ 
     /**
      * @param int $calendarId
      * @param int $courseId
-     * @param int $groupId
      *
      * @return array
      */
@@ -1789,6 +1800,8 @@ 
      * edit a datetime inside attendance calendar table
      * @param	int	attendance calendar id
      * @param	int	attendance id
+     * @param integer $calendar_id
+     * @param integer $attendance_id
      * @return	int affected rows
      */
     public function attendance_calendar_edit($calendar_id, $attendance_id)
@@ -1828,6 +1841,8 @@ 
      * @param	int		attendance calendar id
      * @param	int		attendance id
      * @param	bool	true for removing all calendar inside current attendance, false for removing by calendar id
+     * @param integer $calendar_id
+     * @param integer $attendance_id
      * @return	int affected rows
      */
     public function attendance_calendar_delete($calendar_id, $attendance_id , $all_delete = false)
@@ -1890,6 +1905,9 @@ 
         $this->course_id = $course_id;
     }
 
+    /**
+     * @param string $datetime
+     */
     public function set_date_time($datetime)
     {
         $this->date_time = $datetime;

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