* Copyright (C) 2004-2008 Laurent Destailleur * Copyright (C) 2005-2007 Regis Houssin * Copyright (C) 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/delivery/mod_delivery_saphir.php * \ingroup expedition * \brief Fichier contenant la class du modele de numerotation de reference de livraison Saphir */ require_once DOL_DOCUMENT_ROOT.'/core/modules/delivery/modules_delivery.php'; /** * \class mod_delivery_saphir * \brief Class du modele de numerotation de reference de livraison Saphir */ class mod_delivery_saphir extends ModeleNumRefDeliveryOrder { /** * 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 = ''; /** * @var string Nom du modele * @deprecated * @see $name */ public $nom = 'Saphir'; /** * @var string model name */ public $name = 'Saphir'; /** * 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 .= ''; return $texte; } /** * Return an example of number * * @return string Example */ public function getExample() { global $db, $langs; require_once DOL_DOCUMENT_ROOT . '/delivery/class/delivery.class.php'; require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php'; $delivery = new Delivery($db); $delivery->initAsSpecimen(); $thirdparty = new Societe($db); $thirdparty->initAsSpecimen(); $numExample = $this->getNextValue($thirdparty, $delivery); if (!$numExample) { $numExample = $langs->trans('NotConfigured'); } return $numExample; } /** * Return next free value * * @param Societe $objsoc Object thirdparty * @param Delivery $object Object we need next value for * @return string|int<-1,0> Value if OK, 0 or -1 if KO */ public function getNextValue($objsoc, $object) { global $db; require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php'; // On defini critere recherche compteur $mask = getDolGlobalString('DELIVERY_SAPHIR_MASK'); if (!$mask) { $this->error = 'NotConfigured'; return 0; } $numFinal = get_next_value($db, $mask, 'delivery', 'ref', '', $objsoc, $object->delivery_date); return $numFinal; } /** * Return next free value * * @param Societe $objsoc Object third party * @param Delivery $objforref Object for number to search * @return string|int<-1,0> Next free value, 0 if KO * @deprecated see getNextValue */ public function getNumRef($objsoc, $objforref) { return $this->getNextValue($objsoc, $objforref); } }