dolibarr  17.0.4
modules_bom.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2003-2004 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2011 Laurent Destailleur <eldy@users.sourceforge.net>
4  * Copyright (C) 2004 Eric Seigne <eric.seigne@ryxeo.com>
5  * Copyright (C) 2005-2012 Regis Houssin <regis.houssin@inodbox.com>
6  * Copyright (C) 2006 Andre Cianfarani <acianfa@free.fr>
7  * Copyright (C) 2012 Juanjo Menent <jmenent@2byte.es>
8  * Copyright (C) 2014 Marcos García <marcosgdf@gmail.com>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <https://www.gnu.org/licenses/>.
22  * or see https://www.gnu.org/
23  */
24 
32 require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
33 require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php'; // required for use by classes that inherit
34 
35 
39 abstract class ModelePDFBom extends CommonDocGenerator
40 {
41 
42  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
50  public static function liste_modeles($db, $maxfilenamelength = 0)
51  {
52  // phpcs:enable
53  global $conf;
54 
55  $type = 'bom';
56  $list = array();
57 
58  include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
59  $list = getListOfModels($db, $type, $maxfilenamelength);
60 
61  return $list;
62  }
63 }
64 
65 
66 
70 abstract class ModeleNumRefBoms
71 {
75  public $error = '';
76 
82  public function isEnabled()
83  {
84  return true;
85  }
86 
92  public function info()
93  {
94  global $langs;
95  $langs->load("mrp");
96  return $langs->trans("NoDescription");
97  }
98 
104  public function getExample()
105  {
106  global $langs;
107  $langs->load("mrp");
108  return $langs->trans("NoExample");
109  }
110 
117  public function canBeActivated()
118  {
119  return true;
120  }
121 
129  public function getNextValue($objsoc, $object)
130  {
131  global $langs;
132  return $langs->trans("NotAvailable");
133  }
134 
140  public function getVersion()
141  {
142  global $langs;
143  $langs->load("admin");
144 
145  if ($this->version == 'development') {
146  return $langs->trans("VersionDevelopment");
147  }
148  if ($this->version == 'experimental') {
149  return $langs->trans("VersionExperimental");
150  }
151  if ($this->version == 'dolibarr') {
152  return DOL_VERSION;
153  }
154  if ($this->version) {
155  return $this->version;
156  }
157  return $langs->trans("NotAvailable");
158  }
159 }
Parent class for documents generators.
Parent class to manage numbering of BOMs.
Definition: modules_bom.php:71
isEnabled()
Return if a module can be used or not.
Definition: modules_bom.php:82
getVersion()
Returns version of numbering module.
getNextValue($objsoc, $object)
Returns next assigned value.
info()
Returns the default description of the numbering template.
Definition: modules_bom.php:92
canBeActivated()
Checks if the numbers already in the database do not cause conflicts that would prevent this numberin...
getExample()
Returns an example of numbering.
Parent class for boms models.
Definition: modules_bom.php:40
static liste_modeles($db, $maxfilenamelength=0)
Return list of active generation modules.
Definition: modules_bom.php:50
getListOfModels($db, $type, $maxfilenamelength=0)
Return list of activated modules usable for document generation.