dolibarr 21.0.0-alpha
doc_generic_shipment_odt.modules.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2010-2012 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2012 Juanjo Menent <jmenent@2byte.es>
4 * Copyright (C) 2014 Marcos García <marcosgdf@gmail.com>
5 * Copyright (C) 2016 Charlie Benke <charlie@patas-monkey.com>
6 * Copyright (C) 2018-2021 Philippe Grand <philippe.grand@atoo-net.com>
7 * Copyright (C) 2018-2024 Frédéric France <frederic.france@free.fr>
8 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.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
31require_once DOL_DOCUMENT_ROOT.'/core/modules/expedition/modules_expedition.php';
32require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
33require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
34require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
35require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
36require_once DOL_DOCUMENT_ROOT.'/core/lib/doc.lib.php';
37
38
43{
48 public $version = 'dolibarr';
49
50
56 public function __construct($db)
57 {
58 global $conf, $langs, $mysoc;
59
60 // Load translation files required by the page
61 $langs->loadLangs(array("main", "companies"));
62
63 $this->db = $db;
64 $this->name = "ODT templates";
65 $this->description = $langs->trans("DocumentModelOdt");
66 $this->scandir = 'EXPEDITION_ADDON_PDF_ODT_PATH'; // Name of constant that is used to save list of directories to scan
67
68 // Page size for A4 format
69 $this->type = 'odt';
70 $this->page_largeur = 0;
71 $this->page_hauteur = 0;
72 $this->format = array($this->page_largeur, $this->page_hauteur);
73 $this->marge_gauche = 0;
74 $this->marge_droite = 0;
75 $this->marge_haute = 0;
76 $this->marge_basse = 0;
77
78 $this->option_logo = 1; // Display logo
79 $this->option_tva = 0; // Manage the vat option EXPEDITION_TVAOPTION
80 $this->option_modereg = 0; // Display payment mode
81 $this->option_condreg = 0; // Display payment terms
82 $this->option_multilang = 1; // Available in several languages
83 $this->option_escompte = 0; // Displays if there has been a discount
84 $this->option_credit_note = 0; // Support credit notes
85 $this->option_freetext = 1; // Support add of a personalised text
86 $this->option_draft_watermark = 0; // Support add of a watermark on drafts
87
88 // Get source company
89 $this->emetteur = $mysoc;
90 if (!$this->emetteur->country_code) {
91 $this->emetteur->country_code = substr($langs->defaultlang, -2); // By default if not defined
92 }
93 }
94
95
102 public function info($langs)
103 {
104 global $conf, $langs;
105
106 // Load translation files required by the page
107 $langs->loadLangs(array("errors", "companies"));
108
109 $form = new Form($this->db);
110
111 $texte = $this->description.".<br>\n";
112 $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
113 $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
114 $texte .= '<input type="hidden" name="page_y" value="">';
115 $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
116 $texte .= '<input type="hidden" name="param1" value="EXPEDITION_ADDON_PDF_ODT_PATH">';
117 $texte .= '<table class="nobordernopadding" width="100%">';
118
119 // List of directories area
120 $texte .= '<tr><td>';
121 $texttitle = $langs->trans("ListOfDirectories");
122 $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', trim($conf->global->EXPEDITION_ADDON_PDF_ODT_PATH)));
123 $listoffiles = array();
124 foreach ($listofdir as $key => $tmpdir) {
125 $tmpdir = trim($tmpdir);
126 $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
127 if (!$tmpdir) {
128 unset($listofdir[$key]);
129 continue;
130 }
131 if (!is_dir($tmpdir)) {
132 $texttitle .= img_warning($langs->trans("ErrorDirNotFound", $tmpdir), 0);
133 } else {
134 $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.(ods|odt)');
135 if (count($tmpfiles)) {
136 $listoffiles = array_merge($listoffiles, $tmpfiles);
137 }
138 }
139 }
140 $texthelp = $langs->trans("ListOfDirectoriesForModelGenODT");
141 $texthelp .= '<br><br><span class="opacitymedium">'.$langs->trans("ExampleOfDirectoriesForModelGen").'</span>';
142 // Add list of substitution keys
143 $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
144 $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
145
146 $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1, 3, $this->name);
147 $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
148 $texte .= '<textarea class="flat" cols="60" name="value1">';
149 $texte .= getDolGlobalString('EXPEDITION_ADDON_PDF_ODT_PATH');
150 $texte .= '</textarea>';
151 $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
152 $texte .= '<input type="submit" class="button button-edit reposition smallpaddingimp" name="modify" value="'.$langs->trans("Modify").'">';
153 $texte .= '<br></div></div>';
154
155 // Scan directories
156 $nbofiles = count($listoffiles);
157 if (getDolGlobalString('EXPEDITION_ADDON_PDF_ODT_PATH')) {
158 $texte .= $langs->trans("NumberOfModelFilesFound").': <b>';
159 //$texte.=$nbofiles?'<a id="a_'.get_class($this).'" href="#">':'';
160 $texte .= count($listoffiles);
161 //$texte.=$nbofiles?'</a>':'';
162 $texte .= '</b>';
163 }
164 if ($nbofiles) {
165 $texte .= '<div id="div_'.get_class($this).'" class="hiddenx">';
166 // Show list of found files
167 foreach ($listoffiles as $file) {
168 $texte .= '- '.$file['name'].' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=shipments/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
169 $texte .= ' &nbsp; <a class="reposition" href="'.$_SERVER["PHP_SELF"].'?modulepart=doctemplates&keyforuploaddir=EXPEDITION_ADDON_PDF_ODT_PATH&action=deletefile&token='.newToken().'&file='.urlencode(basename($file['name'])).'">'.img_picto('', 'delete').'</a>';
170 $texte .= '<br>';
171 }
172 $texte .= '</div>';
173 }
174 // Add input to upload a new template file.
175 $texte .= '<div>'.$langs->trans("UploadNewTemplate");
176 $maxfilesizearray = getMaxFileSizeArray();
177 $maxmin = $maxfilesizearray['maxmin'];
178 if ($maxmin > 0) {
179 $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
180 }
181 $texte .= ' <input type="file" name="uploadfile">';
182 $texte .= '<input type="hidden" value="EXPEDITION_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
183 $texte .= '<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
184 $texte .= '</div>';
185 $texte .= '</td>';
186
187 $texte .= '</tr>';
188
189 $texte .= '</table>';
190 $texte .= '</form>';
191
192 return $texte;
193 }
194
195 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
207 public function write_file($object, $outputlangs, $srctemplatepath = '', $hidedetails = 0, $hidedesc = 0, $hideref = 0)
208 {
209 // phpcs:enable
210 global $user, $langs, $conf, $mysoc, $hookmanager;
211
212 if (empty($srctemplatepath)) {
213 dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
214 return -1;
215 }
216
217 // Add odtgeneration hook
218 if (!is_object($hookmanager)) {
219 include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
220 $hookmanager = new HookManager($this->db);
221 }
222 $hookmanager->initHooks(array('odtgeneration'));
223 global $action;
224
225 if (!is_object($outputlangs)) {
226 $outputlangs = $langs;
227 }
228 $sav_charset_output = $outputlangs->charset_output;
229 $outputlangs->charset_output = 'UTF-8';
230
231 // Load translation files required by page
232 $outputlangs->loadLangs(array("main", "dict", "companies", "bills"));
233
234 if ($conf->expedition->multidir_output[$object->entity]."/sending") {
235 // If $object is id instead of object
236 if (!is_object($object)) {
237 $id = $object;
238 $object = new Expedition($this->db);
239 $result = $object->fetch($id);
240 if ($result < 0) {
241 dol_print_error($this->db, $object->error);
242 return -1;
243 }
244 }
245
246 $object->fetch_thirdparty();
247
248 $dir = $conf->expedition->multidir_output[$object->entity]."/sending";
249 $objectref = dol_sanitizeFileName($object->ref);
250 if (!preg_match('/specimen/i', $objectref)) {
251 $dir .= "/".$objectref;
252 }
253 $file = $dir."/".$objectref.".odt";
254
255 if (!file_exists($dir)) {
256 if (dol_mkdir($dir) < 0) {
257 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
258 return -1;
259 }
260 }
261
262 if (file_exists($dir)) {
263 //print "srctemplatepath=".$srctemplatepath; // Src filename
264 $newfile = basename($srctemplatepath);
265 $newfiletmp = preg_replace('/\.od[ts]/i', '', $newfile);
266 $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
267 $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
268 $newfiletmp = $objectref . '_' . $newfiletmp;
269 //$file=$dir.'/'.$newfiletmp.'.'.dol_print_date(dol_now(),'%Y%m%d%H%M%S').'.odt';
270 // Get extension (ods or odt)
271 $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
272 if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
273 $format = getDolGlobalString('MAIN_DOC_USE_TIMING');
274 if ($format == '1') {
275 $format = '%Y%m%d%H%M%S';
276 }
277 $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
278 } else {
279 $filename = $newfiletmp . '.' . $newfileformat;
280 }
281 $file = $dir . '/' . $filename;
282 //print "newdir=".$dir;
283 //print "newfile=".$newfile;
284 //print "file=".$file;
285 //print "conf->societe->dir_temp=".$conf->societe->dir_temp;
286
287 dol_mkdir($conf->expedition->dir_temp);
288 if (!is_writable($conf->expedition->dir_temp)) {
289 $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->expedition->dir_temp);
290 dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
291 return -1;
292 }
293
294 // If SHIPMENT contact defined on invoice, we use it
295 $usecontact = false;
296 $arrayidcontact = $object->getIdContact('external', 'SHIPPING');
297 if (count($arrayidcontact) > 0) {
298 $usecontact = true;
299 $result = $object->fetch_contact($arrayidcontact[0]);
300 }
301
302 // Recipient name
303 $contactobject = null;
304 if (!empty($usecontact)) {
305 // We can use the company of contact instead of thirdparty company
306 if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || getDolGlobalString('MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
307 $object->contact->fetch_thirdparty();
308 $socobject = $object->contact->thirdparty;
309 $contactobject = $object->contact;
310 } else {
311 $socobject = $object->thirdparty;
312 // if we have a SHIPPING contact and we don't use it as thirdparty recipient we store the contact object for later use
313 $contactobject = $object->contact;
314 }
315 } else {
316 $socobject = $object->thirdparty;
317 }
318
319 // Make substitution
320 $substitutionarray = array(
321 '__FROM_NAME__' => $this->emetteur->name,
322 '__FROM_EMAIL__' => $this->emetteur->email,
323 '__TOTAL_TTC__' => $object->total_ttc,
324 '__TOTAL_HT__' => $object->total_ht,
325 '__TOTAL_VAT__' => $object->total_tva
326 );
327 complete_substitutions_array($substitutionarray, $langs, $object);
328 // Call the ODTSubstitution hook
329 $parameters = array('file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$substitutionarray);
330 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
331
332 // Line of free text
333 $newfreetext = '';
334 $paramfreetext = 'EXPEDITION_FREE_TEXT';
335 if (getDolGlobalString($paramfreetext)) {
336 $newfreetext = make_substitutions(getDolGlobalString($paramfreetext), $substitutionarray);
337 }
338
339 // Open and load template
340 require_once ODTPHP_PATH.'odf.php';
341 try {
342 $odfHandler = new Odf(
343 $srctemplatepath,
344 array(
345 'PATH_TO_TMP' => $conf->expedition->dir_temp,
346 'ZIP_PROXY' => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
347 'DELIMITER_LEFT' => '{',
348 'DELIMITER_RIGHT' => '}'
349 )
350 );
351 } catch (Exception $e) {
352 $this->error = $e->getMessage();
353 dol_syslog($e->getMessage(), LOG_INFO);
354 return -1;
355 }
356 // After construction $odfHandler->contentXml contains content and
357 // [!-- BEGIN row.lines --]*[!-- END row.lines --] has been replaced by
358 // [!-- BEGIN lines --]*[!-- END lines --]
359 //print html_entity_decode($odfHandler->__toString());
360 //print exit;
361
362
363 // Make substitutions into odt of freetext
364 try {
365 $odfHandler->setVars('free_text', $newfreetext, true, 'UTF-8');
366 } catch (OdfException $e) {
367 dol_syslog($e->getMessage(), LOG_INFO);
368 }
369
370 // Make substitutions into odt of user info
371 $tmparray = $this->get_substitutionarray_user($user, $outputlangs);
372 foreach ($tmparray as $key => $value) {
373 try {
374 if (preg_match('/logo$/', $key)) { // Image
375 //var_dump($value);exit;
376 if (file_exists($value)) {
377 $odfHandler->setImage($key, $value);
378 } else {
379 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
380 }
381 } else { // Text
382 $odfHandler->setVars($key, $value, true, 'UTF-8');
383 }
384 } catch (OdfException $e) {
385 dol_syslog($e->getMessage(), LOG_INFO);
386 }
387 }
388 // Make substitutions into odt of mysoc
389 $tmparray = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
390 foreach ($tmparray as $key => $value) {
391 try {
392 if (preg_match('/logo$/', $key)) { // Image
393 //var_dump($value);exit;
394 if (file_exists($value)) {
395 $odfHandler->setImage($key, $value);
396 } else {
397 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
398 }
399 } else { // Text
400 $odfHandler->setVars($key, $value, true, 'UTF-8');
401 }
402 } catch (OdfException $e) {
403 dol_syslog($e->getMessage(), LOG_INFO);
404 }
405 }
406 // Make substitutions into odt of thirdparty
407 if ($socobject->element == 'contact') {
409 $tmparray = $this->get_substitutionarray_contact($socobject, $outputlangs);
410 } else {
411 $tmparray = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
412 }
413 foreach ($tmparray as $key => $value) {
414 try {
415 if (preg_match('/logo$/', $key)) { // Image
416 if (file_exists($value)) {
417 $odfHandler->setImage($key, $value);
418 } else {
419 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
420 }
421 } else { // Text
422 $odfHandler->setVars($key, $value, true, 'UTF-8');
423 }
424 } catch (OdfException $e) {
425 dol_syslog($e->getMessage(), LOG_INFO);
426 }
427 }
428
429 if ($usecontact && is_object($contactobject)) {
430 $tmparray = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
431 foreach ($tmparray as $key => $value) {
432 try {
433 if (preg_match('/logo$/', $key)) { // Image
434 if (file_exists($value)) {
435 $odfHandler->setImage($key, $value);
436 } else {
437 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
438 }
439 } else { // Text
440 $odfHandler->setVars($key, $value, true, 'UTF-8');
441 }
442 } catch (OdfException $e) {
443 dol_syslog($e->getMessage(), LOG_INFO);
444 }
445 }
446 }
447
448 // Replace tags of object + external modules
449 $tmparray = array_merge($tmparray, $this->get_substitutionarray_shipment($object, $outputlangs));
450 $tmparray = array_merge($tmparray, $this->get_substitutionarray_other($outputlangs));
451
452 complete_substitutions_array($tmparray, $outputlangs, $object);
453 // Call the ODTSubstitution hook
454 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
455 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
456
457 foreach ($tmparray as $key => $value) {
458 try {
459 if (preg_match('/logo$/', $key)) {
460 // Image
461 if (file_exists($value)) {
462 $odfHandler->setImage($key, $value);
463 } else {
464 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
465 }
466 } else {
467 // Text
468 $odfHandler->setVars($key, $value, true, 'UTF-8');
469 }
470 } catch (OdfException $e) {
471 dol_syslog($e->getMessage(), LOG_INFO);
472 }
473 }
474
475 // Replace tags of lines
476 $foundtagforlines = 1;
477 try {
478 $listlines = $odfHandler->setSegment('lines');
479 } catch (OdfExceptionSegmentNotFound $e) {
480 // We may arrive here if tags for lines not present into template
481 $foundtagforlines = 0;
482 dol_syslog($e->getMessage(), LOG_INFO);
483 }
484 if ($foundtagforlines) {
485 $linenumber = 0;
486 foreach ($object->lines as $line) {
487 $linenumber++;
488 $tmparray = $this->get_substitutionarray_lines($line, $outputlangs, $linenumber);
489 complete_substitutions_array($tmparray, $outputlangs, $object, $line, "completesubstitutionarray_lines");
490 // Call the ODTSubstitutionLine hook
491 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray, 'line' => $line);
492 $reshook = $hookmanager->executeHooks('ODTSubstitutionLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
493 foreach ($tmparray as $key => $val) {
494 try {
495 $listlines->setVars($key, $val, true, 'UTF-8');
496 } catch (SegmentException $e) {
497 dol_syslog($e->getMessage(), LOG_INFO);
498 }
499 }
500 $listlines->merge();
501 }
502 try {
503 $odfHandler->mergeSegment($listlines);
504 } catch (OdfException $e) {
505 $this->error = $e->getMessage();
506 dol_syslog($this->error, LOG_WARNING);
507 return -1;
508 }
509 }
510
511 // Replace labels translated
512 $tmparray = $outputlangs->get_translations_for_substitutions();
513 foreach ($tmparray as $key => $value) {
514 try {
515 $odfHandler->setVars($key, $value, true, 'UTF-8');
516 } catch (OdfException $e) {
517 dol_syslog($e->getMessage(), LOG_INFO);
518 }
519 }
520
521 // Call the beforeODTSave hook
522 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
523 $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
524
525 // Write new file
526 if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
527 try {
528 $odfHandler->exportAsAttachedPDF($file);
529 } catch (Exception $e) {
530 $this->error = $e->getMessage();
531 dol_syslog($e->getMessage(), LOG_INFO);
532 return -1;
533 }
534 } else {
535 try {
536 $odfHandler->saveToDisk($file);
537 } catch (Exception $e) {
538 $this->error = $e->getMessage();
539 dol_syslog($e->getMessage(), LOG_INFO);
540 return -1;
541 }
542 }
543
544 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
545 $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
546
547 dolChmod($file);
548
549 $odfHandler = null; // Destroy object
550
551 $this->result = array('fullpath' => $file);
552
553 return 1; // Success
554 } else {
555 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
556 }
557 }
558
559 return -1;
560 }
561}
$id
Definition account.php:39
if( $user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
Definition card.php:58
get_substitutionarray_shipment($object, $outputlangs, $array_key='object')
Define array with couple substitution key => substitution value Note that vars into substitutions arr...
get_substitutionarray_mysoc($mysoc, $outputlangs)
Define array with couple substitution key => substitution value.
get_substitutionarray_contact($object, $outputlangs, $array_key='object')
Define array with couple substitution key => substitution value.
get_substitutionarray_other($outputlangs)
Define array with couple substitution key => substitution value.
get_substitutionarray_lines($line, $outputlangs, $linenumber=0)
Define array with couple substitution key => substitution value Note that vars into substitutions arr...
get_substitutionarray_thirdparty($object, $outputlangs, $array_key='company')
Define array with couple substitution key => substitution value For example {company_name}...
get_substitutionarray_user($user, $outputlangs)
Define array with couple substitution key => substitution value.
Class to manage shipments.
Class to manage generation of HTML components Only common components must be here.
Class to manage hooks.
Parent class of sending receipts models.
write_file($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
Function to build pdf onto disk.
Class to build documents using ODF templates generator.
info($langs)
Return description of a module.
print $script_file $mode $langs defaultlang(is_numeric($duration_value) ? " delay=". $duration_value :"").(is_numeric($duration_value2) ? " after cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
dol_dir_list($utf8_path, $types="all", $recursive=0, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $nohook=0, $relativename="", $donotfollowsymlinks=0, $nbsecondsold=0)
Scan a directory and return a list of files/directories.
Definition files.lib.php:63
img_warning($titlealt='default', $moreatt='', $morecss='pictowarning')
Show warning logo.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
dolChmod($filepath, $newmask='')
Change mod of a file.
dol_now($mode='auto')
Return date for now.
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs=null, $encodetooutput=false)
Output date in a string format according to outputlangs (or langs if not defined).
newToken()
Return the value of token currently saved into session with name 'newtoken'.
complete_substitutions_array(&$substitutionarray, $outputlangs, $object=null, $parameters=null, $callfunc="completesubstitutionarray")
Complete the $substitutionarray with more entries coming from external module that had set the "subst...
make_substitutions($text, $substitutionarray, $outputlangs=null, $converttextinhtmlifnecessary=0)
Make substitution into a text string, replacing keys with vals from $substitutionarray (oldval=>newva...
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
if(preg_match('/crypted:/i', $dolibarr_main_db_pass)||!empty($dolibarr_main_db_encrypted_pass)) $conf db type
Definition repair.php:139
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:142
getMaxFileSizeArray()
Return the max allowed for file upload.