chamilo / chamilo-lms

main/inc/lib/webservices/Rest.php

Doc Comments -1 removed lines

@@ -318,7 +318,6 @@
     }
 
     /**
-     * @param int $courseId
      * @return array
      * @throws Exception
      */

src/Chamilo/CoreBundle/Composer/ScriptHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -45,7 +45,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getFoldersToDelete()
     {
@@ -95,7 +95,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getFilesToDelete()
     {

plugin/ims_lti/ImsLtiPlugin.php

Doc Comments +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
     /**
      * Get the class instance
      * @staticvar MsiLtiPlugin $result
-     * @return MsiLtiPlugin
+     * @return ImsLtiPlugin
      */
     public static function create()
     {

plugin/ims_lti/ImsLtiTool.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
         return $this->id;
     }
 
+    /**
+     * @return string
+     */
     public function getName()
     {
         return $this->name;

plugin/ims_lti/OAuthSimple.php

Doc Comments +3 added lines

@@ -334,6 +334,9 @@
         return preg_replace('/, $/','',$result);
     }
 
+    /**
+     * @param string $paramString
+     */
     private function _parseParameterString ($paramString)
     {
         $elements = explode('&',$paramString);

main/inc/lib/fileUpload.lib.php

Doc Comments +7 added lines, -6 removed lines

@@ -53,7 +53,7 @@ 
  * Returns the name without extension, used for the title
  *
  * @param string $name
- * @return name without the extension
+ * @return string without the extension
  */
 function get_document_title($name)
 {
@@ -67,7 +67,7 @@ 
  * This function checks if the upload succeeded
  *
  * @param array $uploaded_file ($_FILES)
- * @return true if upload succeeded
+ * @return boolean if upload succeeded
  */
 function process_uploaded_file($uploaded_file, $show_output = true)
 {
@@ -1025,7 +1025,7 @@ 
  * @param array  $courseInfo
  * @param array  $userInfo
  * @param array  $uploaded_file - follows the $_FILES Structure
- * @param string $upload_path   - destination of the upload.
+ * @param string $uploadPath   - destination of the upload.
  *                               This path is to append to $base_work_dir
  * @param string $base_work_dir  - base working directory of the module
  * @param int    $maxFilledSpace  - amount of bytes to not exceed in the base
@@ -1212,7 +1212,7 @@ 
  * @param int $session_id Session ID, if any
  * @param int $userId creator id
  *
- * @return int id if inserted document
+ * @return string|false id if inserted document
  */
 function add_document(
     $_course,
@@ -1346,7 +1346,7 @@ 
  *
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path+filename eg: /main/document/document.php
- * @return	The directory depth
+ * @return	integer directory depth
  */
 function get_levels($filename) {
     $levels = explode('/', $filename);
@@ -1363,6 +1363,8 @@ 
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path,filename
  * action:	Adds an entry to the document table with the default settings.
+ * @param string $upload_path
+ * @param string $filename
  */
 function set_default_settings($upload_path, $filename, $filetype = 'file')
 {
@@ -1818,7 +1820,6 @@ 
  * @param int $groupId
  * @param bool $output
  * @param array $parent
- * @param string $uploadPath
  *
  */
 function add_all_documents_in_folder_to_database(

main/inc/lib/groupmanager.lib.php

Doc Comments +12 added lines, -9 removed lines

@@ -371,7 +371,7 @@ 
      * @author Bart Mollet
      * @param  int  $groupId iid
      * @param string $course_code Default is current course
-     * @return integer              - number of groups deleted.
+     * @return boolean              - number of groups deleted.
      */
     public static function delete_groups($groupId, $course_code = null)
     {
@@ -563,7 +563,7 @@ 
      * @param bool      Whether self registration is allowed or not
      * @param bool      Whether self unregistration is allowed or not
      * @param int       $categoryId
-     * @return bool     TRUE if properties are successfully changed, false otherwise
+     * @return Statement|null     TRUE if properties are successfully changed, false otherwise
      */
     public static function set_group_properties(
         $group_id,
@@ -716,7 +716,7 @@ 
      * @param int $group_id The iid of the group
      * @param string $course_code The course in which the group is (default =
      * current course)
-     * @return array The category
+     * @return integer The category
      */
     public static function get_category_from_group($group_id, $course_code = null)
     {
@@ -782,9 +782,9 @@ 
      * Create group category
      * @param string $title The title of the new category
      * @param string $description The description of the new category
-     * @param bool $self_registration_allowed
-     * @param bool $self_unregistration_allowed
-     * @param int $max_number_of_students
+     * @param integer $self_registration_allowed
+     * @param integer $self_unregistration_allowed
+     * @param int $maximum_number_of_students
      * @param int $groups_per_user
      */
     public static function create_category(
@@ -990,6 +990,8 @@ 
      * @param int $limit
      * @param bool $getCount
      * @param int $courseId
+     * @param string $column
+     * @param string $direction
      * @return array list of user id
      */
     public static function get_users(
@@ -1583,7 +1585,7 @@ 
     /**
      * Subscribe tutor(s) to a specified group in current course
      * @param mixed $user_ids Can be an array with user-id's or a single user-id
-     * @param int $group_id iid
+     * @param int $groupId iid
      * @param int $course_id
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1614,7 +1616,7 @@ 
      * Unsubscribe user(s) from a specified group in current course
      * @param mixed $user_ids Can be an array with user-id's or a single user-id
      * @param int $group_id iid
-     * @return bool TRUE if successful
+     * @return boolean|null TRUE if successful
      */
     public static function unsubscribe_users($user_ids, $group_id)
     {
@@ -1633,7 +1635,7 @@ 
 
     /**
      * Unsubscribe all users from one or more groups
-     * @param int $group_id iid
+     * @param integer $groupId iid
      * @return bool TRUE if successful
      */
     public static function unsubscribe_all_users($groupId)
@@ -1781,6 +1783,7 @@ 
      *
      * @param $user_array_in list of users (must be sorted).
      * @param string $compare_field, the field to be compared
+     * @param string $compare_field
      */
     public static function filter_duplicates($user_array_in, $compare_field)
     {

main/webservices/cm_webservice.php

Doc Comments +5 added lines, -1 removed lines

@@ -37,6 +37,8 @@ 
      *
      * @param int Error code
      * @param string Error message
+     * @param integer $code
+     * @param string $message
      */
     public function __construct($code, $message)
     {
@@ -48,6 +50,7 @@ 
      * Sets the error handler
      *
      * @param WSErrorHandler Error handler
+     * @param WSCMSoapErrorHandler $handler
      */
     public static function setErrorHandler($handler)
     {
@@ -86,6 +89,7 @@ 
 	 * Handle method
 	 *
 	 * @param WSError Error
+	 * @return void
 	 */
 	public function handle($error);
 }
@@ -114,7 +118,7 @@ 
 	 * Verifies the API key
 	 *
 	 * @param string Secret key
-	 * @return mixed WSError in case of failure, null in case of success
+	 * @return WSCMError|null WSError in case of failure, null in case of success
 	 */
 	protected function verifyKey($secret_key)
     {

main/inc/lib/sessionmanager.lib.php

Doc Comments +20 added lines, -16 removed lines

@@ -1619,7 +1619,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,
@@ -1891,7 +1891,7 @@ 
      * @param array $courseInfo
      * @param int $status
      * @param bool $updateTotal
-     * @return bool
+     * @return false|null
      */
     public static function removeUsersFromCourseSession(
         $userList,
@@ -1957,7 +1957,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,
@@ -2140,7 +2140,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,
@@ -2336,6 +2336,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)
@@ -2391,7 +2393,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)
     {
@@ -2615,7 +2617,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)
@@ -3381,8 +3383,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
@@ -3507,6 +3509,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)
@@ -3758,6 +3761,7 @@ 
      * Updates a session status
      * @param	int 	session id
      * @param	int 	status
+     * @param integer $status
      */
     public static function set_session_status($session_id, $status)
     {
@@ -3966,7 +3970,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)
     {
@@ -4074,7 +4078,7 @@ 
 
     /**
      * @param $id
-     * @return bool
+     * @return null|boolean
      */
     public static function protect_teacher_session_edit($id)
     {
@@ -4138,7 +4142,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
@@ -5441,7 +5445,6 @@ 
      * @param string $lastConnectionDate
      * @param array $sessionIdList
      * @param array $studentIdList
-     * @param int $userStatus STUDENT|COURSEMANAGER constants
      *
      * @return array|int
      */
@@ -5593,7 +5596,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()
     {
@@ -5607,7 +5610,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)
     {
@@ -6247,6 +6250,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)
@@ -7577,7 +7581,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)
     {
@@ -7594,7 +7598,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)
     {