dolibarr 24.0.1
doc_generic_invoice_odt.modules.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2010-2012 Laurent Destailleur <ely@users.sourceforge.net>
3 * Copyright (C) 2012 Regis Houssin <regis.houssin@inodbox.com>
4 * Copyright (C) 2014 Marcos García <marcosgdf@gmail.com>
5 * Copyright (C) 2016 Charlie Benke <charlie@patas-monkey.com>
6 * Copyright (C) 2018-2026 Frédéric France <frederic.france@free.fr>
7 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
8 * Copyright (C) 2025 Alexandre Spangaro <alexandre@inovea-conseil.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/facture/modules_facture.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 $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/ODS templates";
65 $this->description = $langs->trans("DocumentModelOdt");
66 $this->update_main_doc_field = 1; // Save the name of generated file as the main doc when generating a doc with this template
67 $this->scandir = 'FACTURE_ADDON_PDF_ODT_PATH'; // Name of constant that is used to save list of directories to scan
68
69 // Page size for A4 format
70 $this->type = 'odt';
71 $this->page_largeur = 0;
72 $this->page_hauteur = 0;
73 $this->format = array($this->page_largeur, $this->page_hauteur);
74 $this->marge_gauche = 0;
75 $this->marge_droite = 0;
76 $this->marge_haute = 0;
77 $this->marge_basse = 0;
78
79 $this->option_logo = 1; // Display logo
80 $this->option_tva = 0; // Manage the vat option FACTURE_TVAOPTION
81 $this->option_modereg = 1; // Display payment mode
82 $this->option_condreg = 1; // Display payment terms
83 $this->option_multilang = 1; // Available in several languages
84 $this->option_escompte = 0; // Displays if there has been a discount
85 $this->option_credit_note = 0; // Support credit notes
86 $this->option_freetext = 1; // Support add of a personalised text
87 $this->option_draft_watermark = 0; // Support add of a watermark on drafts
88
89 if ($mysoc === null) {
90 dol_syslog(get_class($this).'::__construct() Global $mysoc should not be null.'. getCallerInfoString(), LOG_ERR);
91 return;
92 }
93
94 // Retrieves issuer
95 $this->emetteur = $mysoc;
96 if (!$this->emetteur->country_code) {
97 $this->emetteur->country_code = substr($langs->defaultlang, -2); // Par default, si n'etait pas defini
98 }
99 }
100
101
108 public function info($langs)
109 {
110 global $conf, $langs;
111
112 // Load translation files required by the page
113 $langs->loadLangs(array("errors", "companies"));
114
115 $form = new Form($this->db);
116
117 $texte = $this->description.".<br>\n";
118 $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
119 $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
120 $texte .= '<input type="hidden" name="page_y" value="">';
121 $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
122 $texte .= '<input type="hidden" name="param1" value="FACTURE_ADDON_PDF_ODT_PATH">';
123 $texte .= '<table class="nobordernopadding" width="100%">';
124
125 // List of directories area
126 $texte .= '<tr><td valign="middle">';
127 $texttitle = $langs->trans("ListOfDirectories");
128 $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', trim($conf->global->FACTURE_ADDON_PDF_ODT_PATH)));
129 $listoffiles = array();
130 foreach ($listofdir as $key => $tmpdir) {
131 $tmpdir = trim($tmpdir);
132 $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
133 if (!$tmpdir) {
134 unset($listofdir[$key]);
135 continue;
136 }
137 if (!is_dir($tmpdir)) {
138 $texttitle .= img_warning($langs->trans("ErrorDirNotFound", $tmpdir), '');
139 } else {
140 $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.(ods|odt)');
141 if (count($tmpfiles)) {
142 $listoffiles = array_merge($listoffiles, $tmpfiles);
143 }
144 }
145 }
146 $texthelp = $langs->trans("ListOfDirectoriesForModelGenODT");
147 $texthelp .= '<br><br><span class="opacitymedium">'.$langs->trans("ExampleOfDirectoriesForModelGen").'</span>';
148 // Add list of substitution keys
149 $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
150 $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
151
152 $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1, 3, $this->name);
153 $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
154 $texte .= '<textarea class="flat textareafordir" spellcheck="false" cols="60" name="value1">';
155 $texte .= getDolGlobalString('FACTURE_ADDON_PDF_ODT_PATH');
156 $texte .= '</textarea>';
157 $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
158 $texte .= '<input type="submit" class="button button-edit reposition smallpaddingimp" name="modify" value="'.dol_escape_htmltag($langs->trans("Modify")).'">';
159 $texte .= '<br></div></div>';
160
161 // Scan directories
162 $nbofiles = count($listoffiles);
163 if (getDolGlobalString('FACTURE_ADDON_PDF_ODT_PATH')) {
164 $texte .= $langs->trans("NumberOfModelFilesFound").': <b>';
165 //$texte.=$nbofiles?'<a id="a_'.get_class($this).'" href="#">':'';
166 $texte .= count($listoffiles);
167 //$texte.=$nbofiles?'</a>':'';
168 $texte .= '</b>';
169 }
170 if ($nbofiles) {
171 $texte .= '<div id="div_'.get_class($this).'" class="hiddenx">';
172 // Show list of found files
173 foreach ($listoffiles as $file) {
174 $texte .= '- '.$file['name'].' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=invoices/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
175 $texte .= ' &nbsp; <a class="reposition" href="'.$_SERVER["PHP_SELF"].'?modulepart=doctemplates&keyforuploaddir=FACTURE_ADDON_PDF_ODT_PATH&action=deletefile&token='.newToken().'&file='.urlencode(basename($file['name'])).'">'.img_picto('', 'delete').'</a>';
176 $texte .= '<br>';
177 }
178 $texte .= '</div>';
179 }
180 // Add input to upload a new template file.
181 $texte .= '<div>'.$langs->trans("UploadNewTemplate");
182 $maxfilesizearray = getMaxFileSizeArray();
183 $maxmin = $maxfilesizearray['maxmin'];
184 if ($maxmin > 0) {
185 $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
186 }
187 $texte .= ' <input type="file" name="uploadfile">';
188 $texte .= '<input type="hidden" value="FACTURE_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
189 $texte .= '<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
190 $texte .= '</div>';
191 $texte .= '</td>';
192
193 $texte .= '</tr>';
194
195 $texte .= '</table>';
196 $texte .= '</form>';
197
198 return $texte;
199 }
200
201 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
213 public function write_file($object, $outputlangs, $srctemplatepath = '', $hidedetails = 0, $hidedesc = 0, $hideref = 0)
214 {
215 // phpcs:enable
216 global $user, $langs, $conf, $mysoc, $hookmanager;
217
218 if (empty($srctemplatepath)) {
219 dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
220 return -1;
221 }
222
223 // Add odtgeneration hook
224 if (!is_object($hookmanager)) {
225 include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
226 $hookmanager = new HookManager($this->db);
227 }
228 $hookmanager->initHooks(array('odtgeneration'));
229 global $action;
230
231 if (!is_object($outputlangs)) {
232 $outputlangs = $langs;
233 }
234 $sav_charset_output = $outputlangs->charset_output;
235 $outputlangs->charset_output = 'UTF-8';
236
237 // Load translation files required by the page
238 $outputlangs->loadLangs(array("main", "dict", "companies", "bills"));
239
240 if ($conf->facture->dir_output) {
241 // If $object is id instead of object
242 if (!is_object($object)) {
243 $id = $object;
244 $object = new Facture($this->db);
245 $result = $object->fetch($id);
246 if ($result < 0) {
247 dol_print_error($this->db, $object->error);
248 return -1;
249 }
250 }
251
252 $object->fetch_thirdparty();
253
254 $dir = empty($conf->facture->multidir_output[$object->entity ?? $conf->entity]) ? $conf->facture->dir_output : $conf->facture->multidir_output[$object->entity ?? $conf->entity];
255 $objectref = dol_sanitizeFileName($object->ref);
256 if (!preg_match('/specimen/i', $objectref)) {
257 $dir .= "/".$objectref;
258 }
259 $file = $dir."/".$objectref.".odt";
260
261 if (!file_exists($dir)) {
262 if (dol_mkdir($dir) < 0) {
263 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
264 return -1;
265 }
266 }
267
268 if (file_exists($dir)) {
269 //print "srctemplatepath=".$srctemplatepath; // Src filename
270 $newfile = basename($srctemplatepath);
271 $newfiletmp = preg_replace('/\.od[ts]/i', '', $newfile);
272 $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
273 $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
274
275 if (getDolGlobalString('MAIN_ODT_AS_PDF_OMIT_TEMPLATE_NAME')) {
276 $newfiletmp = $objectref;
277 } else {
278 $newfiletmp = $objectref . '_' . $newfiletmp;
279 }
280
281 // Get extension (ods or odt)
282 $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
283 if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
284 $format = getDolGlobalString('MAIN_DOC_USE_TIMING');
285 if ($format == '1') {
286 $format = '%Y%m%d%H%M%S';
287 }
288 $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
289 } else {
290 $filename = $newfiletmp . '.' . $newfileformat;
291 }
292 $file = $dir . '/' . $filename;
293 //$file=$dir.'/'.$newfiletmp.'.'.dol_print_date(dol_now(),'%Y%m%d%H%M%S').'.odt';
294 //print "newdir=".$dir;
295 //print "newfile=".$newfile;
296 //print "file=".$file;
297 //print "conf->societe->dir_temp=".$conf->societe->dir_temp;
298
299 dol_mkdir($conf->facture->dir_temp);
300 if (!is_writable($conf->facture->dir_temp)) {
301 $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->facture->dir_temp);
302 dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
303 return -1;
304 }
305
306 // If BILLING contact defined on invoice, we use it
307 $usecontact = false;
308 $arrayidcontact = $object->getIdContact('external', 'BILLING');
309 if (count($arrayidcontact) > 0) {
310 $usecontact = true;
311 $result = $object->fetch_contact($arrayidcontact[0]);
312 }
313
314 // Recipient name
315 $contactobject = null;
316 if (!empty($usecontact)) {
317 // We can use the company of contact instead of thirdparty company
318 if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || getDolGlobalString('MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
319 $object->contact->fetch_thirdparty();
320 $socobject = $object->contact->thirdparty;
321 $contactobject = $object->contact;
322 } else {
323 $socobject = $object->thirdparty;
324 // if we have a BILLING contact and we don't use it as thirdparty recipient we store the contact object for later use
325 $contactobject = $object->contact;
326 }
327 } else {
328 $socobject = $object->thirdparty;
329 }
330
331 // Fetch info for linked propal
332 $object->fetchObjectLinked(0, '', null, '');
333 //print_r($object->linkedObjects['propal']); exit;
334
335 $propal_object = null;
336 if (!empty($object->linkedObjects['propal'])) {
337 $array_propal_object = $object->linkedObjects['propal'];
338 if (isset($array_propal_object) && is_array($array_propal_object) && count($array_propal_object) > 0) {
339 $tmparrayofvalue = array_values($array_propal_object);
340 $propal_object = $tmparrayofvalue[0];
341 }
342 }
343
344 // and determine category of operation
345 $categoryOfOperation = 0;
346 $nbProduct = 0;
347 $nbService = 0;
348 foreach ($object->lines as $line) {
349 // If DEPOSIT, this line is completely ignored for calculations.
350 if ($line->isDepositLine()) {
351 continue;
352 }
353
354 // determine category of operation
355 if ($categoryOfOperation < 2) {
356 $lineProductType = $line->product_type;
357 if ($lineProductType == Product::TYPE_PRODUCT) {
358 $nbProduct++;
359 } elseif ($lineProductType == Product::TYPE_SERVICE) {
360 $nbService++;
361 }
362 if ($nbProduct > 0 && $nbService > 0) {
363 // mixed products and services
364 $categoryOfOperation = 2;
365 }
366 }
367 }
368
369 // determine category of operation
370 if ($categoryOfOperation <= 0) {
371 // only services
372 if ($nbProduct == 0 && $nbService > 0) {
373 $categoryOfOperation = 1;
374 }
375 }
376
377 // Make substitution
378 $substitutionarray = array(
379 '__FROM_NAME__' => $this->emetteur->name,
380 '__FROM_EMAIL__' => $this->emetteur->email,
381 '__TOTAL_TTC__' => $object->total_ttc,
382 '__TOTAL_HT__' => $object->total_ht,
383 '__TOTAL_VAT__' => $object->total_tva
384 );
385 complete_substitutions_array($substitutionarray, $langs, $object);
386 // Call the ODTSubstitution hook
387 $parameters = array('file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$substitutionarray);
388 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
389
390 // Line of free text
391 $newfreetext = '';
392 $paramfreetext = 'INVOICE_FREE_TEXT';
393 if (getDolGlobalString($paramfreetext)) {
394 $newfreetext = make_substitutions(getDolGlobalString($paramfreetext), $substitutionarray);
395 }
396
397 // Open and load template
398 require_once ODTPHP_PATH.'odf.php';
399 try {
400 $odfHandler = new Odf(
401 $srctemplatepath,
402 array(
403 'PATH_TO_TMP' => $conf->facture->dir_temp,
404 'ZIP_PROXY' => getDolGlobalString('MAIN_ODF_ZIP_PROXY', 'PclZipProxy'), // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
405 'DELIMITER_LEFT' => '{',
406 'DELIMITER_RIGHT' => '}'
407 )
408 );
409 } catch (Exception $e) {
410 $this->error = $e->getMessage();
411 dol_syslog($e->getMessage(), LOG_INFO);
412 return -1;
413 }
414 // After construction $odfHandler->contentXml contains content and
415 // [!-- BEGIN row.lines --]*[!-- END row.lines --] has been replaced by
416 // [!-- BEGIN lines --]*[!-- END lines --]
417 //print html_entity_decode($odfHandler->__toString());
418 //print exit;
419
420
421 // Make substitutions into odt of freetext
422 try {
423 $odfHandler->setVars('free_text', $newfreetext, true, 'UTF-8');
424 } catch (OdfException $e) {
425 dol_syslog($e->getMessage(), LOG_INFO);
426 }
427
428 // Define substitution array
429 $substitutionarray = getCommonSubstitutionArray($outputlangs, 0, null, $object); // Set tags __...__
430 $array_object_from_properties = $this->get_substitutionarray_each_var_object($object, $outputlangs);
431 $array_objet = $this->get_substitutionarray_object($object, $outputlangs); // Set tags object_...
432 $array_user = $this->get_substitutionarray_user($user, $outputlangs); // Set tags myuser_...
433 $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
434 $array_thirdparty = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
435 $array_propal = is_object($propal_object) ? $this->get_substitutionarray_object($propal_object, $outputlangs, 'propal') : array();
436 $array_other = $this->get_substitutionarray_other($outputlangs);
437 // retrieve contact information for use in object as contact_xxx tags
438 $array_thirdparty_contact = array();
439 if ($usecontact && is_object($contactobject)) {
440 $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
441 }
442
443 $tmparray = array_merge($substitutionarray, $array_object_from_properties, $array_user, $array_soc, $array_thirdparty, $array_objet, $array_propal, $array_other, $array_thirdparty_contact);
444 complete_substitutions_array($tmparray, $outputlangs, $object);
445
446 // Complete also with substitution from keys directly found into template
447 // TODO Search all tags {object_...:xxxx} into template then loop on this found tags to analyze them and the the corresponding
448 // property of object and use the xxxx to know how to format it.
449 // Before that, we hard code this substitution as if we have found them into the template.
450
451 $tmparray['object_PREVIOUS_MONTH'] = dol_print_date(dol_time_plus_duree($object->date, -1, 'm'), '%m');
452 $tmparray['object_MONTH'] = dol_print_date($object->date, '%m');
453 $tmparray['object_NEXT_MONTH'] = dol_print_date(dol_time_plus_duree($object->date, 1, 'm'), '%m');
454 $tmparray['object_PREVIOUS_MONTH_TEXT'] = dol_print_date(dol_time_plus_duree($object->date, -1, 'm'), '%B');
455 $tmparray['object_MONTH_TEXT'] = dol_print_date($object->date, '%B');
456 $tmparray['object_NEXT_MONTH_TEXT'] = dol_print_date(dol_time_plus_duree($object->date, 1, 'm'), '%B');
457 $tmparray['object_PREVIOUS_YEAR'] = dol_print_date(dol_time_plus_duree($object->date, -1, 'y'), '%Y');
458 $tmparray['object_YEAR'] = dol_print_date($object->date, '%Y');
459 $tmparray['object_NEXT_YEAR'] = dol_print_date(dol_time_plus_duree($object->date, 1, 'y'), '%Y');
460 $tmparray['object_productorservice_operation'] = $outputlangs->transnoentities("MentionCategoryOfOperations" . $categoryOfOperation);
461
462
463 // Call the ODTSubstitution hook
464 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
465 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
466
467 // retrieve the constant to apply a ratio for image size or set the ratio to 1
468 if (getDolGlobalString('MAIN_DOC_ODT_IMAGE_RATIO')) {
469 $ratio = (float) getDolGlobalString('MAIN_DOC_ODT_IMAGE_RATIO');
470 } else {
471 $ratio = 1;
472 }
473
474 //var_dump($tmparray); exit;
475 foreach ($tmparray as $key => $value) {
476 try {
477 if (preg_match('/logo$/', $key)) { // Image
478 //var_dump($value);exit;
479 if (file_exists($value)) {
480 $odfHandler->setImage($key, $value, $ratio);
481 } else {
482 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
483 }
484 } else {
485 // Text
486 $odfHandler->setVars($key, $value, true, 'UTF-8');
487 }
488 } catch (OdfException $e) {
489 dol_syslog($e->getMessage(), LOG_INFO);
490 }
491 }
492 // Replace tags of lines
493 $foundtagforlines = 1;
494 try {
495 $listlines = $odfHandler->setSegment('lines');
496 } catch (OdfExceptionSegmentNotFound $e) {
497 // We may arrive here if tags for lines not present into template
498 $foundtagforlines = 0;
499 dol_syslog($e->getMessage(), LOG_INFO);
500 }
501 if ($foundtagforlines) {
502 $linenumber = 0;
503 foreach ($object->lines as $line) {
505 $linenumber++;
506 $tmparray = $this->get_substitutionarray_lines($line, $outputlangs, $linenumber);
507 complete_substitutions_array($tmparray, $outputlangs, $object, $line, "completesubstitutionarray_lines");
508 // Call the ODTSubstitutionLine hook
509 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray, 'line' => $line);
510 $reshook = $hookmanager->executeHooks('ODTSubstitutionLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
511 foreach ($tmparray as $key => $val) {
512 try {
513 $listlines->setVars($key, $val, true, 'UTF-8');
514 } catch (SegmentException $e) {
515 dol_syslog($e->getMessage(), LOG_INFO);
516 }
517 }
518 $listlines->merge();
519 }
520 try {
521 $odfHandler->mergeSegment($listlines);
522 } catch (OdfException $e) {
523 $this->error = $e->getMessage();
524 dol_syslog($this->error, LOG_WARNING);
525 return -1;
526 }
527 }
528
529 // Replace labels translated
530 $tmparray = $outputlangs->get_translations_for_substitutions();
531 foreach ($tmparray as $key => $value) {
532 try {
533 $odfHandler->setVars($key, $value, true, 'UTF-8');
534 } catch (OdfException $e) {
535 dol_syslog($e->getMessage(), LOG_INFO);
536 }
537 }
538
539 // Call the beforeODTSave hook
540 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
541 $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
542
543 // Write new file
544 if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
545 try {
546 $odfHandler->exportAsAttachedPDF($file);
547 } catch (Exception $e) {
548 $this->error = $e->getMessage();
549 dol_syslog($e->getMessage(), LOG_INFO);
550 return -1;
551 }
552 } else {
553 try {
554 $odfHandler->saveToDisk($file);
555 } catch (Exception $e) {
556 $this->error = $e->getMessage();
557 dol_syslog($e->getMessage(), LOG_INFO);
558 return -1;
559 }
560 }
561 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
562 $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
563
564 dolChmod($file);
565
566 $odfHandler = null; // Destroy object
567
568 $this->result = array('fullpath' => $file);
569
570 return 1; // Success
571 } else {
572 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
573 return -1;
574 }
575 }
576
577 return -1;
578 }
579}
$id
Support class for third parties, contacts, members, users or resources.
Definition account.php:47
if(! $sortfield) if(! $sortorder) $object
Definition account.php:100
get_substitutionarray_each_var_object(&$object, $outputlangs, $recursive=1)
Define array with couple substitution key => substitution value @phpstan-template T.
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 invoices.
Class to manage generation of HTML components Only common components must be here.
Class to manage hooks.
Parent class of invoice document generators.
write_file($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
Function to build pdf onto disk.
const TYPE_PRODUCT
Regular product.
const TYPE_SERVICE
Service.
Class to build documents using ODF templates generator.
info($langs)
Return description of a module.
global $mysoc
dol_time_plus_duree($time, $duration_value, $duration_unit, $ruleforendofmonth=0)
Add a delay to a date.
Definition date.lib.php:126
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.
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $conf
The main.inc.php has been included so the following variable are now defined:
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:64
dol_now($mode='gmt')
Return date for now.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2, $allowothertags=array())
Show picto whatever it's its name (generic function)
img_warning($titlealt='default', $moreatt='', $morecss='pictowarning')
Show warning logo.
getCallerInfoString()
Get caller info as a string that can be appended to a log message.
dol_sanitizeFileName($str, $newstr='_', $unaccent=1, $includequotes=0, $allowdash=0)
Clean a string to use it as a file name.
dolChmod($filepath, $newmask='')
Change mod of a file.
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_print_date($time, $format='', $tzoutput='auto', $outputlangs=null, $encodetooutput=false, $decorate=0)
Output date in a string format according to outputlangs (or langs if not defined).
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|dolcrypt):/i', $dolibarr_main_db_pass)||!empty($dolibarr_main_db_encrypted_pass)) $conf db type
'integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]',...
Definition repair.php:130
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:133
getMaxFileSizeArray()
Return the max allowed for file upload.