From 701c85620b5d2dbe7b3d6fddce6cc75d7074af14 Mon Sep 17 00:00:00 2001
From: Francis Appels <francis.appels@yahoo.com>
Date: Sun, 3 May 2015 10:00:11 +0200
Subject: [PATCH] Extend sticker classes from abstract class
Extend member and printsheet sticker printer classes from new abstract
commonsticker generator
---
.../modules/member/doc/pdf_standard.class.php | 232 ++----------------
.../doc/pdf_standardlabel.class.php | 46 ++--
2 files changed, 30 insertions(+), 248 deletions(-)
diff --git a/htdocs/core/modules/member/doc/pdf_standard.class.php b/htdocs/core/modules/member/doc/pdf_standard.class.php
index 9268a10f3c4..7df37a7c05c 100644
--- a/htdocs/core/modules/member/doc/pdf_standard.class.php
+++ b/htdocs/core/modules/member/doc/pdf_standard.class.php
@@ -4,6 +4,7 @@
* Copyright (C) 2001-2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2002-2003 Jean-Louis Bergamo <jlb@j1b.org>
* Copyright (C) 2006-2013 Laurent Destailleur <eldy@users.sourceforge.net>
+ * Copyright (C) 2015 Francis Appels <francis.appels@yahoo.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -19,106 +20,38 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/* Inspire de PDF_Label
- * PDF_Label - PDF label editing
- * @package PDF_Label
- * @author Laurent PASSEBECQ <lpasseb@numericable.fr>
- * @copyright 2003 Laurent PASSEBECQ
- * disponible ici : http://www.fpdf.org/fr/script/script29.php
- */
-
-//-------------------------------------------------------------------
-// VERSIONS :
-// 1.0 : Initial release
-// 1.1 : + : Added unit in the constructor
-// + : Now Positions start @ (1,1).. then the first image @top-left of a page is (1,1)
-// + : Added in the description of a label :
-// font-size : defaut char size (can be changed by calling Set_Char_Size(xx);
-// paper-size : Size of the paper for this sheet (thanx to Al Canton)
-// metric : type of unit used in this description
-// You can define your label properties in inches by setting metric to 'in'
-// and printing in millimiter by setting unit to 'mm' in constructor.
-// Added some labels :
-// 5160, 5161, 5162, 5163,5164 : thanx to Al Canton : acanton@adams-blake.com
-// 8600 : thanx to Kunal Walia : kunal@u.washington.edu
-// + : Added 3mm to the position of labels to avoid errors
-////////////////////////////////////////////////////
-
/**
* \file htdocs/core/modules/member/doc/pdf_standard.class.php
* \ingroup member
* \brief Fichier de la classe permettant d'editer au format PDF des etiquettes au format Avery ou personnalise
*/
-require_once DOL_DOCUMENT_ROOT.'/core/lib/pdf.lib.php';
-require_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
-require_once DOL_DOCUMENT_ROOT.'/core/lib/format_cards.lib.php';
-
+require_once DOL_DOCUMENT_ROOT.'/core/class/commonstickergenerator.class.php';
/**
* Class to generate stick sheet with format Avery or other personalised
*/
-class pdf_standard
+class pdf_standard extends CommonStickerGenerator
{
- var $code; // Code of format
- var $format; // Array with informations
-
- // Proprietes privees
- var $_Avery_Name = ''; // Nom du format de l'etiquette
- var $_Margin_Left = 0; // Marge de gauche de l'etiquette
- var $_Margin_Top = 0; // marge en haut de la page avant la premiere etiquette
- var $_X_Space = 0; // Espace horizontal entre 2 bandes d'etiquettes
- var $_Y_Space = 0; // Espace vertical entre 2 bandes d'etiquettes
- var $_X_Number = 0; // NX Nombre d'etiquettes sur la largeur de la page
- var $_Y_Number = 0; // NY Nombre d'etiquettes sur la hauteur de la page
- var $_Width = 0; // Largeur de chaque etiquette
- var $_Height = 0; // Hauteur de chaque etiquette
- var $_Char_Size = 10; // Hauteur des caracteres
- var $_Line_Height = 10; // Hauteur par defaut d'une ligne
- var $_Metric = 'mm'; // Type of metric.. Will help to calculate good values
- var $_Metric_Doc = 'mm'; // Type of metric for the doc..
-
- var $_COUNTX = 1;
- var $_COUNTY = 1;
- var $_First = 1;
-
-
- /**
- * Constructor
- *
- * @param DoliDB $db Database handler
- */
- function __construct($db)
- {
- $this->db = $db;
- }
-
-
/**
- * Methode qui permet de modifier la taille des caracteres
- * Cela modiera aussi l'espace entre chaque ligne
+ * Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)
*
- * @param PDF $pdf PDF
- * @param int $pt point
- * @return void
+ * @param PDF &$pdf PDF reference
+ * @param Translate $outputlangs Output langs
+ * @param array $param Associative array containing label content and optional parameters
+ * @return void
*/
- function Set_Char_Size(&$pdf,$pt)
- {
- if ($pt > 3) {
- $this->_Char_Size = $pt;
- $this->_Line_Height = $this->_Get_Height_Chars($pt);
- $pdf->SetFont('','',$pt);
- }
- }
-
-
- /**
+ function addSticker(&$pdf,$outputlangs,$param) {
+ // use this method in future refactoring
+ }
+
+ /**
* Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)
* - %LOGO% is replace with company logo
* - %PHOTO% is replace with photo provided as parameter
*
- * @param PDF $pdf PDF
+ * @param PDF &$pdf PDF
* @param string $textleft Text left
* @param string $header Header
* @param string $footer Footer
@@ -297,143 +230,6 @@ class pdf_standard
}
}
- /**
- * Print dot line
- *
- * @param PDF $pdf PDF
- * @param int $x1 X1
- * @param int $y1 Y1
- * @param int $x2 X2
- * @param int $y2 Y2
- * @param int $epaisseur Epaisseur
- * @param int $nbPointilles Nb pointilles
- * @return void
- */
- function _Pointille(&$pdf,$x1=0,$y1=0,$x2=210,$y2=297,$epaisseur=1,$nbPointilles=15)
- {
- $pdf->SetLineWidth($epaisseur);
- $length=abs($x1-$x2);
- $hauteur=abs($y1-$y2);
- if($length>$hauteur) {
- $Pointilles=($length/$nbPointilles)/2; // taille des pointilles
- }
- else {
- $Pointilles=($hauteur/$nbPointilles)/2;
- }
- for($i=$x1;$i<=$x2;$i+=$Pointilles+$Pointilles) {
- for($j=$i;$j<=($i+$Pointilles);$j++) {
- if($j<=($x2-1)) {
- $pdf->Line($j,$y1,$j+1,$y1); // on trace le pointill? du haut, point par point
- $pdf->Line($j,$y2,$j+1,$y2); // on trace le pointill? du bas, point par point
- }
- }
- }
- for($i=$y1;$i<=$y2;$i+=$Pointilles+$Pointilles) {
- for($j=$i;$j<=($i+$Pointilles);$j++) {
- if($j<=($y2-1)) {
- $pdf->Line($x1,$j,$x1,$j+1); // on trace le pointill? du haut, point par point
- $pdf->Line($x2,$j,$x2,$j+1); // on trace le pointill? du bas, point par point
- }
- }
- }
- }
-
- /**
- * Fonction realisant une croix aux 4 coins des cartes
- *
- * @param PDF $pdf PDF
- * @param int $x1 X1
- * @param int $y1 Y1
- * @param int $x2 X2
- * @param int $y2 Y2
- * @param int $epaisseur Epaisseur
- * @param int $taille Size
- * @return void
- */
- function _Croix(&$pdf,$x1=0,$y1=0,$x2=210,$y2=297,$epaisseur=1,$taille=4)
- {
- $pdf->SetDrawColor(192,192,192);
-
- $pdf->SetLineWidth($epaisseur);
- $lg=$taille/2;
- // croix haut gauche
- $pdf->Line($x1,$y1-$lg,$x1,$y1+$lg);
- $pdf->Line($x1-$lg,$y1,$x1+$lg,$y1);
- // croix bas gauche
- $pdf->Line($x1,$y2-$lg,$x1,$y2+$lg);
- $pdf->Line($x1-$lg,$y2,$x1+$lg,$y2);
- // croix haut droit
- $pdf->Line($x2,$y1-$lg,$x2,$y1+$lg);
- $pdf->Line($x2-$lg,$y1,$x2+$lg,$y1);
- // croix bas droit
- $pdf->Line($x2,$y2-$lg,$x2,$y2+$lg);
- $pdf->Line($x2-$lg,$y2,$x2+$lg,$y2);
-
- $pdf->SetDrawColor(0,0,0);
- }
-
- /**
- * Convert units (in to mm, mm to in)
- * $src and $dest must be 'in' or 'mm'
- *
- * @param int $value value
- * @param string $src from
- * @param string $dest to
- * @return float value value after conversion
- */
- function _Convert_Metric ($value, $src, $dest)
- {
- if ($src != $dest) {
- $tab['in'] = 39.37008;
- $tab['mm'] = 1000;
- return $value * $tab[$dest] / $tab[$src];
- } else {
- return $value;
- }
- }
-
- /**
- * Give the height for a char size given.
- *
- * @param int $pt Point
- * @return int Height chars
- */
- function _Get_Height_Chars($pt)
- {
- // Tableau de concordance entre la hauteur des caracteres et de l'espacement entre les lignes
- $_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);
- if (in_array($pt, array_keys($_Table_Hauteur_Chars))) {
- return $_Table_Hauteur_Chars[$pt];
- } else {
- return 100; // There is a prob..
- }
- }
-
- /**
- * Set format
- *
- * @param PDF $pdf PDF
- * @param string $format Format
- * @return void
- */
- function _Set_Format(&$pdf, $format)
- {
-
- $this->_Metric = $format['metric'];
- $this->_Avery_Name = $format['name'];
- $this->_Avery_Code = $format['code'];
- $this->_Margin_Left = $this->_Convert_Metric($format['marginLeft'], $this->_Metric, $this->_Metric_Doc);
- $this->_Margin_Top = $this->_Convert_Metric($format['marginTop'], $this->_Metric, $this->_Metric_Doc);
- $this->_X_Space = $this->_Convert_Metric($format['SpaceX'], $this->_Metric, $this->_Metric_Doc);
- $this->_Y_Space = $this->_Convert_Metric($format['SpaceY'], $this->_Metric, $this->_Metric_Doc);
- $this->_X_Number = $format['NX'];
- $this->_Y_Number = $format['NY'];
- $this->_Width = $this->_Convert_Metric($format['width'], $this->_Metric, $this->_Metric_Doc);
- $this->_Height = $this->_Convert_Metric($format['height'], $this->_Metric, $this->_Metric_Doc);
- $this->Set_Char_Size($pdf, $format['font-size']);
- }
-
-
/**
* Function to build PDF on disk, then output on HTTP strem.
*
diff --git a/htdocs/core/modules/printsheet/doc/pdf_standardlabel.class.php b/htdocs/core/modules/printsheet/doc/pdf_standardlabel.class.php
index e8eaeabf12e..d9d9b825a4b 100644
--- a/htdocs/core/modules/printsheet/doc/pdf_standardlabel.class.php
+++ b/htdocs/core/modules/printsheet/doc/pdf_standardlabel.class.php
@@ -20,45 +20,31 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/* Inspire de PDF_Label
- * PDF_Label - PDF label editing
- * @package PDF_Label
- * @author Laurent PASSEBECQ <lpasseb@numericable.fr>
- * @copyright 2003 Laurent PASSEBECQ
- * disponible ici : http://www.fpdf.org/fr/script/script29.php
- */
-
-//-------------------------------------------------------------------
-// VERSIONS :
-// 1.0 : Initial release
-// 1.1 : + : Added unit in the constructor
-// + : Now Positions start @ (1,1).. then the first image @top-left of a page is (1,1)
-// + : Added in the description of a label :
-// font-size : defaut char size (can be changed by calling Set_Char_Size(xx);
-// paper-size : Size of the paper for this sheet (thanx to Al Canton)
-// metric : type of unit used in this description
-// You can define your label properties in inches by setting metric to 'in'
-// and printing in millimiter by setting unit to 'mm' in constructor.
-// Added some labels :
-// 5160, 5161, 5162, 5163,5164 : thanx to Al Canton : acanton@adams-blake.com
-// 8600 : thanx to Kunal Walia : kunal@u.washington.edu
-// + : Added 3mm to the position of labels to avoid errors
-////////////////////////////////////////////////////
-
/**
* \file htdocs/core/modules/printsheet/doc/pdf_standardlabel.class.php
* \ingroup core
* \brief Fichier de la classe permettant d'editer au format PDF des etiquettes au format Avery ou personnalise
*/
-require_once DOL_DOCUMENT_ROOT.'/core/class/pdf_label.class.php';
+require_once DOL_DOCUMENT_ROOT.'/core/class/commonstickergenerator.class.php';
/**
* Class to generate stick sheet with format Avery or other personalised
*/
-class pdf_standardlabel extends pdf_label
+class pdf_standardlabel extends CommonStickerGenerator
{
-
+ /**
+ * Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)
+ *
+ * @param PDF &$pdf PDF reference
+ * @param Translate $outputlangs Output langs
+ * @param array $param Associative array containing label content and optional parameters
+ * @return void
+ */
+ function addSticker(&$pdf,$outputlangs,$param) {
+ // use this method in future refactoring
+ }
+
/**
* Output a sticker on page at position _COUNTX, _COUNTY (_COUNTX and _COUNTY start from 0)
* - %LOGO% is replace with company logo
@@ -73,7 +59,7 @@ class pdf_standardlabel extends pdf_label
* @param string $photo Photo (full path to image file used as replacement for key %PHOTOS% into left, right, header or footer text)
* @return void
*/
- function Add_PDF_card(&$pdf,$textleft,$header,$footer,$outputlangs,$textright='',$photo='')
+ function Add_PDF_label(&$pdf,$textleft,$header,$footer,$outputlangs,$textright='',$photo='')
{
global $mysoc,$conf,$langs;
global $forceimgscalewidth,$forceimgscaleheight;
@@ -320,7 +306,7 @@ class pdf_standardlabel extends pdf_label
foreach($arrayofrecords as $val)
{
// imprime le texte specifique sur la carte
- $this->Add_PDF_card($pdf,$val['textleft'],$val['textheader'],$val['textfooter'],$langs,$val['textright'],$val['photo']);
+ $this->Add_PDF_label($pdf,$val['textleft'],$val['textheader'],$val['textfooter'],$langs,$val['textright'],$val['photo']);
}
//$pdf->SetXY(10, 295);
--
GitLab