* Copyright (C) 2004-2011 Laurent Destailleur * Copyright (C) 2005-2007 Regis Houssin * Copyright (C) 2008 Raphael Bertrand (Resultic) * Copyright (C) 2013 uanjo Menent * Copyright (C) 2022 Anthony Berton * * 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 * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * or see https://www.gnu.org/ */ /** * \file htdocs/core/modules/facture/mod_facture_mercure.php * \ingroup facture * \brief File containing class for numbering module Mercure */ require_once DOL_DOCUMENT_ROOT . '/core/modules/facture/modules_facture.php'; /** * Class of numbering module Mercure for invoices */ class mod_facture_mercure extends ModeleNumRefFactures { /** * Dolibarr version of the loaded document * @var string */ public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' /** * @var string Error message */ public $error = ''; /** * Returns the description of the numbering model * * @return string Texte descripif */ public function info() { global $db, $langs; $langs->load("bills"); $form = new Form($db); $texte = $langs->trans('GenericNumRefModelDesc') . "
\n"; $texte .= '
'; $texte .= ''; $texte .= ''; $texte .= ''; $texte .= ''; $texte .= ''; $texte .= ''; $texte .= ''; $texte .= ''; $texte .= ''; $tooltip = $langs->trans("GenericMaskCodes", $langs->transnoentities("Invoice"), $langs->transnoentities("Invoice")); $tooltip .= $langs->trans("GenericMaskCodes2"); $tooltip .= $langs->trans("GenericMaskCodes3"); $tooltip .= $langs->trans("GenericMaskCodes4a", $langs->transnoentities("Invoice"), $langs->transnoentities("Invoice")); $tooltip .= $langs->trans("GenericMaskCodes5"); // Setting the prefix $texte .= ''; $texte .= ''; $texte .= ''; $texte .= ''; // RECEIPT $texte .= ''; $texte .= ''; $texte .= ''; // Prefix setting of replacement invoices $texte .= ''; $texte .= ''; $texte .= ''; // Prefix setting of credit note $texte .= ''; $texte .= ''; $texte .= ''; // RECEIPT CREDIT NOTE $texte .= ''; $texte .= ''; $texte .= ''; // Prefix setting of deposit $texte .= ''; $texte .= ''; $texte .= ''; $texte .= '
' . $langs->trans("Mask") . ' (' . $langs->trans("InvoiceStandard") . '):' . $form->textwithpicto('', $tooltip, 1, 1) . ' 
' . $langs->trans("Mask") . ' (' . $langs->trans("ReceiptStandard") . '):' . $form->textwithpicto('', $tooltip, 1, 1) . '
' . $langs->trans("Mask") . ' (' . $langs->trans("InvoiceReplacement") . '):' . $form->textwithpicto('', $tooltip, 1, 1) . '
' . $langs->trans("Mask") . ' (' . $langs->trans("InvoiceAvoir") . '):' . $form->textwithpicto('', $tooltip, 1, 1) . '
' . $langs->trans("Mask") . ' (' . $langs->trans("ReceiptInvoiceAvoir") . '):' . $form->textwithpicto('', $tooltip, 1, 1) . '
' . $langs->trans("Mask") . ' (' . $langs->trans("InvoiceDeposit") . '):' . $form->textwithpicto('', $tooltip, 1, 1) . '
'; $texte .= '
'; return $texte; } /** * Return an example of number value * * @return string Example */ public function getExample() { global $conf, $langs, $mysoc; $old_code_client = $mysoc->code_client; $old_code_type = $mysoc->typent_code; $mysoc->code_client = 'CCCCCCCCCC'; $mysoc->typent_code = 'TTTTTTTTTT'; $numExample = $this->getNextValue($mysoc, ''); $mysoc->code_client = $old_code_client; $mysoc->typent_code = $old_code_type; if (!$numExample) { $numExample = 'NotConfigured'; } return $numExample; } /** * Return next value * * @param Societe $objsoc Object third party * @param Facture $invoice Object invoice * @param string $mode 'next' for next value or 'last' for last value * @return string Value if OK, 0 if KO */ public function getNextValue($objsoc, $invoice, $mode = 'next') { global $db; require_once DOL_DOCUMENT_ROOT . '/core/lib/functions2.lib.php'; // Get Mask value $mask = ''; if (is_object($invoice) && $invoice->type == 1) { $mask = getDolGlobalString('FACTURE_MERCURE_MASK_REPLACEMENT', getDolGlobalString('FACTURE_MERCURE_MASK_INVOICE')); } elseif (is_object($invoice) && $invoice->type == 2) { $mask = getDolGlobalString('FACTURE_MERCURE_MASK_CREDIT'); } elseif (is_object($invoice) && $invoice->type == 7) { $mask = getDolGlobalString('FACTURE_MERCURE_MASK_RECEIPT'); } elseif (is_object($invoice) && $invoice->type == 8) { $mask = getDolGlobalString('FACTURE_MERCURE_MASK_RECEIPT_CREDIT'); } elseif (is_object($invoice) && $invoice->type == 3) { $mask = getDolGlobalString('FACTURE_MERCURE_MASK_DEPOSIT'); } else { $mask = getDolGlobalString('FACTURE_MERCURE_MASK_INVOICE'); } if (!$mask) { $this->error = 'NotConfigured'; return 0; } $where = ''; //if ($facture->type == 2) $where.= " AND type = 2"; //else $where.=" AND type != 2"; // Get entities $entity = getEntity('invoicenumber', 1, $invoice); $numFinal = get_next_value($db, $mask, 'facture', 'ref', $where, $objsoc, $invoice->date, $mode, false, null, $entity); if (!preg_match('/([0-9])+/', $numFinal)) { $this->error = $numFinal; } return $numFinal; } /** * Return next free value * * @param Societe $objsoc Object third party * @param string $objforref Object for number to search * @param string $mode 'next' for next value or 'last' for last value * @return string Next free value */ public function getNumRef($objsoc, $objforref, $mode = 'next') { return $this->getNextValue($objsoc, $objforref, $mode); } }