dolibarr 25.0.0-alpha
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/functions.lib.php';
36require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
37require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
38require_once DOL_DOCUMENT_ROOT.'/core/lib/doc.lib.php';
39
40
45{
50 public $emetteur;
51
56 public $phpmin = array(7, 0);
57
61 public $version = 'dolibarr';
62
66 public $position = 60;
67
68
74 public function __construct($db)
75 {
76 global $langs, $mysoc;
77
78 // Load translation files required by the page
79 $langs->loadLangs(array("main", "companies"));
80
81 $this->db = $db;
82 $this->name = "ODT templates";
83 $this->description = $langs->trans("DocumentModelOdt");
84 $this->scandir = 'MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH'; // Name of constant that is used to save list of directories to scan
85
86 // Page size for A4 format
87 $this->type = 'odt';
88 $this->page_largeur = 0;
89 $this->page_hauteur = 0;
90 $this->format = array($this->page_largeur, $this->page_hauteur);
91 $this->marge_gauche = 0;
92 $this->marge_droite = 0;
93 $this->marge_haute = 0;
94 $this->marge_basse = 0;
95
96 $this->option_logo = 1; // Display logo
97 $this->option_tva = 0; // Manage the vat option FACTURE_TVAOPTION
98 $this->option_modereg = 0; // Display payment mode
99 $this->option_condreg = 0; // Display payment terms
100 $this->option_multilang = 1; // Available in several languages
101 $this->option_escompte = 0; // Displays if there has been a discount
102 $this->option_credit_note = 0; // Support credit notes
103 $this->option_freetext = 1; // Support add of a personalised text
104 $this->option_draft_watermark = 0; // Support add of a watermark on drafts
105
106 if ($mysoc === null) {
107 dol_syslog(get_class($this).'::__construct() Global $mysoc should not be null.'. getCallerInfoString(), LOG_ERR);
108 return;
109 }
110
111 // Get source company
112 $this->emetteur = $mysoc;
113 if (!$this->emetteur->country_code) {
114 $this->emetteur->country_code = dol_substr($langs->defaultlang, -2); // By default if not defined
115 }
116 }
117
118
125 public function info($langs)
126 {
127 global $langs;
128
129 // Load translation files required by the page
130 $langs->loadLangs(array("errors", "companies"));
131
132 $form = new Form($this->db);
133
134 $odtPath = trim(getDolGlobalString('MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH'));
135
136 $texte = $this->description.".<br>\n";
137 $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" enctype="multipart/form-data">';
138 $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
139 $texte .= '<input type="hidden" name="page_y" value="">';
140 $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
141 $texte .= '<input type="hidden" name="param1" value="MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH">';
142
143 $texte .= '<table class="nobordernopadding centpercent">';
144
145 // List of directories area
146 $texte .= '<tr><td>';
147 $texttitle = $langs->trans("ListOfDirectories");
148 $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', $odtPath));
149 $listoffiles = array();
150 foreach ($listofdir as $key => $tmpdir) {
151 $tmpdir = trim($tmpdir);
152 $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
153 if (!$tmpdir) {
154 unset($listofdir[$key]);
155 continue;
156 }
157 if (!dol_is_dir($tmpdir)) {
158 $texttitle .= img_warning($langs->trans("ErrorDirNotFound", $tmpdir), '');
159 } else {
160 $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.(ods|odt)');
161 if (count($tmpfiles)) {
162 $listoffiles = array_merge($listoffiles, $tmpfiles);
163 }
164 }
165 }
166 $texthelp = $langs->trans("ListOfDirectoriesForModelGenODT");
167 $texthelp .= '<br><br><span class="opacitymedium">'.$langs->trans("ExampleOfDirectoriesForModelGen").'</span>';
168 // Add list of substitution keys
169 $texthelp .= '<br>'.$langs->trans("FollowingSubstitutionKeysCanBeUsed").'<br>';
170 $texthelp .= $langs->transnoentitiesnoconv("FullListOnOnlineDocumentation"); // This contains an url, we don't modify it
171
172 // Scan directories
173 $nbofiles = count($listoffiles);
174 if ($odtPath) {
175 $texte .= '<span class="opacitylow">'.$langs->trans("NumberOfModelFilesFound").': <b>';
176 //$texte.=$nbofiles?'<a id="a_'.get_class($this).'" href="#">':'';
177 $texte .= count($listoffiles);
178 //$texte.=$nbofiles?'</a>':'';
179 $texte .= '</b></span>';
180 }
181
182 if ($nbofiles) {
183 $texte .= '<div id="div_'.get_class($this).'" class="hiddenx opacitylow">';
184 // Show list of found files
185 foreach ($listoffiles as $file) {
186 $texte .= '- '.$file['name'].' <a href="'.DOL_URL_ROOT.'/document.php?modulepart=doctemplates&file=mymodule_myobject/'.urlencode(basename($file['name'])).'">'.img_picto('', 'listlight').'</a>';
187 $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>';
188 $texte .= '<br>';
189 }
190 $texte .= '</div>';
191 }
192
193 if (!getDolGlobalString('MAIN_NO_MULTIDIR_FOR_ODT')) {
194 $texte .= '<br>';
195 $texte .= $form->textwithpicto($texttitle, $texthelp, 1, 'help', '', 1, 3, $this->name);
196 $texte .= '<div><div style="display: inline-block; min-width: 100px; vertical-align: middle;">';
197 $texte .= '<textarea class="flat textareafordir" spellcheck="false" cols="60" name="value1">';
198 $texte .= $odtPath;
199 $texte .= '</textarea>';
200 $texte .= '</div><div style="display: inline-block; vertical-align: middle;">';
201 $texte .= '<input type="submit" class="button button-edit smallpaddingimp reposition" name="modify" value="'.dolPrintHTMLForAttribute($langs->trans("Modify")).'">';
202 $texte .= '<br></div></div>';
203 } else {
204 $texte .= '<br>';
205 $texte .= '<input type="hidden" name="value1" value="MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH">';
206 }
207
208 // Add input to upload a new template file.
209 $texte .= '<div>'.$langs->trans("UploadNewTemplate");
210 $maxfilesizearray = getMaxFileSizeArray();
211 $maxmin = $maxfilesizearray['maxmin'];
212 if ($maxmin > 0) {
213 $texte .= '<input type="hidden" name="MAX_FILE_SIZE" value="'.($maxmin * 1024).'">'; // MAX_FILE_SIZE must precede the field type=file
214 }
215 $texte .= ' <input type="file" name="uploadfile">';
216 $texte .= '<input type="hidden" value="MYMODULE_MYOBJECT_ADDON_PDF_ODT_PATH" name="keyforuploaddir">';
217 $texte .= '<input type="submit" class="button smallpaddingimp reposition" value="'.dol_escape_htmltag($langs->trans("Upload")).'" name="upload">';
218 $texte .= '</div>';
219
220 $texte .= '</td>';
221
222 $texte .= '</tr>';
223
224 $texte .= '</table>';
225 $texte .= '</form>';
226
227 return $texte;
228 }
229
230 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
242 public function write_file($object, $outputlangs, $srctemplatepath = '', $hidedetails = 0, $hidedesc = 0, $hideref = 0)
243 {
244 // phpcs:enable
245 global $user, $langs, $conf, $mysoc, $hookmanager;
246 global $action;
247
248 if (empty($srctemplatepath)) {
249 dol_syslog("doc_generic_odt::write_file parameter srctemplatepath empty", LOG_WARNING);
250 return -1;
251 }
252
253 // Add odtgeneration hook
254 if (!is_object($hookmanager)) {
255 include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
256 $hookmanager = new HookManager($this->db);
257 }
258 $hookmanager->initHooks(array('odtgeneration'));
259 global $action;
260
261 if (!is_object($outputlangs)) {
262 $outputlangs = $langs;
263 }
264 $sav_charset_output = $outputlangs->charset_output;
265 $outputlangs->charset_output = 'UTF-8';
266
267 $outputlangs->loadLangs(array("main", "dict", "companies", "bills"));
268
269 if ($conf->mymodule->dir_output) {
270 // If $object is id instead of object
271 if (!is_object($object)) {
272 $id = $object;
273 $object = new MyObject($this->db);
274 $result = $object->fetch($id);
275 if ($result < 0) {
276 dol_print_error($this->db, $object->error);
277 return -1;
278 }
279 }
280
281 $object->fetch_thirdparty();
282
283 $dir = $conf->mymodule->multidir_output[isset($object->entity) ? $object->entity : 1];
284 $objectref = dol_sanitizeFileName($object->ref);
285 if (!preg_match('/specimen/i', $objectref)) {
286 $dir .= "/".$objectref;
287 }
288 $file = $dir."/".$objectref.".odt";
289
290 if (!file_exists($dir)) {
291 if (dol_mkdir($dir) < 0) {
292 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
293 return -1;
294 }
295 }
296
297 if (file_exists($dir)) {
298 //print "srctemplatepath=".$srctemplatepath; // Src filename
299 $newfile = basename($srctemplatepath);
300 $newfiletmp = preg_replace('/\.od[ts]/i', '', $newfile);
301 $newfiletmp = preg_replace('/template_/i', '', $newfiletmp);
302 $newfiletmp = preg_replace('/modele_/i', '', $newfiletmp);
303
304 $newfiletmp = $objectref . '_' . $newfiletmp;
305 //$file=$dir.'/'.$newfiletmp.'.'.dol_print_date(dol_now(),'%Y%m%d%H%M%S').'.odt';
306
307 // Get extension (ods or odt)
308 $newfileformat = dol_substr($newfile, strrpos($newfile, '.') + 1);
309 if (getDolGlobalString('MAIN_DOC_USE_TIMING')) {
310 $format = getDolGlobalString('MAIN_DOC_USE_TIMING');
311 if ($format == '1') {
312 $format = '%Y%m%d%H%M%S';
313 }
314 $filename = $newfiletmp . '-' . dol_print_date(dol_now(), $format) . '.' . $newfileformat;
315 } else {
316 $filename = $newfiletmp . '.' . $newfileformat;
317 }
318 $file = $dir . '/' . $filename;
319 //print "newdir=".$dir;
320 //print "newfile=".$newfile;
321 //print "file=".$file;
322 //print "conf->societe->dir_temp=".$conf->societe->dir_temp;
323
324 dol_mkdir($conf->mymodule->dir_temp);
325 if (!dol_is_writable($conf->mymodule->dir_temp)) {
326 $this->error = $langs->transnoentities("ErrorFailedToWriteInTempDirectory", $conf->mymodule->dir_temp);
327 dol_syslog('Error in write_file: ' . $this->error, LOG_ERR);
328 return -1;
329 }
330
331 // If CUSTOMER contact defined on object, we use it
332 $usecontact = false;
333 $arrayidcontact = $object->getIdContact('external', 'CUSTOMER');
334 if (count($arrayidcontact) > 0) {
335 $usecontact = true;
336 $result = $object->fetch_contact($arrayidcontact[0]);
337 }
338
339 // Recipient name
340 $contactobject = null;
341 if (!empty($usecontact)) {
342 // We can use the company of contact instead of thirdparty company
343 if ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || getDolGlobalInt('MAIN_USE_COMPANY_NAME_OF_CONTACT'))) {
344 $object->contact->fetch_thirdparty();
345 $socobject = $object->contact->thirdparty;
346 $contactobject = $object->contact;
347 } else {
348 $socobject = $object->thirdparty;
349 // if we have a CUSTOMER contact and we don't use it as thirdparty recipient we store the contact object for later use
350 $contactobject = $object->contact;
351 }
352 } else {
353 $socobject = $object->thirdparty;
354 }
355
356 // Make substitution
357 $substitutionarray = array(
358 '__FROM_NAME__' => $this->emetteur->name,
359 '__FROM_EMAIL__' => $this->emetteur->email,
360 '__TOTAL_TTC__' => $object->total_ttc,
361 '__TOTAL_HT__' => $object->total_ht,
362 '__TOTAL_VAT__' => $object->total_tva
363 );
364 complete_substitutions_array($substitutionarray, $langs, $object);
365 // Call the ODTSubstitution hook
366 $parameters = array('file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$substitutionarray);
367 $reshook = $hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
368
369 // Line of free text
370 $newfreetext = '';
371 $paramfreetext = 'MYMODULE_MYOBJECT_FREE_TEXT';
372 if (getDolGlobalString($paramfreetext)) {
373 $newfreetext = make_substitutions(getDolGlobalString($paramfreetext), $substitutionarray);
374 }
375
376 // Open and load template
377 require_once ODTPHP_PATH.'odf.php';
378 try {
379 $odfHandler = new Odf(
380 $srctemplatepath,
381 array(
382 'PATH_TO_TMP' => $conf->mymodule->dir_temp,
383 'ZIP_PROXY' => getDolGlobalString('MAIN_ODF_ZIP_PROXY', 'PclZipProxy'), // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
384 'DELIMITER_LEFT' => '{',
385 'DELIMITER_RIGHT' => '}'
386 )
387 );
388 } catch (Exception $e) {
389 $this->error = $e->getMessage();
390 dol_syslog($e->getMessage(), LOG_INFO);
391 return -1;
392 }
393 // After construction $odfHandler->contentXml contains content and
394 // [!-- BEGIN row.lines --]*[!-- END row.lines --] has been replaced by
395 // [!-- BEGIN lines --]*[!-- END lines --]
396 //print html_entity_decode($odfHandler->__toString());
397 //print exit;
398
399 $object->fetch_optionals();
400
401 // Make substitutions into odt of freetext
402 try {
403 $odfHandler->setVars('free_text', $newfreetext, true, 'UTF-8');
404 } catch (OdfException $e) {
405 dol_syslog($e->getMessage(), LOG_INFO);
406 }
407
408 // Define substitution array
409 $substitutionarray = getCommonSubstitutionArray($outputlangs, 0, null, $object);
410 $array_object_from_properties = $this->get_substitutionarray_each_var_object($object, $outputlangs);
411 $array_objet = $this->get_substitutionarray_object($object, $outputlangs);
412 $array_user = $this->get_substitutionarray_user($user, $outputlangs);
413 $array_soc = $this->get_substitutionarray_mysoc($mysoc, $outputlangs);
414 $array_thirdparty = $this->get_substitutionarray_thirdparty($socobject, $outputlangs);
415 $array_other = $this->get_substitutionarray_other($outputlangs);
416 // retrieve contact information for use in object as contact_xxx tags
417 $array_thirdparty_contact = array();
418 if ($usecontact && is_object($contactobject)) {
419 $array_thirdparty_contact = $this->get_substitutionarray_contact($contactobject, $outputlangs, 'contact');
420 }
421
422 $tmparray = array_merge($substitutionarray, $array_object_from_properties, $array_user, $array_soc, $array_thirdparty, $array_objet, $array_other, $array_thirdparty_contact);
423 complete_substitutions_array($tmparray, $outputlangs, $object);
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 // retrieve the constant to apply a ratio for image size or set the ratio to 1
430 if (getDolGlobalString('MAIN_DOC_ODT_IMAGE_RATIO')) {
431 $ratio = (float) getDolGlobalString('MAIN_DOC_ODT_IMAGE_RATIO');
432 } else {
433 $ratio = 1;
434 }
435
436 foreach ($tmparray as $key => $value) {
437 try {
438 if (preg_match('/logo$/', $key)) {
439 // Image
440 if (file_exists($value)) {
441 $odfHandler->setImage($key, $value, $ratio);
442 } else {
443 $odfHandler->setVars($key, 'ErrorFileNotFound', true, 'UTF-8');
444 }
445 } else {
446 // Text
447 $odfHandler->setVars($key, $value, true, 'UTF-8');
448 }
449 } catch (OdfException $e) {
450 dol_syslog($e->getMessage(), LOG_INFO);
451 }
452 }
453 // Replace tags of lines
454 $foundtagforlines = 1;
455 try {
456 $listlines = $odfHandler->setSegment('lines');
457 } catch (OdfExceptionSegmentNotFound $e) {
458 // We may arrive here if tags for lines not present into template
459 $foundtagforlines = 0;
460 dol_syslog($e->getMessage(), LOG_INFO);
461 }
462
463 if ($foundtagforlines) {
464 $linenumber = 0;
465 foreach ($object->lines as $line) {
467 $linenumber++;
468
469 $tmparray = $this->get_substitutionarray_lines($line, $outputlangs, $linenumber);
470 complete_substitutions_array($tmparray, $outputlangs, $object, $line, "completesubstitutionarray_lines");
471 // Call the ODTSubstitutionLine hook
472 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray, 'line' => $line);
473 $reshook = $hookmanager->executeHooks('ODTSubstitutionLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
474 foreach ($tmparray as $key => $val) {
475 try {
476 $listlines->setVars($key, $val, true, 'UTF-8');
477 } catch (SegmentException $e) {
478 dol_syslog($e->getMessage(), LOG_INFO);
479 }
480 }
481 $listlines->merge();
482 }
483 try {
484 $odfHandler->mergeSegment($listlines);
485 } catch (OdfException $e) {
486 $this->error = $e->getMessage();
487 dol_syslog($this->error, LOG_WARNING);
488 return -1;
489 }
490 }
491
492 // Replace labels translated
493 $tmparray = $outputlangs->get_translations_for_substitutions();
494 foreach ($tmparray as $key => $value) {
495 try {
496 $odfHandler->setVars($key, $value, true, 'UTF-8');
497 } catch (OdfException $e) {
498 dol_syslog($e->getMessage(), LOG_INFO);
499 }
500 }
501
502 // Call the beforeODTSave hook
503
504 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
505 $reshook = $hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
506
507 // Write new file
508 if (getDolGlobalString('MAIN_ODT_AS_PDF')) {
509 try {
510 $odfHandler->exportAsAttachedPDF($file);
511 } catch (Exception $e) {
512 $this->error = $e->getMessage();
513 dol_syslog($e->getMessage(), LOG_INFO);
514 return -1;
515 }
516 } else {
517 try {
518 $odfHandler->saveToDisk($file);
519 } catch (Exception $e) {
520 $this->error = $e->getMessage();
521 dol_syslog($e->getMessage(), LOG_INFO);
522 return -1;
523 }
524 }
525
526 $parameters = array('odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputlangs, 'substitutionarray' => &$tmparray);
527 $reshook = $hookmanager->executeHooks('afterODTCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
528
529 dolChmod($file);
530
531 $odfHandler = null; // Destroy object
532
533 $this->result = array('fullpath' => $file);
534
535 return 1; // Success
536 } else {
537 $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
538 return -1;
539 }
540 }
541
542 return -1;
543 }
544}
$id
Support class for third parties, contacts, members, users or resources.
Definition account.php:47
if(! $sortfield) if(! $sortorder) $object
Definition account.php:100
$propal type
'integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]',...
Definition propal.php:281
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $conf
The main.inc.php has been included so the following variable are now defined:
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 generation of HTML components Only common components must be here.
Class to manage hooks.
Parent class for document models.
write_file($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0)
Function to build a document on disk.
Class for MyObject.
Class to build documents using ODF templates generator.
info($langs)
Return description of a module.
global $mysoc
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_is_writable($folderorfile)
Test if directory or filename is writable.
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:66
dol_is_dir($folder)
Test if filename is a directory.
dol_now($mode='gmt')
Return date for now.
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.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
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...
dol_substr($string, $start, $length=null, $stringencoding='', $trunconbytes=0)
Make a substring.
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).
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)
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:165
getMaxFileSizeArray()
Return the max allowed for file upload.