pdf_tcpdflabel.class.php

<?php
/* Copyright (C) 2003 Steve Dillon
 * Copyright (C) 2003 Laurent Passebecq
 * 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>
 * Copyright (C) 2024-2025  MDW           <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024-2025  Frédéric France         <frederic.france@free.fr>
 *
 * 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
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/class/commonstickergenerator.class.php';
 
class pdf_tcpdflabel extends CommonStickerGenerator
{
  // define 1d barcode style
  private $_style1d = array(
    'position' => '',
    'align' => 'C',
    'stretch' => false,
    'fitwidth' => true,
    'cellfitalign' => '',
    'border' => false,
    'hpadding' => 'auto',
    'vpadding' => 'auto',
    'fgcolor' => array(0, 0, 0),
    'bgcolor' => false,
    'text' => true,
    'font' => 'helvetica',
    'fontsize' => 8,
    'stretchtext' => 4
  );
 
  // set style for 2d barcode
  private $_style2d = array(
    'border' => false,
    'vpadding' => 'auto',
    'hpadding' => 'auto',
    'fgcolor' => array(0, 0, 0),
    'bgcolor' => false,
    'module_width' => 1, // width of a single module in points
    'module_height' => 1 // height of a single module in points
  );
 
  private $_align2d = 'N';
 
  private $_xres = 0.4;
 
  private function writeBarcode(&$pdf, $code, $encoding, $is2d, $x, $y, $w, $h)
  {
    if ($is2d) {
      $pdf->write2DBarcode($code, $encoding, $x, $y, $w, $h, $this->_style2d, $this->_align2d);
    } else {
      $pdf->write1DBarcode($code, $encoding, $x, $y, $w, $h, $this->_xres, $this->_style1d);
    }
  }
 
  public function addSticker(&$pdf, $outputlangs, $param)
  {
    global $mysoc, $conf;
 
    $textleft = $param['textleft'];
    $header = $param['textheader'];
    $footer = $param['textfooter'];
    $textright = $param['textright'];
    $code = $param['code'];
    $encoding = $param['encoding'];
    $is2d = $param['is2d'];
 
 
 
    // We are in a new page, then we must add a page
    if (($this->_COUNTX == 0) && ($this->_COUNTY == 0) and (!$this->_First == 1)) {
      $pdf->AddPage();
    }
    $this->_First = 0;
    $_PosX = $this->_Margin_Left + ($this->_COUNTX * ($this->_Width + $this->_X_Space));
    $_PosY = $this->_Margin_Top + ($this->_COUNTY * ($this->_Height + $this->_Y_Space));
 
    // Define logo
    $logo = $conf->mycompany->dir_output.'/logos/'.$mysoc->logo;
    if (!is_readable($logo)) {
      $logo = '';
      if (!empty($mysoc->logo_small) && is_readable($conf->mycompany->dir_output.'/logos/thumbs/'.$mysoc->logo_small)) {
        $logo = $conf->mycompany->dir_output.'/logos/thumbs/'.$mysoc->logo_small;
      } elseif (!empty($mysoc->logo) && is_readable($conf->mycompany->dir_output.'/logos/'.$mysoc->logo)) {
        $logo = $conf->mycompany->dir_output.'/logos/'.$mysoc->logo;
      }
    }
 
    $xleft = 2;
    $ytop = 2;
 
    // Top
    if ($header != '') {
      $pdf->SetXY($_PosX + $xleft, $_PosY + 1); // Only 1 mm and not ytop for top text
      $pdf->Cell(2 * strlen($header), $this->_Line_Height, $outputlangs->convToOutputCharset($header), 0, 1, 'C');
    }
 
    $ytop += (empty($header) ? 0 : (1 + $this->_Line_Height));
 
    // Define widthtouse and heighttouse
    $pageMargins = $pdf->getMargins();
    $maxwidthtouse = round($this->_Width - 2 * $xleft);
    $maxheighttouse = round($this->_Height - 2 * $ytop);
    $maxheighttouse -= (empty($footer) ? 0 : (1 + $this->_Line_Height));
    $defaultratio = ($maxwidthtouse / $maxheighttouse);
    $widthtouse = $maxwidthtouse;
    $heighttouse = $maxheighttouse;
    $logoHeight = $heighttouse;
    $logoWidth = $widthtouse;
 
    //var_dump($this->_Width.'x'.$this->_Height.' with border and scale '.$imgscale.' => max '.$maxwidthtouse.'x'.$maxheighttouse.' => We use '.$widthtouse.'x'.$heighttouse);exit;
 
    // Center
    if ($textright == '') { // Only a left part
      // Output left area
      if ($textleft == '%LOGO%' && $logo) {
        $pdf->Image($logo, $_PosX + $xleft, $_PosY + $ytop, 0, $logoHeight);
      } elseif ($code && !empty($encoding)) {
        $this->writeBarcode($pdf, $code, $encoding, $is2d, $_PosX + $xleft, $_PosY + $ytop, $widthtouse, $heighttouse);
      } else {
        $pdf->SetXY($_PosX + $xleft, $_PosY + $ytop);
        $pdf->MultiCell($this->_Width, $this->_Line_Height, $outputlangs->convToOutputCharset($textleft), 0, 'L');
      }
    } elseif ($textleft != '' && $textright != '') {  // left and right part
      $logoHeight = $heighttouse / 2;
      $logoWidth = $widthtouse / 2;
      if (($textleft == '%LOGO%' || $textleft == '%PHOTO%' || $textleft == '%BARCODE%') && !strstr($textright, '%')) {   // left part logo/barcode right part text
        if ($textleft == '%LOGO%' && $logo) {
          $pdf->Image($logo, $_PosX + $xleft, $_PosY + $ytop, $logoWidth, 0);
        } elseif ($code && !empty($encoding)) {
          $this->writeBarcode($pdf, $code, $encoding, $is2d, $_PosX + $xleft, $_PosY + $ytop, $widthtouse / 2, $heighttouse);
        }
        $pdf->SetXY($_PosX + ($widthtouse / 2), $_PosY + $ytop);
        $pdf->MultiCell($widthtouse / 2, $this->_Line_Height, $outputlangs->convToOutputCharset($textright), 0, 'R');
      } elseif (($textright == '%LOGO%' || $textright == '%PHOTO%' || $textright == '%BARCODE%') && !strstr($textleft, '%')) { // right part logo/barcode left part text
        if ($textright == '%LOGO%' && $logo) {
          $pdf->Image($logo, $_PosX + ($widthtouse / 2), $_PosY + $ytop, $logoWidth, 0);
        } elseif ($code && !empty($encoding)) {
          $this->writeBarcode($pdf, $code, $encoding, $is2d, $_PosX + ($widthtouse / 2), $_PosY + $ytop, $widthtouse / 2, $heighttouse);
        }
        $pdf->SetXY($_PosX + $xleft, $_PosY + $ytop);
        $pdf->MultiCell($widthtouse / 2, $this->_Line_Height, $outputlangs->convToOutputCharset($textleft), 0, 'L');
      } elseif ($textleft == '%LOGO%') {   // left part logo right part text/barcode
        if ($logo) {
          $pdf->Image($logo, $_PosX + $xleft, $_PosY + $ytop, 0, $logoHeight);
        }
        if ($code && !empty($encoding)) {
          $this->writeBarcode($pdf, $code, $encoding, $is2d, $_PosX + $xleft + $logoWidth + 1, $_PosY + $ytop, $widthtouse - $logoWidth - 1, $heighttouse);
        } else {
          $pdf->SetXY($_PosX + $xleft + $logoWidth + 1, $_PosY + $ytop);
          $pdf->MultiCell($widthtouse - $logoWidth - 1, $this->_Line_Height, $outputlangs->convToOutputCharset($textright), 0, 'R');
        }
      } elseif ($textright == '%LOGO%') {  // right part logo left part text/barcode
        if ($logo) {
          $pdf->Image($logo, $_PosX + $xleft + $widthtouse - $logoWidth + 1, $_PosY + $ytop, 0, $logoHeight);
        }
        if ($code && !empty($encoding)) {
          $this->writeBarcode($pdf, $code, $encoding, $is2d, $_PosX + $xleft, $_PosY + $ytop, $widthtouse - $logoWidth - 1, $heighttouse);
        } else {
          $pdf->SetXY($_PosX + $xleft, $_PosY + $ytop);
          $pdf->MultiCell($widthtouse - $logoWidth - 1, $this->_Line_Height, $outputlangs->convToOutputCharset($textleft), 0, 'L');
        }
      } else { // text on halft left and text on half right
        $pdf->SetXY($_PosX + $xleft, $_PosY + $ytop);
        $pdf->MultiCell(round($this->_Width / 2), $this->_Line_Height, $outputlangs->convToOutputCharset($textleft), 0, 'L');
        $pdf->SetXY($_PosX + round($this->_Width / 2), $_PosY + $ytop);
        $pdf->MultiCell(round($this->_Width / 2) - 2, $this->_Line_Height, $outputlangs->convToOutputCharset($textright), 0, 'R');
      }
    } else { // Only a right part
      // Output right area
      if ($textright == '%LOGO%' && $logo) {
        $pdf->Image($logo, $_PosX + $this->_Width - $widthtouse - $xleft, $_PosY + $ytop, 0, $logoHeight);
      } elseif ($code && !empty($encoding)) {
        $this->writeBarcode($pdf, $code, $encoding, $is2d, $_PosX + $this->_Width - $widthtouse - $xleft, $_PosY + $ytop, $widthtouse, $heighttouse);
      } else {
        $pdf->SetXY($_PosX + $xleft, $_PosY + $ytop);
        $pdf->MultiCell($this->_Width - $xleft, $this->_Line_Height, $outputlangs->convToOutputCharset($textright), 0, 'R');
      }
    }
 
    // Bottom
    if ($footer != '') {
      $pdf->SetXY($_PosX, $_PosY + $this->_Height - $this->_Line_Height - 1);
      $pdf->Cell($this->_Width, $this->_Line_Height, $outputlangs->convToOutputCharset($footer), 0, 1, 'C');
    }
    //print "$_PosY+$this->_Height-$this->_Line_Height-1<br>\n";
 
    $this->_COUNTY++;
 
    if ($this->_COUNTY == $this->_Y_Number) {
      // Si on est en bas de page, on remonte le 'curseur' de position
      $this->_COUNTX++;
      $this->_COUNTY = 0;
    }
 
    if ($this->_COUNTX == $this->_X_Number) {
      // Si on est en bout de page, alors on repart sur une nouvelle page
      $this->_COUNTX = 0;
      $this->_COUNTY = 0;
    }
  }
 
 
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_file($arrayofrecords, $outputlangs, $srctemplatepath, $outputdir = '', $filename = 'tmp_address_sheet.pdf')
  {
    // phpcs:enable
    global $user, $conf, $langs, $mysoc, $_Avery_Labels;
 
    $this->code = $srctemplatepath;
    $this->Tformat = $_Avery_Labels[$this->code];
    if (empty($this->Tformat)) {
      dol_print_error(null, 'ErrorBadTypeForCard'.$this->code);
      exit;
    }
    $this->type = 'pdf';
    // standard format or custom
    $paper_size = $this->Tformat['paper-size'];
    if (!is_string($paper_size) || $paper_size != 'custom') {
      $this->format = $paper_size;
    } else {
      //custom
      $resolution = array($this->Tformat['custom_x'], $this->Tformat['custom_y']);
      $this->format = $resolution;
    }
 
    if (!is_object($outputlangs)) {
      $outputlangs = $langs;
    }
    // For backward compatibility with FPDF, force output charset to ISO, because FPDF expect text to be encoded in ISO
    if (getDolGlobalString('MAIN_USE_FPDF')) {
      $outputlangs->charset_output = 'ISO-8859-1';
    }
 
    // Load traductions files required by page
    $outputlangs->loadLangs(array("main", "dict", "companies", "admin"));
 
    $title = $outputlangs->transnoentities('Labels');
    $keywords = $title." ".$outputlangs->convToOutputCharset($mysoc->name);
 
    $dir = (empty($outputdir) ? $conf->adherent->dir_temp : $outputdir);
    $file = $dir."/".$filename;
 
    if (!file_exists($dir)) {
      if (dol_mkdir($dir) < 0) {
        $this->error = $langs->trans("ErrorCanNotCreateDir", $dir);
        return 0;
      }
    }
 
    $pdf = pdf_getInstance($this->format, $this->Tformat['metric'], $this->Tformat['orientation']);
 
    if (class_exists('TCPDF')) {
      $pdf->setPrintHeader(false);
      $pdf->setPrintFooter(false);
    }
    $pdf->SetFont(pdf_getPDFFont($outputlangs));
 
    $pdf->SetTitle($title);
    $pdf->SetSubject($title);
    $pdf->SetCreator("Dolibarr ".DOL_VERSION);
    $pdf->SetAuthor($outputlangs->convToOutputCharset($user->getFullName($outputlangs)));
    $pdf->SetKeyWords($keywords);
    if (getDolGlobalString('MAIN_DISABLE_PDF_COMPRESSION')) {
      $pdf->SetCompression(false);
    }
 
    $pdf->SetMargins(0, 0);
    $pdf->setAutoPageBreak(false);
 
    $this->_Metric_Doc = $this->Tformat['metric'];
    // Permet de commencer l'impression de l'etiquette desiree dans le cas ou la page a deja service
    $posX = 1;
    $posY = 1;
    if ($posX > 0) {
      $posX--;
    } else {
      $posX = 0;
    }
    if ($posY > 0) {
      $posY--;
    } else {
      $posY = 0;
    }
    $this->_COUNTX = $posX;
    $this->_COUNTY = $posY;
    $this->_Set_Format($pdf, $this->Tformat);
 
 
    $pdf->Open();
    $pdf->AddPage();
 
 
    // Add each record
    foreach ($arrayofrecords as $val) {
      // imprime le texte specifique sur la carte
      $this->addSticker($pdf, $outputlangs, $val);
    }
 
    //$pdf->SetXY(10, 295);
    //$pdf->Cell($this->_Width, $this->_Line_Height, 'XXX',0,1,'C');
 
 
    // Output to file
    $pdf->Output($file, 'F');
 
    dolChmod($file);
 
    $this->result = array('fullpath' => $file);
 
    return 1;
  }
}