dolibarr  19.0.0-dev
modules_don.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2003-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2008 Laurent Destailleur <eldy@users.sourceforge.net>
4  * Copyright (C) 2004 Eric Seigne <eric.seigne@ryxeo.com>
5  * Copyright (C) 2005 Regis Houssin <regis.houssin@inodbox.com>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <https://www.gnu.org/licenses/>.
19  * or see https://www.gnu.org/
20  */
21 
27 require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
28 require_once DOL_DOCUMENT_ROOT.'/don/class/don.class.php';
29 
30 
31 
35 abstract class ModeleDon extends CommonDocGenerator
36 {
40  public $error = '';
41 
42  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
50  public static function liste_modeles($db, $maxfilenamelength = 0)
51  {
52  // phpcs:enable
53  $type = 'donation';
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 
67 abstract class ModeleNumRefDons
68 {
72  public $error = '';
73 
79  public function isEnabled()
80  {
81  return true;
82  }
83 
89  public function info()
90  {
91  global $langs;
92  $langs->load("bills");
93  return $langs->trans("NoDescription");
94  }
95 
101  public function getExample()
102  {
103  global $langs;
104  $langs->load("bills");
105  return $langs->trans("NoExample");
106  }
107 
114  public function canBeActivated()
115  {
116  return true;
117  }
118 
124  public function getNextValue()
125  {
126  global $langs;
127  return $langs->trans("NotAvailable");
128  }
129 
135  public function getVersion()
136  {
137  global $langs;
138  $langs->load("admin");
139 
140  if ($this->version == 'development') {
141  return $langs->trans("VersionDevelopment");
142  }
143  if ($this->version == 'experimental') {
144  return $langs->trans("VersionExperimental");
145  }
146  if ($this->version == 'dolibarr') {
147  return DOL_VERSION;
148  }
149  if ($this->version) {
150  return $this->version;
151  }
152  return $langs->trans("NotAvailable");
153  }
154 }
Parent class for documents generators.
Parent class of subscription templates.
Definition: modules_don.php:36
static liste_modeles($db, $maxfilenamelength=0)
Return list of active generation modules.
Definition: modules_don.php:50
Parent class of donation numbering templates.
Definition: modules_don.php:68
canBeActivated()
Checks if the numbers already in the database do not cause conflicts that would prevent this numberin...
isEnabled()
Return if a module can be used or not.
Definition: modules_don.php:79
getVersion()
Renvoi version du module numerotation.
getExample()
Return an example of numbering.
getNextValue()
Renvoi prochaine valeur attribuee.
info()
Returns the default description of the numbering pattern.
Definition: modules_don.php:89
getListOfModels($db, $type, $maxfilenamelength=0)
Return list of activated modules usable for document generation.