dolibarr  20.0.0-beta
mod_facture_mercure.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2003-2007 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2011 Laurent Destailleur <eldy@users.sourceforge.net>
4  * Copyright (C) 2005-2007 Regis Houssin <regis.houssin@inodbox.com>
5  * Copyright (C) 2008 Raphael Bertrand (Resultic) <raphael.bertrand@resultic.fr>
6  * Copyright (C) 2013 Juanjo Menent <jmenent@2byte.es>
7  * Copyright (C) 2022 Anthony Berton <anthony.berton@bb2a.fr>
8  * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <https://www.gnu.org/licenses/>.
22  * or see https://www.gnu.org/
23  */
24 
30 require_once DOL_DOCUMENT_ROOT.'/core/modules/facture/modules_facture.php';
31 
32 
37 {
42  public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr'
43 
47  public $error = '';
48 
49 
56  public function info($langs)
57  {
58  global $db, $langs;
59 
60  $langs->load("bills");
61 
62  $form = new Form($db);
63 
64  $texte = $langs->trans('GenericNumRefModelDesc')."<br>\n";
65  $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST">';
66  $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
67  $texte .= '<input type="hidden" name="action" value="updateMask">';
68  $texte .= '<input type="hidden" name="maskconstinvoice" value="FACTURE_MERCURE_MASK_INVOICE">';
69  $texte .= '<input type="hidden" name="maskconstreplacement" value="FACTURE_MERCURE_MASK_REPLACEMENT">';
70  $texte .= '<input type="hidden" name="maskconstcredit" value="FACTURE_MERCURE_MASK_CREDIT">';
71  $texte .= '<input type="hidden" name="maskconstdeposit" value="FACTURE_MERCURE_MASK_DEPOSIT">';
72  $texte .= '<table class="nobordernopadding" width="100%">';
73 
74  $tooltip = $langs->trans("GenericMaskCodes", $langs->transnoentities("Invoice"), $langs->transnoentities("Invoice"));
75  $tooltip .= $langs->trans("GenericMaskCodes2");
76  $tooltip .= $langs->trans("GenericMaskCodes3");
77  $tooltip .= $langs->trans("GenericMaskCodes4a", $langs->transnoentities("Invoice"), $langs->transnoentities("Invoice"));
78  $tooltip .= $langs->trans("GenericMaskCodes5");
79 
80  // Setting the prefix
81  $texte .= '<tr><td><span class="opacitymedium">'.$langs->trans("Mask").' ('.$langs->trans("InvoiceStandard").'):</span></td>';
82  $texte .= '<td class="right">'.$form->textwithpicto('<input type="text" class="flat minwidth175" name="maskinvoice" value="'.getDolGlobalString("FACTURE_MERCURE_MASK_INVOICE").'">', $tooltip, 1, 1).'</td>';
83 
84  $texte .= '<td class="left" rowspan="3">&nbsp; <input type="submit" class="button button-edit reposition smallpaddingimp" name="Button"value="'.$langs->trans("Modify").'"></td>';
85 
86  $texte .= '</tr>';
87 
88  // Prefix setting of replacement invoices
89  $texte .= '<tr><td><span class="opacitymedium">'.$langs->trans("Mask").' ('.$langs->trans("InvoiceReplacement").'):</span></td>';
90  $texte .= '<td class="right">'.$form->textwithpicto('<input type="text" class="flat minwidth175" name="maskreplacement" value="'.getDolGlobalString("FACTURE_MERCURE_MASK_REPLACEMENT").'">', $tooltip, 1, 1).'</td>';
91  $texte .= '</tr>';
92 
93  // Prefix setting of credit note
94  $texte .= '<tr><td><span class="opacitymedium">'.$langs->trans("Mask").' ('.$langs->trans("InvoiceAvoir").'):</span></td>';
95  $texte .= '<td class="right">'.$form->textwithpicto('<input type="text" class="flat minwidth175" name="maskcredit" value="'.getDolGlobalString("FACTURE_MERCURE_MASK_CREDIT").'">', $tooltip, 1, 1).'</td>';
96  $texte .= '</tr>';
97 
98  // Prefix setting of deposit
99  $texte .= '<tr><td><span class="opacitymedium">'.$langs->trans("Mask").' ('.$langs->trans("InvoiceDeposit").'):</span></td>';
100  $texte .= '<td class="right">'.$form->textwithpicto('<input type="text" class="flat minwidth175" name="maskdeposit" value="'.getDolGlobalString("FACTURE_MERCURE_MASK_DEPOSIT").'">', $tooltip, 1, 1).'</td>';
101  $texte .= '</tr>';
102 
103  $texte .= '</table>';
104  $texte .= '</form>';
105 
106  return $texte;
107  }
108 
114  public function getExample()
115  {
116  global $mysoc;
117 
118  $old_code_client = $mysoc->code_client;
119  $old_code_type = $mysoc->typent_code;
120  $mysoc->code_client = 'CCCCCCCCCC';
121  $mysoc->typent_code = 'TTTTTTTTTT';
122  $numExample = $this->getNextValue($mysoc, '');
123  $mysoc->code_client = $old_code_client;
124  $mysoc->typent_code = $old_code_type;
125 
126  if (!$numExample) {
127  $numExample = 'NotConfigured';
128  }
129  return $numExample;
130  }
131 
140  public function getNextValue($objsoc, $invoice, $mode = 'next')
141  {
142  global $db;
143 
144  require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
145 
146  // Get Mask value
147  $mask = '';
148  if (is_object($invoice) && $invoice->type == 1) {
149  $mask = getDolGlobalString('FACTURE_MERCURE_MASK_REPLACEMENT', getDolGlobalString('FACTURE_MERCURE_MASK_INVOICE'));
150  } elseif (is_object($invoice) && $invoice->type == 2) {
151  $mask = getDolGlobalString('FACTURE_MERCURE_MASK_CREDIT');
152  } elseif (is_object($invoice) && $invoice->type == 3) {
153  $mask = getDolGlobalString('FACTURE_MERCURE_MASK_DEPOSIT');
154  } else {
155  $mask = getDolGlobalString('FACTURE_MERCURE_MASK_INVOICE');
156  }
157  if (!$mask) {
158  $this->error = 'NotConfigured';
159  return 0;
160  }
161 
162  $where = '';
163  //if ($facture->type == 2) $where.= " AND type = 2";
164  //else $where.=" AND type != 2";
165 
166  // Get entities
167  $entity = getEntity('invoicenumber', 1, $invoice);
168  $numFinal = get_next_value($db, $mask, 'facture', 'ref', $where, $objsoc, (empty($invoice) ? dol_now() : $invoice->date), $mode, false, null, $entity);
169  if (!preg_match('/([0-9])+/', $numFinal)) {
170  $this->error = $numFinal;
171  }
172 
173  return $numFinal;
174  }
175 
176 
186  public function getNumRef($objsoc, $objforref, $mode = 'next')
187  {
188  return $this->getNextValue($objsoc, $objforref, $mode);
189  }
190 }
Class to manage generation of HTML components Only common components must be here.
Parent class of invoice reference numbering templates.
Class of numbering module Mercure for invoices.
getNextValue($objsoc, $invoice, $mode='next')
Return next value.
getExample()
Return an example of number value.
getNumRef($objsoc, $objforref, $mode='next')
Return next free value.
info($langs)
Returns the description of the numbering model.
get_next_value($db, $mask, $table, $field, $where='', $objsoc='', $date='', $mode='next', $bentityon=true, $objuser=null, $forceentity=null)
Return last or next value for a mask (according to area we should not reset)
dol_now($mode='auto')
Return date for now.
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
getEntity($element, $shared=1, $currentobject=null)
Get list of entity id to use.