chamilo / chamilo-lms

src/Chamilo/CoreBundle/Entity/UsergroupRelUser.php

Doc Comments +1 added lines, -1 removed lines

@@ -117,7 +117,7 @@
      * Set relationType
      *
      * @param integer $relationType
-     * @return GroupRelUser
+     * @return UsergroupRelUser
      */
     public function setRelationType($relationType)
     {

main/admin/course_user_import.php

Doc Comments +3 added lines, -1 removed lines

@@ -9,6 +9,7 @@ 
 
 /**
  * Validates the imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $users_courses
  */
 function validate_data($users_courses)
 {
@@ -65,6 +66,7 @@ 
 
 /**
  * Saves imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $users_courses
  */
 function save_data($users_courses)
 {
@@ -133,7 +135,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/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)
 {

Indentation +12 added lines, -12 removed lines

@@ -70,7 +70,7 @@ 
             $oskill = new Skill();
             $skill_id = $oskill->add($skill);
             $parents[$saved_id] = $skill_id;
-		}
+        }
     }
 }
 
@@ -81,12 +81,12 @@ 
  */
 function parse_csv_data($file)
 {
-	$skills = Import :: csvToArray($file);
-	foreach ($skills as $index => $skill) {
-		$skills[$index] = $skill;
-	}
+    $skills = Import :: csvToArray($file);
+    foreach ($skills as $index => $skill) {
+        $skills[$index] = $skill;
+    }
 
-	return $skills;
+    return $skills;
 }
 
 /**
@@ -94,7 +94,7 @@ 
  */
 function element_start($parser, $data)
 {
-	$data = api_utf8_decode($data);
+    $data = api_utf8_decode($data);
     global $skill;
     global $current_tag;
     switch ($data) {
@@ -111,7 +111,7 @@ 
  */
 function element_end($parser, $data)
 {
-	$data = api_utf8_decode($data);
+    $data = api_utf8_decode($data);
     global $skill;
     global $skills;
     global $current_value;
@@ -130,9 +130,9 @@ 
  */
 function character_data($parser, $data)
 {
-	$data = trim(api_utf8_decode($data));
-	global $current_value;
-	$current_value = $data;
+    $data = trim(api_utf8_decode($data));
+    global $current_value;
+    $current_value = $data;
 }
 
 /**
@@ -154,7 +154,7 @@ 
     xml_parse($parser, api_utf8_encode_xml(file_get_contents($file)));
     xml_parser_free($parser);
 
-	return $skills;
+    return $skills;
 }
 
 $this_section = SECTION_PLATFORM_ADMIN;

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)
 {

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -364,7 +364,7 @@
 $user_id_error = array();
 $error_message = '';
 
-if (isset($_POST['formSent']) && $_POST['formSent'] AND
+if (isset($_POST['formSent']) && $_POST['formSent'] and
     $_FILES['import_file']['size'] !== 0
 ) {
     $file_type = $_POST['file_type'];

Braces +8 added lines, -2 removed lines

@@ -535,8 +535,14 @@
 <p><?php echo get_lang('CSVMustLookLike').' ('.get_lang('MandatoryFields').')'; ?> :</p>
 <blockquote>
 <pre>
-<b>LastName</b>;<b>FirstName</b>;<b>Email</b>;UserName;Password;AuthSource;OfficialCode;PhoneNumber;Status;ExpiryDate;<span style="color:red;"><?php if (count($list) > 0) echo implode(';', $list).';'; ?></span>Courses;ClassId;
-<b>xxx</b>;<b>xxx</b>;<b>xxx</b>;xxx;xxx;<?php echo implode('/', $defined_auth_sources); ?>;xxx;xxx;user/teacher/drh;0000-00-00 00:00:00;<span style="color:red;"><?php if (count($list_reponse) > 0) echo implode(';', $list_reponse).';'; ?></span>xxx1|xxx2|xxx3;1;<br />
+<b>LastName</b>;<b>FirstName</b>;<b>Email</b>;UserName;Password;AuthSource;OfficialCode;PhoneNumber;Status;ExpiryDate;<span style="color:red;"><?php if (count($list) > 0) {
+    echo implode(';', $list).';';
+}
+?></span>Courses;ClassId;
+<b>xxx</b>;<b>xxx</b>;<b>xxx</b>;xxx;xxx;<?php echo implode('/', $defined_auth_sources); ?>;xxx;xxx;user/teacher/drh;0000-00-00 00:00:00;<span style="color:red;"><?php if (count($list_reponse) > 0) {
+    echo implode(';', $list_reponse).';';
+}
+?></span>xxx1|xxx2|xxx3;1;<br />
 </pre>
 </blockquote>
 <p><?php echo get_lang('XMLMustLookLike').' ('.get_lang('MandatoryFields').')'; ?> :</p>

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)
 {

Braces +4 added lines, -1 removed lines

@@ -464,7 +464,10 @@
 <blockquote>
     <pre>
         <b>UserName</b>;LastName;FirstName;Email;NewUserName;Password;AuthSource;OfficialCode;PhoneNumber;Status;ExpiryDate;Active;Language;Courses;ClassId;
-        xxx;xxx;xxx;xxx;xxx;xxx;xxx;xxx;xxx;user/teacher/drh;YYYY-MM-DD 00:00:00;0/1;xxx;<span style="color:red;"><?php if (count($list_reponse) > 0) echo implode(';', $list_reponse).';'; ?></span>xxx1|xxx2|xxx3;1;<br />
+        xxx;xxx;xxx;xxx;xxx;xxx;xxx;xxx;xxx;user/teacher/drh;YYYY-MM-DD 00:00:00;0/1;xxx;<span style="color:red;"><?php if (count($list_reponse) > 0) {
+    echo implode(';', $list_reponse).';';
+}
+?></span>xxx1|xxx2|xxx3;1;<br />
     </pre>
 </blockquote>
 <p><?php

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
  */

Braces +2 added lines, -1 removed lines

@@ -10,7 +10,8 @@
 /**
  * Validates imported data.
  */
-function validate_data($classes) {
+function validate_data($classes)
+{
     $errors = array();
     $usergroup = new UserGroup();
     foreach ($classes as $index => $class) {

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);

Braces +6 added lines, -3 removed lines

@@ -12,7 +12,8 @@ 
 /**
  * Validates imported data.
  */
-function validate_data($user_classes) {
+function validate_data($user_classes)
+{
     global $purification_option_for_usernames;
     $errors = array();
     $classcodes = array();
@@ -67,7 +68,8 @@ 
 /**
  * Saves imported data.
  */
-function save_data($users_classes, $deleteUsersNotInList = false) {
+function save_data($users_classes, $deleteUsersNotInList = false)
+{
 
     global $purification_option_for_usernames;
 
@@ -117,7 +119,8 @@ 
  * @param string $file Path to the CSV-file
  * @return array All course-information read from the file
  */
-function parse_csv_data($file) {
+function parse_csv_data($file)
+{
     $courses = Import::csvToArray($file);
     return $courses;
 }

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')
     {

Indentation +8 added lines, -8 removed lines

@@ -115,13 +115,13 @@ 
     }
 
     /**
-    * Export tabular data to XML-file
-    * @param array  Simple array of data to put in XML
-    * @param string Name of file to be given to the user
-    * @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
-    */
+     * Export tabular data to XML-file
+     * @param array  Simple array of data to put in XML
+     * @param string Name of file to be given to the user
+     * @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
+     */
     public static function arrayToXml(
         $data,
         $filename = 'export',
@@ -200,7 +200,7 @@ 
         foreach ($data as $row) {
             $string .= "\n".str_repeat("\t", $level).'<'.$row['name'].'>';
             if (is_array($row['value'])) {
-            	$string .= self::_export_complex_table_xml_helper($row['value'], $level + 1)."\n";
+                $string .= self::_export_complex_table_xml_helper($row['value'], $level + 1)."\n";
                 $string .= str_repeat("\t", $level).'</'.$row['name'].'>';
             } else {
                 $string .= $row['value'];