dolibarr 18.0.6
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 $type = 'shipping';
57 $list = array();
58
59 include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
60 $list = getListOfModels($db, $type, $maxfilenamelength);
61
62 return $list;
63 }
64}
65
66
71{
75 public $error = '';
76
77 public $version;
78
79
84 public function isEnabled()
85 {
86 return true;
87 }
88
94 public function info()
95 {
96 global $langs;
97 $langs->load("sendings");
98 return $langs->trans("NoDescription");
99 }
100
106 public function getExample()
107 {
108 global $langs;
109 $langs->load("sendings");
110 return $langs->trans("NoExample");
111 }
112
118 public function canBeActivated()
119 {
120 return true;
121 }
122
130 public function getNextValue($objsoc, $shipment)
131 {
132 global $langs;
133 return $langs->trans("NotAvailable");
134 }
135
141 public function getVersion()
142 {
143 global $langs;
144 $langs->load("admin");
145
146 if ($this->version == 'development') {
147 return $langs->trans("VersionDevelopment");
148 }
149 if ($this->version == 'experimental') {
150 return $langs->trans("VersionExperimental");
151 }
152 if ($this->version == 'dolibarr') {
153 return DOL_VERSION;
154 }
155 if ($this->version) {
156 return $this->version;
157 }
158 return $langs->trans("NotAvailable");
159 }
160}
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.