dolibarr  19.0.0-dev
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  $type = 'bom';
54  $list = array();
55 
56  include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
57  $list = getListOfModels($db, $type, $maxfilenamelength);
58 
59  return $list;
60  }
61 }
62 
63 
64 
68 abstract class ModeleNumRefBoms
69 {
73  public $error = '';
74 
80  public function isEnabled()
81  {
82  return true;
83  }
84 
90  public function info()
91  {
92  global $langs;
93  $langs->load("mrp");
94  return $langs->trans("NoDescription");
95  }
96 
102  public function getExample()
103  {
104  global $langs;
105  $langs->load("mrp");
106  return $langs->trans("NoExample");
107  }
108 
115  public function canBeActivated()
116  {
117  return true;
118  }
119 
127  public function getNextValue($objsoc, $object)
128  {
129  global $langs;
130  return $langs->trans("NotAvailable");
131  }
132 
138  public function getVersion()
139  {
140  global $langs;
141  $langs->load("admin");
142 
143  if ($this->version == 'development') {
144  return $langs->trans("VersionDevelopment");
145  }
146  if ($this->version == 'experimental') {
147  return $langs->trans("VersionExperimental");
148  }
149  if ($this->version == 'dolibarr') {
150  return DOL_VERSION;
151  }
152  if ($this->version) {
153  return $this->version;
154  }
155  return $langs->trans("NotAvailable");
156  }
157 }
Parent class for documents generators.
Parent class to manage numbering of BOMs.
Definition: modules_bom.php:69
isEnabled()
Return if a module can be used or not.
Definition: modules_bom.php:80
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:90
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.