dolibarr  18.0.0-alpha
modules_holiday.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  * Copyright (C) 2018 Charlene Benke <charlie@patas-monkey.com>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <https://www.gnu.org/licenses/>.
24  * or see https://www.gnu.org/
25  */
26 
33  require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
34 
35 
39 abstract class ModelePDFHoliday extends CommonDocGenerator
40 {
44  public $error = '';
45 
46 
47  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
55  public static function liste_modeles($db, $maxfilenamelength = 0)
56  {
57  // phpcs:enable
58  $type = 'holiday';
59  $list = array();
60 
61  include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
62  $list = getListOfModels($db, $type, $maxfilenamelength);
63 
64  return $list;
65  }
66 }
67 
68 
73 {
77  public $error = '';
78 
84  public function isEnabled()
85  {
86  return true;
87  }
88 
94  public function info()
95  {
96  global $langs;
97  $langs->load("holiday");
98  return $langs->trans("NoDescription");
99  }
100 
106  public function getExample()
107  {
108  global $langs;
109  $langs->load("holiday");
110  return $langs->trans("NoExample");
111  }
112 
118  public function canBeActivated()
119  {
120  return true;
121  }
122 
130  public function getNextValue($objsoc, $holiday)
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  } elseif ($this->version == 'experimental') {
149  return $langs->trans("VersionExperimental");
150  } elseif ($this->version == 'dolibarr') {
151  return DOL_VERSION;
152  } elseif ($this->version) {
153  return $this->version;
154  } else {
155  return $langs->trans("NotAvailable");
156  }
157  }
158 }
ModelNumRefHolidays\getExample
getExample()
Return numbering example.
Definition: modules_holiday.php:106
ModelNumRefHolidays\canBeActivated
canBeActivated()
Test if existing numbers make problems with numbering.
Definition: modules_holiday.php:118
ModelNumRefHolidays\getVersion
getVersion()
Return numbering version module.
Definition: modules_holiday.php:141
ModelePDFHoliday
Parent class to manage holidays document templates.
Definition: modules_holiday.php:39
ModelePDFHoliday\liste_modeles
static liste_modeles($db, $maxfilenamelength=0)
Return list of active generation modules.
Definition: modules_holiday.php:55
ModelNumRefHolidays\info
info()
Return default description of numbering model.
Definition: modules_holiday.php:94
ModelNumRefHolidays
Parent class for all holidays numbering modules.
Definition: modules_holiday.php:72
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
ModelNumRefHolidays\isEnabled
isEnabled()
Return if a module can be used or not.
Definition: modules_holiday.php:84
ModelNumRefHolidays\getNextValue
getNextValue($objsoc, $holiday)
Return next value.
Definition: modules_holiday.php:130