From 6f04525cdf0d04e70f1e2719d5fa554cb8cb13ad Mon Sep 17 00:00:00 2001
From: Eric <eric.espie@combodo.com>
Date: Wed, 12 Feb 2020 15:00:10 +0100
Subject: [PATCH] :art: cleanup code

---
 pages/ajax.csvimport.php | 15 ++++++++++---
 pages/csvimport.php      | 47 ++++++++++++++++++++--------------------
 2 files changed, 36 insertions(+), 26 deletions(-)

diff --git a/pages/ajax.csvimport.php b/pages/ajax.csvimport.php
index 73ee62445..e833817e4 100644
--- a/pages/ajax.csvimport.php
+++ b/pages/ajax.csvimport.php
@@ -28,9 +28,12 @@ require_once(APPROOT.'/application/csvpage.class.inc.php');
 /**
  * Determines if the name of the field to be mapped correspond
  * to the name of an external key or an Id of the given class
+ *
  * @param string $sClassName The name of the class
  * @param string $sFieldCode The attribute code of the field , or empty if no match
+ *
  * @return bool true if the field corresponds to an id/External key, false otherwise
+ * @throws \Exception
  */
 function IsIdField($sClassName, $sFieldCode)
 {
@@ -52,10 +55,13 @@ function IsIdField($sClassName, $sFieldCode)
 
 /**
  * Get all the fields xxx->yyy based on the field xxx which is an external key
- * @param string $sExtKeyAttCode Attribute code of the external key
+ *
+ * @param $sAttCode
  * @param AttributeDefinition $oExtKeyAttDef Attribute definition of the external key
  * @param bool $bAdvanced True if advanced mode
- * @return Ash List of codes=>display name: xxx->yyy where yyy are the reconciliation keys for the object xxx 
+ *
+ * @return array List of codes=>display name: xxx->yyy where yyy are the reconciliation keys for the object xxx
+ * @throws \CoreException
  */
 function GetMappingsForExtKey($sAttCode, AttributeDefinition $oExtKeyAttDef, $bAdvanced)
 {
@@ -88,12 +94,15 @@ function GetMappingsForExtKey($sAttCode, AttributeDefinition $oExtKeyAttDef, $bA
  *       If not in advanced mode, all "id" fields (id and external keys) must be mapped to ":none:" (i.e -- ignore this field --)
  *       External fields that do not correspond to a reconciliation key must be mapped to ":none:"
  *       Otherwise, if a field equals either the 'code' or the 'label' (translated) of a field, then it's mapped automatically
+ *
  * @param string $sClassName Name of the class used for the mapping
  * @param string $sFieldName Name of the field, as it comes from the data file (header line)
  * @param integer $iFieldIndex Number of the field in the sequence
  * @param bool $bAdvancedMode Whether or not advanced mode was chosen
  * @param string $sDefaultChoice If set, this will be the item selected by default
+ *
  * @return string The HTML code corresponding to the drop-down list for this field
+ * @throws \CoreException
  */
 function GetMappingForField($sClassName, $sFieldName, $iFieldIndex, $bAdvancedMode, $sDefaultChoice)
 {
@@ -213,7 +222,7 @@ function GetMappingForField($sClassName, $sFieldName, $iFieldIndex, $bAdvancedMo
 			$sSelected = ' selected';
 		}
 
-		$sHtml .= "<option value=\"$sAttCode\"$sSelected>$sLabel</option>\n";
+		$sHtml .= "<option value=\"$sAttCode\" $sSelected>$sLabel</option>\n";
 	}
 	$sHtml .= "</select>\n";
 	return $sHtml;
diff --git a/pages/csvimport.php b/pages/csvimport.php
index ba3810b6a..cf618ce23 100644
--- a/pages/csvimport.php
+++ b/pages/csvimport.php
@@ -37,16 +37,18 @@ try
 
 	/**
 	 * Helper function to build a select from the list of valid classes for a given action
+	 *
 	 * @param string $sName The name of the select in the HTML form
-	 * @param string $sDefaulfValue The defaut value (i.e the value selected by default)
+	 * @param $sDefaultValue
 	 * @param integer $iWidthPx The width (in pixels) of the drop-down list
 	 * @param integer $iActionCode The ActionCode (from UserRights) to check for authorization for the classes
+	 *
 	 * @return string The HTML fragment corresponding to the select tag
 	 */
 	function GetClassesSelect($sName, $sDefaultValue, $iWidthPx, $iActionCode = null)
 	{
 		$sHtml = "<select id=\"select_$sName\" name=\"$sName\">";
-		$sHtml .= "<option tyle=\"width: ".$iWidthPx."px;\" title=\"Select the class you want to load\" value=\"\">".Dict::S('UI:CSVImport:ClassesSelectOne')."</option>\n";
+		$sHtml .= "<option style=\"width: ".$iWidthPx."px;\" title=\"Select the class you want to load\" value=\"\">".Dict::S('UI:CSVImport:ClassesSelectOne')."</option>\n";
 		$aValidClasses = array();
 		$aClassCategories = array('bizmodel');
 		if (UserRights::IsAdministrator())
@@ -60,10 +62,10 @@ try
 			if ( (is_null($iActionCode) || UserRights::IsActionAllowed($sClassName, $iActionCode)) &&
 			     (!MetaModel::IsAbstract($sClassName)) )
 			{
-				$sSelected = ($sClassName == $sDefaultValue) ? " selected" : "";
+				$sSelected = ($sClassName == $sDefaultValue) ? "selected" : "";
 				$sDescription = MetaModel::GetClassDescription($sClassName);
 				$sDisplayName = MetaModel::GetName($sClassName);
-				$aValidClasses[$sDisplayName] = "<option style=\"width: ".$iWidthPx."px;\" title=\"$sDescription\" value=\"$sClassName\"$sSelected>$sDisplayName</option>";
+				$aValidClasses[$sDisplayName] = "<option style=\"width: ".$iWidthPx."px;\" title=\"$sDescription\" value=\"$sClassName\" $sSelected >$sDisplayName</option>";
 			}
 		}
 		}
@@ -92,7 +94,7 @@ try
 	 * Returns the number of occurences of each char from the set in the specified string
 	 * @param string $sString The input data
 	 * @param array $aSet The set of characters to count
-	 * @return hash 'char' => nb of occurences
+	 * @return array 'char' => nb of occurences
 	 */
 	function CountCharsFromSet($sString, $aSet)
 	{
@@ -155,7 +157,7 @@ try
 	/**
 	 * Try to predict the CSV parameters based on the input data
 	 * @param string $sCSVData The input data
-	 * @return hash 'separator' => the_guessed_separator, 'qualifier' => the_guessed_text_qualifier
+	 * @return array 'separator' => the_guessed_separator, 'qualifier' => the_guessed_text_qualifier
 	 */
 	function GuessParameters($sCSVData)
 	{
@@ -171,7 +173,6 @@ try
 	 * @param WebPage $oP The Page for the output
 	 * @param string $sClass The class of objects to synchronize
 	 * @param integer $iCount The number of objects to synchronize
-	 * @return none
 	 */
 	 function DisplaySynchroBanner(WebPage $oP, $sClass, $iCount)
 	 {
@@ -576,7 +577,7 @@ try
 			$iCount = count($aRes);
 			//$oPage->add('<input type="submit" value="'.Dict::S('UI:Button:DoImport').'" onClick="$(\'#wizForm\').block();"/></p>');
 			$sConfirm = $bShouldConfirm ? 'true' : 'false';
-			$oPage->add('<input type="button" value="'.Dict::S('UI:Button:DoImport')."\" onClick=\"return DoSubmit($sConfirm);\"/></p>");
+			$oPage->add('<input type="button" value="'.Dict::S('UI:Button:DoImport')."\" onClick=\"return DoSubmit({$sConfirm})\"/></p>");
 		}
 		else
 		{
@@ -1153,27 +1154,27 @@ EOF
 		$oPage->add('<h2>'.Dict::S('UI:Title:CSVImportStep2').'</h2>');
 		$oPage->add('<div class="wizContainer">');
 		$oPage->add('<table><tr><td style="vertical-align:top;padding-right:30px;">');
-		$oPage->add('<form enctype="multipart/form-data" id="wizForm" method="post" id="csv_options">');
+		$oPage->add('<form enctype="multipart/form-data" id="wizForm" method="post" class="csv_options">');
 		$oPage->add('<h3>'.Dict::S('UI:CSVImport:SeparatorCharacter').'</h3>');
-		$oPage->add('<p><input type="radio" name="separator" value="," onClick="DoPreview()"'.IsChecked($sSeparator, ',').'/> '.Dict::S('UI:CSVImport:SeparatorComma+').'<br/>');
-		$oPage->add('<input type="radio" name="separator" value=";" onClick="DoPreview()"'.IsChecked($sSeparator, ';').'/> '.Dict::S('UI:CSVImport:SeparatorSemicolon+').'<br/>');
-		$oPage->add('<input type="radio" name="separator" value="tab" onClick="DoPreview()"'.IsChecked($sSeparator, "\t").'/> '.Dict::S('UI:CSVImport:SeparatorTab+').'<br/>');
-		$oPage->add('<input type="radio" name="separator" value="other"  onClick="DoPreview()"'.IsChecked($sOtherSeparator, '', true).'/> '.Dict::S('UI:CSVImport:SeparatorOther').' <input type="text" size="3" maxlength="1" name="other_separator" id="other_separator" value="'.$sOtherSeparator.'" onClick="DoPreview()"/>');
+		$oPage->add('<p><input type="radio" name="separator" value="," onClick="DoPreview()" '.IsChecked($sSeparator, ',').' /> '.Dict::S('UI:CSVImport:SeparatorComma+').'<br/>');
+		$oPage->add('<input type="radio" name="separator" value=";" onClick="DoPreview()" '.IsChecked($sSeparator, ';').' /> '.Dict::S('UI:CSVImport:SeparatorSemicolon+').'<br/>');
+		$oPage->add('<input type="radio" name="separator" value="tab" onClick="DoPreview()" '.IsChecked($sSeparator, "\t").' /> '.Dict::S('UI:CSVImport:SeparatorTab+').'<br/>');
+		$oPage->add('<input type="radio" name="separator" value="other"  onClick="DoPreview()" '.IsChecked($sOtherSeparator, '', true).'/> '.Dict::S('UI:CSVImport:SeparatorOther').' <input type="text" size="3" maxlength="1" name="other_separator" id="other_separator" value="'.$sOtherSeparator.'" onClick="DoPreview()"/>');
 		$oPage->add('</p>');
 		$oPage->add('</td><td style="vertical-align:top;padding-right:30px;">');
 		$oPage->add('<h3>'.Dict::S('UI:CSVImport:TextQualifierCharacter').'</h3>');
-		$oPage->add('<p><input type="radio" name="text_qualifier" value="&#34;" onClick="DoPreview()"'.IsChecked($sTextQualifier, '"').'/> '.Dict::S('UI:CSVImport:QualifierDoubleQuote+').'<br/>');
-		$oPage->add('<input type="radio" name="text_qualifier" value="&#39;"  onClick="DoPreview()"'.IsChecked($sTextQualifier, "'").'/> '.Dict::S('UI:CSVImport:QualifierSimpleQuote+').'<br/>');
-		$oPage->add('<input type="radio" name="text_qualifier" value="other"  onClick="DoPreview()"'.IsChecked($sOtherTextQualifier, '', true).'/> '.Dict::S('UI:CSVImport:QualifierOther').' <input type="text" size="3" maxlength="1" name="other_qualifier"  value="'.htmlentities($sOtherTextQualifier, ENT_QUOTES, 'UTF-8').'" onChange="DoPreview()"/>');
+		$oPage->add('<p><input type="radio" name="text_qualifier" value="&#34;" onClick="DoPreview()" '.IsChecked($sTextQualifier, '"').' /> '.Dict::S('UI:CSVImport:QualifierDoubleQuote+').'<br/>');
+		$oPage->add('<input type="radio" name="text_qualifier" value="&#39;"  onClick="DoPreview()" '.IsChecked($sTextQualifier, "'").' /> '.Dict::S('UI:CSVImport:QualifierSimpleQuote+').'<br/>');
+		$oPage->add('<input type="radio" name="text_qualifier" value="other"  onClick="DoPreview()" '.IsChecked($sOtherTextQualifier, '', true).'/> '.Dict::S('UI:CSVImport:QualifierOther').' <input type="text" size="3" maxlength="1" name="other_qualifier"  value="'.htmlentities($sOtherTextQualifier, ENT_QUOTES, 'UTF-8').'" onChange="DoPreview()"/>');
 		$oPage->add('</p>');
 		$oPage->add('</td><td style="vertical-align:top;padding-right:30px;">');
 		$oPage->add('<h3>'.Dict::S('UI:CSVImport:CommentsAndHeader').'</h3>');
-		$oPage->add('<p><input type="checkbox" name="header_line" id="box_header" value="1" onClick="DoPreview()"'.IsChecked($bHeaderLine, 1).'/> '.Dict::S('UI:CSVImport:TreatFirstLineAsHeader').'<p>');
-		$oPage->add('<p><input type="checkbox" name="box_skiplines" value="1" id="box_skiplines" onClick="DoPreview()"'.IsChecked($bBoxSkipLines, 1).'/> '.Dict::Format('UI:CSVImport:Skip_N_LinesAtTheBeginning', '<input type="text" size=2 name="nb_skipped_lines" id="nb_skipped_lines" onChange="DoPreview()" value="'.$iSkippedLines.'">').'<p>');
+		$oPage->add('<p><input type="checkbox" name="header_line" id="box_header" value="1" onClick="DoPreview()" '.IsChecked($bHeaderLine, 1).' /> '.Dict::S('UI:CSVImport:TreatFirstLineAsHeader').'<p>');
+		$oPage->add('<p><input type="checkbox" name="box_skiplines" value="1" id="box_skiplines" onClick="DoPreview()" '.IsChecked($bBoxSkipLines, 1).' /> '.Dict::Format('UI:CSVImport:Skip_N_LinesAtTheBeginning', '<input type="text" size=2 name="nb_skipped_lines" id="nb_skipped_lines" onChange="DoPreview()" value="'.$iSkippedLines.'">').'<p>');
 		$oPage->add('</td><td style="vertical-align:top;">');
 		$oPage->add('<h3>'.Dict::S('UI:CSVImport:DateAndTimeFormats').'</h3>');
-		$oPage->add('<p><input type="radio" name="date_time_format" id="radio_date_time_std" value="default"'.IsChecked($sDateTimeFormat, 'default').'/><label for="radio_date_time_std"> '.Dict::Format('UI:CSVImport:DefaultDateTimeFormat_Format_Example', htmlentities((string)AttributeDateTime::GetFormat(), ENT_QUOTES, 'UTF-8'), date((string)AttributeDateTime::GetFormat())).'</label><p>');
-		$oPage->add('<p><input type="radio" name="date_time_format" id="radio_date_time_custom" value="custom"'.IsChecked($sDateTimeFormat, 'custom').'/><label for="radio_date_time_custom"> '.Dict::Format('UI:CSVImport:CustomDateTimeFormat', '<input type="text" size="15" name="custom_date_time_format" id="custom_date_time_format" title="" value="'.htmlentities($sCustomDateTimeFormat, ENT_QUOTES, 'UTF-8').'">').'</label><p>');
+		$oPage->add('<p><input type="radio" name="date_time_format" id="radio_date_time_std" value="default" '.IsChecked($sDateTimeFormat, 'default').' /><label for="radio_date_time_std"> '.Dict::Format('UI:CSVImport:DefaultDateTimeFormat_Format_Example', htmlentities((string)AttributeDateTime::GetFormat(), ENT_QUOTES, 'UTF-8'), date((string)AttributeDateTime::GetFormat())).'</label><p>');
+		$oPage->add('<p><input type="radio" name="date_time_format" id="radio_date_time_custom" value="custom" '.IsChecked($sDateTimeFormat, 'custom').' /><label for="radio_date_time_custom"> '.Dict::Format('UI:CSVImport:CustomDateTimeFormat', '<input type="text" size="15" name="custom_date_time_format" id="custom_date_time_format" title="" value="'.htmlentities($sCustomDateTimeFormat, ENT_QUOTES, 'UTF-8').'">').'</label><p>');
 		$oPage->add('</td></tr></table>');
 		$oPage->add('<input type="hidden" name="csvdata_truncated" id="csvdata_truncated" value="'.htmlentities($sCSVDataTruncated, ENT_QUOTES, 'UTF-8').'"/>');
 		$oPage->add('<input type="hidden" name="csvdata" id="csvdata" value="'.htmlentities($sUTF8Data, ENT_QUOTES, 'UTF-8').'"/>');
@@ -1317,16 +1318,16 @@ EOF
 				'<p><input type="file" name="csvdata"/></p>';
 				
 		$sFileLoadHtml .= '<p>'.Dict::S('UI:CSVImport:Encoding').': ';
-		$sFileLoadHtml .= '<select name="encoding" style="font-family:Arial,Helvetica,Sans-serif">'; // IE 8 has some troubles if the font is different
+		$sFileLoadHtml .= '<select name="encoding" style="font-family:Arial,Helvetica,sans-serif">'; // IE 8 has some troubles if the font is different
 		$aPossibleEncodings = utils::GetPossibleEncodings(MetaModel::GetConfig()->GetCSVImportCharsets());
 		foreach($aPossibleEncodings as $sIconvCode => $sDisplayName )
 		{
 			$sSelected  = '';
 			if ($sEncoding == $sIconvCode)
 			{
-				$sSelected = ' selected';
+				$sSelected = 'selected';
 			}
-			$sFileLoadHtml .= '<option value="'.$sIconvCode.'"'.$sSelected.'>'.$sDisplayName.'</option>';
+			$sFileLoadHtml .= '<option value="'.$sIconvCode.'" '.$sSelected.' >'.$sDisplayName.'</option>';
 		}
 		$sFileLoadHtml .= '</select></p>';
 		$sFileLoadHtml .= '<p><input type="submit" value="'.Dict::S('UI:Button:Next').'"/></p>'.