dolibarr 20.0.0
chequereceipts.php
1<?php
2/* Copyright (C) 2009 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2010-2016 Juanjo Menent <jmenent@2byte.es>
4 * Copyright (C) 2013-2018 Philippe Grand <philippe.grand@atoo-net.com>
5 * Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
6 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
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 */
21
22
29// Load Dolibarr environment
30require '../main.inc.php';
31require_once DOL_DOCUMENT_ROOT.'/core/lib/admin.lib.php';
32require_once DOL_DOCUMENT_ROOT.'/core/lib/pdf.lib.php';
33require_once DOL_DOCUMENT_ROOT.'/core/lib/bank.lib.php';
34require_once DOL_DOCUMENT_ROOT.'/compta/paiement/cheque/class/remisecheque.class.php';
35
36// Load translation files required by the page
37$langs->loadLangs(array("admin", "companies", "bills", "other", "banks"));
38
39if (!$user->admin) {
41}
42
43$action = GETPOST('action', 'aZ09');
44$value = GETPOST('value', 'alpha');
45
46
47if (!getDolGlobalString('CHEQUERECEIPTS_ADDON')) {
48 $conf->global->CHEQUERECEIPTS_ADDON = 'mod_chequereceipts_mint.php';
49}
50
51
52
53/*
54 * Actions
55 */
56
57if ($action == 'updateMask') {
58 $maskconstchequereceipts = GETPOST('maskconstchequereceipts', 'aZ09');
59 $maskchequereceipts = GETPOST('maskchequereceipts', 'alpha');
60 if ($maskconstchequereceipts && preg_match('/_MASK$/', $maskconstchequereceipts)) {
61 $res = dolibarr_set_const($db, $maskconstchequereceipts, $maskchequereceipts, 'chaine', 0, '', $conf->entity);
62 }
63
64 if (!($res > 0)) {
65 $error++;
66 }
67
68 if (!$error) {
69 setEventMessages($langs->trans("SetupSaved"), null, 'mesgs');
70 } else {
71 setEventMessages($langs->trans("Error"), null, 'errors');
72 }
73}
74
75if ($action == 'setmod') {
76 dolibarr_set_const($db, "CHEQUERECEIPTS_ADDON", $value, 'chaine', 0, '', $conf->entity);
77}
78
79if ($action == 'set_BANK_CHEQUERECEIPT_FREE_TEXT') {
80 $freetext = GETPOST('BANK_CHEQUERECEIPT_FREE_TEXT', 'restricthtml'); // No alpha here, we want exact string
81
82 $res = dolibarr_set_const($db, "BANK_CHEQUERECEIPT_FREE_TEXT", $freetext, 'chaine', 0, '', $conf->entity);
83
84 if (!($res > 0)) {
85 $error++;
86 }
87
88 if (!$error) {
89 setEventMessages($langs->trans("SetupSaved"), null, 'mesgs');
90 } else {
91 setEventMessages($langs->trans("Error"), null, 'errors');
92 }
93}
94
95/*
96 * View
97 */
98
99$dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);
100llxHeader("", $langs->trans("BankSetupModule"), '', '', 0, 0, '', '', '', 'mod-admin page-chequereceipts');
101
102$form = new Form($db);
103
104$linkback = '<a href="'.DOL_URL_ROOT.'/admin/modules.php?restore_lastsearch_values=1">'.$langs->trans("BackToModuleList").'</a>';
105print load_fiche_titre($langs->trans("BankSetupModule"), $linkback, 'title_setup');
106
107$head = bank_admin_prepare_head(null);
108print dol_get_fiche_head($head, 'checkreceipts', $langs->trans("BankSetupModule"), -1, 'account');
109
110/*
111 * Numbering module
112 */
113
114print load_fiche_titre($langs->trans("ChequeReceiptsNumberingModule"), '', '');
115
116print '<div class="div-table-responsive-no-min">';
117print '<table class="noborder centpercent">';
118print '<tr class="liste_titre">';
119print '<td>'.$langs->trans("Name").'</td>';
120print '<td>'.$langs->trans("Description").'</td>';
121print '<td class="nowrap">'.$langs->trans("Example").'</td>';
122print '<td class="center" width="60">'.$langs->trans("Status").'</td>';
123print '<td class="center" width="16">'.$langs->trans("ShortInfo").'</td>';
124print '</tr>'."\n";
125
126clearstatcache();
127
128foreach ($dirmodels as $reldir) {
129 $dir = dol_buildpath($reldir."core/modules/cheque/");
130 if (is_dir($dir)) {
131 $handle = opendir($dir);
132 if (is_resource($handle)) {
133 while (($file = readdir($handle)) !== false) {
134 if (!is_dir($dir.$file) || (substr($file, 0, 1) != '.' && substr($file, 0, 3) != 'CVS')) {
135 $filebis = $file;
136 $name = substr($file, 4, dol_strlen($file) - 16);
137 $classname = preg_replace('/\.php$/', '', $file);
138 // For compatibility
139 if (!is_file($dir.$filebis)) {
140 $filebis = $file."/".$file.".modules.php";
141 $classname = "mod_chequereceipt_".$file;
142 }
143 // Check if there is a filter on country
144 preg_match('/\-(.*)_(.*)$/', $classname, $reg);
145 if (!empty($reg[2]) && $reg[2] != strtoupper($mysoc->country_code)) {
146 continue;
147 }
148
149 $classname = preg_replace('/\-.*$/', '', $classname);
150 if (!class_exists($classname) && is_readable($dir.$filebis) && (preg_match('/mod_/', $filebis) || preg_match('/mod_/', $classname)) && substr($filebis, dol_strlen($filebis) - 3, 3) == 'php') {
151 // Charging the numbering class
152 require_once $dir.$filebis;
153
154 $module = new $classname($db);
155 '@phan-var-force ModeleNumRefChequeReceipts $module';
156
157 // Show modules according to features level
158 if ($module->version == 'development' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 2) {
159 continue;
160 }
161 if ($module->version == 'experimental' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 1) {
162 continue;
163 }
164
165 if ($module->isEnabled()) {
166 print '<tr class="oddeven"><td width="100">';
167 print(empty($module->name) ? $name : $module->name);
168 print "</td><td>\n";
169
170 print $module->info($langs);
171
172 print '</td>';
173
174 // Show example of numbering module
175 print '<td class="nowrap">';
176 $tmp = $module->getExample();
177 if (preg_match('/^Error/', $tmp)) {
178 $langs->load("errors");
179 print '<div class="error">'.$langs->trans($tmp).'</div>';
180 } elseif ($tmp == 'NotConfigured') {
181 print '<span class="opacitymedium">'.$langs->trans($tmp).'</span>';
182 } else {
183 print $tmp;
184 }
185 print '</td>'."\n";
186
187 print '<td class="center">';
188 if ($conf->global->CHEQUERECEIPTS_ADDON == $file || getDolGlobalString('CHEQUERECEIPTS_ADDON') . '.php' == $file) {
189 print img_picto($langs->trans("Activated"), 'switch_on');
190 } else {
191 print '<a class="reposition" href="'.$_SERVER["PHP_SELF"].'?action=setmod&token='.newToken().'&value='.preg_replace('/\.php$/', '', $file).'&label='.urlencode($module->name).'" alt="'.$langs->trans("Default").'">'.img_picto($langs->trans("Disabled"), 'switch_off').'</a>';
192 }
193 print '</td>';
194
195 $chequereceipts = new RemiseCheque($db);
196 $chequereceipts->initAsSpecimen();
197
198 // Example
199 $htmltooltip = '';
200 $htmltooltip .= ''.$langs->trans("Version").': <b>'.$module->getVersion().'</b><br>';
201 $nextval = $module->getNextValue($mysoc, $chequereceipts);
202 if ("$nextval" != $langs->trans("NotAvailable")) { // Keep " on nextval
203 $htmltooltip .= $langs->trans("NextValue").': ';
204 if ($nextval) {
205 if (preg_match('/^Error/', $nextval) || $nextval == 'NotConfigured') {
206 $nextval = $langs->trans($nextval);
207 }
208 $htmltooltip .= $nextval.'<br>';
209 } else {
210 $htmltooltip .= $langs->trans($module->error).'<br>';
211 }
212 }
213
214 print '<td class="center">';
215 print $form->textwithpicto('', $htmltooltip, 1, 0);
216
217 if (getDolGlobalString('CHEQUERECEIPTS_ADDON').'.php' == $file) { // If module is the one used, we show existing errors
218 if (!empty($module->error)) {
219 dol_htmloutput_mesg($module->error, '', 'error', 1);
220 }
221 }
222
223 print '</td>';
224
225 print "</tr>\n";
226 }
227 }
228 }
229 }
230 closedir($handle);
231 }
232 }
233}
234
235print '</table>';
236print '</div>';
237
238print '<br>';
239
240
241/*
242 * Other options
243 */
244print load_fiche_titre($langs->trans("OtherOptions"), '', '');
245
246print '<form action="'.$_SERVER["PHP_SELF"].'" method="post">';
247print '<input type="hidden" name="token" value="'.newToken().'">';
248print '<input type="hidden" name="action" value="set_BANK_CHEQUERECEIPT_FREE_TEXT">';
249
250print '<table class="noborder centpercent">';
251print '<tr class="liste_titre">';
252print '<td>'.$langs->trans("Parameters").'</td>';
253print '<td class="center" width="60">&nbsp;</td>';
254print '<td width="80">&nbsp;</td>';
255print "</tr>\n";
256
257$substitutionarray = pdf_getSubstitutionArray($langs, null, null, 2);
258$substitutionarray['__(AnyTranslationKey)__'] = $langs->trans("Translation");
259$htmltext = '<i>'.$langs->trans("AvailableVariables").':<br>';
260foreach ($substitutionarray as $key => $val) {
261 $htmltext .= $key.'<br>';
262}
263$htmltext .= '</i>';
264
265print '<tr class="oddeven"><td colspan="2">';
266print $form->textwithpicto($langs->trans("FreeLegalTextOnChequeReceipts"), $langs->trans("AddCRIfTooLong").'<br><br>'.$htmltext, 1, 'help', '', 0, 2, 'freetexttooltip').'<br>';
267$variablename = 'BANK_CHEQUERECEIPT_FREE_TEXT';
268if (!getDolGlobalString('PDF_ALLOW_HTML_FOR_FREE_TEXT')) {
269 print '<textarea name="'.$variablename.'" class="flat" cols="120">'.getDolGlobalString($variablename).'</textarea>';
270} else {
271 include_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php';
272 $doleditor = new DolEditor($variablename, getDolGlobalString($variablename), '', 80, 'dolibarr_notes');
273 print $doleditor->Create();
274}
275print '</td><td class="right">';
276print '<input type="submit" class="button button-edit" value="'.$langs->trans("Modify").'">';
277print "</td></tr>\n";
278print '</table>';
279print "<br>";
280
281print '</table>'."\n";
282
283print dol_get_fiche_end();
284
285print '</form>';
286
287// End of page
288llxFooter();
289$db->close();
dolibarr_set_const($db, $name, $value, $type='chaine', $visible=0, $note='', $entity=1)
Insert a parameter (key,value) into database (delete old key then insert it again).
if(!defined('NOREQUIRESOC')) if(!defined( 'NOREQUIRETRAN')) if(!defined('NOTOKENRENEWAL')) if(!defined( 'NOREQUIREMENU')) if(!defined('NOREQUIREHTML')) if(!defined( 'NOREQUIREAJAX')) llxHeader()
Empty header.
Definition wrapper.php:55
llxFooter()
Empty footer.
Definition wrapper.php:69
bank_admin_prepare_head($object)
Prepare array with list of tabs.
Definition bank.lib.php:134
Class to manage a WYSIWYG editor.
Class to manage generation of HTML components Only common components must be here.
Class to manage cheque delivery receipts.
load_fiche_titre($title, $morehtmlright='', $picto='generic', $pictoisfullpath=0, $id='', $morecssontable='', $morehtmlcenter='')
Load a title with picto.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
dol_get_fiche_head($links=array(), $active='', $title='', $notab=0, $picto='', $pictoisfullpath=0, $morehtmlright='', $morecss='', $limittoshow=0, $moretabssuffix='', $dragdropfile=0)
Show tabs of a record.
dol_get_fiche_end($notab=0)
Return tab footer of a card.
dol_strlen($string, $stringencoding='UTF-8')
Make a strlen call.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
newToken()
Return the value of token currently saved into session with name 'newtoken'.
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
Return value of a param into GET or POST supervariable.
setEventMessages($mesg, $mesgs, $style='mesgs', $messagekey='', $noduplicate=0)
Set event messages in dol_events session object.
dol_buildpath($path, $type=0, $returnemptyifnotfound=0)
Return path of url or filesystem.
dol_htmloutput_mesg($mesgstring='', $mesgarray=array(), $style='ok', $keepembedded=0)
Print formatted messages to output (Used to show messages on html output).
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
pdf_getSubstitutionArray($outputlangs, $exclude=null, $object=null, $onlykey=0, $include=null)
Return array of possible substitutions for PDF content (without external module substitutions).
Definition pdf.lib.php:769
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:140
accessforbidden($message='', $printheader=1, $printfooter=1, $showonlymessage=0, $params=null)
Show a message to say access is forbidden and stop program.