dolibarr  17.0.4
modules_contract.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2003-2004 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2007 Laurent Destailleur <eldy@users.sourceforge.net>
4  * Copyright (C) 2004 Eric Seigne <eric.seigne@ryxeo.com>
5  * Copyright (C) 2005-2009 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) 2013 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 
34 
38 abstract class ModelePDFContract extends CommonDocGenerator
39 {
43  public $error = '';
44 
45 
46  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
54  public static function liste_modeles($db, $maxfilenamelength = 0)
55  {
56  // phpcs:enable
57  global $conf;
58 
59  $type = 'contract';
60  $list = array();
61 
62  include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
63  $list = getListOfModels($db, $type, $maxfilenamelength);
64 
65  return $list;
66  }
67 }
68 
69 
74 {
78  public $error = '';
79 
85  public function isEnabled()
86  {
87  return true;
88  }
89 
95  public function info()
96  {
97  global $langs;
98  $langs->load("contracts");
99  return $langs->trans("NoDescription");
100  }
101 
107  public function getExample()
108  {
109  global $langs;
110  $langs->load("contracts");
111  return $langs->trans("NoExample");
112  }
113 
119  public function canBeActivated()
120  {
121  return true;
122  }
123 
131  public function getNextValue($objsoc, $contract)
132  {
133  global $langs;
134  return $langs->trans("NotAvailable");
135  }
136 
142  public function getVersion()
143  {
144  global $langs;
145  $langs->load("admin");
146 
147  if ($this->version == 'development') {
148  return $langs->trans("VersionDevelopment");
149  }
150  if ($this->version == 'experimental') {
151  return $langs->trans("VersionExperimental");
152  }
153  if ($this->version == 'dolibarr') {
154  return DOL_VERSION;
155  }
156  if ($this->version) {
157  return $this->version;
158  }
159  return $langs->trans("NotAvailable");
160  }
161 }
Parent class for documents generators.
Parent class for all contract numbering modules.
getExample()
Return numbering example.
getNextValue($objsoc, $contract)
Return next value.
getVersion()
Return numbering version module.
canBeActivated()
Test if existing numbers make problems with numbering.
info()
Return default description of numbering model.
isEnabled()
Return if a module can be used or not.
Parent class to manage intervention document templates.
static liste_modeles($db, $maxfilenamelength=0)
Return list of active generation modules.
getListOfModels($db, $type, $maxfilenamelength=0)
Return list of activated modules usable for document generation.