Clean code

This commit is contained in:
Laurent Destailleur 2024-11-12 12:57:08 +01:00
parent b86a48106b
commit a64de4d24d
5 changed files with 30 additions and 20 deletions

View File

@ -157,7 +157,7 @@ if (empty($reshook)) {
// Get encoder (barcode_type_coder) from barcode type id (barcode_type)
$stdobject = new GenericObject($db);
$stdobject->barcode_type = $fk_barcode_type;
$result = $stdobject->fetch_barcode();
$result = $stdobject->fetchBarCode();
if ($result <= 0) {
$error++;
setEventMessages('Failed to get bar code type information '.$stdobject->error, $stdobject->errors, 'errors');
@ -171,8 +171,8 @@ if (empty($reshook)) {
if (!$error && $stdobject !== null) {
$code = $forbarcode;
$generator = $stdobject->barcode_type_coder; // coder (loaded by fetch_barcode). Engine.
$encoding = strtoupper($stdobject->barcode_type_code); // code (loaded by fetch_barcode). Example 'ean', 'isbn', ...
$generator = $stdobject->barcode_type_coder; // coder (loaded by fetchBarCode). Engine.
$encoding = strtoupper($stdobject->barcode_type_code); // code (loaded by fetchBarCode). Example 'ean', 'isbn', ...
$diroutput = $conf->barcode->dir_temp;
dol_mkdir($diroutput);

View File

@ -425,25 +425,25 @@ abstract class CommonObject
/**
* @var int Barcode type
* @see fetch_barcode()
* @see fetchBarCode()
*/
public $barcode_type;
/**
* @var string Code of the barcode type
* @see fetch_barcode(), barcode_type
* @see fetchBarCode(), barcode_type
*/
public $barcode_type_code;
/**
* @var string Label of the barcode type
* @see fetch_barcode(), barcode_type
* @see fetchBarCode(), barcode_type
*/
public $barcode_type_label;
/**
* @var string
* @see fetch_barcode(), barcode_type
* @see fetchBarCode(), barcode_type
*/
public $barcode_type_coder;
@ -1702,7 +1702,7 @@ abstract class CommonObject
*/
public function listeTypeContacts($source = 'internal', $option = 0, $activeonly = 0, $code = '', $element = '', $excludeelement = '')
{
global $langs, $conf;
global $langs;
$langs->loadLangs(array('bills', 'contracts', 'interventions', 'orders', 'projects', 'propal', 'ticket', 'agenda'));
@ -1784,8 +1784,6 @@ abstract class CommonObject
*/
public function getIdContact($source, $code, $status = 0)
{
global $conf;
$result = array();
$i = 0;
// Particular case for shipping
@ -1952,13 +1950,24 @@ abstract class CommonObject
* if it is not defined, ->element must be defined to know default barcode type.
*
* @return int<-1,1> Return integer <0 if KO, 0 if can't guess type of barcode (ISBN, EAN13...), >0 if OK (all barcode properties loaded)
* @deprecated Use fetchBarCode()
*/
public function fetch_barcode()
{
// phpcs:enable
global $conf;
return fetchBarCode();
}
dol_syslog(get_class($this).'::fetch_barcode this->element='.$this->element.' this->barcode_type='.$this->barcode_type);
/**
* Load data for barcode into properties ->barcode_type*
* Properties ->barcode_type that is id of barcode. Type is used to find other properties, but
* if it is not defined, ->element must be defined to know default barcode type.
*
* @return int<-1,1> Return integer <0 if KO, 0 if can't guess type of barcode (ISBN, EAN13...), >0 if OK (all barcode properties loaded)
*/
public function fetchBarCode()
{
dol_syslog(get_class($this).'::fetchBarCode this->element='.$this->element.' this->barcode_type='.$this->barcode_type);
$idtype = $this->barcode_type;
if (empty($idtype) && $idtype != '0') { // If type of barcode no set, we try to guess. If set to '0' it means we forced to have type remain not defined
@ -1967,7 +1976,7 @@ abstract class CommonObject
} elseif ($this->element == 'societe') {
$idtype = getDolGlobalString('GENBARCODE_BARCODETYPE_THIRDPARTY');
} else {
dol_syslog('Call fetch_barcode with barcode_type not defined and cannot be guessed', LOG_WARNING);
dol_syslog('Call fetchBarCode with barcode_type not defined and cannot be guessed', LOG_WARNING);
}
}
@ -1976,10 +1985,11 @@ abstract class CommonObject
$sql = "SELECT rowid, code, libelle as label, coder";
$sql .= " FROM ".$this->db->prefix()."c_barcode_type";
$sql .= " WHERE rowid = ".((int) $idtype);
dol_syslog(get_class($this).'::fetch_barcode', LOG_DEBUG);
$resql = $this->db->query($sql);
if ($resql) {
$obj = $this->db->fetch_object($resql);
$this->barcode_type = $obj->rowid;
$this->barcode_type_code = $obj->code;
$this->barcode_type_label = $obj->label;

View File

@ -10290,8 +10290,8 @@ class Form
// Complete object if not complete
if (empty($object->barcode_type_code) || empty($object->barcode_type_coder)) {
// @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
$result = $object->fetch_barcode();
//Check if fetch_barcode() failed
$result = $object->fetchBarCode();
//Check if fetchBarCode() failed
if ($result < 1) {
return '<!-- ErrorFetchBarcode -->';
}

View File

@ -590,7 +590,7 @@ if (empty($reshook)) {
$stdobject = new GenericObject($db);
$stdobject->element = 'product';
$stdobject->barcode_type = GETPOSTINT('fk_barcode_type');
$result = $stdobject->fetch_barcode();
$result = $stdobject->fetchBarCode();
if ($result < 0) {
$error++;
$mesg = 'Failed to get bar code type information ';
@ -835,7 +835,7 @@ if (empty($reshook)) {
$stdobject = new GenericObject($db);
$stdobject->element = 'product';
$stdobject->barcode_type = GETPOSTINT('fk_barcode_type');
$result = $stdobject->fetch_barcode();
$result = $stdobject->fetchBarCode();
if ($result < 0) {
$error++;
$mesg = 'Failed to get bar code type information ';
@ -2555,7 +2555,7 @@ if (is_object($objcanvas) && $objcanvas->displayCanvasExists($canvasdisplayactio
print $formbarcode->formBarcodeType($_SERVER['PHP_SELF'].'?id='.$object->id, $object->barcode_type, 'fk_barcode_type');
$fk_barcode_type = $object->barcode_type;
} else {
$object->fetch_barcode();
$object->fetchBarCode();
$fk_barcode_type = $object->barcode_type;
print $object->barcode_type_label ? $object->barcode_type_label : ($object->barcode ? '<div class="warning">'.$langs->trans("SetDefaultBarcodeType").'<div>' : '');
}

View File

@ -1260,7 +1260,7 @@ if ($id > 0 || $ref) {
if (!empty($arrayfields['pfp.fk_barcode_type']['checked'])) {
print '<td class="center">';
$productfourn->barcode_type = !empty($productfourn->supplier_fk_barcode_type) ? $productfourn->supplier_fk_barcode_type : 0;
$productfourn->fetch_barcode();
$productfourn->fetchBarCode();
print $productfourn->barcode_type_label ? $productfourn->barcode_type_label : ($productfourn->supplier_barcode ? '<div class="warning">'.$langs->trans("SetDefaultBarcodeType").'<div>' : '');
print '</td>';
}