dolibarr 21.0.0-alpha
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 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
10 * Copyright (C) 2024 Nick Fragoulis
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 3 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <https://www.gnu.org/licenses/>.
24 * or see https://www.gnu.org/
25 */
26
32require_once DOL_DOCUMENT_ROOT.'/core/modules/facture/modules_facture.php';
33
34
39{
44 public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr'
45
49 public $error = '';
50
51
58 public function info($langs)
59 {
60 global $db, $langs;
61
62 $langs->load("bills");
63
64 $form = new Form($db);
65
66 $texte = $langs->trans('GenericNumRefModelDesc')."<br>\n";
67 $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST">';
68 $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
69 $texte .= '<input type="hidden" name="action" value="updateMask">';
70 $texte .= '<input type="hidden" name="maskconstinvoice" value="FACTURE_MERCURE_MASK_INVOICE">';
71 $texte .= '<input type="hidden" name="maskconstreplacement" value="FACTURE_MERCURE_MASK_REPLACEMENT">';
72 $texte .= '<input type="hidden" name="maskconstcredit" value="FACTURE_MERCURE_MASK_CREDIT">';
73 $texte .= '<input type="hidden" name="maskconstdeposit" value="FACTURE_MERCURE_MASK_DEPOSIT">';
74 $texte .= '<table class="nobordernopadding" width="100%">';
75
76 $tooltip = $langs->trans("GenericMaskCodes", $langs->transnoentities("Invoice"), $langs->transnoentities("Invoice"));
77 $tooltip .= $langs->trans("GenericMaskCodes2");
78 $tooltip .= '<br>';
79 $tooltip .= $langs->trans("GenericMaskCodes3");
80 $tooltip .= '<br>';
81 $tooltip .= $langs->trans("GenericMaskCodes4a", $langs->transnoentities("Invoice"), $langs->transnoentities("Invoice"));
82 $tooltip .= $langs->trans("GenericMaskCodes5");
83 $tooltip .= '<br>'.$langs->trans("GenericMaskCodes5b");
84
85 // Setting the prefix
86 $texte .= '<tr><td><span class="opacitymedium">'.$langs->trans("Mask").' ('.$langs->trans("InvoiceStandard").'):</span></td>';
87 $texte .= '<td class="right">'.$form->textwithpicto('<input type="text" class="flat minwidth175" name="maskinvoice" value="'.getDolGlobalString("FACTURE_MERCURE_MASK_INVOICE").'">', $tooltip, 1, 1, '', 0, 3, 'tooltipstandardmercure').'</td>';
88
89 $texte .= '<td class="left" rowspan="3">&nbsp; <input type="submit" class="button button-edit reposition smallpaddingimp" name="Button"value="'.$langs->trans("Modify").'"></td>';
90
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, '', 0, 3, 'tooltipcreditnotemercure').'</td>';
96 $texte .= '</tr>';
97
98 // Prefix setting of replacement invoices
99 if (!getDolGlobalString('INVOICE_DISABLE_REPLACEMENT')) {
100 $texte .= '<tr><td><span class="opacitymedium">'.$langs->trans("Mask").' ('.$langs->trans("InvoiceReplacement").'):</span></td>';
101 $texte .= '<td class="right">'.$form->textwithpicto('<input type="text" class="flat minwidth175" name="maskreplacement" value="'.getDolGlobalString("FACTURE_MERCURE_MASK_REPLACEMENT").'">', $tooltip, 1, 1, '', 0, 3, 'tooltipreplacementmercure').'</td>';
102 $texte .= '</tr>';
103 }
104
105 // Prefix setting of deposit
106 if (!getDolGlobalString('INVOICE_DISABLE_DEPOSIT')) {
107 $texte .= '<tr><td><span class="opacitymedium">'.$langs->trans("Mask").' ('.$langs->trans("InvoiceDeposit").'):</span></td>';
108 $texte .= '<td class="right">'.$form->textwithpicto('<input type="text" class="flat minwidth175" name="maskdeposit" value="'.getDolGlobalString("FACTURE_MERCURE_MASK_DEPOSIT").'">', $tooltip, 1, 1, '', 0, 3, 'tooltipdownpaymentmercure').'</td>';
109 $texte .= '</tr>';
110 }
111
112 $texte .= '</table>';
113 $texte .= '</form>';
114
115 return $texte;
116 }
117
123 public function getExample()
124 {
125 global $mysoc;
126
127 $old_code_client = $mysoc->code_client;
128 $old_code_type = $mysoc->typent_code;
129 $mysoc->code_client = 'CCCCCCCCCC';
130 $mysoc->typent_code = 'TTTTTTTTTT';
131 $numExample = $this->getNextValue($mysoc, null);
132 $mysoc->code_client = $old_code_client;
133 $mysoc->typent_code = $old_code_type;
134
135 if (!$numExample) {
136 $numExample = 'NotConfigured';
137 }
138 return $numExample;
139 }
140
149 public function getNextValue($objsoc, $invoice, $mode = 'next')
150 {
151 global $db;
152
153 require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
154
155 // Get Mask value
156 $mask = '';
157 if (is_object($invoice) && $invoice->type == 1) {
158 $mask = getDolGlobalString('FACTURE_MERCURE_MASK_REPLACEMENT', getDolGlobalString('FACTURE_MERCURE_MASK_INVOICE'));
159 } elseif (is_object($invoice) && $invoice->type == 2) {
160 $mask = getDolGlobalString('FACTURE_MERCURE_MASK_CREDIT');
161 } elseif (is_object($invoice) && $invoice->type == 3 && !getDolGlobalString('INVOICE_DISABLE_DEPOSIT')) {
162 $mask = getDolGlobalString('FACTURE_MERCURE_MASK_DEPOSIT');
163 } else {
164 $mask = getDolGlobalString('FACTURE_MERCURE_MASK_INVOICE');
165 }
166 if (!$mask) {
167 $this->error = 'NotConfigured';
168 return 0;
169 }
170
171 $where = '';
172 //if ($facture->type == 2) $where.= " AND type = 2";
173 //else $where.=" AND type != 2";
174
175 // Get entities
176 $entity = getEntity('invoicenumber', 1, $invoice);
177 $numFinal = get_next_value($db, $mask, 'facture', 'ref', $where, $objsoc, (empty($invoice) ? dol_now() : $invoice->date), $mode, false, null, $entity);
178 if (!preg_match('/([0-9])+/', $numFinal)) {
179 $this->error = $numFinal;
180 }
181
182 return $numFinal;
183 }
184
185
195 public function getNumRef($objsoc, $objforref, $mode = 'next')
196 {
197 return $this->getNextValue($objsoc, $objforref, $mode);
198 }
199}
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 not used or last value used.
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 a Dolibarr global constant string value.
getEntity($element, $shared=1, $currentobject=null)
Get list of entity id to use.