chamilo / chamilo-lms

main/inc/lib/grade_model.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -259,10 +259,10 @@
     }
 
     /**
-     * @param $form
+     * @param CatForm $form
      * @param string $name
      * @param null $default_value
-     * @return bool
+     * @return false|null
      */
     public function fill_grade_model_select_in_form(&$form, $name = 'gradebook_model_id', $default_value = null)
     {

main/inc/lib/link.lib.php

Doc Comments +10 added lines, -1 removed lines

@@ -477,6 +477,7 @@ 
      *
      * Get link info
      * @param int link id
+     * @param integer $id
      * @return array link info
      *
      **/
@@ -1058,7 +1059,9 @@ 
     /**
      * Displays the edit, delete and move icons
      * @param int   Category ID
-     * @return void
+     * @param integer $currentCategory
+     * @param integer $countCategories
+     * @return string
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      */
     public static function showCategoryAdminTools($category, $currentCategory, $countCategories)
@@ -1222,6 +1225,7 @@ 
     /**
      * CSV file import functions
      * @author René Haentjens , Ghent University
+     * @param string $catname
      */
     public static function get_cat($catname)
     {
@@ -1261,6 +1265,11 @@ 
     /**
      * CSV file import functions
      * @author René Haentjens , Ghent University
+     * @param string $url
+     * @param string $title
+     * @param string $description
+     * @param string $on_homepage
+     * @param string $hidden
      */
     public static function put_link($url, $cat, $title, $description, $on_homepage, $hidden)
     {

main/inc/lib/system_announcements.lib.php

Doc Comments +3 added lines, -1 removed lines

@@ -306,7 +306,7 @@ 
      * @param int    Whether the announcement should be visible to anonymous users (1) or not (0)
      * @param string The language for which the announvement should be shown. Leave null for all langages
      * @param int    Whether to send an e-mail to all users (1) or not (0)
-     * @return mixed  insert_id on success, false on failure
+     * @return false|string  insert_id on success, false on failure
      */
     public static function add_announcement(
         $title,
@@ -667,6 +667,8 @@ 
 	 * @param	int		Whether to send to all teachers (1) or not (0)
 	 * @param	int		Whether to send to all students (1) or not (0)
 	 * @param	string	Language (optional, considered for all languages if left empty)
+	 * @param integer|null $teacher
+	 * @param integer|null $student
      * @return  bool    True if the message was sent or there was no destination matching. False on database or e-mail sending error.
 	 */
     public static function send_system_announcement_by_email(

main/inc/lib/urlmanager.lib.php

Doc Comments +16 added lines, -13 removed lines

@@ -18,7 +18,7 @@ 
     * @param	string	$url The URL of the site
     * @param	string  $description The description of the site
     * @param	int		$active is active or not
-    * @return boolean if success
+    * @return Doctrine\DBAL\Driver\Statement|null if success
     */
     public static function add($url, $description, $active)
     {
@@ -43,7 +43,7 @@ 
     * @param	string 	$url
     * @param	string  $description The description of the site
     * @param	int		$active is active or not
-    * @return 	boolean if success
+    * @return 	Doctrine\DBAL\Driver\Statement|null if success
     */
     public static function update($url_id, $url, $description, $active)
     {
@@ -386,7 +386,7 @@ 
     * @author Julio Montoya
     * @param int user id
     * @param int url id
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_user_exist($user_id, $url_id)
     {
@@ -404,7 +404,7 @@ 
     * @author Julio Montoya
     * @param int $courseId
     * @param int $urlId
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_course_exist($courseId, $urlId)
     {
@@ -425,7 +425,7 @@ 
      * @author Julio Montoya
      * @param int $userGroupId
      * @param int $urlId
-     * @return boolean true if success
+     * @return integer true if success
      * */
     public static function relationUrlUsergroupExist($userGroupId, $urlId)
     {
@@ -445,7 +445,7 @@ 
     * @author Julio Montoya
     * @param int user id
     * @param int url id
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_session_exist($session_id, $url_id)
     {
@@ -568,6 +568,8 @@ 
      * @author Julio Montoya
      * @param  array of course ids
      * @param  array of url_ids
+     * @param integer[] $courseCategoryList
+     * @param integer[] $urlList
      * @return array
      **/
     public static function addCourseCategoryListToUrl($courseCategoryList, $urlList)
@@ -598,7 +600,7 @@ 
      * @author Julio Montoya
      * @param int $categoryCourseId
      * @param int $urlId
-     * @return boolean true if success
+     * @return integer true if success
      * */
     public static function relationUrlCourseCategoryExist($categoryCourseId, $urlId)
     {
@@ -615,7 +617,7 @@ 
     /**
      * @param int $userGroupId
      * @param int $urlId
-     * @return int
+     * @return string
      */
     public static function addUserGroupToUrl($userGroupId, $urlId)
     {
@@ -716,7 +718,7 @@ 
      * @param int $courseId
      * @param int $url_id
      *
-     * @return resource
+     * @return boolean
      */
     public static function add_course_to_url($courseId, $url_id = 1)
     {
@@ -807,7 +809,7 @@ 
     * @param  int  $courseId
     * @param  int  $urlId
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete_url_rel_course($courseId, $urlId)
     {
@@ -825,7 +827,7 @@ 
      * @param  int $userGroupId
      * @param  int $urlId
      *
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public static function delete_url_rel_usergroup($userGroupId, $urlId)
     {
@@ -844,7 +846,7 @@ 
      * @param  int $userGroupId
      * @param  int $urlId
      *
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public static function deleteUrlRelCourseCategory($userGroupId, $urlId)
     {
@@ -862,8 +864,9 @@ 
     * @author Julio Montoya
     * @param  char  course code
     * @param  int url id
+    * @param integer $url_id
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete_url_rel_session($session_id, $url_id)
     {

src/Chamilo/CourseBundle/Entity/CForumThread.php

Doc Comments +1 added lines, -1 removed lines

@@ -181,7 +181,7 @@
 
     /**
      * set threadPeerQualify
-     * @param $threadPeerQualify
+     * @param integer $threadPeerQualify
      * @return $this
      */
     public function setThreadPeerQualify($threadPeerQualify)

plugin/vchamilo/lib/Virtual.php

Doc Comments +9 added lines, -7 removed lines

@@ -140,7 +140,7 @@ 
     * provides a side connection to a vchamilo database
     * @param array $_configuration
      *
-    * @return \Doctrine\DBAL\Driver\Connection
+    * @return string
     */
     public static function bootConnection(&$_configuration)
     {
@@ -303,7 +303,7 @@ 
 
     /**
     * get a proper SQLdump command
-    * @param object $vmoodledata the complete new host information
+    * @param stdClass $vchamilodata
     * @return string the shell command
     */
     public static function getDatabaseDumpCmd($vchamilodata)
@@ -383,8 +383,8 @@ 
 
     /**
      * Dumps a SQL 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 dumpDatabase($vchamilo, $outputfilerad)
@@ -560,6 +560,8 @@ 
     * 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)
     {
@@ -628,7 +630,7 @@ 
     /**
      * @param string $path
      *
-     * @return mixed
+     * @return string
      */
     public static function chopLastSlash($path)
     {
@@ -760,7 +762,7 @@ 
     }
 
     /**
-     * @param object $instance
+     * @param stdClass $instance
      * @return \Doctrine\DBAL\Connection
      */
     public static function getConnectionFromInstance($instance, $getManager = false)
@@ -1169,7 +1171,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)
     {

main/lp/openoffice_document.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -186,9 +186,9 @@
 
     /**
      * Get images files from remote host (with webservices)
-     * @param   array $file current ppt file details
+     * @param   string $file current ppt file details
      * @param   string  $size The expected final size of the rendered slides
-     * @return  array images files
+     * @return  string images files
      */
     private function _get_remote_ppt2lp_files($file, $size = null)
     {

main/inc/lib/extra_field.lib.php

Doc Comments +6 added lines, -6 removed lines

@@ -140,7 +140,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getValidExtraFieldTypes()
     {
@@ -217,7 +217,7 @@ 
 
     /**
      * @param array $conditions
-     * @param null  $order_field_options_by
+     * @param string  $order_field_options_by
      *
      * @return array
      */
@@ -375,7 +375,7 @@ 
     /**
      * @param string $handler
      *
-     * @return array
+     * @return string[]
      */
     public static function get_extra_fields_by_handler($handler)
     {
@@ -574,7 +574,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_field_types()
     {
@@ -584,7 +584,7 @@ 
     /**
      * @param int $id
      *
-     * @return null
+     * @return string|null
      */
     public function get_field_type_by_id($id)
     {
@@ -1822,7 +1822,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getJqgridColumnNames()
     {

main/inc/lib/sessionmanager.lib.php

Doc Comments +24 added lines, -17 removed lines

@@ -1344,7 +1344,7 @@ 
      * @param string    $description
      * @param int       $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
@@ -1573,7 +1573,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,
@@ -1845,7 +1845,7 @@ 
      * @param array $courseInfo
      * @param int $status
      * @param bool $updateTotal
-     * @return bool
+     * @return false|null
      */
     public static function removeUsersFromCourseSession(
         $userList,
@@ -1911,7 +1911,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,
@@ -2094,7 +2094,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,
@@ -2290,6 +2290,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)
@@ -2569,7 +2571,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)
@@ -3064,6 +3066,7 @@ 
      * @param string $orderCondition
      * @param string $keyword
      * @param string $description
+     * @param integer $status
      * @return array sessions
      */
     public static function getSessionsFollowedByUser(
@@ -3276,8 +3279,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
@@ -3402,6 +3405,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)
@@ -3653,6 +3657,7 @@ 
      * Updates a session status
      * @param	int 	session id
      * @param	int 	status
+     * @param integer $status
      */
     public static function set_session_status($session_id, $status)
     {
@@ -3861,7 +3866,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)
     {
@@ -3969,7 +3974,7 @@ 
 
     /**
      * @param $id
-     * @return bool
+     * @return null|boolean
      */
     public static function protect_teacher_session_edit($id)
     {
@@ -4033,7 +4038,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
@@ -5281,7 +5286,6 @@ 
      * @param string $lastConnectionDate
      * @param array $sessionIdList
      * @param array $studentIdList
-     * @param int $userStatus STUDENT|COURSEMANAGER constants
      *
      * @return array|int
      */
@@ -5433,7 +5437,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()
     {
@@ -5447,7 +5451,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)
     {
@@ -6087,6 +6091,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)
@@ -6599,6 +6604,8 @@ 
      * Converts "start date" and "end date" to "From start date to end date" string
      * @param string $startDate
      * @param string $endDate
+     * @param boolean $showTime
+     * @param boolean $dateHuman
      *
      * @return string
      */
@@ -7415,7 +7422,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)
     {
@@ -7432,7 +7439,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)
     {
@@ -7530,7 +7537,7 @@ 
     /**
      * Return true if coach is allowed to access this session
      * @param int $sessionId
-     * @return bool
+     * @return integer
      */
     public static function isSessionDateOkForCoach($sessionId)
     {