dolibarr 21.0.0-alpha
pdf_standard_actions.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2004 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3 * Copyright (C) 2004-2012 Laurent Destailleur <eldy@users.sourceforge.net>
4 * Copyright (C) 2005-2009 Regis Houssin <regis.houssin@inodbox.com>
5 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
6 * Copyright (C) 2024 Frédéric France <frederic.france@free.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
29require_once DOL_DOCUMENT_ROOT.'/core/lib/pdf.lib.php';
30require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
31require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
32require_once DOL_DOCUMENT_ROOT.'/comm/action/class/actioncomm.class.php';
33require_once DOL_DOCUMENT_ROOT.'/projet/class/project.class.php';
34
39{
43 public $db;
44
48 public $error;
49
53 public $errors;
54
58 public $description;
59
63 public $date_edition;
64
68 public $year;
69
73 public $month;
74
78 public $title;
79
83 public $subject;
84
88 public $marge_gauche;
89
93 public $marge_droite;
94
98 public $marge_haute;
99
103 public $marge_basse;
104
108 public $format;
109
113 public $type;
114
118 public $page_hauteur;
119
123 public $page_largeur;
124
128 public $result;
129
137 public function __construct($db, $month, $year)
138 {
139 global $langs;
140
141 // Load translation files required by the page
142 $langs->loadLangs(array("commercial", "projects"));
143
144 $this->db = $db;
145 $this->description = "";
146 $this->date_edition = time();
147 $this->month = $month;
148 $this->year = $year;
149
150 // Page size for A4 format
151 $this->type = 'pdf';
152 $formatarray = pdf_getFormat();
153 $this->page_largeur = $formatarray['width'];
154 $this->page_hauteur = $formatarray['height'];
155 $this->format = array($this->page_largeur, $this->page_hauteur);
156 $this->marge_gauche = getDolGlobalInt('MAIN_PDF_MARGIN_LEFT', 10);
157 $this->marge_droite = getDolGlobalInt('MAIN_PDF_MARGIN_RIGHT', 10);
158 $this->marge_haute = getDolGlobalInt('MAIN_PDF_MARGIN_TOP', 10);
159 $this->marge_basse = getDolGlobalInt('MAIN_PDF_MARGIN_BOTTOM', 10);
160
161 $this->title = $langs->transnoentitiesnoconv("ActionsReport").' '.$this->year."-".$this->month;
162 $this->subject = $langs->transnoentitiesnoconv("ActionsReport").' '.$this->year."-".$this->month;
163 }
164
165 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
173 public function write_file($object, $outputlangs)
174 {
175 // phpcs:enable
176 global $user, $conf, $langs, $hookmanager;
177
178 if (!is_object($outputlangs)) {
179 $outputlangs = $langs;
180 }
181 // For backward compatibility with FPDF, force output charset to ISO, because FPDF expect text to be encoded in ISO
182 if (getDolGlobalString('MAIN_USE_FPDF')) {
183 $outputlangs->charset_output = 'ISO-8859-1';
184 }
185
186 // Load traductions files required by page
187 $outputlangs->loadLangs(array("main", "dict", "companies", "bills", "products"));
188
189 $dir = $conf->agenda->dir_temp."/";
190 $file = $dir."actions-".sprintf("%02d", $this->month)."-".sprintf("%04d", $this->year).".pdf";
191
192 if (!file_exists($dir)) {
193 if (dol_mkdir($dir) < 0) {
194 $this->error = $langs->trans("ErrorCanNotCreateDir", $dir);
195 return 0;
196 }
197 }
198
199 if (file_exists($dir)) {
200 // Add pdfgeneration hook
201 if (!is_object($hookmanager)) {
202 include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
203 $hookmanager = new HookManager($this->db);
204 }
205 $hookmanager->initHooks(array('pdfgeneration'));
206
207 global $action;
208 $object = new stdClass();
209
210 $parameters = array('file' => $file, 'outputlangs' => $outputlangs);
211 $reshook = $hookmanager->executeHooks('beforePDFCreation', $parameters, $object, $action); // Note that $action and $object may have been modified by some hooks
212
213 $pdf = pdf_getInstance($this->format);
214 $heightforinfotot = 50; // Height reserved to output the info and total part
215 $heightforfreetext = getDolGlobalInt('MAIN_PDF_FREETEXT_HEIGHT', 5); // Height reserved to output the free text on last page
216 $heightforfooter = $this->marge_basse + 8; // Height reserved to output the footer (value include bottom margin)
217 $pdf->SetAutoPageBreak(1, 0);
218
219 if (class_exists('TCPDF')) {
220 $pdf->setPrintHeader(false);
221 $pdf->setPrintFooter(false);
222 }
223 $pdf->SetFont(pdf_getPDFFont($outputlangs));
224
225 $pdf->Open();
226 $pagenb = 0;
227 $pdf->SetDrawColor(128, 128, 128);
228 $pdf->SetFillColor(220, 220, 220);
229
230 $pdf->SetTitle($outputlangs->convToOutputCharset($this->title));
231 $pdf->SetSubject($outputlangs->convToOutputCharset($this->subject));
232 $pdf->SetCreator("Dolibarr ".DOL_VERSION);
233 $pdf->SetAuthor($outputlangs->convToOutputCharset($user->getFullName($outputlangs)));
234 $pdf->SetKeywords($outputlangs->convToOutputCharset($this->title." ".$this->subject));
235
236 // @phan-suppress-next-line PhanPluginSuspiciousParamOrder
237 $pdf->SetMargins($this->marge_gauche, $this->marge_haute, $this->marge_droite); // Left, Top, Right
238
239 $nbpage = $this->_pages($pdf, $outputlangs); // Write content
240
241 if (method_exists($pdf, 'AliasNbPages')) {
242 $pdf->AliasNbPages(); // @phan-suppress-current-line PhanUndeclaredMethod
243 }
244 $pdf->Close();
245
246 $pdf->Output($file, 'F');
247
248 // Add pdfgeneration hook
249 if (!is_object($hookmanager)) {
250 include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
251 $hookmanager = new HookManager($this->db);
252 }
253 $hookmanager->initHooks(array('pdfgeneration'));
254 $parameters = array('file' => $file, 'object' => $object, 'outputlangs' => $outputlangs);
255 global $action;
256 $reshook = $hookmanager->executeHooks('afterPDFCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
257 if ($reshook < 0) {
258 $this->error = $hookmanager->error;
259 $this->errors = $hookmanager->errors;
260 }
261
262 dolChmod($file);
263
264 $this->result = array('fullpath' => $file);
265
266 return 1;
267 }
268 return 0;
269 }
270
278 private function _pages(&$pdf, $outputlangs)
279 {
280 global $conf;
281
282 $height = 3; // height for text separation
283 $pagenb = 1;
284
285 $y = $this->_pagehead($pdf, $outputlangs, $pagenb);
286 $y++;
287 $pdf->SetFont('', '', 8);
288
289 $sql = "SELECT s.nom as thirdparty, s.rowid as socid, s.client,";
290 $sql .= " a.id, a.datep as dp, a.datep2 as dp2,";
291 $sql .= " a.fk_contact, a.note, a.percent as percent, a.fulldayevent, a.label, a.fk_project,";
292 $sql .= " c.code, c.libelle as label_type,";
293 $sql .= " u.login";
294 $sql .= " FROM ".MAIN_DB_PREFIX."c_actioncomm as c, ".MAIN_DB_PREFIX."user as u, ".MAIN_DB_PREFIX."actioncomm as a";
295 $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."societe as s ON a.fk_soc = s.rowid";
296 $sql .= " WHERE c.id=a.fk_action AND a.fk_user_author = u.rowid";
297 $sql .= " AND a.datep BETWEEN '".$this->db->idate(dol_get_first_day($this->year, $this->month, false))."'";
298 $sql .= " AND '".$this->db->idate(dol_get_last_day($this->year, $this->month, false))."'";
299 $sql .= " AND a.entity = ".$conf->entity;
300 $sql .= " ORDER BY a.datep DESC";
301
302 $eventstatic = new ActionComm($this->db);
303 $projectstatic = new Project($this->db);
304
305 dol_syslog(get_class($this)."::_page", LOG_DEBUG);
306 $resql = $this->db->query($sql);
307 if ($resql) {
308 $num = $this->db->num_rows($resql);
309 $i = 0;
310 $y0 = $y1 = $y2 = $y3 = 0;
311
312 while ($i < $num) {
313 $obj = $this->db->fetch_object($resql);
314
315 $eventstatic->id = $obj->id;
316 $eventstatic->percentage = $obj->percent;
317 $eventstatic->fulldayevent = $obj->fulldayevent;
318
319 $y = max($y, $pdf->GetY(), $y0, $y1, $y2, $y3);
320
321 // Calculate height of text
322 $text = '';
323 if (!preg_match('/^'.preg_quote($obj->label, '/').'/', $obj->note)) {
324 $text = $obj->label."\n";
325 }
326 $text .= dolGetFirstLineOfText(dol_string_nohtmltag($obj->note), 1);
327 // Add status to text
328 $text .= "\n";
329 $status = $outputlangs->trans("Status").': '.dol_htmlentitiesbr_decode($eventstatic->getLibStatut(1, 1));
330 $text .= $status;
331 if ($obj->fk_project > 0) {
332 $projectstatic->fetch($obj->fk_project);
333 if ($projectstatic->ref) {
334 $text .= ($status ? ' - ' : '').$outputlangs->transnoentitiesnoconv("Project").": ".dol_htmlentitiesbr_decode($projectstatic->ref);
335 }
336 }
337
338 //print 'd'.$text; exit;
339 $nboflines = dol_nboflines($text);
340
341 $heightlinemax = max(2 * $height, $nboflines * $height);
342 // Check if there is enough space to print record
343 if ((1 + $y + $heightlinemax) >= ($this->page_hauteur - $this->marge_haute)) {
344 // We need to break page
345 $pagenb++;
346 $y = $this->_pagehead($pdf, $outputlangs, $pagenb);
347 $y++;
348 $pdf->SetFont('', '', 8);
349 }
350 $y++;
351
352 // Date
353 $pdf->SetXY($this->marge_gauche, $y);
354 $textdate = dol_print_date($this->db->jdate($obj->dp), "day")."\n".dol_print_date($this->db->jdate($obj->dp), "hour");
355 if ($obj->dp2) {
356 if (dol_print_date($this->db->jdate($obj->dp), "day") != dol_print_date($this->db->jdate($obj->dp2), "day")) {
357 $textdate .= " -> ".dol_print_date($this->db->jdate($obj->dp2), "day")." - ".dol_print_date($this->db->jdate($obj->dp2), "hour");
358 } else {
359 $textdate .= " -> ".dol_print_date($this->db->jdate($obj->dp2), "hour");
360 }
361 }
362 $textdate = $outputlangs->trans("ID").' '.$obj->id.' - '.$textdate;
363 $pdf->MultiCell(45 - $this->marge_gauche, $height, $textdate, 0, 'L', 0);
364 $y0 = $pdf->GetY();
365
366 // Third party
367 $pdf->SetXY(45, $y);
368 $pdf->MultiCell(28, $height, dol_trunc($outputlangs->convToOutputCharset($obj->thirdparty), 28), 0, 'L', 0);
369 $y1 = $pdf->GetY();
370
371 // Action code
372 $code = $obj->code;
373 if (!getDolGlobalString('AGENDA_USE_EVENT_TYPE')) {
374 if ($code == 'AC_OTH') {
375 $code = 'AC_MANUAL';
376 }
377 if ($code == 'AC_OTH_AUTO') {
378 $code = 'AC_AUTO';
379 }
380 }
381 $pdf->SetXY(73, $y);
382 $labelactiontype = $outputlangs->transnoentitiesnoconv("Action".$code);
383 $labelactiontypeshort = $outputlangs->transnoentitiesnoconv("Action".$code.'Short');
384 $pdf->MultiCell(32, $height, dol_trunc($outputlangs->convToOutputCharset($labelactiontypeshort == "Action".$code.'Short' ? $labelactiontype : $labelactiontypeshort), 32), 0, 'L', 0);
385 $y2 = $pdf->GetY();
386
387 // Description of event
388 $pdf->SetXY(106, $y);
389 $pdf->MultiCell(94, $height, $outputlangs->convToOutputCharset(dol_trunc(dol_string_nohtmltag($text, 0), 250, 'right', 'UTF-8', 0)), 0, 'L', 0);
390 $y3 = $pdf->GetY();
391
392 $i++;
393 }
394 }
395
396 return 1;
397 }
398
407 private function _pagehead(&$pdf, $outputlangs, $pagenb)
408 {
409 // Do not add the BACKGROUND as this is a report
410 //pdf_pagehead($pdf,$outputlangs,$this->page_hauteur);
411
412 // New page
413 $pdf->AddPage();
414
415 // Show title
416 $pdf->SetFont('', 'B', 10);
417 $pdf->SetXY($this->marge_gauche, $this->marge_haute);
418 $pdf->MultiCell(120, 1, $outputlangs->convToOutputCharset($this->title), 0, 'L', 0);
419 // Show page nb only on iso languages (so default Helvetica font)
420 if (pdf_getPDFFont($outputlangs) == 'Helvetica') {
421 $pdf->SetXY($this->page_largeur - $this->marge_droite - 40, $this->marge_haute);
422 $pdf->MultiCell(40, 1, $pagenb.'/'.$pdf->getAliasNbPages(), 0, 'R', 0);
423 }
424
425 $y = $pdf->GetY() + 2;
426
427 $pdf->Rect($this->marge_gauche, $y, ($this->page_largeur - $this->marge_gauche - $this->marge_droite), ($this->page_hauteur - $this->marge_haute - $this->marge_basse));
428 $y = $pdf->GetY() + 1;
429
430 return $y;
431 }
432}
if( $user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
Definition card.php:58
Class to manage agenda events (actions)
Class to manage hooks.
Class to manage projects.
Class to generate event report.
_pagehead(&$pdf, $outputlangs, $pagenb)
Show top header of page.
__construct($db, $month, $year)
Constructor.
write_file($object, $outputlangs)
Write the object to document file to disk.
_pages(&$pdf, $outputlangs)
Write content of pages.
dol_get_first_day($year, $month=1, $gm=false)
Return GMT time for first day of a month or year.
Definition date.lib.php:595
dol_get_last_day($year, $month=12, $gm=false)
Return GMT time for last day of a month or year.
Definition date.lib.php:614
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_htmlentitiesbr_decode($stringtodecode, $pagecodeto='UTF-8')
This function is called to decode a HTML string (it decodes entities and br tags)
dolGetFirstLineOfText($text, $nboflines=1, $charset='UTF-8')
Return first line of text.
dol_string_nohtmltag($stringtoclean, $removelinefeed=1, $pagecodeto='UTF-8', $strip_tags=0, $removedoublespaces=1)
Clean a string from all HTML tags and entities.
dolChmod($filepath, $newmask='')
Change mod of a file.
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).
dol_trunc($string, $size=40, $trunc='right', $stringencoding='UTF-8', $nodot=0, $display=0)
Truncate a string to a particular length adding '…' if string larger than length.
dol_nboflines($s, $maxchar=0)
Return nb of lines of a clear text.
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)
pdf_getFormat($outputlangs=null, $mode='setup')
Return array with format properties of default PDF format.
Definition pdf.lib.php:86
pdf_getPDFFont($outputlangs)
Return font name to use for PDF generation.
Definition pdf.lib.php:265
pdf_getInstance($format='', $metric='mm', $pagetype='P')
Return a PDF instance object.
Definition pdf.lib.php:128
if(preg_match('/crypted:/i', $dolibarr_main_db_pass)||!empty($dolibarr_main_db_encrypted_pass)) $conf db type
Definition repair.php:137