chamilo / chamilo-lms

main/admin/class_import.php

Doc Comments +2 added lines

@@ -11,6 +11,7 @@ 
 
 /**
  * Validates imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $classes
  */
 function validate_data($classes) {
     $errors = array();
@@ -35,6 +36,7 @@ 
 
 /**
  * Save imported class data to database
+ * @param Ddeboer\DataImport\Reader\CsvReader $classes
  */
 function save_data($classes) {
     $number_of_added_classes = 0;

main/admin/course_import.php

Doc Comments +1 added lines, -1 removed lines

@@ -151,7 +151,7 @@
 /**
  * Read the CSV-file
  * @param string $file Path to the CSV-file
- * @return array All course-information read from the file
+ * @return Ddeboer\DataImport\Reader\CsvReader All course-information read from the file
  */
 function parse_csv_data($file)
 {

main/admin/course_user_import_by_email.php

Doc Comments +3 added lines, -1 removed lines

@@ -8,6 +8,7 @@ 
  */
 /**
  * Validates the imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $users_courses
  */
 function validate_data($users_courses)
 {
@@ -66,6 +67,7 @@ 
 
 /**
  * Saves imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $users_courses
  */
 function save_data($users_courses)
 {
@@ -134,7 +136,7 @@ 
 /**
  * Reads CSV-file.
  * @param string $file Path to the CSV-file
- * @return array All course-information read from the file
+ * @return Ddeboer\DataImport\Reader\CsvReader All course-information read from the file
  */
 function parse_csv_data($file)
 {

main/admin/skills_import.php

Doc Comments +3 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
 
 /**
  * Validate the imported data.
- * @param $skills
+ * @param Ddeboer\DataImport\Reader\CsvReader $skills
  * @return array
  */
 function validate_data($skills)
@@ -50,6 +50,7 @@ 
 /**
  * Save the imported data
  * @param   array   List of users
+ * @param Ddeboer\DataImport\Reader\CsvReader $skills
  * @return  void
  * @uses global variable $inserted_in_course,
  * which returns the list of courses the user was inserted in
@@ -77,7 +78,7 @@ 
 /**
  * Read the CSV-file
  * @param string $file Path to the CSV-file
- * @return array All userinformation read from the file
+ * @return Ddeboer\DataImport\Reader\CsvReader All userinformation read from the file
  */
 function parse_csv_data($file)
 {

main/admin/user_import.php

Doc Comments +1 added lines, -1 removed lines

@@ -227,7 +227,7 @@
 /**
  * Read the CSV-file
  * @param string $file Path to the CSV-file
- * @return array All userinformation read from the file
+ * @return Ddeboer\DataImport\Reader\CsvReader All userinformation read from the file
  */
 function parse_csv_data($file)
 {

main/admin/user_update_import.php

Doc Comments +4 added lines, -1 removed lines

@@ -15,6 +15,9 @@ 
 // Set this option to true to enforce strict purification for usenames.
 $purification_option_for_usernames = false;
 
+/**
+ * @param Ddeboer\DataImport\Reader\CsvReader $users
+ */
 function validate_data($users)
 {
     global $defined_auth_sources;
@@ -228,7 +231,7 @@ 
 /**
  * Read the CSV-file
  * @param string $file Path to the CSV-file
- * @return array All userinformation read from the file
+ * @return Ddeboer\DataImport\Reader\CsvReader All userinformation read from the file
  */
 function parse_csv_data($file)
 {

main/admin/usergroup_import.php

Doc Comments +2 added lines, -1 removed lines

@@ -9,6 +9,7 @@ 
 
 /**
  * Validates imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $classes
  */
 function validate_data($classes) {
     $errors = array();
@@ -36,7 +37,7 @@ 
 /**
  * Save imported class data to database
  *
- * @param $classes
+ * @param Ddeboer\DataImport\Reader\CsvReader $classes
  *
  * @return int
  */

main/admin/usergroup_user_import.php

Doc Comments +3 added lines, -1 removed lines

@@ -11,6 +11,7 @@ 
 
 /**
  * Validates imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $user_classes
  */
 function validate_data($user_classes) {
     global $purification_option_for_usernames;
@@ -66,6 +67,7 @@ 
 
 /**
  * Saves imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $users_classes
  */
 function save_data($users_classes, $deleteUsersNotInList = false) {
 
@@ -115,7 +117,7 @@ 
 /**
  * Reads a CSV-file.
  * @param string $file Path to the CSV-file
- * @return array All course-information read from the file
+ * @return Ddeboer\DataImport\Reader\CsvReader All course-information read from the file
  */
 function parse_csv_data($file) {
     $courses = Import::csvToArray($file);

main/inc/lib/export.lib.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -38,7 +38,7 @@ 
      * @param array $data
      * @param string $filename
      *
-     * @return mixed csv file | false if no data to export
+     * @return false|null csv file | false if no data to export
      */
     public static function arrayToCsv($data, $filename = 'export')
     {
@@ -160,7 +160,7 @@ 
      * @param string Name of common tag to place each line in
      * @param string Name of the root element. A root element should always be given.
      * @param string Encoding in which the data is provided
-     * @return void  Prompts the user for a file download
+     * @return boolean  Prompts the user for a file download
      */
     public static function export_complex_table_xml(
         $data,
@@ -286,7 +286,7 @@ 
      * @param string $name
      * @param string $format
      *
-     * @return bool
+     * @return false|null
      */
     public static function htmlToOdt($html, $name, $format = 'odt')
     {