chamilo / chamilo-lms

main/exercise/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/admin/settings.lib.php

Doc Comments +4 added lines, -3 removed lines

@@ -1154,7 +1154,7 @@ 
 /**
  * Returns an array containing the list of options used to populate the gradebook_number_decimals variable
  * This function is called through a call_user_func() in the generate_settings_form function.
- * @return array List of gradebook_number_decimals options
+ * @return string[] List of gradebook_number_decimals options
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
  */
@@ -1575,8 +1575,9 @@ 
 }
 /**
  * Helper function to generates a form elements group
- * @param object $form The form where the elements group has to be added
+ * @param FormValidator $form The form where the elements group has to be added
  * @param array $values Values to browse through
+ * @param string $elementName
  * @return array
  */
 function formGenerateElementsGroup($form, $values = array(), $elementName)
@@ -1592,7 +1593,7 @@ 
 }
 /**
  * Helper function with allowed file types for CSS
- * @return  array Array of file types (no indexes)
+ * @return  string[] Array of file types (no indexes)
  */
 function getAllowedFileTypes()
 {

main/inc/lib/extra_field_option.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -412,7 +412,7 @@ 
      * Gets an array of options for a specific field
      * @param int $field_id The field ID
      * @param bool $add_id_in_array Whether to add the row ID in the result
-     * @param null $ordered_by Extra ordering query bit
+     * @param null|string $ordered_by Extra ordering query bit
      * @return array The options if they exists. Otherwise return false
      */
     public function get_field_options_by_field($field_id, $add_id_in_array = false, $ordered_by = null)
@@ -782,8 +782,8 @@ 
     }
 
     /**
-     * @param $defaultDisplayText
-     * @return mixed|string
+     * @param string $defaultDisplayText
+     * @return string
      */
     public static function getLanguageVariable($defaultDisplayText)
     {

main/inc/lib/formvalidator/FormValidator.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -954,7 +954,7 @@
     /**
      * This function has been created for avoiding changes directly within QuickForm class.
      * When we use it, the element is threated as 'required' to be dealt during validation.
-     * @param array $element The array of elements
+     * @param array $elements The array of elements
      * @param string $message The message displayed
      */
     public function add_multiple_required_rule($elements, $message)

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/glossary.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -95,7 +95,7 @@ 
      *
      * @param array  $values  Array of title + description (name => $title, description => $comment)
      *
-     * @return mixed   Term id on success, false on failure
+     * @return false|string   Term id on success, false on failure
      *
      */
     public static function save_glossary($values, $showMessage = true)
@@ -448,7 +448,7 @@ 
 
     /**
      * Display the glossary terms in a list
-     * @return bool true
+     * @return string true
      */
     public static function displayGlossaryList()
     {
@@ -585,7 +585,7 @@ 
      * Update action icons column
      *
      * @param integer $glossary_id
-     * @param array   $url_params Parameters to use to affect links
+     * @param string   $url_params Parameters to use to affect links
      * @param array   $row The line of results from a query on the glossary table
      *
      * @return string HTML string for the action icons columns

main/inc/lib/extra_field.lib.php

Doc Comments +7 added lines, -7 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)
     {
@@ -1826,7 +1826,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getJqgridColumnNames()
     {
@@ -2086,7 +2086,7 @@ 
     }
 
     /**
-     * @param array $columns
+     * @param string[] $columns
      * @param array  $column_model
      * @param array  $extraFields
      * @return array

app/check.php

Doc Comments +3 added lines

@@ -96,6 +96,9 @@
     echo PHP_EOL;
 }
 
+/**
+ * @param string $message
+ */
 function echo_style($style, $message)
 {
     // ANSI color codes

main/inc/lib/auth.lib.php

Doc Comments +8 added lines

@@ -183,6 +183,7 @@ 
      * (moving a course to a different course category)
      * @param  int    $courseId
      * @param  int       Category id
+     * @param integer $newcategory
      * @return bool      True if it success
      */
     public function updateCourseCategory($courseId, $newcategory)
@@ -215,6 +216,9 @@ 
      * @param   string    Direction (up/down)
      * @param   string    Course code
      * @param   int       Category id
+     * @param string $direction
+     * @param string $course2move
+     * @param integer $category
      * @return  bool      True if it success
      */
     public function move_course($direction, $course2move, $category)
@@ -285,6 +289,8 @@ 
      * Moves the course one place up or down
      * @param string    Direction up/down
      * @param string    Category id
+     * @param string $direction
+     * @param integer $category2move
      * @return bool     True If it success
      */
     public function move_category($direction, $category2move)
@@ -348,6 +354,8 @@ 
      * Updates the user course category in the chamilo_user database
      * @param   string  Category title
      * @param   int     Category id
+     * @param string $title
+     * @param integer $category_id
      * @return  bool    True if it success
      */
     public function store_edit_course_category($title, $category_id)