dolibarr 18.0.6
modules_chequereceipts.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2003-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3 * Copyright (C) 2004-2009 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) 2016 Juanjo Menent <jmenent@2byte.es>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 * or see https://www.gnu.org/
21 */
22
29require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
30require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
31require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php'; // Requis car utilise dans les classes qui heritent
32
38{
42 public $error = '';
43
49 public function isEnabled()
50 {
51 return true;
52 }
53
59 public function info()
60 {
61 global $langs;
62 $langs->load("bills");
63 return $langs->trans("NoDescription");
64 }
65
71 public function getExample()
72 {
73 global $langs;
74 $langs->load("bills");
75 return $langs->trans("NoExample");
76 }
77
84 public function canBeActivated()
85 {
86 return true;
87 }
88
96 public function getNextValue($objsoc, $object)
97 {
98 global $langs;
99 return $langs->trans("NotAvailable");
100 }
101
107 public function getVersion()
108 {
109 global $langs;
110 $langs->load("admin");
111
112 if ($this->version == 'development') {
113 return $langs->trans("VersionDevelopment");
114 }
115 if ($this->version == 'experimental') {
116 return $langs->trans("VersionExperimental");
117 }
118 if ($this->version == 'dolibarr') {
119 return DOL_VERSION;
120 }
121 if ($this->version) {
122 return $this->version;
123 }
124 return $langs->trans("NotAvailable");
125 }
126}
127
132{
136 public $error = '';
137
138 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
146 public static function liste_modeles($db, $maxfilenamelength = 0)
147 {
148 // phpcs:enable
149 $type = 'chequereceipt';
150 $list = array();
151
152 include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
153 $list = getListOfModels($db, $type, $maxfilenamelength);
154 // TODO Remove this to use getListOfModels only
155 $list = array('blochet'=>'blochet');
156
157 return $list;
158 }
159}
160
161
173function chequereceipt_pdf_create($db, $id, $message, $modele, $outputlangs)
174{
175 global $conf, $langs;
176 $langs->load("bills");
177
178 $dir = DOL_DOCUMENT_ROOT."/core/modules/cheque/doc/";
179
180 // Positionne modele sur le nom du modele a utiliser
181 if (!dol_strlen($modele)) {
182 if (!empty($conf->global->CHEQUERECEIPT_ADDON_PDF)) {
183 $modele = $conf->global->CHEQUERECEIPT_ADDON_PDF;
184 } else {
185 //print $langs->trans("Error")." ".$langs->trans("Error_FACTURE_ADDON_PDF_NotDefined");
186 //return 0;
187 $modele = 'blochet';
188 }
189 }
190
191 // Charge le modele
192 $file = "pdf_".$modele.".modules.php";
193 if (file_exists($dir.$file)) {
194 $classname = "pdf_".$modele;
195 require_once $dir.$file;
196
197 $obj = new $classname($db);
198
199 // We save charset_output to restore it because write_file can change it if needed for
200 // output format that does not support UTF8.
201 $sav_charset_output = $outputlangs->charset_output;
202 if ($obj->write_file($id, $outputlangs) > 0) {
203 $outputlangs->charset_output = $sav_charset_output;
204 return 1;
205 } else {
206 $outputlangs->charset_output = $sav_charset_output;
207 dol_print_error($db, "chequereceipt_pdf_create Error: ".$obj->error);
208 return -1;
209 }
210 } else {
211 dol_print_error('', $langs->trans("Error")." ".$langs->trans("ErrorFileDoesNotExists", $dir.$file));
212 return -1;
213 }
214}
Parent class for documents generators.
Class parent for templates of document generation.
static liste_modeles($db, $maxfilenamelength=0)
Return list of active generation modules.
Cheque Receipts numbering references mother class.
getExample()
Return numbering example.
canBeActivated()
Checks if the numbers already in the database do not cause conflicts that would prevent this numberin...
getNextValue($objsoc, $object)
Returns the next value.
isEnabled()
Return if a module can be used or not.
getVersion()
Returns the module numbering version.
info()
Return the default description of numbering module.
getListOfModels($db, $type, $maxfilenamelength=0)
Return list of activated modules usable for document generation.
dol_print_error($db='', $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
dol_strlen($string, $stringencoding='UTF-8')
Make a strlen call.
chequereceipt_pdf_create($db, $id, $message, $modele, $outputlangs)
Cree un bordereau remise de cheque.