dolibarr  17.0.3
mod_codecompta_aquarium.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2004-2007 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2005 Eric Seigne <eric.seigne@ryxeo.com>
4  * Copyright (C) 2006-2011 Laurent Destailleur <eldy@users.sourceforge.net>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <https://www.gnu.org/licenses/>.
18  * or see https://www.gnu.org/
19  */
20 
26 require_once DOL_DOCUMENT_ROOT.'/core/modules/societe/modules_societe.class.php';
27 
28 
33 {
37  public $name = 'Aquarium';
38 
43  public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr'
44 
45  public $prefixcustomeraccountancycode;
46 
47  public $prefixsupplieraccountancycode;
48 
49  public $position = 20;
50 
51 
55  public function __construct()
56  {
57  global $conf;
58  if (!isset($conf->global->COMPANY_AQUARIUM_MASK_CUSTOMER) || trim($conf->global->COMPANY_AQUARIUM_MASK_CUSTOMER) == '') {
59  $conf->global->COMPANY_AQUARIUM_MASK_CUSTOMER = '411';
60  }
61  if (!isset($conf->global->COMPANY_AQUARIUM_MASK_SUPPLIER) || trim($conf->global->COMPANY_AQUARIUM_MASK_SUPPLIER) == '') {
62  $conf->global->COMPANY_AQUARIUM_MASK_SUPPLIER = '401';
63  }
64  $this->prefixcustomeraccountancycode = $conf->global->COMPANY_AQUARIUM_MASK_CUSTOMER;
65  $this->prefixsupplieraccountancycode = $conf->global->COMPANY_AQUARIUM_MASK_SUPPLIER;
66  }
67 
68 
75  public function info($langs)
76  {
77  global $conf;
78  global $form;
79 
80  $langs->load("companies");
81 
82  $tooltip = '';
83  $texte = '<form action="'.$_SERVER["PHP_SELF"].'" method="POST">';
84  $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
85  $texte .= '<input type="hidden" name="page_y" value="">';
86  $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
87  $texte .= '<input type="hidden" name="param1" value="COMPANY_AQUARIUM_MASK_SUPPLIER">';
88  $texte .= '<input type="hidden" name="param2" value="COMPANY_AQUARIUM_MASK_CUSTOMER">';
89  $texte .= '<table class="nobordernopadding" width="100%">';
90  $s1 = $form->textwithpicto('<input type="text" class="flat" size="4" name="value1" value="'.$conf->global->COMPANY_AQUARIUM_MASK_SUPPLIER.'">', $tooltip, 1, 1);
91  $s2 = $form->textwithpicto('<input type="text" class="flat" size="4" name="value2" value="'.$conf->global->COMPANY_AQUARIUM_MASK_CUSTOMER.'">', $tooltip, 1, 1);
92  $texte .= '<tr><td>';
93  // trans remove html entities
94  $texte .= $langs->trans("ModuleCompanyCodeCustomer".$this->name, '{s2}')."<br>\n";
95  $texte .= $langs->trans("ModuleCompanyCodeSupplier".$this->name, '{s1}')."<br>\n";
96  $texte = str_replace(array('{s1}', '{s2}'), array($s1, $s2), $texte);
97  $texte .= "<br>\n";
98  if (!isset($conf->global->COMPANY_AQUARIUM_REMOVE_SPECIAL) || !empty($conf->global->$conf->global->COMPANY_AQUARIUM_REMOVE_SPECIAL)) {
99  $texte .= $langs->trans('RemoveSpecialChars').' = '.yn(1)."<br>\n";
100  }
101  //if (!empty($conf->global->COMPANY_AQUARIUM_REMOVE_ALPHA)) $texte.=$langs->trans('COMPANY_AQUARIUM_REMOVE_ALPHA').' = '.yn($conf->global->COMPANY_AQUARIUM_REMOVE_ALPHA)."<br>\n";
102  if (!empty($conf->global->COMPANY_AQUARIUM_CLEAN_REGEX)) {
103  $texte .= $langs->trans('COMPANY_AQUARIUM_CLEAN_REGEX').' = '.$conf->global->COMPANY_AQUARIUM_CLEAN_REGEX."<br>\n";
104  }
105  $texte .= '</td>';
106  $texte .= '<td class="right"><input type="submit" class="button button-edit reposition" name="modify" value="'.$langs->trans("Modify").'"></td>';
107  $texte .= '</tr></table>';
108  $texte .= '</form>';
109 
110  return $texte;
111  }
112 
121  public function getExample($langs, $objsoc = 0, $type = -1)
122  {
123  $s = '';
124  $s .= $this->prefixcustomeraccountancycode.'CUSTCODE';
125  $s .= "<br>\n";
126  $s .= $this->prefixsupplieraccountancycode.'SUPPCODE';
127  return $s;
128  }
129 
130 
131  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
140  public function get_code($db, $societe, $type = '')
141  {
142  // phpcs:enable
143  global $conf;
144 
145  $i = 0;
146  $this->db = $db;
147 
148  dol_syslog("mod_codecompta_aquarium::get_code search code for type=".$type." company=".(!empty($societe->name) ? $societe->name : ''));
149 
150  // Regle gestion compte compta
151  if ($type == 'customer') {
152  $codetouse = (!empty($societe->code_client) ? $societe->code_client : 'CUSTCODE');
153  $prefix = $this->prefixcustomeraccountancycode;
154  } elseif ($type == 'supplier') {
155  $codetouse = (!empty($societe->code_fournisseur) ? $societe->code_fournisseur : 'SUPPCODE');
156  $prefix = $this->prefixsupplieraccountancycode;
157  } else {
158  $this->error = 'Bad value for parameter type';
159  return -1;
160  }
161 
162  //$conf->global->COMPANY_AQUARIUM_CLEAN_REGEX='^..(..)..';
163 
164  // Remove special char if COMPANY_AQUARIUM_REMOVE_SPECIAL is set to 1 or not set (default)
165  if (!isset($conf->global->COMPANY_AQUARIUM_REMOVE_SPECIAL) || !empty($conf->global->COMPANY_AQUARIUM_REMOVE_SPECIAL)) {
166  $codetouse = preg_replace('/([^a-z0-9])/i', '', $codetouse);
167  }
168  // Remove special alpha if COMPANY_AQUARIUM_REMOVE_ALPHA is set to 1
169  if (!empty($conf->global->COMPANY_AQUARIUM_REMOVE_ALPHA)) {
170  $codetouse = preg_replace('/([a-z])/i', '', $codetouse);
171  }
172  // Apply a regex replacement pattern on code if COMPANY_AQUARIUM_CLEAN_REGEX is set. Value must be a regex with parenthesis. The part into parenthesis is kept, the rest removed.
173  if (!empty($conf->global->COMPANY_AQUARIUM_CLEAN_REGEX)) { // Example: $conf->global->COMPANY_AQUARIUM_CLEAN_REGEX='^..(..)..';
174  $codetouse = preg_replace('/'.$conf->global->COMPANY_AQUARIUM_CLEAN_REGEX.'/', '\1\2\3', $codetouse);
175  }
176 
177  $codetouse = $prefix.strtoupper($codetouse);
178 
179  $is_dispo = $this->verif($db, $codetouse, $societe, $type);
180  if (!$is_dispo) {
181  $this->code = $codetouse;
182  } else {
183  // Pour retour
184  $this->code = $codetouse;
185  }
186  dol_syslog("mod_codecompta_aquarium::get_code found code=".$this->code);
187  return $is_dispo;
188  }
189 
190 
200  public function verif($db, $code, $societe, $type)
201  {
202  $sql = "SELECT ";
203  if ($type == 'customer') {
204  $sql .= "code_compta";
205  } elseif ($type == 'supplier') {
206  $sql .= "code_compta_fournisseur";
207  }
208  $sql .= " FROM ".MAIN_DB_PREFIX."societe";
209  $sql .= " WHERE ";
210  if ($type == 'customer') {
211  $sql .= "code_compta";
212  } elseif ($type == 'supplier') {
213  $sql .= "code_compta_fournisseur";
214  }
215  $sql .= " = '".$db->escape($code)."'";
216  if (!empty($societe->id)) {
217  $sql .= " AND rowid <> ".$societe->id;
218  }
219 
220  $resql = $db->query($sql);
221  if ($resql) {
222  if ($db->num_rows($resql) == 0) {
223  dol_syslog("mod_codecompta_aquarium::verif code '".$code."' available");
224  return 1; // Dispo
225  } else {
226  dol_syslog("mod_codecompta_aquarium::verif code '".$code."' not available");
227  return 0; // Non dispo
228  }
229  } else {
230  $this->error = $db->error()." sql=".$sql;
231  return -1; // Erreur
232  }
233  }
234 }
db
$conf db
API class for accounts.
Definition: inc.php:41
yn
yn($yesno, $case=1, $color=0)
Return yes or no in current language.
Definition: functions.lib.php:6677
$form
if($cancel &&! $id) if($action=='add' &&! $cancel) if($action=='delete') if($id) $form
Actions.
Definition: card.php:143
name
$conf db name
Definition: repair.php:122
ModeleAccountancyCode
Parent class for third parties accountancy code generators.
Definition: modules_societe.class.php:277
mod_codecompta_aquarium
Class to manage accountancy code of thirdparties with Aquarium rules.
Definition: mod_codecompta_aquarium.php:32
code
print *****$script_file(".$version.") pid code
! Closing after partial payment: discount_vat, badcustomer or badsupplier, bankcharge,...
Definition: sync_members_ldap2dolibarr.php:60
mod_codecompta_aquarium\verif
verif($db, $code, $societe, $type)
Return if a code is available.
Definition: mod_codecompta_aquarium.php:200
$resql
if(isModEnabled('facture') &&!empty($user->rights->facture->lire)) if((isModEnabled('fournisseur') &&empty($conf->global->MAIN_USE_NEW_SUPPLIERMOD) && $user->hasRight("fournisseur", "facture", "lire"))||(isModEnabled('supplier_invoice') && $user->hasRight("supplier_invoice", "lire"))) if(isModEnabled('don') &&!empty($user->rights->don->lire)) if(isModEnabled('tax') &&!empty($user->rights->tax->charges->lire)) if(isModEnabled('facture') &&isModEnabled('commande') && $user->hasRight("commande", "lire") &&empty($conf->global->WORKFLOW_DISABLE_CREATE_INVOICE_FROM_ORDER)) $resql
Social contributions to pay.
Definition: index.php:745
dol_syslog
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
Definition: functions.lib.php:1628
mod_codecompta_aquarium\info
info($langs)
Return description of module.
Definition: mod_codecompta_aquarium.php:75
mod_codecompta_aquarium\getExample
getExample($langs, $objsoc=0, $type=-1)
Return an example of result returned by getNextValue.
Definition: mod_codecompta_aquarium.php:121
mod_codecompta_aquarium\__construct
__construct()
Constructor.
Definition: mod_codecompta_aquarium.php:55
mod_codecompta_aquarium\get_code
get_code($db, $societe, $type='')
Set accountancy account code for a third party into this->code.
Definition: mod_codecompta_aquarium.php:140