chamilo / chamilo-lms

main/inc/lib/sessionmanager.lib.php

Doc Comments +24 added lines, -17 removed lines

@@ -1336,7 +1336,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
@@ -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)
     {
@@ -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)
     {
@@ -3960,7 +3965,7 @@ 
 
     /**
      * @param $id
-     * @return bool
+     * @return null|boolean
      */
     public static function protect_teacher_session_edit($id)
     {
@@ -4024,7 +4029,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
@@ -5266,7 +5271,6 @@ 
      * @param string $lastConnectionDate
      * @param array $sessionIdList
      * @param array $studentIdList
-     * @param int $userStatus STUDENT|COURSEMANAGER constants
      *
      * @return array|int
      */
@@ -5418,7 +5422,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()
     {
@@ -5432,7 +5436,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)
     {
@@ -6072,6 +6076,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)
@@ -6584,6 +6589,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
      */
@@ -7402,7 +7409,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 +7426,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 +7524,7 @@ 
     /**
      * Return true if coach is allowed to access this session
      * @param int $sessionId
-     * @return bool
+     * @return integer
      */
     public static function isSessionDateOkForCoach($sessionId)
     {

main/dropbox/dropbox_class.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -267,7 +267,7 @@
 	 * @param string $author
 	 * @param string $filename
 	 * @param int $filesize
-	 * @param array $recipient_ids
+	 * @param unknown_type|null $recipient_ids
 	 */
 	public function _createNewSentWork($uploader_id, $title, $description, $author, $filename, $filesize, $recipient_ids)
     {

main/exercice/export/qti2/qti2_classes.php

Doc Comments +5 added lines

@@ -72,6 +72,7 @@ 
     /**
      * Return the XML flow for the possible answers.
      *
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -147,6 +148,7 @@ 
      * Export the text with missing words.
      *
      *
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -204,6 +206,7 @@ 
 {
     /**
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -295,6 +298,7 @@ 
     /**
      * TODO update this to match hot spots instead of copying matching
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment, $questionDesc='', $questionMedia='')
     {
@@ -382,6 +386,7 @@ 
     /**
      * TODO implement
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment, $questionDesc='', $questionMedia='')
 	{

main/exercice/hotpotatoes.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -259,7 +259,7 @@ 
  * @param    reference    Reference to the array to search
  * @param    string       Node we are looking for in the array
  * @param string $node
- * @return   mixed        Node name or false if not found
+ * @return   false|string        Node name or false if not found
  */
 function myarraysearch(&$array, $node)
 {
@@ -280,7 +280,7 @@ 
  * Searches an image name into an array.
  * @param    reference        Reference to an array to search
  * @param    string           String to look for
- * @return   mixed            String given if found, false otherwise
+ * @return   false|string            String given if found, false otherwise
  * @uses     myarraysearch    This function is just an additional layer on the myarraysearch() function
  */
 function CheckImageName(&$imgparams, $string)

main/gradebook/lib/be/category.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -1545,7 +1545,7 @@
      * Retrieve all categories inside a course independent category
      * that should be visible to a student.
      * @param integer $cat_id parent category
-     * @param $stud_id student id
+     * @param integer $stud_id student id
      * @param $cats optional: if defined, the categories will be added to this array
      */
     public function get_independent_categories_with_result_for_student($cat_id, $stud_id, $cats = array())

main/gradebook/lib/be/evaluation.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -273,7 +273,7 @@
 
 
 	/**
-	 * @param array $result
+	 * @param Doctrine\DBAL\Driver\Statement|null $result
 	 * @return array
 	 */
 	private static function create_evaluation_objects_from_sql_result($result)

main/inc/lib/api.lib.php

Doc Comments +4 added lines, -1 removed lines

@@ -1359,6 +1359,7 @@ 
  * Gets the list of courses a specific user is subscribed to
  * @param int       User ID
  * @param boolean   $fetch_session Whether to get session courses or not - NOT YET IMPLEMENTED
+ * @param integer $userid
  * @return array    Array of courses in the form [0]=>('code'=>xxx,'db'=>xxx,'dir'=>xxx,'status'=>d)
  */
 function api_get_user_courses($userid, $fetch_session = true)
@@ -6756,7 +6757,7 @@ 
 /**
  * Returns an array of global configuration settings which should be ignored
  * when printing the configuration settings screens
- * @return array Array of strings, each identifying one of the excluded settings
+ * @return string[] Array of strings, each identifying one of the excluded settings
  */
 function api_get_locked_settings() {
     return array(
@@ -6799,6 +6800,7 @@ 
  * false if he isn't. If the user ID is given and is an integer, then the same
  * ID is simply returned
  * @param  integer User ID
+ * @param integer $user_id
  * @return boolean Integer User ID is logged in, or false otherwise
  */
 function api_user_is_login($user_id = null) {
@@ -7243,6 +7245,7 @@ 
 /**
  * Gets memory limit in bytes
  * @param string The memory size (128M, 1G, 1000K, etc)
+ * @param string $mem
  * @return int
  * @assert (null) === false
  * @assert ('1t')  === 1099511627776

main/inc/lib/course_description.lib.php

Doc Comments +5 added lines, -5 removed lines

@@ -359,7 +359,7 @@ 
 
     /**
      * Get description titles by default
-     * @return array
+     * @return string[]
      */
     public function get_default_description_title()
     {
@@ -378,7 +378,7 @@ 
 
     /**
      * Get description titles editable by default
-     * @return array
+     * @return boolean[]
      */
     public function get_default_description_title_editable()
     {
@@ -397,7 +397,7 @@ 
 
     /**
      * Get description icons by default
-     * @return array
+     * @return string[]
      */
     public function get_default_description_icon()
     {
@@ -417,7 +417,7 @@ 
 
     /**
      * Get questions by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_question()
     {
@@ -436,7 +436,7 @@ 
 
     /**
      * Get informations by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_information()
     {

main/inc/lib/course.lib.php

Doc Comments +3 added lines, -1 removed lines

@@ -2309,7 +2309,7 @@ 
 
     /**
      * Creates a file called mysql_dump.sql in the course folder
-     * @param $course_code The code of the course
+     * @param string $course_code The code of the course
      * @todo Implementation for single database
      */
     public static function create_database_dump($course_code)
@@ -3352,6 +3352,7 @@ 
      * in the sense that any user clicking them is registered as a student
      * @param int       User id
      * @param bool      Whether to show the document quick-loader or not
+     * @param integer $user_id
      * @return string
      */
     public static function returnSpecialCourses($user_id, $load_dirs = false)
@@ -3654,6 +3655,7 @@ 
      *  class userportal-course-item.
      * @param int      User category id
      * @param bool      Whether to show the document quick-loader or not
+     * @param integer $user_category_id
      * @return string
      */
     public static function returnCoursesWithoutCategories($user_category_id, $load_dirs = false)