dolibarr 21.0.0-beta
doc_generic_myobject_odt.modules.php
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 * Copyright (C) ---Replace with your own copyright and developer email---
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 3 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <https://www.gnu.org/licenses/>.
23 * or see https://www.gnu.org/
24 */
25
32dol_include_once('/mymodule/core/modules/mymodule/modules_myobject.php');
33require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
34require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
35require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
36require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
37require_once DOL_DOCUMENT_ROOT.'/core/lib/doc.lib.php';
38
39
44{
49 public $emetteur;
50
55 public $phpmin = array(7, 0);
56
60 public $version = 'dolibarr';
61
62
68 public function __construct($db)
69 {
70 global $langs, $mysoc;
71
72 // Load translation files required by the page
73 $langs->loadLangs(array("main", "companies"));
74
75 $this->db = $db;
76 $this->name = "ODT templates";
77 $this->description = $langs->trans("DocumentModelOdt");
78 $this->scandir = 'MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH'; // Name of constant that is used to save list of directories to scan
79
80 // Page size for A4 format
81 $this->type = 'odt';
82 $this->page_largeur = 0;
83 $this->page_hauteur = 0;
84 $this->format = array($this->page_largeur, $this->page_hauteur);
85 $this->marge_gauche = 0;
86 $this->marge_droite = 0;
87 $this->marge_haute = 0;
88 $this->marge_basse = 0;
89
90 $this->option_logo = 1; // Display logo
91 $this->option_tva = 0; // Manage the vat option FACTURE_TVAOPTION
92 $this->option_modereg = 0; // Display payment mode
93 $this->option_condreg = 0; // Display payment terms
94 $this->option_multilang = 1; // Available in several languages
95 $this->option_escompte = 0; // Displays if there has been a discount
96 $this->option_credit_note = 0; // Support credit notes
97 $this->option_freetext = 1; // Support add of a personalised text
98 $this->option_draft_watermark = 0; // Support add of a watermark on drafts
99
100 if ($mysoc === null) {
101 dol_syslog(get_class($this).'::__construct() Global $mysoc should not be null.'. getCallerInfoString(), LOG_ERR);
102 return;
103 }
104
105 // Get source company
106 $this->emetteur = $mysoc;
107 if (!$this->emetteur->country_code) {
108 $this->emetteur->country_code = substr($langs->defaultlang, -2); // By default if not defined
109 }
110 }
111
112
119 public function info($langs)
120 {
121 global $conf, $langs;
122
123 // Load translation files required by the page
124 $langs->loadLangs(array("errors", "companies"));
125
126 $form = new Form($this->db);
127
128 $texte = $this->description.".<br>\n";
129 $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
130 $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
131 $texte .= '<input type="hidden" name="page_y" value="">';
132 $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
133 $texte .= '<input type="hidden" name="param1" value="MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH">';
134 $texte .= '<table class="nobordernopadding centpercent">';
135
136 // List of directories area
137 $texte .= '<tr><td>';
138 $texttitle = $langs->trans("ListOfDirectories");
139 $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', trim(getDolGlobalString('MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH'))));
140 $listoffiles = array();
141 foreach ($listofdir as $key => $tmpdir) {
142 $tmpdir = trim($tmpdir);
143 $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
144 if (!$tmpdir) {
145 unset($listofdir[$key]);
146 continue;
147 }
148 if (!is_dir($tmpdir)) {
149 $texttitle .= img_warning($langs->trans("ErrorDirNotFound", $tmpdir), '');
150 } else {
151 $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.(ods|odt)');
152 if (count($tmpfiles)) {
153 $listoffiles = array_merge($listoffiles, $tmpfiles);
154 }
155 }
156 }
157 $texthelp = $langs->trans("ListOfDirectoriesForModelGenODT");
158 $texthelp .= '<br><br><span class="opacitymedium">'.$langs->trans("ExampleOfDirectoriesForModelGen").'</span>';
159 // Add list of substitution keys
160 $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
161 $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
162
163 if (!getDolGlobalString('MAIN_NO_MULTIDIR_FOR_ODT')) {
164 $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1, 3, $this->name);
165 $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
166 $texte .= '<textarea class="flat" cols="60" name="value1">';
167 $texte .= getDolGlobalString('MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH');
168 $texte .= '</textarea>';
169 $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
170 $texte .= '<input type="submit" class="button smallpaddingimp reposition" name="modify" value="'.dol_escape_htmltag($langs->trans("Modify")).'">';
171 $texte .= '<br></div></div>';
172 } else {
173 $texte .= '<br>';
174 $texte .= '<input type="hidden" name="value1" value="MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH">';
175 }
176
177 // Scan directories
178 $nbofiles = count($listoffiles);
179 if (getDolGlobalString('MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH')) {
180 $texte .= $langs->trans("NumberOfModelFilesFound").': <b>';
181 //$texte.=$nbofiles?'<a id="a_'.get_class($this).'" href="#">':'';
182 $texte .= count($listoffiles);
183 //$texte.=$nbofiles?'</a>':'';
184 $texte .= '</b>';
185 }
186
187 if ($nbofiles) {
188 $texte .= '<div id="div_'.get_class($this).'" class="hiddenx">';
189 // Show list of found files
190 foreach ($listoffiles as $file) {
191 $texte .= '- '.$file['name'].' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=mymodule_myobject/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
192 $texte .= ' &nbsp; <a class="reposition" href="'.$_SERVER["PHP_SELF"].'?modulepart=doctemplates&keyforuploaddir=MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH&action=deletefile&token='.newToken().'&file='.urlencode(basename($file['name'])).'">'.img_picto('', 'delete').'</a>';
193 $texte .= '<br>';
194 }
195 $texte .= '</div>';
196 }
197
198 // Add input to upload a new template file.
199 $texte .= '<div>'.$langs->trans("UploadNewTemplate");
200 $maxfilesizearray = getMaxFileSizeArray();
201 $maxmin = $maxfilesizearray['maxmin'];
202 if ($maxmin > 0) {
203 $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
204 }
205 $texte .= ' <input type="file" name="uploadfile">';
206 $texte .= '<input type="hidden" value="MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
207 $texte .= '<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
208 $texte .= '</div>';
209
210 $texte .= '</td>';
211
212 $texte .= '</tr>';
213
214 $texte .= '</table>';
215 $texte .= '</form>';
216
217 return $texte;
218 }
219
220 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
232 public function write_file($object, $outputlangs, $srctemplatepath = '', $hidedetails = 0, $hidedesc = 0, $hideref = 0)
233 {
234 // phpcs:enable
235 global $user, $langs, $conf, $mysoc, $hookmanager;
236 global $action;
237
238 if (empty($srctemplatepath)) {
239 dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
240 return -1;
241 }
242
243 // Add odtgeneration hook
244 $hookmanager->initHooks(array('odtgeneration'));
245
246 if (!is_object($outputlangs)) {
247 $outputlangs = $langs;
248 }
249 $sav_charset_output = $outputlangs->charset_output;
250 $outputlangs->charset_output = 'UTF-8';
251
252 $outputlangs->loadLangs(array("main", "dict", "companies", "bills"));
253
254 if ($conf->mymodule->dir_output) {
255 // If $object is id instead of object
256 if (!is_object($object)) {
257 $id = $object;
258 $object = new MyObject($this->db);
259 $result = $object->fetch($id);
260 if ($result < 0) {
261 dol_print_error($this->db, $object->error);
262 return -1;
263 }
264 }
265
266 $object->fetch_thirdparty();
267
268 $dir = $conf->mymodule->multidir_output[isset($object->entity) ? $object->entity : 1];
269 $objectref = dol_sanitizeFileName($object->ref);
270 if (!preg_match('/specimen/i', $objectref)) {
271 $dir .= "/".$objectref;
272 }
273 $file = $dir."/".$objectref.".odt";
274
275 if (!file_exists($dir)) {
276 if (dol_mkdir($dir) < 0) {
277 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
278 return -1;
279 }
280 }
281
282 if (file_exists($dir)) {
283 //print "srctemplatepath=".$srctemplatepath; // Src filename
284 $newfile = basename($srctemplatepath);
285 $newfiletmp = preg_replace('/\.od[ts]/i', '', $newfile);
286 $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
287 $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
288
289 $newfiletmp = $objectref . '_' . $newfiletmp;
290 //$file=$dir.'/'.$newfiletmp.'.'.dol_print_date(dol_now(),'%Y%m%d%H%M%S').'.odt';
291
292 // Get extension (ods or odt)
293 $newfileformat = substr($newfile, strrpos($newfile, '.') + 1);
294 if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
295 $format = getDolGlobalString('MAIN_DOC_USE_TIMING');
296 if ($format == '1') {
297 $format = '%Y%m%d%H%M%S';
298 }
299 $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
300 } else {
301 $filename = $newfiletmp . '.' . $newfileformat;
302 }
303 $file = $dir . '/' . $filename;
304 //print "newdir=".$dir;
305 //print "newfile=".$newfile;
306 //print "file=".$file;
307 //print "conf->societe->dir_temp=".$conf->societe->dir_temp;
308
309 dol_mkdir($conf->mymodule->dir_temp);
310 if (!is_writable($conf->mymodule->dir_temp)) {
311 $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->mymodule->dir_temp);
312 dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
313 return -1;
314 }
315
316 // If CUSTOMER contact defined on object, we use it
317 $usecontact = false;
318 $arrayidcontact = $object->getIdContact('external', 'CUSTOMER');
319 if (count($arrayidcontact) > 0) {
320 $usecontact = true;
321 $result = $object->fetch_contact($arrayidcontact[0]);
322 }
323
324 // Recipient name
325 $contactobject = null;
326 if (!empty($usecontact)) {
327 // We can use the company of contact instead of thirdparty company
328 if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || getDolGlobalInt('MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
329 $object->contact->fetch_thirdparty();
330 $socobject = $object->contact->thirdparty;
331 $contactobject = $object->contact;
332 } else {
333 $socobject = $object->thirdparty;
334 // if we have a CUSTOMER contact and we don't use it as thirdparty recipient we store the contact object for later use
335 $contactobject = $object->contact;
336 }
337 } else {
338 $socobject = $object->thirdparty;
339 }
340
341 // Make substitution
342 $substitutionarray = array(
343 '__FROM_NAME__' => $this->emetteur->name,
344 '__FROM_EMAIL__' => $this->emetteur->email,
345 '__TOTAL_TTC__' => $object->total_ttc,
346 '__TOTAL_HT__' => $object->total_ht,
347 '__TOTAL_VAT__' => $object->total_tva
348 );
349 complete_substitutions_array($substitutionarray, $langs, $object);
350 // Call the ODTSubstitution hook
351 $parameters = array('file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$substitutionarray);
352 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
353
354 // Line of free text
355 $newfreetext = '';
356 $paramfreetext = 'MYMODULE_MYOBJECT_FREE_TEXT';
357 if (getDolGlobalString($paramfreetext)) {
358 $newfreetext = make_substitutions(getDolGlobalString($paramfreetext), $substitutionarray);
359 }
360
361 // Open and load template
362 require_once ODTPHP_PATH.'odf.php';
363 try {
364 $odfHandler = new Odf(
365 $srctemplatepath,
366 array(
367 'PATH_TO_TMP' => $conf->mymodule->dir_temp,
368 'ZIP_PROXY' => getDolGlobalString('MAIN_ODF_ZIP_PROXY', 'PclZipProxy'), // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
369 'DELIMITER_LEFT' => '{',
370 'DELIMITER_RIGHT' => '}'
371 )
372 );
373 } catch (Exception $e) {
374 $this->error = $e->getMessage();
375 dol_syslog($e->getMessage(), LOG_INFO);
376 return -1;
377 }
378 // After construction $odfHandler->contentXml contains content and
379 // [!-- BEGIN row.lines --]*[!-- END row.lines --] has been replaced by
380 // [!-- BEGIN lines --]*[!-- END lines --]
381 //print html_entity_decode($odfHandler->__toString());
382 //print exit;
383
384
385 // Make substitutions into odt of freetext
386 try {
387 $odfHandler->setVars('free_text', $newfreetext, true, 'UTF-8');
388 } catch (OdfException $e) {
389 dol_syslog($e->getMessage(), LOG_INFO);
390 }
391
392 // Define substitution array
393 $substitutionarray = getCommonSubstitutionArray($outputlangs, 0, null, $object);
394 $array_object_from_properties = $this->get_substitutionarray_each_var_object($object, $outputlangs);
395 $array_objet = $this->get_substitutionarray_object($object, $outputlangs);
396 $array_user = $this->get_substitutionarray_user($user, $outputlangs);
397 $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
398 $array_thirdparty = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
399 $array_other = $this->get_substitutionarray_other($outputlangs);
400 // retrieve contact information for use in object as contact_xxx tags
401 $array_thirdparty_contact = array();
402 if ($usecontact && is_object($contactobject)) {
403 $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
404 }
405
406 $tmparray = array_merge($substitutionarray, $array_object_from_properties, $array_user, $array_soc, $array_thirdparty, $array_objet, $array_other, $array_thirdparty_contact);
407 complete_substitutions_array($tmparray, $outputlangs, $object);
408
409 // Call the ODTSubstitution hook
410 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
411 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
412
413 foreach ($tmparray as $key => $value) {
414 try {
415 if (preg_match('/logo$/', $key)) {
416 // Image
417 if (file_exists($value)) {
418 $odfHandler->setImage($key, $value);
419 } else {
420 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
421 }
422 } else {
423 // Text
424 $odfHandler->setVars($key, $value, true, 'UTF-8');
425 }
426 } catch (OdfException $e) {
427 dol_syslog($e->getMessage(), LOG_INFO);
428 }
429 }
430 // Replace tags of lines
431 $foundtagforlines = 1;
432 try {
433 $listlines = $odfHandler->setSegment('lines');
434 } catch (OdfExceptionSegmentNotFound $e) {
435 // We may arrive here if tags for lines not present into template
436 $foundtagforlines = 0;
437 dol_syslog($e->getMessage(), LOG_INFO);
438 }
439
440 if ($foundtagforlines) {
441 $linenumber = 0;
442 foreach ($object->lines as $line) {
443 $linenumber++;
444 $tmparray = $this->get_substitutionarray_lines($line, $outputlangs, $linenumber);
445 complete_substitutions_array($tmparray, $outputlangs, $object, $line, "completesubstitutionarray_lines");
446 // Call the ODTSubstitutionLine hook
447 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray, 'line' => $line);
448 $reshook = $hookmanager->executeHooks('ODTSubstitutionLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
449 foreach ($tmparray as $key => $val) {
450 try {
451 $listlines->setVars($key, $val, true, 'UTF-8');
452 } catch (SegmentException $e) {
453 dol_syslog($e->getMessage(), LOG_INFO);
454 }
455 }
456 $listlines->merge();
457 }
458 try {
459 $odfHandler->mergeSegment($listlines);
460 } catch (OdfException $e) {
461 $this->error = $e->getMessage();
462 dol_syslog($this->error, LOG_WARNING);
463 return -1;
464 }
465 }
466
467 // Replace labels translated
468 $tmparray = $outputlangs->get_translations_for_substitutions();
469 foreach ($tmparray as $key => $value) {
470 try {
471 $odfHandler->setVars($key, $value, true, 'UTF-8');
472 } catch (OdfException $e) {
473 dol_syslog($e->getMessage(), LOG_INFO);
474 }
475 }
476
477 // Call the beforeODTSave hook
478
479 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
480 $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
481
482 // Write new file
483 if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
484 try {
485 $odfHandler->exportAsAttachedPDF($file);
486 } catch (Exception $e) {
487 $this->error = $e->getMessage();
488 dol_syslog($e->getMessage(), LOG_INFO);
489 return -1;
490 }
491 } else {
492 try {
493 $odfHandler->saveToDisk($file);
494 } catch (Exception $e) {
495 $this->error = $e->getMessage();
496 dol_syslog($e->getMessage(), LOG_INFO);
497 return -1;
498 }
499 }
500
501 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
502 $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
503
504 dolChmod($file);
505
506 $odfHandler = null; // Destroy object
507
508 $this->result = array('fullpath' => $file);
509
510 return 1; // Success
511 } else {
512 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
513 return -1;
514 }
515 }
516
517 return -1;
518 }
519}
$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 generation of HTML components Only common components must be here.
Parent class for document models.
Class for MyObject.
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.
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.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
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).
if(!function_exists( 'dol_getprefix')) dol_include_once($relpath, $classname='')
Make an include_once using default root and alternate root if it fails.
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.