dolibarr  17.0.4
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  global $conf;
54 
55  $type = 'donation';
56  $list = array();
57 
58  include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
59  $list = getListOfModels($db, $type, $maxfilenamelength);
60 
61  return $list;
62  }
63 }
64 
65 
69 abstract class ModeleNumRefDons
70 {
74  public $error = '';
75 
81  public function isEnabled()
82  {
83  return true;
84  }
85 
91  public function info()
92  {
93  global $langs;
94  $langs->load("bills");
95  return $langs->trans("NoDescription");
96  }
97 
103  public function getExample()
104  {
105  global $langs;
106  $langs->load("bills");
107  return $langs->trans("NoExample");
108  }
109 
116  public function canBeActivated()
117  {
118  return true;
119  }
120 
126  public function getNextValue()
127  {
128  global $langs;
129  return $langs->trans("NotAvailable");
130  }
131 
137  public function getVersion()
138  {
139  global $langs;
140  $langs->load("admin");
141 
142  if ($this->version == 'development') {
143  return $langs->trans("VersionDevelopment");
144  }
145  if ($this->version == 'experimental') {
146  return $langs->trans("VersionExperimental");
147  }
148  if ($this->version == 'dolibarr') {
149  return DOL_VERSION;
150  }
151  if ($this->version) {
152  return $this->version;
153  }
154  return $langs->trans("NotAvailable");
155  }
156 }
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:70
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:81
getVersion()
Renvoi version du module numerotation.
getExample()
Return an example of numbering.
getNextValue()
Renvoi prochaine valeur attribuee.
info()
Renvoi la description par defaut du modele de numerotation.
Definition: modules_don.php:91
getListOfModels($db, $type, $maxfilenamelength=0)
Return list of activated modules usable for document generation.