dolibarr  17.0.4
modules_expedition.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-2011 Regis Houssin <regis.houssin@inodbox.com>
6  * Copyright (C) 2006 Andre Cianfarani <acianfa@free.fr>
7  * Copyright (C) 2011 Juanjo Menent <jmenent@2byte.es>
8  * Copyright (C) 2011-2019 Philippe Grand <philippe.grand@atoo-net.com>
9  * Copyright (C) 2014 Marcos GarcĂ­a <marcosgdf@gmail.com>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <https://www.gnu.org/licenses/>.
23  * or see https://www.gnu.org/
24  */
25 
32  require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
33 
38 {
42  public $error = '';
43 
44 
45  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
53  public static function liste_modeles($db, $maxfilenamelength = 0)
54  {
55  // phpcs:enable
56  global $conf;
57 
58  $type = 'shipping';
59  $list = array();
60 
61  include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
62  $list = getListOfModels($db, $type, $maxfilenamelength);
63 
64  return $list;
65  }
66 }
67 
68 
72 abstract class ModelNumRefExpedition
73 {
77  public $error = '';
78 
83  public function isEnabled()
84  {
85  return true;
86  }
87 
93  public function info()
94  {
95  global $langs;
96  $langs->load("sendings");
97  return $langs->trans("NoDescription");
98  }
99 
105  public function getExample()
106  {
107  global $langs;
108  $langs->load("sendings");
109  return $langs->trans("NoExample");
110  }
111 
117  public function canBeActivated()
118  {
119  return true;
120  }
121 
129  public function getNextValue($objsoc, $shipment)
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 of numbering models of sending receipts references.
getVersion()
Returns version of the numbering model.
canBeActivated()
Test if existing numbers make problems with numbering.
info()
Return default description of numbering model.
isEnabled()
Return if a model can be used or not.
getExample()
Returns numbering example.
getNextValue($objsoc, $shipment)
Returns next value assigned.
Parent class of sending receipts models.
static liste_modeles($db, $maxfilenamelength=0)
Return list of active generation models.
getListOfModels($db, $type, $maxfilenamelength=0)
Return list of activated modules usable for document generation.