dolibarr  17.0.4
commonstickergenerator.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  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program. If not, see <https://www.gnu.org/licenses/>.
21  */
22 
23 /* Inspire de PDF_Label
24  * PDF_Label - PDF label editing
25  * @package PDF_Label
26  * @author Laurent PASSEBECQ <lpasseb@numericable.fr>
27  * @copyright 2003 Laurent PASSEBECQ
28  * disponible ici : http://www.fpdf.org/fr/script/script29.php
29  */
30 
31 //-------------------------------------------------------------------
32 // VERSIONS :
33 // 1.0 : Initial release
34 // 1.1 : + : Added unit in the constructor
35 // + : Now Positions start @ (1,1).. then the first image @top-left of a page is (1,1)
36 // + : Added in the description of a label :
37 // font-size : defaut char size (can be changed by calling Set_Char_Size(xx);
38 // paper-size : Size of the paper for this sheet (thanx to Al Canton)
39 // metric : type of unit used in this description
40 // You can define your label properties in inches by setting metric to 'in'
41 // and printing in millimiter by setting unit to 'mm' in constructor.
42 // Added some labels :
43 // 5160, 5161, 5162, 5163,5164 : thanx to Al Canton : acanton@adams-blake.com
44 // 8600 : thanx to Kunal Walia : kunal@u.washington.edu
45 // + : Added 3mm to the position of labels to avoid errors
47 
54 require_once DOL_DOCUMENT_ROOT.'/core/lib/pdf.lib.php';
55 require_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
56 require_once DOL_DOCUMENT_ROOT.'/core/lib/format_cards.lib.php';
57 
58 
62 abstract class CommonStickerGenerator
63 {
64  public $code; // Code of format
65 
69  public $page_largeur;
70 
74  public $page_hauteur;
75 
79  public $format;
80 
84  public $marge_gauche;
85 
89  public $marge_droite;
90 
94  public $marge_haute;
95 
99  public $marge_basse;
100 
101  // phpcs:disable PEAR.NamingConventions.ValidVariableName.PublicUnderscore
102  // protected
103  // Nom du format de l'etiquette
104  protected $_Avery_Name = '';
105  // Marge de gauche de l'etiquette
106  protected $_Margin_Left = 0;
107  // marge en haut de la page avant la premiere etiquette
108  protected $_Margin_Top = 0;
109  // Espace horizontal entre 2 bandes d'etiquettes
110  protected $_X_Space = 0;
111  // Espace vertical entre 2 bandes d'etiquettes
112  protected $_Y_Space = 0;
113  // NX Nombre d'etiquettes sur la largeur de la page
114  protected $_X_Number = 0;
115  // NY Nombre d'etiquettes sur la hauteur de la page
116  protected $_Y_Number = 0;
117  // Largeur de chaque etiquette
118  protected $_Width = 0;
119  // Hauteur de chaque etiquette
120  protected $_Height = 0;
121  // Hauteur des caracteres
122  protected $_Char_Size = 10;
123  // Hauteur par defaut d'une ligne
124  protected $_Line_Height = 10;
125  // Type of metric.. Will help to calculate good values
126  protected $_Metric = 'mm';
127  // Type of metric for the doc..
128  protected $_Metric_Doc = 'mm';
129  protected $_COUNTX = 1;
130  protected $_COUNTY = 1;
131  protected $_First = 1;
132  public $Tformat;
133 
134 
135  // phpcs:enable
141  public function __construct($db)
142  {
143  $this->db = $db;
144  }
145 
146  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
156  abstract public function write_file($arrayofrecords, $outputlangs, $srctemplatepath, $outputdir = '');
157  // phpcs:enable
158 
167  abstract public function addSticker(&$pdf, $outputlangs, $param);
168 
169  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
178  public function Set_Char_Size(&$pdf, $pt)
179  {
180  // phpcs:enable
181  if ($pt > 3) {
182  $this->_Char_Size = $pt;
183  $this->_Line_Height = $this->_Get_Height_Chars($pt);
184  $pdf->SetFont('', '', $pt);
185  }
186  }
187 
188  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
189  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
202  protected function _Pointille(&$pdf, $x1 = 0, $y1 = 0, $x2 = 210, $y2 = 297, $epaisseur = 1, $nbPointilles = 15)
203  {
204  // phpcs:enable
205  $pdf->SetLineWidth($epaisseur);
206  $length = abs($x1 - $x2);
207  $hauteur = abs($y1 - $y2);
208  if ($length > $hauteur) {
209  $Pointilles = ($length / $nbPointilles) / 2; // taille des pointilles
210  } else {
211  $Pointilles = ($hauteur / $nbPointilles) / 2;
212  }
213  for ($i = $x1; $i <= $x2; $i += $Pointilles + $Pointilles) {
214  for ($j = $i; $j <= ($i + $Pointilles); $j++) {
215  if ($j <= ($x2 - 1)) {
216  $pdf->Line($j, $y1, $j + 1, $y1); // on trace le pointill? du haut, point par point
217  $pdf->Line($j, $y2, $j + 1, $y2); // on trace le pointill? du bas, point par point
218  }
219  }
220  }
221  for ($i = $y1; $i <= $y2; $i += $Pointilles + $Pointilles) {
222  for ($j = $i; $j <= ($i + $Pointilles); $j++) {
223  if ($j <= ($y2 - 1)) {
224  $pdf->Line($x1, $j, $x1, $j + 1); // on trace le pointill? du haut, point par point
225  $pdf->Line($x2, $j, $x2, $j + 1); // on trace le pointill? du bas, point par point
226  }
227  }
228  }
229  }
230 
231  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
232  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
245  protected function _Croix(&$pdf, $x1 = 0, $y1 = 0, $x2 = 210, $y2 = 297, $epaisseur = 1, $taille = 4)
246  {
247  // phpcs:enable
248  $pdf->SetDrawColor(192, 192, 192);
249 
250  $pdf->SetLineWidth($epaisseur);
251  $lg = $taille / 2;
252  // croix haut gauche
253  $pdf->Line($x1, $y1 - $lg, $x1, $y1 + $lg);
254  $pdf->Line($x1 - $lg, $y1, $x1 + $lg, $y1);
255  // croix bas gauche
256  $pdf->Line($x1, $y2 - $lg, $x1, $y2 + $lg);
257  $pdf->Line($x1 - $lg, $y2, $x1 + $lg, $y2);
258  // croix haut droit
259  $pdf->Line($x2, $y1 - $lg, $x2, $y1 + $lg);
260  $pdf->Line($x2 - $lg, $y1, $x2 + $lg, $y1);
261  // croix bas droit
262  $pdf->Line($x2, $y2 - $lg, $x2, $y2 + $lg);
263  $pdf->Line($x2 - $lg, $y2, $x2 + $lg, $y2);
264 
265  $pdf->SetDrawColor(0, 0, 0);
266  }
267 
277  private function convertMetric($value, $src, $dest)
278  {
279  if ($src != $dest) {
280  $tab = array(
281  'in'=>39.37008,
282  'mm'=>1000
283  );
284  return $value * $tab[$dest] / $tab[$src];
285  }
286 
287  return $value;
288  }
289 
290  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
291  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
298  protected function _Get_Height_Chars($pt)
299  {
300  // phpcs:enable
301  // Array for link between height of characters and space between lines
302  $_Table_Hauteur_Chars = array(6=>2, 7=>2.5, 8=>3, 9=>3.5, 10=>4, 11=>6, 12=>7, 13=>8, 14=>9, 15=>10);
303  if (in_array($pt, array_keys($_Table_Hauteur_Chars))) {
304  return $_Table_Hauteur_Chars[$pt];
305  } else {
306  return 100; // There is a prob..
307  }
308  }
309 
310  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
311  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
319  protected function _Set_Format(&$pdf, $format)
320  {
321  // phpcs:enable
322  $this->_Metric = $format['metric'];
323  $this->_Avery_Name = $format['name'];
324  $this->_Avery_Code = empty($format['code'])?'':$format['code'];
325  $this->_Margin_Left = $this->convertMetric($format['marginLeft'], $this->_Metric, $this->_Metric_Doc);
326  $this->_Margin_Top = $this->convertMetric($format['marginTop'], $this->_Metric, $this->_Metric_Doc);
327  $this->_X_Space = $this->convertMetric($format['SpaceX'], $this->_Metric, $this->_Metric_Doc);
328  $this->_Y_Space = $this->convertMetric($format['SpaceY'], $this->_Metric, $this->_Metric_Doc);
329  $this->_X_Number = $format['NX'];
330  $this->_Y_Number = $format['NY'];
331  $this->_Width = $this->convertMetric($format['width'], $this->_Metric, $this->_Metric_Doc);
332  $this->_Height = $this->convertMetric($format['height'], $this->_Metric, $this->_Metric_Doc);
333  $this->Set_Char_Size($pdf, $format['font-size']);
334  }
335 }
Class to generate stick sheet with format Avery or other personalised.
_Get_Height_Chars($pt)
protected Give the height for a char size given.
_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_Char_Size(&$pdf, $pt)
Methode qui permet de modifier la taille des caracteres Cela modiera aussi l'espace entre chaque lign...
convertMetric($value, $src, $dest)
Convert units (in to mm, mm to in) $src and $dest must be 'in' or 'mm'.
_Set_Format(&$pdf, $format)
protected Set format
_Pointille(&$pdf, $x1=0, $y1=0, $x2=210, $y2=297, $epaisseur=1, $nbPointilles=15)
protected Print dot line
write_file($arrayofrecords, $outputlangs, $srctemplatepath, $outputdir='')
Function to build PDF on disk, then output on HTTP strem.
addSticker(&$pdf, $outputlangs, $param)
Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)
$conf db
API class for accounts.
Definition: inc.php:41