* Copyright (C) 2019-2024 Frédéric France * Copyright (C) 2024 MDW * * 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/cheque/mod_chequereceipt_thyme.php * \ingroup cheque * \brief File containing class for numbering module Thyme */ require_once DOL_DOCUMENT_ROOT.'/core/modules/cheque/modules_chequereceipts.php'; /** * Class to manage cheque receipts numbering rules Thyme */ class mod_chequereceipt_thyme extends ModeleNumRefChequeReceipts { /** * Dolibarr version of the loaded document * @var string Version, possible values are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'''|'development'|'dolibarr'|'experimental' */ public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' /** * @var string Error message */ public $error = ''; public $name = 'Thyme'; /** * Returns the description of the numbering model * * @param Translate $langs Lang object to use for output * @return string Descriptive text */ public function info($langs) { global $langs, $db; $langs->load("bills"); $form = new Form($db); $texte = $langs->trans('GenericNumRefModelDesc')."
\n"; $texte .= '

'; $texte .= ''; $texte .= ''; $texte .= ''; $texte .= ''; $tooltip = $langs->trans("GenericMaskCodes", $langs->transnoentities("CheckReceiptShort"), $langs->transnoentities("CheckReceiptShort")); $tooltip .= $langs->trans("GenericMaskCodes2"); $tooltip .= $langs->trans("GenericMaskCodes3"); $tooltip .= $langs->trans("GenericMaskCodes4a", $langs->transnoentities("CheckReceiptShort"), $langs->transnoentities("CheckReceiptShort")); $tooltip .= $langs->trans("GenericMaskCodes5"); //$tooltip .= '
'.$langs->trans("GenericMaskCodes5b"); // Parametrage du prefix $texte .= ''; $texte .= ''; $texte .= ''; $texte .= ''; $texte .= '

'.$langs->trans("Mask").':

'.$form->textwithpicto('', $tooltip, 1, 'help', 'valignmiddle', 0, 3, $this->name).'

'; $texte .= '

'; return $texte; } /** * Return an example of numbering * * @return string Example */ public function getExample() { global $db, $langs; require_once DOL_DOCUMENT_ROOT . '/compta/paiement/cheque/class/remisecheque.class.php'; require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php'; $remise = new RemiseCheque($db); $remise->initAsSpecimen(); $thirdparty = new Societe($db); $thirdparty->initAsSpecimen(); $numExample = $this->getNextValue($thirdparty, $remise); if (!$numExample) { $numExample = $langs->trans('NotConfigured'); } return $numExample; } /** * Return next free value * * @param Societe $objsoc Object third party * @param RemiseCheque $object Object we need next value for * @return string|int<-1,0> Next value if OK, -1 if KO */ public function getNextValue($objsoc, $object) { global $db; require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php'; // We get cursor rule $mask = getDolGlobalString('CHEQUERECEIPTS_THYME_MASK'); if (!$mask) { $this->error = 'NotConfigured'; return 0; } $date = (empty($object) ? dol_now() : $object->date_bordereau); $numFinal = get_next_value($db, $mask, 'bordereau_cheque', 'ref', '', $objsoc, $date); return $numFinal; } }