Scrutinizer Auto-Fixes (#1170)

This commit consists of patches automatically generated for this project on https://scrutinizer-ci.com

Author: AngelFQC

main/auth/external_login/ldap.inc.php

@@ -28,7 +28,7 @@ function extldap_purify_string($string)
 /**
  * Establishes a connection to the LDAP server and sets the protocol version
  *
- * @return resource ldap link identifier or false
+ * @return boolean ldap link identifier or false
  * @author ndiechburg <[email protected]>
  * */
 function extldap_connect()
@@ -77,6 +77,7 @@ function extldap_connect()
 /**
  * Authenticate user on external ldap server and return user ldap entry if that succeeds
  *
+ * @param string $password
  * @return mixed false if user cannot authenticate on ldap, user ldap entry if tha succeeds
  * @author ndiechburg <[email protected]>
  * Modified by [email protected]
@@ -237,7 +238,7 @@ function extldap_get_user_search_string($username)
 
 /**
  * Imports all LDAP users into Chamilo
- * @return bool false on error, true otherwise
+ * @return false|null false on error, true otherwise
  */
 function extldap_import_all_users()
 {

main/auth/shibboleth/db/shibboleth_upgrade.class.php

@@ -35,7 +35,7 @@ public static function update()
      * Creates the 'shibb_unique_id' field in the table 'user' of the main Chamilo database if it doesn't exist yet
      *
      * @author Nicolas Rod
-     * @return void
+     * @return false|null
      */
     public static function create_shibb_unique_id_field_if_missing()
     {

main/auth/shibboleth/lib/store.class.php

@@ -346,6 +346,9 @@ protected function query($sql)
         return $result;
     }
 
+    /**
+     * @param string $sql
+     */
     protected function execute($sql)
     {
         return Database::query($sql, null, __FILE__);

main/auth/sso/sso.Drupal.class.php

@@ -90,7 +90,7 @@ public function ask_master()
 
     /**
      * Validates the received active connection data with the database
-     * @return	bool	Return the loginFailed variable value to local.inc.php
+     * @return	null|false	Return the loginFailed variable value to local.inc.php
      */
     public function check_user()
     {

main/coursecopy/classes/Course.class.php

@@ -327,6 +327,7 @@ public function to_system_encoding()
 
     /**
     * Serialize the course with the best serializer available
+    * @return string
     */
     public static function serialize($course)
     {
@@ -339,6 +340,7 @@ public static function serialize($course)
 
     /**
     * Unserialize the course with the best serializer available
+    * @param string $course
     */
     public static function unserialize($course)
     {

main/coursecopy/classes/CourseBuilder.class.php

@@ -123,7 +123,7 @@ public function get_course()
      * @param string   $courseCode
      * @param bool     true if you want to get the elements that exists in the course and
      *                 in the session, (session_id = 0 or session_id = X)
-     * @return object The course object structure
+     * @return Course The course object structure
      */
     public function build(
         $session_id = 0,

main/coursecopy/classes/CourseRestorer.class.php

@@ -84,7 +84,7 @@ class CourseRestorer
 
     /**
      * CourseRestorer constructor.
-     * @param array $course
+     * @param Course $course
      */
     public function __construct($course)
     {
@@ -133,7 +133,7 @@ public function set_tool_copy_settings($array)
 	 * @param int	    $session_id
 	 * @param bool	    $update_course_settings Course settings are going to be restore?
      * @param bool      $respect_base_content
-     * @return bool
+     * @return false|null
 	 */
     public function restore(
         $destination_course_code = '',
@@ -1154,6 +1154,7 @@ public function restore_forum_category($my_id = null, $sessionId = 0)
 
 	/**
 	 * Restore a forum-topic
+	 * @param false|string $forum_id
 	 */
     public function restore_topic($thread_id, $forum_id, $sessionId = 0)
     {
@@ -1210,6 +1211,7 @@ public function restore_topic($thread_id, $forum_id, $sessionId = 0)
 	/**
 	 * Restore a forum-post
 	 * @TODO Restore tree-structure of posts. For example: attachments to posts.
+	 * @param false|string $topic_id
 	 */
     public function restore_post($id, $topic_id, $forum_id, $sessionId = 0)
     {
@@ -2306,6 +2308,7 @@ public function restore_surveys($sessionId = 0)
 
 	/**
 	 * Check availability of a survey code
+	 * @param string $survey_code
 	 */
     public function is_survey_code_available($survey_code)
     {
@@ -2320,6 +2323,7 @@ public function is_survey_code_available($survey_code)
 
 	/**
 	 * Restore survey-questions
+	 * @param string $survey_id
 	 */
     public function restore_survey_question($id, $survey_id)
     {
@@ -2776,6 +2780,8 @@ public function restore_student_publication($sessionId = 0)
     * @param string The path origin
     * @param string The path destination
     * @param boolean Option Overwrite
+    * @param string $source
+    * @param string $dest
     * @return void()
     * @deprecated
     */

main/coursecopy/classes/CourseSelectForm.class.php

@@ -13,7 +13,7 @@ class CourseSelectForm
 {
 	/**
 	 * Display the form
-	 * @param array $hidden_fiels Hidden fields to add to the form.
+	 * @param array $hidden_fields Hidden fields to add to the form.
 	 * @param boolean the document array will be serialize. This is used in the course_copy.php file
 	 */
 	static function display_form($course, $hidden_fields = null, $avoid_serialize = false)
@@ -570,7 +570,7 @@ public static function get_posted_course($from = '', $session_id = 0, $course_co
 
 	/**
 	 * Display the form session export
-	 * @param array $hidden_fiels Hidden fields to add to the form.
+	 * @param array $hidden_fields Hidden fields to add to the form.
 	 * @param boolean the document array will be serialize. This is used in the course_copy.php file
 	 */
 	 public static function display_form_session_export($list_course, $hidden_fields = null, $avoid_serialize = false)

main/coursecopy/classes/Event.class.php

@@ -50,9 +50,6 @@ class CalendarEvent extends Coursecopy\Resource
      * @param int $id
      * @param string $title
      * @param string $content
-     * @param string $date
-     * @param string $hour
-     * @param int $duration
      */
     public function __construct(
         $id,

main/coursecopy/classes/QuizQuestion.class.php

@@ -115,6 +115,9 @@ public function add_answer(
         $this->answers[] = $answer;
     }
 
+    /**
+     * @param QuizQuestionOption $option_obj
+     */
     public function add_option($option_obj)
     {
         $this->question_options[$option_obj->obj->id] = $option_obj;