dolibarr  9.0.0
modules_action.php
1 <?php
2 /* Copyright (C) 2003-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2010 Laurent Destailleur <eldy@users.sourceforge.net>
4  * Copyright (C) 2004 Eric Seigne <eric.seigne@ryxeo.com>
5  * Copyright (C) 2005-2012 Regis Houssin <regis.houssin@inodbox.com>
6  * Copyright (C) 2016 Charlie Benke <charlie@patas-monkey.com>
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 <http://www.gnu.org/licenses/>.
20  * or see http://www.gnu.org/
21  */
22 
23 require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
24 
29 abstract class ModeleAction extends CommonDocGenerator
30 {
34  public $error='';
35 
36  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.NotCamelCaps
44  static function liste_modeles($db,$maxfilenamelength=0)
45  {
46  // phpcs:enable
47  global $conf;
48 
49  $type='action';
50  $liste=array();
51 
52  include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
53  $liste=getListOfModels($db,$type,$maxfilenamelength);
54 
55  return $liste;
56  }
57 }
58 
59 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.NotCamelCaps
72 function action_create($db, $object, $modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
73 {
74  // phpcs:enable
75  global $conf,$langs,$user;
76  $langs->load("action");
77 
78  $error=0;
79 
80  $srctemplatepath='';
81 
82  // Positionne modele sur le nom du modele de fichinter a utiliser
83  if (! dol_strlen($modele))
84  {
85  if (! empty($conf->global->ACTION_EVENT_ADDON_PDF))
86  {
87  $modele = $conf->global->ACTION_EVENT_ADDON_PDF;
88  }
89  else
90  {
91  $modele = 'soleil';
92  }
93  }
94 
95  // If selected modele is a filename template (then $modele="modelname:filename")
96  $tmp=explode(':',$modele,2);
97  if (! empty($tmp[1]))
98  {
99  $modele=$tmp[0];
100  $srctemplatepath=$tmp[1];
101  }
102 
103  // Search template files
104  $file=''; $classname=''; $filefound=0;
105  $dirmodels=array('/');
106  if (is_array($conf->modules_parts['models'])) $dirmodels=array_merge($dirmodels,$conf->modules_parts['models']);
107  foreach($dirmodels as $reldir)
108  {
109  foreach(array('doc','pdf') as $prefix)
110  {
111  $file = $prefix."_".$modele.".modules.php";
112 
113  // On verifie l'emplacement du modele
114  $file=dol_buildpath($reldir."core/modules/action/doc/".$file,0);
115  if (file_exists($file))
116  {
117  $filefound=1;
118  $classname=$prefix.'_'.$modele;
119  break;
120  }
121  }
122  if ($filefound) break;
123  }
124 
125  // Charge le modele
126  if ($filefound)
127  {
128  require_once $file;
129 
130  $obj = new $classname($db);
131 
132  // We save charset_output to restore it because write_file can change it if needed for
133  // output format that does not support UTF8.
134  $sav_charset_output=$outputlangs->charset_output;
135  if ($obj->write_file($object, $outputlangs, $srctemplatepath, $hidedetails, $hidedesc, $hideref) > 0)
136  {
137  $outputlangs->charset_output=$sav_charset_output;
138 
139  // We delete old preview
140  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
141  dol_delete_preview($object);
142 
143  return 1;
144  }
145  else
146  {
147  $outputlangs->charset_output=$sav_charset_output;
148  dol_print_error($db,"action_pdf_create Error: ".$obj->error);
149  return 0;
150  }
151  }
152  else
153  {
154  print $langs->trans("Error")." ".$langs->trans("ErrorFileDoesNotExists",$file);
155  return 0;
156  }
157 }
print
Draft customers invoices.
Definition: index.php:91
dol_delete_preview($object)
Delete all preview files linked to object instance.
Definition: files.lib.php:1324
dol_print_error($db='', $error='', $errors=null)
Affiche message erreur system avec toutes les informations pour faciliter le diagnostic et la remonte...
dol_buildpath($path, $type=0, $returnemptyifnotfound=0)
Return path of url or filesystem.
static liste_modeles($db, $maxfilenamelength=0)
Return list of active generation modules.
Parent class for documents generators.
getListOfModels($db, $type, $maxfilenamelength=0)
Return list of activated modules usable for document generation.
Parent class for product models of doc generators.
dol_strlen($string, $stringencoding='UTF-8')
Make a strlen call.