dolibarr  19.0.0-dev
modules_myobject.php
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-2012 Regis Houssin <regis.houssin@inodbox.com>
6  * Copyright (C) 2006 Andre Cianfarani <acianfa@free.fr>
7  * Copyright (C) 2012 Juanjo Menent <jmenent@2byte.es>
8  * Copyright (C) 2014 Marcos GarcĂ­a <marcosgdf@gmail.com>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <https://www.gnu.org/licenses/>.
22  * or see https://www.gnu.org/
23  */
24 
31 require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
32 require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php'; // required for use by classes that inherit
33 
34 
38 abstract class ModelePDFMyObject extends CommonDocGenerator
39 {
40 
44  public $page_largeur;
45 
49  public $page_hauteur;
50 
54  public $format;
55 
59  public $marge_gauche;
60 
64  public $marge_droite;
65 
69  public $marge_haute;
70 
74  public $marge_basse;
75 
76 
77  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
85  public static function liste_modeles($db, $maxfilenamelength = 0)
86  {
87  // phpcs:enable
88  global $conf;
89 
90  $type = 'myobject';
91  $list = array();
92 
93  include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
94  $list = getListOfModels($db, $type, $maxfilenamelength);
95 
96  return $list;
97  }
98 }
99 
100 
101 
105 abstract class ModeleNumRefMyObject
106 {
110  public $error = '';
111 
117  public function isEnabled()
118  {
119  return true;
120  }
121 
127  public function info()
128  {
129  global $langs;
130  $langs->load("mymodule@mymodule");
131  return $langs->trans("NoDescription");
132  }
133 
139  public function getExample()
140  {
141  global $langs;
142  $langs->load("mymodule@mymodule");
143  return $langs->trans("NoExample");
144  }
145 
153  public function canBeActivated($object)
154  {
155  return true;
156  }
157 
164  public function getNextValue($object)
165  {
166  global $langs;
167  return $langs->trans("NotAvailable");
168  }
169 
175  public function getVersion()
176  {
177  global $langs;
178  $langs->load("admin");
179 
180  if ($this->version == 'development') {
181  return $langs->trans("VersionDevelopment");
182  }
183  if ($this->version == 'experimental') {
184  return $langs->trans("VersionExperimental");
185  }
186  if ($this->version == 'dolibarr') {
187  return DOL_VERSION;
188  }
189  if ($this->version) {
190  return $this->version;
191  }
192  return $langs->trans("NotAvailable");
193  }
194 }
ModeleNumRefMyObject\isEnabled
isEnabled()
Return if a module can be used or not.
Definition: modules_myobject.php:117
ModeleNumRefMyObject\info
info()
Returns the default description of the numbering template.
Definition: modules_myobject.php:127
ModeleNumRefMyObject
Parent class to manage numbering of MyObject.
Definition: modules_myobject.php:105
ModelePDFMyObject
Parent class for documents models.
Definition: modules_myobject.php:38
ModeleNumRefMyObject\canBeActivated
canBeActivated($object)
Checks if the numbers already in the database do not cause conflicts that would prevent this numberin...
Definition: modules_myobject.php:153
ModeleNumRefMyObject\getNextValue
getNextValue($object)
Returns next assigned value.
Definition: modules_myobject.php:164
ModelePDFMyObject\liste_modeles
static liste_modeles($db, $maxfilenamelength=0)
Return list of active generation modules.
Definition: modules_myobject.php:85
ModeleNumRefMyObject\getVersion
getVersion()
Returns version of numbering module.
Definition: modules_myobject.php:175
getListOfModels
getListOfModels($db, $type, $maxfilenamelength=0)
Return list of activated modules usable for document generation.
Definition: functions2.lib.php:1925
CommonDocGenerator
Parent class for documents generators.
Definition: commondocgenerator.class.php:36
ModeleNumRefMyObject\getExample
getExample()
Returns an example of numbering.
Definition: modules_myobject.php:139