dolibarr  19.0.0-dev
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-2019 Frédéric France <frederic.france@netlogic.fr>
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 
29 require_once DOL_DOCUMENT_ROOT.'/core/modules/facture/modules_facture.php';
30 require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
31 require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
32 require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
33 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
34 require_once DOL_DOCUMENT_ROOT.'/core/lib/doc.lib.php';
35 
36 
41 {
46  public $emetteur;
47 
52  public $version = 'dolibarr';
53 
54 
60  public function __construct($db)
61  {
62  global $conf, $langs, $mysoc;
63 
64  // Load translation files required by the page
65  $langs->loadLangs(array("main", "companies"));
66 
67  $this->db = $db;
68  $this->name = "ODT/ODS templates";
69  $this->description = $langs->trans("DocumentModelOdt");
70  $this->scandir = 'FACTURE_ADDON_PDF_ODT_PATH'; // Name of constant that is used to save list of directories to scan
71 
72  // Page size for A4 format
73  $this->type = 'odt';
74  $this->page_largeur = 0;
75  $this->page_hauteur = 0;
76  $this->format = array($this->page_largeur, $this->page_hauteur);
77  $this->marge_gauche = 0;
78  $this->marge_droite = 0;
79  $this->marge_haute = 0;
80  $this->marge_basse = 0;
81 
82  $this->option_logo = 1; // Display logo
83  $this->option_tva = 0; // Manage the vat option FACTURE_TVAOPTION
84  $this->option_modereg = 0; // Display payment mode
85  $this->option_condreg = 0; // Display payment terms
86  $this->option_multilang = 1; // Available in several languages
87  $this->option_escompte = 0; // Displays if there has been a discount
88  $this->option_credit_note = 0; // Support credit notes
89  $this->option_freetext = 1; // Support add of a personalised text
90  $this->option_draft_watermark = 0; // Support add of a watermark on drafts
91 
92  // Recupere emetteur
93  $this->emetteur = $mysoc;
94  if (!$this->emetteur->country_code) {
95  $this->emetteur->country_code = substr($langs->defaultlang, -2); // Par defaut, 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), 0);
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  // Add list of substitution keys
146  $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
147  $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
148 
149  $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1);
150  $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
151  $texte .= '<textarea class="flat" cols="60" name="value1">';
152  $texte .= $conf->global->FACTURE_ADDON_PDF_ODT_PATH;
153  $texte .= '</textarea>';
154  $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
155  $texte .= '<input type="submit" class="button small reposition" name="modify"value="'.$langs->trans("Modify").'">';
156  $texte .= '<br></div></div>';
157 
158  // Scan directories
159  $nbofiles = count($listoffiles);
160  if (!empty($conf->global->FACTURE_ADDON_PDF_ODT_PATH)) {
161  $texte .= $langs->trans("NumberOfModelFilesFound").': <b>';
162  //$texte.=$nbofiles?'<a id="a_'.get_class($this).'" href="#">':'';
163  $texte .= count($listoffiles);
164  //$texte.=$nbofiles?'</a>':'';
165  $texte .= '</b>';
166  }
167  if ($nbofiles) {
168  $texte .= '<div id="div_'.get_class($this).'" class="hiddenx">';
169  // Show list of found files
170  foreach ($listoffiles as $file) {
171  $texte .= '- '.$file['name'].' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=invoices/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
172  $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>';
173  $texte .= '<br>';
174  }
175  $texte .= '</div>';
176  }
177  // Add input to upload a new template file.
178  $texte .= '<div>'.$langs->trans("UploadNewTemplate");
179  $maxfilesizearray = getMaxFileSizeArray();
180  $maxmin = $maxfilesizearray['maxmin'];
181  if ($maxmin > 0) {
182  $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
183  }
184  $texte .= ' <input type="file" name="uploadfile">';
185  $texte .= '<input type="hidden" value="FACTURE_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
186  $texte .= '<input type="submit" class="button small reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
187  $texte .= '</div>';
188  $texte .= '</td>';
189 
190  $texte .= '<td rowspan="2" class="tdtop hideonsmartphone">';
191  $texte .= '<span class="opacitymedium">';
192  $texte .= $langs->trans("ExampleOfDirectoriesForModelGen");
193  $texte .= '</span>';
194  $texte .= '</td>';
195  $texte .= '</tr>';
196 
197  $texte .= '</table>';
198  $texte .= '</form>';
199 
200  return $texte;
201  }
202 
203  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
215  public function write_file($object, $outputlangs, $srctemplatepath, $hidedetails = 0, $hidedesc = 0, $hideref = 0)
216  {
217  // phpcs:enable
218  global $user, $langs, $conf, $mysoc, $hookmanager;
219 
220  if (empty($srctemplatepath)) {
221  dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
222  return -1;
223  }
224 
225  // Add odtgeneration hook
226  if (!is_object($hookmanager)) {
227  include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
228  $hookmanager = new HookManager($this->db);
229  }
230  $hookmanager->initHooks(array('odtgeneration'));
231  global $action;
232 
233  if (!is_object($outputlangs)) {
234  $outputlangs = $langs;
235  }
236  $sav_charset_output = $outputlangs->charset_output;
237  $outputlangs->charset_output = 'UTF-8';
238 
239  // Load translation files required by the page
240  $outputlangs->loadLangs(array("main", "dict", "companies", "bills"));
241 
242  if ($conf->facture->dir_output) {
243  // If $object is id instead of object
244  if (!is_object($object)) {
245  $id = $object;
246  $object = new Facture($this->db);
247  $result = $object->fetch($id);
248  if ($result < 0) {
249  dol_print_error($this->db, $object->error);
250  return -1;
251  }
252  }
253 
254  $object->fetch_thirdparty();
255 
256  $dir = $conf->facture->dir_output;
257  $objectref = dol_sanitizeFileName($object->ref);
258  if (!preg_match('/specimen/i', $objectref)) {
259  $dir .= "/".$objectref;
260  }
261  $file = $dir."/".$objectref.".odt";
262 
263  if (!file_exists($dir)) {
264  if (dol_mkdir($dir) < 0) {
265  $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
266  return -1;
267  }
268  }
269 
270  if (file_exists($dir)) {
271  //print "srctemplatepath=".$srctemplatepath; // Src filename
272  $newfile = basename($srctemplatepath);
273  $newfiletmp = preg_replace('/\.od[ts]/i', '', $newfile);
274  $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
275  $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
276 
277  $newfiletmp = $objectref . '_' . $newfiletmp;
278 
279  // Get extension (ods or odt)
280  $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
281  if (getDolGlobalInt('MAIN_DOC_USE_TIMING')) {
282  $format = getDolGlobalInt('MAIN_DOC_USE_TIMING');
283  if ($format == '1') {
284  $format = '%Y%m%d%H%M%S';
285  }
286  $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
287  } else {
288  $filename = $newfiletmp . '.' . $newfileformat;
289  }
290  $file = $dir . '/' . $filename;
291  //$file=$dir.'/'.$newfiletmp.'.'.dol_print_date(dol_now(),'%Y%m%d%H%M%S').'.odt';
292  //print "newdir=".$dir;
293  //print "newfile=".$newfile;
294  //print "file=".$file;
295  //print "conf->societe->dir_temp=".$conf->societe->dir_temp;
296 
297  dol_mkdir($conf->facture->dir_temp);
298  if (!is_writable($conf->facture->dir_temp)) {
299  $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->facture->dir_temp);
300  dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
301  return -1;
302  }
303 
304  // If BILLING contact defined on invoice, we use it
305  $usecontact = false;
306  $arrayidcontact = $object->getIdContact('external', 'BILLING');
307  if (count($arrayidcontact) > 0) {
308  $usecontact = true;
309  $result = $object->fetch_contact($arrayidcontact[0]);
310  }
311 
312  // Recipient name
313  $contactobject = null;
314  if (!empty($usecontact)) {
315  // We can use the company of contact instead of thirdparty company
316  if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || !empty($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT))) {
317  $object->contact->fetch_thirdparty();
318  $socobject = $object->contact->thirdparty;
319  $contactobject = $object->contact;
320  } else {
321  $socobject = $object->thirdparty;
322  // if we have a BILLING contact and we dont use it as thirdparty recipient we store the contact object for later use
323  $contactobject = $object->contact;
324  }
325  } else {
326  $socobject = $object->thirdparty;
327  }
328 
329  // Fetch info for linked propal
330  $object->fetchObjectLinked('', '', '', '');
331  //print_r($object->linkedObjects['propal']); exit;
332 
333  $propal_object = null;
334  if (!empty($object->linkedObjects['propal'])) {
335  $array_propal_object = $object->linkedObjects['propal'];
336  if (isset($array_propal_object) && is_array($array_propal_object) && count($array_propal_object) > 0) {
337  $tmparrayofvalue = array_values($array_propal_object);
338  $propal_object = $tmparrayofvalue[0];
339  }
340  }
341 
342  // Make substitution
343  $substitutionarray = array(
344  '__FROM_NAME__' => $this->emetteur->name,
345  '__FROM_EMAIL__' => $this->emetteur->email,
346  '__TOTAL_TTC__' => $object->total_ttc,
347  '__TOTAL_HT__' => $object->total_ht,
348  '__TOTAL_VAT__' => $object->total_tva
349  );
350  complete_substitutions_array($substitutionarray, $langs, $object);
351  // Call the ODTSubstitution hook
352  $parameters = array('file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$substitutionarray);
353  $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
354 
355  // Line of free text
356  $newfreetext = '';
357  $paramfreetext = 'INVOICE_FREE_TEXT';
358  if (!empty($conf->global->$paramfreetext)) {
359  $newfreetext = make_substitutions($conf->global->$paramfreetext, $substitutionarray);
360  }
361 
362  // Open and load template
363  require_once ODTPHP_PATH.'odf.php';
364  try {
365  $odfHandler = new Odf(
366  $srctemplatepath,
367  array(
368  'PATH_TO_TMP' => $conf->facture->dir_temp,
369  'ZIP_PROXY' => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
370  'DELIMITER_LEFT' => '{',
371  'DELIMITER_RIGHT' => '}'
372  )
373  );
374  } catch (Exception $e) {
375  $this->error = $e->getMessage();
376  dol_syslog($e->getMessage(), LOG_INFO);
377  return -1;
378  }
379  // After construction $odfHandler->contentXml contains content and
380  // [!-- BEGIN row.lines --]*[!-- END row.lines --] has been replaced by
381  // [!-- BEGIN lines --]*[!-- END lines --]
382  //print html_entity_decode($odfHandler->__toString());
383  //print exit;
384 
385 
386  // Make substitutions into odt of freetext
387  try {
388  $odfHandler->setVars('free_text', $newfreetext, true, 'UTF-8');
389  } catch (OdfException $e) {
390  dol_syslog($e->getMessage(), LOG_INFO);
391  }
392 
393  // Define substitution array
394  $substitutionarray = getCommonSubstitutionArray($outputlangs, 0, null, $object); // Set tags __...__
395  $array_object_from_properties = $this->get_substitutionarray_each_var_object($object, $outputlangs);
396  $array_objet = $this->get_substitutionarray_object($object, $outputlangs); // Set tags object_...
397  $array_user = $this->get_substitutionarray_user($user, $outputlangs); // Set tags myuser_...
398  $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
399  $array_thirdparty = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
400  $array_propal = is_object($propal_object) ? $this->get_substitutionarray_object($propal_object, $outputlangs, 'propal') : array();
401  $array_other = $this->get_substitutionarray_other($outputlangs);
402  // retrieve contact information for use in object as contact_xxx tags
403  $array_thirdparty_contact = array();
404  if ($usecontact && is_object($contactobject)) {
405  $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
406  }
407 
408  $tmparray = array_merge($substitutionarray, $array_object_from_properties, $array_user, $array_soc, $array_thirdparty, $array_objet, $array_propal, $array_other, $array_thirdparty_contact);
409  complete_substitutions_array($tmparray, $outputlangs, $object);
410 
411  // Complete also with substitution from keys directly found into template
412  // TODO Search all tags {object_...:xxxx} into template then loop on this found tags to analyze them and the the corresponding
413  // property of object and use the xxxx to know how to format it.
414  // Before that, we hard code this substitution as if we have found them into the template.
415  $tmparray['object_PREVIOUS_MONTH'] = dol_print_date(dol_time_plus_duree($object->date, -1, 'm'), '%m');
416  $tmparray['object_MONTH'] = dol_print_date($object->date, '%m');
417  $tmparray['object_NEXT_MONTH'] = dol_print_date(dol_time_plus_duree($object->date, 1, 'm'), '%m');
418  $tmparray['object_PREVIOUS_MONTH_TEXT'] = dol_print_date(dol_time_plus_duree($object->date, -1, 'm'), '%B');
419  $tmparray['object_MONTH_TEXT'] = dol_print_date($object->date, '%B');
420  $tmparray['object_NEXT_MONTH_TEXT'] = dol_print_date(dol_time_plus_duree($object->date, 1, 'm'), '%B');
421  $tmparray['object_PREVIOUS_YEAR'] = dol_print_date(dol_time_plus_duree($object->date, -1, 'y'), '%Y');
422  $tmparray['object_YEAR'] = dol_print_date($object->date, '%Y');
423  $tmparray['object_NEXT_YEAR'] = dol_print_date(dol_time_plus_duree($object->date, 1, 'y'), '%Y');
424 
425  // Call the ODTSubstitution hook
426  $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$tmparray);
427  $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
428 
429  //var_dump($tmparray); exit;
430  foreach ($tmparray as $key => $value) {
431  try {
432  if (preg_match('/logo$/', $key)) { // Image
433  //var_dump($value);exit;
434  if (file_exists($value)) {
435  $odfHandler->setImage($key, $value);
436  } else {
437  $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
438  }
439  } else {
440  // Text
441  $odfHandler->setVars($key, $value, true, 'UTF-8');
442  }
443  } catch (OdfException $e) {
444  dol_syslog($e->getMessage(), LOG_INFO);
445  }
446  }
447  // Replace tags of lines
448  try {
449  $foundtagforlines = 1;
450  try {
451  $listlines = $odfHandler->setSegment('lines');
452  } catch (OdfException $e) {
453  // We may arrive here if tags for lines not present into template
454  $foundtagforlines = 0;
455  dol_syslog($e->getMessage(), LOG_INFO);
456  }
457  if ($foundtagforlines) {
458  $linenumber = 0;
459  foreach ($object->lines as $line) {
460  $linenumber++;
461  $tmparray = $this->get_substitutionarray_lines($line, $outputlangs, $linenumber);
462  complete_substitutions_array($tmparray, $outputlangs, $object, $line, "completesubstitutionarray_lines");
463  // Call the ODTSubstitutionLine hook
464  $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$tmparray, 'line'=>$line);
465  $reshook = $hookmanager->executeHooks('ODTSubstitutionLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
466  foreach ($tmparray as $key => $val) {
467  try {
468  $listlines->setVars($key, $val, true, 'UTF-8');
469  } catch (OdfException $e) {
470  dol_syslog($e->getMessage(), LOG_INFO);
471  } catch (SegmentException $e) {
472  dol_syslog($e->getMessage(), LOG_INFO);
473  }
474  }
475  $listlines->merge();
476  }
477  $odfHandler->mergeSegment($listlines);
478  }
479  } catch (OdfException $e) {
480  $this->error = $e->getMessage();
481  dol_syslog($this->error, LOG_WARNING);
482  return -1;
483  }
484 
485  // Replace labels translated
486  $tmparray = $outputlangs->get_translations_for_substitutions();
487  foreach ($tmparray as $key => $value) {
488  try {
489  $odfHandler->setVars($key, $value, true, 'UTF-8');
490  } catch (OdfException $e) {
491  dol_syslog($e->getMessage(), LOG_INFO);
492  }
493  }
494 
495  // Call the beforeODTSave hook
496  $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$tmparray);
497  $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
498 
499  // Write new file
500  if (!empty($conf->global->MAIN_ODT_AS_PDF)) {
501  try {
502  $odfHandler->exportAsAttachedPDF($file);
503  } catch (Exception $e) {
504  $this->error = $e->getMessage();
505  dol_syslog($e->getMessage(), LOG_INFO);
506  return -1;
507  }
508  } else {
509  try {
510  $odfHandler->saveToDisk($file);
511  } catch (Exception $e) {
512  $this->error = $e->getMessage();
513  dol_syslog($e->getMessage(), LOG_INFO);
514  return -1;
515  }
516  }
517  $parameters = array('odfHandler'=>&$odfHandler, 'file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs, 'substitutionarray'=>&$tmparray);
518  $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
519 
520  dolChmod($file);
521 
522  $odfHandler = null; // Destroy object
523 
524  $this->result = array('fullpath'=>$file);
525 
526  return 1; // Success
527  } else {
528  $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
529  return -1;
530  }
531  }
532 
533  return -1;
534  }
535 }
get_substitutionarray_each_var_object(&$object, $outputlangs, $recursive=1)
Define array with couple substitution key => substitution value.
get_substitutionarray_object($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 invoices.
Class to manage generation of HTML components Only common components must be here.
Class to manage hooks.
Parent class of invoice document generators.
Class to build documents using ODF templates generator.
write_file($object, $outputlangs, $srctemplatepath, $hidedetails=0, $hidedesc=0, $hideref=0)
Function to build a document on disk using the generic odt module.
info($langs)
Return description of a module.
if($cancel &&! $id) if($action=='add' &&! $cancel) if($action=='delete') if($id) $form
Actions.
Definition: card.php:143
dol_time_plus_duree($time, $duration_value, $duration_unit, $ruleforendofmonth=0)
Add a delay to a date.
Definition: date.lib.php:122
print *****$script_file(".$version.") pid cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
dol_dir_list($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:62
img_warning($titlealt='default', $moreatt='', $morecss='pictowarning')
Show warning logo.
dol_print_error($db='', $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs='', $encodetooutput=false)
Output date in a string format according to outputlangs (or langs if not defined).
dolChmod($filepath, $newmask='')
Change mod of a file.
dol_now($mode='auto')
Return date for now.
getDolGlobalInt($key, $default=0)
Return dolibarr global constant int value.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
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.
getCommonSubstitutionArray($outputlangs, $onlykey=0, $exclude=null, $object=null, $include=null)
Return array of possible common substitutions.
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:120
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:123
getMaxFileSizeArray()
Return the max allowed for file upload.