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