* 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/project/mod_project_universal.php * \ingroup project * \brief File containing the Universal project reference numbering model class */ require_once DOL_DOCUMENT_ROOT.'/core/modules/project/modules_project.php'; /** * Class to manage the numbering module Universal for project references */ class mod_project_universal extends ModeleNumRefProjects { /** * @var DoliDB $db */ public $db; /** * 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 code (or message) */ public $error = ''; /** * @var string Nom du modele * @deprecated * @see $name */ public $nom = 'Universal'; /** * @var string model name */ public $name = 'Universal'; /** * 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; // Load translation files required by the page $langs->loadLangs(array("projects", "admin")); $form = new Form($this->db); $texte = $langs->trans('GenericNumRefModelDesc')."
\n"; $texte .= ''; return $texte; } /** * Return an example of numbering * * @return string Example */ public function getExample() { global $db, $langs; require_once DOL_DOCUMENT_ROOT . '/projet/class/project.class.php'; require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php'; $project = new Project($db); $project->initAsSpecimen(); $thirdparty = new Societe($db); $thirdparty->initAsSpecimen(); $numExample = $this->getNextValue($thirdparty, $project); if (!$numExample) { $numExample = $langs->trans('NotConfigured'); } return $numExample; } /** * Return next value * * @param ?Societe $objsoc Object third party * @param Project $project Object project * @return string|int<-1,0> Value if OK, 0 if KO */ public function getNextValue($objsoc, $project) { global $db, $langs; require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php'; // We define criterion search counter $mask = getDolGlobalString('PROJECT_UNIVERSAL_MASK'); if (!$mask) { $this->error = $langs->trans('NotConfigured'); return 0; } // Get entities $entity = getEntity('projectnumber', 1, $project); $date = (empty($project->date_c) ? dol_now() : $project->date_c); $numFinal = get_next_value($db, $mask, 'projet', 'ref', '', (is_object($objsoc) ? $objsoc : ''), $date, 'next', false, null, $entity); return $numFinal; } }