Merge pull request #28886 from mdeweerd/fix/deprecatedfunccall

Fix Deprecated Function Calls
2025-12-24 02:11:27 +01:00 · 2024-03-16 15:33:34 +01:00
parent effd277a12 7b53202f74
commit a9f3cdf5d0
15 changed files with 125 additions and 110 deletions
--- a/htdocs/core/class/commonnumrefgenerator.class.php
+++ b/htdocs/core/class/commonnumrefgenerator.class.php
@@ -1,6 +1,7 @@
 <?php
 /* Copyright (C) 2023	Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2024		Frédéric France			<frederic.france@free.fr>
+ * Copyright (C) 2024		MDW							<mdeweerd@users.noreply.github.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
@@ -88,7 +89,7 @@ abstract class CommonNumRefGenerator
 	 *
 	 *  @param	Translate	$langs		Object langs
 	 *  @return string      			Model name
-	 *  @deprecated
+	 *  @deprecated Use getName() instead
 	 *  @see getName()
 	 */
 	public function getNom($langs)
--- a/htdocs/core/class/html.form.class.php
+++ b/htdocs/core/class/html.form.class.php
@@ -4321,7 +4321,7 @@ class Form
 	 *                                > 0 : force deposit percentage (for example, from company object)
 	 * @param int $noprint if set to one we return the html to print, if 0 (default) we print it
 	 * @return    void|string
