dolibarr 21.0.0-alpha
pdf_standard_member.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2003 Steve Dillon
3 * Copyright (C) 2003 Laurent Passebecq
4 * Copyright (C) 2001-2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
5 * Copyright (C) 2002-2003 Jean-Louis Bergamo <jlb@j1b.org>
6 * Copyright (C) 2006-2013 Laurent Destailleur <eldy@users.sourceforge.net>
7 * Copyright (C) 2015 Francis Appels <francis.appels@yahoo.com>
8 * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
9 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
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 */
24
31require_once DOL_DOCUMENT_ROOT.'/core/class/commonstickergenerator.class.php';
32
37{
42 public $version = 'dolibarr';
43
44
50 public function __construct($db)
51 {
52 global $langs;
53
54 // Translations
55 $langs->loadLangs(array("main", "admin"));
56
57 $this->db = $db;
58 $this->name = "standard";
59 $this->description = $langs->trans('TemplateforBusinessCards');
60 //$this->update_main_doc_field = 1; // Save the name of generated file as the main doc when generating a doc with this template
61
62 $this->type = 'pdf-various-sizes';
63 }
64
73 public function addSticker(&$pdf, $outputlangs, $param)
74 {
75 // use this method in future refactoring
76 }
77
78 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
94 public function Add_PDF_card(&$pdf, $textleft, $header, $footer, $outputlangs, $textright = '', $idmember = 0, $photo = '')
95 {
96 // phpcs:enable
97 global $db, $mysoc, $conf, $langs;
98 global $forceimgscalewidth, $forceimgscaleheight;
99
100 $imgscalewidth = (empty($forceimgscalewidth) ? 0.3 : $forceimgscalewidth); // Scale of image for width (1=Full width of sticker)
101 $imgscaleheight = (empty($forceimgscalewidth) ? 0.5 : $forceimgscalewidth); // Scale of image for height (1=Full height of sticker)
102
103 // We are in a new page, then we must add a page
104 if (($this->_COUNTX == 0) && ($this->_COUNTY == 0) and (!$this->_First == 1)) {
105 $pdf->AddPage();
106 }
107 $this->_First = 0;
108 $_PosX = $this->_Margin_Left + ($this->_COUNTX * ($this->_Width + $this->_X_Space));
109 $_PosY = $this->_Margin_Top + ($this->_COUNTY * ($this->_Height + $this->_Y_Space));
110
111 // Define logo
112 $logo = $conf->mycompany->dir_output.'/logos/'.$mysoc->logo;
113 if (!is_readable($logo)) {
114 $logo = '';
115 if (!empty($mysoc->logo_small) && is_readable($conf->mycompany->dir_output.'/logos/thumbs/'.$mysoc->logo_small)) {
116 $logo = $conf->mycompany->dir_output.'/logos/thumbs/'.$mysoc->logo_small;
117 } elseif (!empty($mysoc->logo) && is_readable($conf->mycompany->dir_output.'/logos/'.$mysoc->logo)) {
118 $logo = $conf->mycompany->dir_output.'/logos/'.$mysoc->logo;
119 }
120 }
121
122 $member = new Adherent($db);
123 $member->id = $idmember;
124 $member->ref = (string) $idmember;
125
126 // Define photo
127 $dir = $conf->adherent->dir_output;
128 if (!empty($photo)) {
129 $file = get_exdir(0, 0, 0, 0, $member, 'member').'photos/'.$photo;
130 $photo = $dir.'/'.$file;
131 if (!is_readable($photo)) {
132 $photo = '';
133 }
134 }
135
136 // Define background image
137 $backgroundimage = '';
138 if (getDolGlobalString('ADHERENT_CARD_BACKGROUND') && file_exists($conf->adherent->dir_output.'/' . getDolGlobalString('ADHERENT_CARD_BACKGROUND'))) {
139 $backgroundimage = $conf->adherent->dir_output.'/' . getDolGlobalString('ADHERENT_CARD_BACKGROUND');
140 }
141
142 // Print lines
143 if ($this->code == "CARD") {
144 $this->Tformat = $this->_Avery_Labels["CARD"];
145 //$this->_Pointille($pdf,$_PosX,$_PosY,$_PosX+$this->_Width,$_PosY+$this->_Height,0.3,25);
146 $this->_Croix($pdf, $_PosX, $_PosY, $_PosX + $this->_Width, $_PosY + $this->_Height, 0.1, 10);
147 }
148
149 // Background
150 if ($backgroundimage) {
151 $pdf->image($backgroundimage, $_PosX, $_PosY, $this->_Width, $this->_Height);
152 }
153
154 $xleft = 2;
155 $ytop = 2;
156
157 // Top
158 if ($header != '') {
159 if ($this->code == "CARD") {
160 $pdf->SetDrawColor(128, 128, 128);
161 $pdf->Line($_PosX, $_PosY + $this->_Line_Height + 1, $_PosX + $this->_Width, $_PosY + $this->_Line_Height + 1); // Only 1 mm and not ytop for top text
162 $pdf->SetDrawColor(0, 0, 0);
163 }
164 $pdf->SetXY($_PosX + $xleft, $_PosY + 1); // Only 1 mm and not ytop for top text
165 $pdf->Cell($this->_Width - 2 * $xleft, $this->_Line_Height, $outputlangs->convToOutputCharset($header), 0, 1, 'C');
166 }
167
168
169 $ytop += (empty($header) ? 0 : (1 + $this->_Line_Height));
170
171 // Define widthtouse and heighttouse
172 $maxwidthtouse = round(($this->_Width - 2 * $xleft) * $imgscalewidth);
173 $maxheighttouse = round(($this->_Height - 2 * $ytop) * $imgscaleheight);
174 $defaultratio = ($maxwidthtouse / $maxheighttouse);
175 $widthtouse = $maxwidthtouse;
176 $heighttouse = 0; // old value for image
177 $tmp = dol_getImageSize($photo, false);
178 if (isset($tmp['height'])) {
179 $imgratio = $tmp['width'] / $tmp['height'];
180 if ($imgratio >= $defaultratio) {
181 $widthtouse = $maxwidthtouse;
182 $heighttouse = round($widthtouse / $imgratio);
183 } else {
184 $heighttouse = $maxheighttouse;
185 $widthtouse = round($heighttouse * $imgratio);
186 }
187 }
188 //var_dump($this->_Width.'x'.$this->_Height.' with border and scale '.$imgscale.' => max '.$maxwidthtouse.'x'.$maxheighttouse.' => We use '.$widthtouse.'x'.$heighttouse);exit;
189
190 // Center
191 if ($textright == '') { // Only a left part
192 // Output left area
193 if ($textleft == '__LOGO__' && $logo) {
194 $pdf->Image($logo, $_PosX + $xleft, $_PosY + $ytop, $widthtouse, $heighttouse);
195 } elseif ($textleft == '__PHOTO__' && $photo) {
196 $pdf->Image($photo, $_PosX + $xleft, $_PosY + $ytop, $widthtouse, $heighttouse);
197 } else {
198 $pdf->SetXY($_PosX + $xleft, $_PosY + $ytop);
199 $pdf->MultiCell($this->_Width, $this->_Line_Height, $outputlangs->convToOutputCharset($textleft), 0, 'L');
200 }
201 } elseif ($textleft != '' && $textright != '') { //
202 if ($textleft == '__LOGO__' || $textleft == '__PHOTO__') {
203 if ($textleft == '__LOGO__' && $logo) {
204 $pdf->Image($logo, $_PosX + $xleft, $_PosY + $ytop, $widthtouse, $heighttouse);
205 } elseif ($textleft == '__PHOTO__' && $photo) {
206 $pdf->Image($photo, $_PosX + $xleft, $_PosY + $ytop, $widthtouse, $heighttouse);
207 }
208 $pdf->SetXY($_PosX + $xleft + $widthtouse + 1, $_PosY + $ytop);
209 $pdf->MultiCell($this->_Width - $xleft - $xleft - $widthtouse - 1, $this->_Line_Height, $outputlangs->convToOutputCharset($textright), 0, 'R');
210 } elseif ($textright == '__LOGO__' || $textright == '__PHOTO__') {
211 if ($textright == '__LOGO__' && $logo) {
212 $pdf->Image($logo, $_PosX + $this->_Width - $widthtouse - $xleft, $_PosY + $ytop, $widthtouse, $heighttouse);
213 } elseif ($textright == '__PHOTO__' && $photo) {
214 $pdf->Image($photo, $_PosX + $this->_Width - $widthtouse - $xleft, $_PosY + $ytop, $widthtouse, $heighttouse);
215 }
216 $pdf->SetXY($_PosX + $xleft, $_PosY + $ytop);
217 $pdf->MultiCell($this->_Width - $widthtouse - $xleft - $xleft - 1, $this->_Line_Height, $outputlangs->convToOutputCharset($textleft), 0, 'L');
218 } else { // text on halft left and text on half right
219 $pdf->SetXY($_PosX + $xleft, $_PosY + $ytop);
220 $pdf->MultiCell(round($this->_Width / 2), $this->_Line_Height, $outputlangs->convToOutputCharset($textleft), 0, 'L');
221 $pdf->SetXY($_PosX + round($this->_Width / 2), $_PosY + $ytop);
222 $pdf->MultiCell(round($this->_Width / 2) - 2, $this->_Line_Height, $outputlangs->convToOutputCharset($textright), 0, 'R');
223 }
224 } else { // Only a right part
225 // Output right area
226 if ($textright == '__LOGO__' && $logo) {
227 $pdf->Image($logo, $_PosX + $this->_Width - $widthtouse - $xleft, $_PosY + $ytop, $widthtouse, $heighttouse);
228 } elseif ($textright == '__PHOTO__' && $photo) {
229 $pdf->Image($photo, $_PosX + $this->_Width - $widthtouse - $xleft, $_PosY + $ytop, $widthtouse, $heighttouse);
230 } else {
231 $pdf->SetXY($_PosX + $xleft, $_PosY + $ytop);
232 $pdf->MultiCell($this->_Width - $xleft, $this->_Line_Height, $outputlangs->convToOutputCharset($textright), 0, 'R');
233 }
234 }
235
236 // Bottom
237 if ($footer != '') {
238 if ($this->code == "CARD") {
239 $pdf->SetDrawColor(128, 128, 128);
240 $pdf->Line($_PosX, $_PosY + $this->_Height - $this->_Line_Height - 2, $_PosX + $this->_Width, $_PosY + $this->_Height - $this->_Line_Height - 2);
241 $pdf->SetDrawColor(0, 0, 0);
242 }
243 $pdf->SetXY($_PosX, $_PosY + $this->_Height - $this->_Line_Height - 1);
244 $pdf->Cell($this->_Width, $this->_Line_Height, $outputlangs->convToOutputCharset($footer), 0, 1, 'C');
245 }
246 //print "$_PosY+$this->_Height-$this->_Line_Height-1<br>\n";
247
248 $this->_COUNTY++;
249
250 if ($this->_COUNTY == $this->_Y_Number) {
251 // Si on est en bas de page, on remonte le 'curseur' de position
252 $this->_COUNTX++;
253 $this->_COUNTY = 0;
254 }
255
256 if ($this->_COUNTX == $this->_X_Number) {
257 // Si on est en bout de page, alors on repart sur une nouvelle page
258 $this->_COUNTX = 0;
259 $this->_COUNTY = 0;
260 }
261 }
262
263 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
275 public function write_file($object, $outputlangs, $srctemplatepath, $mode = 'member', $nooutput = 0, $filename = 'tmp_cards')
276 {
277 // phpcs:enable
278 global $user, $conf, $langs, $mysoc, $_Avery_Labels;
279
280 $this->code = $srctemplatepath;
281
282 if (is_object($object)) {
283 if ($object->country == '-') {
284 $object->country = '';
285 }
286
287 $now = dol_now();
288 $year = dol_print_date($now, '%Y');
289 $month = dol_print_date($now, '%m');
290 $day = dol_print_date($now, '%d');
291
292 // List of values to scan for a replacement
293 $substitutionarray = array(
294 '__ID__' => $object->id,
295 '__REF__' => $object->ref,
296 '__LOGIN__' => empty($object->login) ? '' : $object->login,
297 '__FIRSTNAME__' => empty($object->firstname) ? '' : $object->firstname,
298 '__LASTNAME__' => empty($object->lastname) ? '' : $object->lastname,
299 '__FULLNAME__' => $object->getFullName($langs),
300 '__COMPANY__' => empty($object->company) ? '' : $object->company,
301 '__ADDRESS__' => empty($object->address) ? '' : $object->address,
302 '__ZIP__' => empty($object->zip) ? '' : $object->zip,
303 '__TOWN__' => empty($object->town) ? '' : $object->town,
304 '__COUNTRY__' => empty($object->country) ? '' : $object->country,
305 '__COUNTRY_CODE__' => empty($object->country_code) ? '' : $object->country_code,
306 '__EMAIL__' => empty($object->email) ? '' : $object->email,
307 '__BIRTH__' => dol_print_date($object->birth, 'day'),
308 '__TYPE__' => empty($object->type) ? '' : $object->type,
309 '__YEAR__' => $year,
310 '__MONTH__' => $month,
311 '__DAY__' => $day,
312 '__DOL_MAIN_URL_ROOT__' => DOL_MAIN_URL_ROOT,
313 '__SERVER__' => "https://".$_SERVER["SERVER_NAME"]."/"
314 );
315 complete_substitutions_array($substitutionarray, $langs);
316
317 // For business cards
318 $textleft = make_substitutions(getDolGlobalString("ADHERENT_CARD_TEXT"), $substitutionarray);
319 $textheader = make_substitutions(getDolGlobalString("ADHERENT_CARD_HEADER_TEXT"), $substitutionarray);
320 $textfooter = make_substitutions(getDolGlobalString("ADHERENT_CARD_FOOTER_TEXT"), $substitutionarray);
321 $textright = make_substitutions(getDolGlobalString("ADHERENT_CARD_TEXT_RIGHT"), $substitutionarray);
322
323 $nb = $_Avery_Labels[$this->code]['NX'] * $_Avery_Labels[$this->code]['NY'];
324 if ($nb <= 0) {
325 $nb = 1; // Protection to avoid empty page
326 }
327
328 $arrayofmembers = array();
329 for ($j = 0; $j < $nb; $j++) {
330 $arrayofmembers[] = array(
331 'textleft' => $textleft,
332 'textheader' => $textheader,
333 'textfooter' => $textfooter,
334 'textright' => $textright,
335 'id' => (isset($object->id) ? $object->id : ""),
336 'photo' => (isset($object->photo) ? $object->photo : "")
337 );
338 }
339
340 $arrayofrecords = $arrayofmembers;
341 } else {
342 // Old usage
343 $arrayofrecords = $object;
344 }
345
346 $this->Tformat = $_Avery_Labels[$this->code];
347 if (empty($this->Tformat)) {
348 dol_print_error(null, 'ErrorBadTypeForCard'.$this->code);
349 exit;
350 }
351
352 $this->type = 'pdf';
353 $filename .= '.pdf';
354
355 // standard format or custom
356 if ($this->Tformat['paper-size'] != 'custom') {
357 $this->format = $this->Tformat['paper-size'];
358 } else {
359 //custom
360 $resolution = array($this->Tformat['custom_x'], $this->Tformat['custom_y']);
361 $this->format = $resolution;
362 }
363
364 if (!is_object($outputlangs)) {
365 $outputlangs = $langs;
366 }
367 // For backward compatibility with FPDF, force output charset to ISO, because FPDF expect text to be encoded in ISO
368 if (getDolGlobalString('MAIN_USE_FPDF')) {
369 $outputlangs->charset_output = 'ISO-8859-1';
370 }
371
372 // Load traductions files required by page
373 $outputlangs->loadLangs(array("main", "dict", "companies", "admin", "members"));
374
375 if (empty($mode) || $mode == 'member') {
376 $title = $outputlangs->transnoentities('MembersCards');
377 $keywords = $outputlangs->transnoentities('MembersCards')." ".$outputlangs->transnoentities("Foundation")." ".$outputlangs->convToOutputCharset($mysoc->name);
378 } else {
379 dol_print_error(null, 'Bad value for $mode');
380 return -1;
381 }
382
383
384 if (is_object($object)) {
385 $outputdir = $conf->adherent->dir_output;
386 $dir = $outputdir."/".get_exdir(0, 0, 0, 0, $object, 'member');
387 $file = $dir.'/'.$filename;
388 } else {
389 $outputdir = $conf->adherent->dir_temp;
390 $dir = $outputdir;
391 $file = $dir.'/'.$filename;
392 }
393
394 //var_dump($file);exit;
395
396 if (!file_exists($dir)) {
397 if (dol_mkdir($dir) < 0) {
398 $this->error = $langs->trans("ErrorCanNotCreateDir", $dir);
399 return 0;
400 }
401 }
402
403 $pdf = pdf_getInstance($this->format, $this->Tformat['metric'], $this->Tformat['orientation']);
404
405 if (class_exists('TCPDF')) {
406 $pdf->setPrintHeader(false);
407 $pdf->setPrintFooter(false);
408 }
409 $pdf->SetFont(pdf_getPDFFont($outputlangs));
410
411 $pdf->SetTitle($title);
412 $pdf->SetSubject($title);
413 $pdf->SetCreator("Dolibarr ".DOL_VERSION);
414 $pdf->SetAuthor($outputlangs->convToOutputCharset($user->getFullName($outputlangs)));
415 $pdf->SetKeyWords($keywords);
416 if (getDolGlobalString('MAIN_DISABLE_PDF_COMPRESSION')) {
417 $pdf->SetCompression(false);
418 }
419
420 $pdf->SetMargins(0, 0);
421 $pdf->SetAutoPageBreak(false);
422
423 $this->_Metric_Doc = $this->Tformat['metric'];
424 // Permet de commencer l'impression de l'etiquette desiree dans le cas ou la page a deja service
425 $posX = 1;
426 $posY = 1;
427 if ($posX > 0) {
428 $posX--;
429 } else {
430 $posX = 0;
431 }
432 if ($posY > 0) {
433 $posY--;
434 } else {
435 $posY = 0;
436 }
437 $this->_COUNTX = $posX;
438 $this->_COUNTY = $posY;
439 $this->_Set_Format($pdf, $this->Tformat);
440
441
442 $pdf->Open();
443 $pdf->AddPage();
444
445
446 // Add each record
447 foreach ($arrayofrecords as $val) {
448 // imprime le texte specifique sur la carte
449 $this->Add_PDF_card($pdf, $val['textleft'], $val['textheader'], $val['textfooter'], $langs, $val['textright'], $val['id'], $val['photo']);
450 }
451
452 //$pdf->SetXY(10, 295);
453 //$pdf->Cell($this->_Width, $this->_Line_Height, 'XXX',0,1,'C');
454
455
456 // Output to file
457 $pdf->Output($file, 'F');
458
459 dolChmod($file);
460
461 $this->result = array('fullpath' => $file);
462
463 // Output to http stream
464 if (empty($nooutput)) {
465 clearstatcache();
466
467 $attachment = true;
468 if (getDolGlobalString('MAIN_DISABLE_FORCE_SAVEAS')) {
469 $attachment = false;
470 }
471 $type = dol_mimetype($filename);
472
473 //if ($encoding) header('Content-Encoding: '.$encoding);
474 if ($type) {
475 header('Content-Type: '.$type);
476 }
477 if ($attachment) {
478 header('Content-Disposition: attachment; filename="'.$filename.'"');
479 } else {
480 header('Content-Disposition: inline; filename="'.$filename.'"');
481 }
482
483 // Ajout directives pour resoudre bug IE
484 header('Cache-Control: Public, must-revalidate');
485 header('Pragma: public');
486
487 readfile($file);
488 }
489
490 return 1;
491 }
492}
if( $user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
Definition card.php:58
Class to manage members of a foundation.
Class to generate stick sheet with format Avery or other personalised.
_Croix(&$pdf, $x1=0, $y1=0, $x2=210, $y2=297, $epaisseur=1, $taille=4)
protected Function realisant une croix aux 4 coins des cartes
_Set_Format(&$pdf, $format)
protected Set format
Class to generate stick sheet with format Avery or other personalised.
Add_PDF_card(&$pdf, $textleft, $header, $footer, $outputlangs, $textright='', $idmember=0, $photo='')
Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)
write_file($object, $outputlangs, $srctemplatepath, $mode='member', $nooutput=0, $filename='tmp_cards')
Function to build PDF on disk, then output on HTTP stream.
addSticker(&$pdf, $outputlangs, $param)
Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)
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_mimetype($file, $default='application/octet-stream', $mode=0)
Return MIME type of a file from its name with extension.
dolChmod($filepath, $newmask='')
Change mod of a file.
dol_now($mode='auto')
Return date for now.
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).
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_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart='')
Return a path to have a the directory according to object where files are stored.
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
dol_getImageSize($file, $url=false)
Return size of image file on disk (Supported extensions are gif, jpg, png, bmp and webp)
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
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:140