chamilo / chamilo-lms

src/Chamilo/CoreBundle/Component/Filesystem/Data.php

Doc Comments +2 added lines, -2 removed lines

@@ -116,7 +116,7 @@ 
 
     /**
      * Create folders
-     * @param array            $folderList
+     * @param string[]            $folderList
      * @param OutputInterface  $output
      * @param string           $folderPermissions
      */
@@ -200,7 +200,7 @@ 
      * http://chamilo/courses/ABC/document/file.jpg
      * @param string $content
      *
-     * @return string
+     * @return \simplehtmldom_1_5\simple_html_dom
      */
     public function convertRelativeToAbsoluteUrl($content)
     {

plugin/azure_active_directory/src/AzureActiveDirectory.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
     /**
      * Instance the plugin
      * @staticvar null $result
-     * @return Tour
+     * @return AzureActiveDirectory
      */
     static function create()
     {

src/Chamilo/CoreBundle/Entity/Language.php

Doc Comments +2 added lines, -2 removed lines

@@ -195,7 +195,7 @@ 
     /**
      * Get parentId
      *
-     * @return boolean
+     * @return integer
      */
     public function getParentId()
     {
@@ -205,7 +205,7 @@ 
     /**
      * Get id
      *
-     * @return boolean
+     * @return integer
      */
     public function getId()
     {

main/newscorm/learnpathItem.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -1869,7 +1869,7 @@ 
 
     /**
      * Get the extra terms (tags) that identify this item
-     * @return mixed
+     * @return string
      */
     public function get_terms()
     {
@@ -2069,7 +2069,7 @@ 
 
     /**
      * Opens/launches the item. Initialises runtime values.
-     * @return    boolean    True on success, false on failure.
+     * @return    boolean|null    True on success, false on failure.
      */
     public function open($allow_new_attempt = false)
     {
@@ -3504,7 +3504,7 @@ 
 
     /**
      * Checks if the current status is part of the list of status given
-     * @param  array  $list  An array of status to check for.
+     * @param  string[]  $list  An array of status to check for.
      * If the current status is one of the strings, return true
      *
      * @return boolean True if the status was one of the given strings,
@@ -3681,7 +3681,7 @@ 
     /**
      * Write objectives to DB. This method is separate from write_to_db() because otherwise
      * objectives are lost as a side effect to AJAX and session concurrent access
-     * @return    boolean        True or false on error
+     * @return    boolean|null        True or false on error
      */
     public function write_objectives_to_db()
     {
@@ -4322,7 +4322,7 @@ 
      * Removes the relation between the current item and an audio file. The file
      * is only removed from the lp_item table, but remains in the document table
      * and directory
-     * @return bool
+     * @return false|null
      */
     public function remove_audio()
     {

main/inc/lib/CourseChatUtils.php

Doc Comments +2 added lines, -2 removed lines

@@ -1415,7 +1415,7 @@ 
 
     /**
      * Get the emoji list to include in chat
-     * @return array
+     * @return string[]
      */
     public static function getEmojisToInclude()
     {
@@ -1738,7 +1738,7 @@ 
 
     /**
      * Get the number of users connected in chat
-     * @return mixed
+     * @return integer
      */
     public function countUsersOnline()
     {

main/inc/lib/course_category.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -1073,8 +1073,8 @@
 
 /**
  * Get li HTML of page number
- * @param $pageNumber
- * @param $pageLength
+ * @param integer $pageNumber
+ * @param integer $pageLength
  * @param array $liAttributes
  * @param string $content
  * @return string

main/inc/lib/sessionmanager.lib.php

Doc Comments +25 added lines, -20 removed lines

@@ -1334,9 +1334,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
@@ -1565,7 +1565,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,
@@ -1837,7 +1837,7 @@ 
      * @param array $courseInfo
      * @param int $status
      * @param bool $updateTotal
-     * @return bool
+     * @return false|null
      */
     public static function removeUsersFromCourseSession(
         $userList,
@@ -1903,7 +1903,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,
@@ -2086,7 +2086,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,
@@ -2282,6 +2282,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)
@@ -2337,7 +2339,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)
     {
@@ -2356,7 +2358,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 = '')
     {
@@ -2561,7 +2563,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)
@@ -3056,6 +3058,7 @@ 
      * @param string $orderCondition
      * @param string $keyword
      * @param string $description
+     * @param integer $status
      * @return array sessions
      */
     public static function getSessionsFollowedByUser(
@@ -3268,8 +3271,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
@@ -3394,6 +3397,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)
@@ -3645,6 +3649,7 @@ 
      * Updates a session status
      * @param	int 	session id
      * @param	int 	status
+     * @param integer $status
      */
     public static function set_session_status($session_id, $status)
     {
@@ -3853,7 +3858,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)
     {
@@ -3961,7 +3966,7 @@ 
 
     /**
      * @param $id
-     * @return bool
+     * @return null|boolean
      */
     public static function protect_teacher_session_edit($id)
     {
@@ -4025,7 +4030,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
@@ -5267,7 +5272,6 @@ 
      * @param string $lastConnectionDate
      * @param array $sessionIdList
      * @param array $studentIdList
-     * @param int $userStatus STUDENT|COURSEMANAGER constants
      *
      * @return array|int
      */
@@ -5419,7 +5423,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()
     {
@@ -5433,7 +5437,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)
     {
@@ -6073,6 +6077,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)
@@ -7402,7 +7407,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)
     {
@@ -7419,7 +7424,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)
     {
@@ -7517,7 +7522,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/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/userportal.lib.php

Doc Comments +6 added lines, -5 removed lines

@@ -682,6 +682,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)
@@ -732,8 +733,8 @@ 
 
     /**
      * @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
@@ -1704,8 +1705,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)
@@ -1726,7 +1727,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