-	 * @deprecated
+	 * @deprecated Use getSelectConditionsPaiements() instead and handle noprint locally.
 	 */
 	public function select_conditions_paiements($selected = 0, $htmlname = 'condid', $filtertype = -1, $addempty = 0, $noinfoadmin = 0, $morecss = '', $deposit_percent = -1, $noprint = 0)
 	{
--- a/htdocs/core/class/html.formsetup.class.php
+++ b/htdocs/core/class/html.formsetup.class.php
@@ -1,5 +1,6 @@
 <?php
 /* Copyright (C) 2021  John BOTELLA    <john.botella@atm-consulting.fr>
+ * Copyright (C) 2024		MDW							<mdeweerd@users.noreply.github.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
@@ -154,15 +155,15 @@ class FormSetup
 			return $hookmanager->resPrint;
 		} else {
 			$out = '<!-- Start generateOutput from FormSetup class  -->';
-			$out.= $this->htmlBeforeOutputForm;
+			$out .= $this->htmlBeforeOutputForm;

 			if ($editMode) {
-				$out.= '<form ' . self::generateAttributesStringFromArray($this->formAttributes) . ' >';
+				$out .= '<form ' . self::generateAttributesStringFromArray($this->formAttributes) . ' >';

 				// generate hidden values from $this->formHiddenInputs
 				if (!empty($this->formHiddenInputs) && is_array($this->formHiddenInputs)) {
 					foreach ($this->formHiddenInputs as $hiddenKey => $hiddenValue) {
-						$out.= '<input type="hidden" name="'.dol_escape_htmltag($hiddenKey).'" value="' . dol_escape_htmltag($hiddenValue) . '">';
+						$out .= '<input type="hidden" name="'.dol_escape_htmltag($hiddenKey).'" value="' . dol_escape_htmltag($hiddenValue) . '">';
 					}
 				}
 			}
@@ -180,7 +181,7 @@ class FormSetup
 				return $hookmanager->resPrint;
 			} elseif ($editMode) {
 				$out .= '<div class="form-setup-button-container center">'; // Todo : remove .center by adding style to form-setup-button-container css class in all themes
-				$out.= $this->htmlOutputMoreButton;
+				$out .= $this->htmlOutputMoreButton;
 				$out .= '<input class="button button-save" type="submit" value="' . $this->langs->trans("Save") . '">'; // Todo fix dolibarr style for <button and use <button instead of input
 				/*$out .= ' &nbsp;&nbsp; ';
 				$out .= '<a class="button button-cancel" type="submit" href="' . $this->formAttributes['action'] . '">'.$this->langs->trans('Cancel').'</a>';
@@ -192,7 +193,7 @@ class FormSetup
 				$out .= '</form>';
 			}

-			$out.= $this->htmlAfterOutputForm;
+			$out .= $this->htmlAfterOutputForm;

 			return $out;
 		}
@@ -311,27 +312,27 @@ class FormSetup
 	public function generateLineOutput($item, $editMode = false)
 	{
 		$out = '';
-		if ($item->enabled==1) {
+		if ($item->enabled == 1) {
 			$trClass = 'oddeven';
 			if ($item->getType() == 'title') {
 				$trClass = 'liste_titre';
 			}

 			$this->setupNotEmpty++;
-			$out.= '<tr class="'.$trClass.'">';
+			$out .= '<tr class="'.$trClass.'">';

-			$out.= '<td class="col-setup-title">';
-			$out.= '<span id="helplink'.$item->confKey.'" class="spanforparamtooltip">';
-			$out.= $this->form->textwithpicto($item->getNameText(), $item->getHelpText(), 1, 'info', '', 0, 3, 'tootips'.$item->confKey);
-			$out.= '</span>';
-			$out.= '</td>';
+			$out .= '<td class="col-setup-title">';
+			$out .= '<span id="helplink'.$item->confKey.'" class="spanforparamtooltip">';
+			$out .= $this->form->textwithpicto($item->getNameText(), $item->getHelpText(), 1, 'info', '', 0, 3, 'tootips'.$item->confKey);
+			$out .= '</span>';
+			$out .= '</td>';

-			$out.= '<td>';
+			$out .= '<td>';

 			if ($editMode) {
-				$out.= $item->generateInputField();
+				$out .= $item->generateInputField();
 			} else {
-				$out.= $item->generateOutputField();
+				$out .= $item->generateOutputField();
 			}

 			if (!empty($item->errors)) {
@@ -339,8 +340,8 @@ class FormSetup
 				setEventMessages(null, $item->errors, 'errors');
 			}

-			$out.= '</td>';
-			$out.= '</tr>';
+			$out .= '</td>';
+			$out .= '</tr>';
 		}

 		return $out;
@@ -393,6 +394,7 @@ class FormSetup

 		$item = new FormSetupItem($confKey);
 		// need to be ignored from scrutinizer setTypeFromTypeString was created as deprecated to incite developer to use object oriented usage
+		// @phan-suppress-next-line PhanDeprecatedFunction
 		/** @scrutinizer ignore-deprecated */ $item->setTypeFromTypeString($params['type']);

 		if (!empty($params['enabled'])) {
@@ -831,7 +833,9 @@ class FormSetupItem
 		$out = (($this->langs->trans($this->confKey) != $this->confKey) ? $this->langs->trans($this->confKey) : $this->langs->trans('MissingTranslationForConfKey', $this->confKey));

 		// if conf defined on entity 0, prepend a picto to indicate it will apply across all entities
-		if (isModEnabled('multicompany') && $this->entity == 0) $out = img_picto($this->langs->trans('AllEntities'), 'fa-globe-americas em088 opacityhigh') . '&nbsp;' . $out;
+		if (isModEnabled('multicompany') && $this->entity == 0) {
+			$out = img_picto($this->langs->trans('AllEntities'), 'fa-globe-americas em088 opacityhigh') . '&nbsp;' . $out;
+		}

 		return $out;
 	}
@@ -866,51 +870,51 @@ class FormSetupItem
 		$out = '';

 		if ($this->type == 'title') {
-			$out.= $this->generateOutputField(); // title have no input
+			$out .= $this->generateOutputField(); // title have no input
 		} elseif ($this->type == 'multiselect') {
-			$out.= $this->generateInputFieldMultiSelect();
+			$out .= $this->generateInputFieldMultiSelect();
 		} elseif ($this->type == 'select') {
-			$out.= $this->generateInputFieldSelect();
+			$out .= $this->generateInputFieldSelect();
 		} elseif ($this->type == 'selectUser') {
-			$out.= $this->generateInputFieldSelectUser();
+			$out .= $this->generateInputFieldSelectUser();
 		} elseif ($this->type == 'textarea') {
-			$out.= $this->generateInputFieldTextarea();
-		} elseif ($this->type== 'html') {
-			$out.= $this->generateInputFieldHtml();
-		} elseif ($this->type== 'color') {
-			$out.=  $this->generateInputFieldColor();
+			$out .= $this->generateInputFieldTextarea();
+		} elseif ($this->type == 'html') {
+			$out .= $this->generateInputFieldHtml();
+		} elseif ($this->type == 'color') {
+			$out .=  $this->generateInputFieldColor();
 		} elseif ($this->type == 'yesno') {
 			if (!empty($conf->use_javascript_ajax)) {
-				$out.= ajax_constantonoff($this->confKey);
+				$out .= ajax_constantonoff($this->confKey);
 			} else {
-				$out.= $this->form->selectyesno($this->confKey, $this->fieldValue, 1);
+				$out .= $this->form->selectyesno($this->confKey, $this->fieldValue, 1);
 			}
 		} elseif (preg_match('/emailtemplate:/', $this->type)) {
-			$out.= $this->generateInputFieldEmailTemplate();
+			$out .= $this->generateInputFieldEmailTemplate();
 		} elseif (preg_match('/category:/', $this->type)) {
-			$out.=$this->generateInputFieldCategories();
+			$out .= $this->generateInputFieldCategories();
 		} elseif (preg_match('/thirdparty_type/', $this->type)) {
 			require_once DOL_DOCUMENT_ROOT.'/core/class/html.formcompany.class.php';
 			$formcompany = new FormCompany($this->db);
-			$out.= $formcompany->selectProspectCustomerType($this->fieldValue, $this->confKey);
+			$out .= $formcompany->selectProspectCustomerType($this->fieldValue, $this->confKey);
 		} elseif ($this->type == 'securekey') {
-			$out.= $this->generateInputFieldSecureKey();
+			$out .= $this->generateInputFieldSecureKey();
 		} elseif ($this->type == 'product') {
 			if (isModEnabled("product") || isModEnabled("service")) {
 				$selected = (empty($this->fieldValue) ? '' : $this->fieldValue);
-				$out.= $this->form->select_produits($selected, $this->confKey, '', 0, 0, 1, 2, '', 0, array(), 0, '1', 0, $this->cssClass, 0, '', null, 1);
+				$out .= $this->form->select_produits($selected, $this->confKey, '', 0, 0, 1, 2, '', 0, array(), 0, '1', 0, $this->cssClass, 0, '', null, 1);
 			}
 		} elseif ($this->type == 'selectBankAccount') {
 			if (isModEnabled("bank")) {
 				$selected = (empty($this->fieldValue) ? '' : $this->fieldValue);
-				$out.= $this->form->select_comptes($selected, $this->confKey, 0, '', 0, '', 0, '', 1);
+				$out .= $this->form->select_comptes($selected, $this->confKey, 0, '', 0, '', 0, '', 1);
 			}
 		} elseif ($this->type == 'password') {
-			$out.= $this->generateInputFieldPassword('dolibarr');
+			$out .= $this->generateInputFieldPassword('dolibarr');
 		} elseif ($this->type == 'genericpassword') {
-			$out.= $this->generateInputFieldPassword('generic');
+			$out .= $this->generateInputFieldPassword('generic');
 		} else {
-			$out.= $this->generateInputFieldText();
+			$out .= $this->generateInputFieldText();
 		}

 		return $out;
@@ -937,8 +941,8 @@ class FormSetupItem
 	public function generateInputFieldTextarea()
 	{
 		$out = '<textarea class="flat" name="'.$this->confKey.'" id="'.$this->confKey.'" cols="50" rows="5" wrap="soft">' . "\n";
-		$out.= dol_htmlentities($this->fieldValue);
-		$out.= "</textarea>\n";
+		$out .= dol_htmlentities($this->fieldValue);
+		$out .= "</textarea>\n";
 		return $out;
 	}

@@ -1021,7 +1025,7 @@ class FormSetupItem
 		global $conf;
 		$out = '<input required="required" type="text" class="flat" id="'.$this->confKey.'" name="'.$this->confKey.'" value="'.(GETPOST($this->confKey, 'alpha') ? GETPOST($this->confKey, 'alpha') : $this->fieldValue).'" size="40">';
 		if (!empty($conf->use_javascript_ajax)) {
-			$out.= '&nbsp;'.img_picto($this->langs->trans('Generate'), 'refresh', 'id="generate_token'.$this->confKey.'" class="linkobject"');
+			$out .= '&nbsp;'.img_picto($this->langs->trans('Generate'), 'refresh', 'id="generate_token'.$this->confKey.'" class="linkobject"');
 		}

 		// Add button to autosuggest a key
@@ -1167,25 +1171,25 @@ class FormSetupItem
 		if ($this->type == 'title') {
 			// nothing to do
 		} elseif ($this->type == 'textarea') {
-			$out.= dol_nl2br($this->fieldValue);
+			$out .= dol_nl2br($this->fieldValue);
 		} elseif ($this->type == 'multiselect') {
-			$out.= $this->generateOutputFieldMultiSelect();
+			$out .= $this->generateOutputFieldMultiSelect();
 		} elseif ($this->type == 'select') {
-			$out.= $this->generateOutputFieldSelect();
+			$out .= $this->generateOutputFieldSelect();
 		} elseif ($this->type == 'selectUser') {
-			$out.= $this->generateOutputFieldSelectUser();
+			$out .= $this->generateOutputFieldSelectUser();
 		} elseif ($this->type == 'html') {
-			$out.=  $this->fieldValue;
+			$out .=  $this->fieldValue;
 		} elseif ($this->type == 'color') {
-			$out.=  $this->generateOutputFieldColor();
+			$out .=  $this->generateOutputFieldColor();
 		} elseif ($this->type == 'yesno') {
 			if (!empty($conf->use_javascript_ajax)) {
-				$out.= ajax_constantonoff($this->confKey);
+				$out .= ajax_constantonoff($this->confKey);
 			} else {
 				if ($this->fieldValue == 1) {
-					$out.= $langs->trans('yes');
+					$out .= $langs->trans('yes');
 				} else {
-					$out.= $langs->trans('no');
+					$out .= $langs->trans('no');
 				}
 			}
 		} elseif (preg_match('/emailtemplate:/', $this->type)) {
@@ -1199,7 +1203,7 @@ class FormSetupItem
 				if (is_numeric($template) && $template < 0) {
 					$this->setErrors($formmail->errors);
 				}
-				$out.= $this->langs->trans($template->label);
+				$out .= $this->langs->trans($template->label);
 			}
 		} elseif (preg_match('/category:/', $this->type)) {
 			require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
@@ -1213,16 +1217,16 @@ class FormSetupItem
 			foreach ($ways as $way) {
 				$toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories"' . ($c->color ? ' style="background: #' . $c->color . ';"' : ' style="background: #bbb"') . '>' . $way . '</li>';
 			}
-			$out.='<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr">' . implode(' ', $toprint) . '</ul></div>';
+			$out .= '<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr">' . implode(' ', $toprint) . '</ul></div>';
 		} elseif (preg_match('/thirdparty_type/', $this->type)) {
-			if ($this->fieldValue==2) {
-				$out.= $this->langs->trans("Prospect");
-			} elseif ($this->fieldValue==3) {
-				$out.= $this->langs->trans("ProspectCustomer");
-			} elseif ($this->fieldValue==1) {
-				$out.= $this->langs->trans("Customer");
-			} elseif ($this->fieldValue==0) {
-				$out.= $this->langs->trans("NorProspectNorCustomer");
+			if ($this->fieldValue == 2) {
+				$out .= $this->langs->trans("Prospect");
+			} elseif ($this->fieldValue == 3) {
+				$out .= $this->langs->trans("ProspectCustomer");
+			} elseif ($this->fieldValue == 1) {
+				$out .= $this->langs->trans("Customer");
+			} elseif ($this->fieldValue == 0) {
+				$out .= $this->langs->trans("NorProspectNorCustomer");
 			}
 		} elseif ($this->type == 'product') {
 			require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
@@ -1230,7 +1234,7 @@ class FormSetupItem
 			$product = new Product($this->db);
 			$resprod = $product->fetch($this->fieldValue);
 			if ($resprod > 0) {
-				$out.= $product->ref;
+				$out .= $product->ref;
 			} elseif ($resprod < 0) {
 				$this->setErrors($product->errors);
 			}
@@ -1240,14 +1244,14 @@ class FormSetupItem
 			$bankaccount = new Account($this->db);
 			$resbank = $bankaccount->fetch($this->fieldValue);
 			if ($resbank > 0) {
-				$out.= $bankaccount->label;
+				$out .= $bankaccount->label;
 			} elseif ($resbank < 0) {
 				$this->setErrors($bankaccount->errors);
 			}
 		} elseif ($this->type == 'password' || $this->type == 'genericpassword') {
-			$out.= str_repeat('*', strlen($this->fieldValue));
+			$out .= str_repeat('*', strlen($this->fieldValue));
 		} else {
-			$out.= $this->fieldValue;
+			$out .= $this->fieldValue;
 		}

 		return $out;
@@ -1270,7 +1274,7 @@ class FormSetupItem
 		if (!empty($TSelected)) {
 			foreach ($TSelected as $selected) {
 				if (!empty($this->fieldOptions[$selected])) {
-					$outPut.= dolGetBadge('', $this->fieldOptions[$selected], 'info').' ';
+					$outPut .= dolGetBadge('', $this->fieldOptions[$selected], 'info').' ';
 				}
 			}
 		}
@@ -1285,7 +1289,7 @@ class FormSetupItem
 	public function generateOutputFieldColor()
 	{
 		global $langs;
-		$this->fieldAttr['disabled']=null;
+		$this->fieldAttr['disabled'] = null;
 		$color = colorArrayToHex(colorStringToArray($this->fieldValue, array()), '');
 		if ($color) {
 			return '<input type="text" class="colorthumb" disabled="disabled" style="padding: 1px; margin-top: 0; margin-bottom: 0; background-color: #'.$color.'" value="'.$color.'">';
@@ -1299,7 +1303,7 @@ class FormSetupItem
 	 */
 	public function generateInputFieldColor()
 	{
-		$this->fieldAttr['type']= 'color';
+		$this->fieldAttr['type'] = 'color';
 		$default = $this->defaultFieldValue;
 		include_once DOL_DOCUMENT_ROOT.'/core/class/html.formother.class.php';
 		$formother = new FormOther($this->db);
--- a/htdocs/core/modules/barcode/modules_barcode.class.php
+++ b/htdocs/core/modules/barcode/modules_barcode.class.php
@@ -90,7 +90,7 @@ abstract class ModeleNumRefBarCode extends CommonNumRefGenerator
 		$s .= $langs->trans("Name").': <b>'.$this->name.'</b><br>';
 		$s .= $langs->trans("Version").': <b>'.$this->getVersion().'</b><br>';
 		if ($type != -1) {
-			$s .= $langs->trans("ValidityControledByModule").': <b>'.$this->getNom($langs).'</b><br>';
+			$s .= $langs->trans("ValidityControledByModule").': <b>'.$this->getName($langs).'</b><br>';
 		}
 		$s .= '<br>';
 		$s .= '<u>'.$langs->trans("ThisIsModuleRules").':</u><br>';
--- a/htdocs/core/modules/product/modules_product.class.php
+++ b/htdocs/core/modules/product/modules_product.class.php
@@ -4,6 +4,7 @@
 * Copyright (C) 2004      Eric Seigne          <eric.seigne@ryxeo.com>
 * Copyright (C) 2005-2012 Regis Houssin        <regis.houssin@inodbox.com>
 * Copyright (C) 2024		Frédéric France			<frederic.france@free.fr>
+ * Copyright (C) 2024		MDW							<mdeweerd@users.noreply.github.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
@@ -125,7 +126,7 @@ abstract class ModeleProductCode extends CommonNumRefGenerator
 		}
 		$s = '';
 		if ($type == -1) {
-			$s .= $langs->trans("Name").': <b>'.$this->getNom($langs).'</b><br>';
+			$s .= $langs->trans("Name").': <b>'.$this->getName($langs).'</b><br>';
 			$s .= $langs->trans("Version").': <b>'.$this->getVersion().'</b><br>';
 		} elseif ($type == 0) {
 			$s .= $langs->trans("ProductCodeDesc").'<br>';
@@ -133,7 +134,7 @@ abstract class ModeleProductCode extends CommonNumRefGenerator
 			$s .= $langs->trans("ServiceCodeDesc").'<br>';
 		}
 		if ($type != -1) {
-			$s .= $langs->trans("ValidityControledByModule").': <b>'.$this->getNom($langs).'</b><br>';
+			$s .= $langs->trans("ValidityControledByModule").': <b>'.$this->getName($langs).'</b><br>';
 		}
 		$s .= '<br>';
 		$s .= '<u>'.$langs->trans("ThisIsModuleRules").':</u><br>';
--- a/htdocs/core/modules/societe/modules_societe.class.php
+++ b/htdocs/core/modules/societe/modules_societe.class.php
@@ -136,14 +136,14 @@ abstract class ModeleThirdPartyCode extends CommonNumRefGenerator

 		$s = '';
 		if ($type == -1) {
-			$s .= $langs->trans("Name").': <b>'.$this->getNom($langs).'</b><br>';
+			$s .= $langs->trans("Name").': <b>'.$this->getName($langs).'</b><br>';
 		} elseif ($type == 0) {
 			$s .= $langs->trans("CustomerCodeDesc").'<br>';
 		} elseif ($type == 1) {
 			$s .= $langs->trans("SupplierCodeDesc").'<br>';
 		}
 		if ($type != -1) {
-			$s .= $langs->trans("ValidityControledByModule").': <b>'.$this->getNom($langs).'</b><br>';
+			$s .= $langs->trans("ValidityControledByModule").': <b>'.$this->getName($langs).'</b><br>';
 		}
 		$s .= '<br>';
 		$s .= '<u>'.$langs->trans("ThisIsModuleRules").':</u><br>';