pdf_rouget.modules.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2005      Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2005-2012 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2012 Regis Houssin    <regis.houssin@inodbox.com>
 * Copyright (C) 2014-2015 Marcos García        <marcosgdf@gmail.com>
 * Copyright (C) 2018-2020  Frédéric France     <frederic.france@netlogic.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/>.
 * or see https://www.gnu.org/
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/modules/expedition/modules_expedition.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/pdf.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/product.lib.php';
 
 
class pdf_rouget extends ModelePdfExpedition
{
  public $db;
 
  public $name;
 
  public $description;
 
  public $update_main_doc_field;
 
  public $type;
 
  public $phpmin = array(5, 6);
 
  public $version = 'dolibarr';
 
  public $page_largeur;
 
  public $page_hauteur;
 
  public $format;
 
  public $marge_gauche;
 
  public $marge_droite;
 
  public $marge_haute;
 
  public $marge_basse;
 
  public $emetteur;
 
 
  public function __construct(DoliDB $db)
  {
    global $conf, $langs, $mysoc;
 
    $this->db = $db;
    $this->name = "rouget";
    $this->description = $langs->trans("DocumentModelStandardPDF").' ('.$langs->trans("OldImplementation").')';
    $this->update_main_doc_field = 1; // Save the name of generated file as the main doc when generating a doc with this template
 
    $this->type = 'pdf';
    $formatarray = pdf_getFormat();
    $this->page_largeur = $formatarray['width'];
    $this->page_hauteur = $formatarray['height'];
    $this->format = array($this->page_largeur, $this->page_hauteur);
    $this->marge_gauche = isset($conf->global->MAIN_PDF_MARGIN_LEFT) ? $conf->global->MAIN_PDF_MARGIN_LEFT : 10;
    $this->marge_droite = isset($conf->global->MAIN_PDF_MARGIN_RIGHT) ? $conf->global->MAIN_PDF_MARGIN_RIGHT : 10;
    $this->marge_haute = isset($conf->global->MAIN_PDF_MARGIN_TOP) ? $conf->global->MAIN_PDF_MARGIN_TOP : 10;
    $this->marge_basse = isset($conf->global->MAIN_PDF_MARGIN_BOTTOM) ? $conf->global->MAIN_PDF_MARGIN_BOTTOM : 10;
 
    $this->option_logo = 1; // Display logo
    $this->option_draft_watermark = 1; // Support add of a watermark on drafts
    $this->watermark = '';
 
    // Get source company
    $this->emetteur = $mysoc;
    if (!$this->emetteur->country_code) {
      $this->emetteur->country_code = substr($langs->defaultlang, -2); // By default if not defined
    }
 
    // Define position of columns
    $this->posxdesc = $this->marge_gauche + 1;
    $this->posxweightvol = $this->page_largeur - $this->marge_droite - 82;
    $this->posxqtyordered = $this->page_largeur - $this->marge_droite - 60;
    $this->posxqtytoship = $this->page_largeur - $this->marge_droite - 28;
    $this->posxpuht = $this->page_largeur - $this->marge_droite;
 
    if (!empty($conf->global->SHIPPING_PDF_DISPLAY_AMOUNT_HT)) {  // Show also the prices
      $this->posxweightvol = $this->page_largeur - $this->marge_droite - 118;
      $this->posxqtyordered = $this->page_largeur - $this->marge_droite - 96;
      $this->posxqtytoship = $this->page_largeur - $this->marge_droite - 68;
      $this->posxpuht = $this->page_largeur - $this->marge_droite - 40;
      $this->posxtotalht = $this->page_largeur - $this->marge_droite - 20;
    }
 
    if (!empty($conf->global->SHIPPING_PDF_HIDE_WEIGHT_AND_VOLUME)) {
      $this->posxweightvol = $this->posxqtyordered;
    }
 
    $this->posxpicture = $this->posxweightvol - (empty($conf->global->MAIN_DOCUMENTS_WITH_PICTURE_WIDTH) ? 20 : $conf->global->MAIN_DOCUMENTS_WITH_PICTURE_WIDTH); // width of images
 
    // To work with US executive format
    if ($this->page_largeur < 210) {
      $this->posxweightvol -= 20;
      $this->posxpicture -= 20;
      $this->posxqtyordered -= 20;
      $this->posxqtytoship -= 20;
    }
 
    if (!empty($conf->global->SHIPPING_PDF_HIDE_ORDERED)) {
      $this->posxweightvol += ($this->posxqtytoship - $this->posxqtyordered);
      $this->posxpicture += ($this->posxqtytoship - $this->posxqtyordered);
      $this->posxqtyordered = $this->posxqtytoship;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_file($object, $outputlangs, $srctemplatepath = '', $hidedetails = 0, $hidedesc = 0, $hideref = 0)
  {
    // phpcs:enable
    global $user, $conf, $langs, $hookmanager;
 
    $object->fetch_thirdparty();
 
    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 (!empty($conf->global->MAIN_USE_FPDF)) {
      $outputlangs->charset_output = 'ISO-8859-1';
    }
 
    // Load traductions files required by page
    $outputlangs->loadLangs(array("main", "bills", "products", "dict", "companies", "propal", "deliveries", "sendings", "productbatch", "other"));
 
    // Show Draft Watermark
    if ($object->statut == $object::STATUS_DRAFT && (!empty($conf->global->SHIPPING_DRAFT_WATERMARK))) {
      $this->watermark = $conf->global->SHIPPING_DRAFT_WATERMARK;
    }
 
    $nblines = count($object->lines);
 
    // Loop on each lines to detect if there is at least one image to show
    $realpatharray = array();
    if (!empty($conf->global->MAIN_GENERATE_SHIPMENT_WITH_PICTURE)) {
      $objphoto = new Product($this->db);
 
      for ($i = 0; $i < $nblines; $i++) {
        if (empty($object->lines[$i]->fk_product)) {
          continue;
        }
 
        $objphoto = new Product($this->db);
        $objphoto->fetch($object->lines[$i]->fk_product);
        if (!empty($conf->global->PRODUCT_USE_OLD_PATH_FOR_PHOTO)) {
          $pdir = get_exdir($object->lines[$i]->fk_product, 2, 0, 0, $objphoto, 'product').$object->lines[$i]->fk_product."/photos/";
          $dir = $conf->product->dir_output.'/'.$pdir;
        } else {
          $pdir = get_exdir(0, 2, 0, 0, $objphoto, 'product').dol_sanitizeFileName($objphoto->ref).'/';
          $dir = $conf->product->dir_output.'/'.$pdir;
        }
 
        $realpath = '';
 
        foreach ($objphoto->liste_photos($dir, 1) as $key => $obj) {
          if (empty($conf->global->CAT_HIGH_QUALITY_IMAGES)) {
            // If CAT_HIGH_QUALITY_IMAGES not defined, we use thumb if defined and then original photo
            if ($obj['photo_vignette']) {
              $filename = $obj['photo_vignette'];
            } else {
              $filename = $obj['photo'];
            }
          } else {
            $filename = $obj['photo'];
          }
 
          $realpath = $dir.$filename;
          break;
        }
 
        if ($realpath) {
          $realpatharray[$i] = $realpath;
        }
      }
    }
 
    if (count($realpatharray) == 0) {
      $this->posxpicture = $this->posxweightvol;
    }
 
    if ($conf->expedition->dir_output) {
      // Definition de $dir et $file
      if ($object->specimen) {
        $dir = $conf->expedition->dir_output."/sending";
        $file = $dir."/SPECIMEN.pdf";
      } else {
        $expref = dol_sanitizeFileName($object->ref);
        $dir = $conf->expedition->dir_output."/sending/".$expref;
        $file = $dir."/".$expref.".pdf";
      }
 
      if (!file_exists($dir)) {
        if (dol_mkdir($dir) < 0) {
          $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
          return 0;
        }
      }
 
      if (file_exists($dir)) {
        // Add pdfgeneration hook
        if (!is_object($hookmanager)) {
          include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
          $hookmanager = new HookManager($this->db);
        }
        $hookmanager->initHooks(array('pdfgeneration'));
        $parameters = array('file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs);
        global $action;
        $reshook = $hookmanager->executeHooks('beforePDFCreation', $parameters, $object, $action); // Note that $action and $object may have been modified by some hooks
 
        // Set nblines with the new facture lines content after hook
        $nblines = count($object->lines);
 
        $pdf = pdf_getInstance($this->format);
        $default_font_size = pdf_getPDFFontSize($outputlangs);
        $heightforinfotot = 8; // Height reserved to output the info and total part
        $heightforfreetext = (isset($conf->global->MAIN_PDF_FREETEXT_HEIGHT) ? $conf->global->MAIN_PDF_FREETEXT_HEIGHT : 5); // Height reserved to output the free text on last page
        $heightforfooter = $this->marge_basse + 8; // Height reserved to output the footer (value include bottom margin)
        if (!empty($conf->global->MAIN_GENERATE_DOCUMENTS_SHOW_FOOT_DETAILS)) {
          $heightforfooter += 6;
        }
        $pdf->SetAutoPageBreak(1, 0);
 
        if (class_exists('TCPDF')) {
          $pdf->setPrintHeader(false);
          $pdf->setPrintFooter(false);
        }
        $pdf->SetFont(pdf_getPDFFont($outputlangs));
        // Set path to the background PDF File
        if (!empty($conf->global->MAIN_ADD_PDF_BACKGROUND)) {
          $pagecount = $pdf->setSourceFile($conf->mycompany->dir_output.'/'.$conf->global->MAIN_ADD_PDF_BACKGROUND);
          $tplidx = $pdf->importPage(1);
        }
 
        $pdf->Open();
        $pagenb = 0;
        $pdf->SetDrawColor(128, 128, 128);
 
        if (method_exists($pdf, 'AliasNbPages')) {
          $pdf->AliasNbPages();
        }
 
        $pdf->SetTitle($outputlangs->convToOutputCharset($object->ref));
        $pdf->SetSubject($outputlangs->transnoentities("Shipment"));
        $pdf->SetCreator("Dolibarr ".DOL_VERSION);
        $pdf->SetAuthor($outputlangs->convToOutputCharset($user->getFullName($outputlangs)));
        $pdf->SetKeyWords($outputlangs->convToOutputCharset($object->ref)." ".$outputlangs->transnoentities("Shipment"));
        if (!empty($conf->global->MAIN_DISABLE_PDF_COMPRESSION)) {
          $pdf->SetCompression(false);
        }
 
        $pdf->SetMargins($this->marge_gauche, $this->marge_haute, $this->marge_droite); // Left, Top, Right
 
        // New page
        $pdf->AddPage();
        if (!empty($tplidx)) {
          $pdf->useTemplate($tplidx);
        }
        $pagenb++;
        $this->_pagehead($pdf, $object, 1, $outputlangs);
        $pdf->SetFont('', '', $default_font_size - 1);
        $pdf->MultiCell(0, 3, ''); // Set interline to 3
        $pdf->SetTextColor(0, 0, 0);
 
        $tab_top = 90;
        $tab_top_newpage = (empty($conf->global->MAIN_PDF_DONOTREPEAT_HEAD) ? 42 : 10);
 
        $tab_height = $this->page_hauteur - $tab_top - $heightforfooter - $heightforfreetext;
 
        // Incoterm
        $height_incoterms = 0;
        if (!empty($conf->incoterm->enabled)) {
          $desc_incoterms = $object->getIncotermsForPDF();
          if ($desc_incoterms) {
            $tab_top -= 2;
 
            $pdf->SetFont('', '', $default_font_size - 1);
            $pdf->writeHTMLCell(190, 3, $this->posxdesc - 1, $tab_top - 1, dol_htmlentitiesbr($desc_incoterms), 0, 1);
            $nexY = $pdf->GetY();
            $height_incoterms = $nexY - $tab_top;
 
            // Rect takes a length in 3rd parameter
            $pdf->SetDrawColor(192, 192, 192);
            $pdf->Rect($this->marge_gauche, $tab_top - 1, $this->page_largeur - $this->marge_gauche - $this->marge_droite, $height_incoterms + 1);
 
            $tab_top = $nexY + 6;
            $height_incoterms += 4;
          }
        }
 
        if (!empty($object->note_public) || !empty($object->tracking_number)) {
          $tab_top = 88 + $height_incoterms;
          $tab_top_alt = $tab_top;
 
          $pdf->SetFont('', 'B', $default_font_size - 2);
 
          //$tab_top_alt += 1;
 
          // Tracking number
          if (!empty($object->tracking_number)) {
            $pdf->writeHTMLCell(60, 4, $this->posxdesc - 1, $tab_top - 1, $outputlangs->transnoentities("TrackingNumber")." : ".$object->tracking_number, 0, 1, false, true, 'L');
            $tab_top_alt = $pdf->GetY();
 
            $object->getUrlTrackingStatus($object->tracking_number);
            if (!empty($object->tracking_url)) {
              if ($object->shipping_method_id > 0) {
                // Get code using getLabelFromKey
                $code = $outputlangs->getLabelFromKey($this->db, $object->shipping_method_id, 'c_shipment_mode', 'rowid', 'code');
                $label = '';
                if ($object->tracking_url != $object->tracking_number) {
                  $label .= $outputlangs->trans("LinkToTrackYourPackage")."<br>";
                }
                $label .= $outputlangs->trans("SendingMethod").": ".$outputlangs->trans("SendingMethod".strtoupper($code));
                //var_dump($object->tracking_url != $object->tracking_number);exit;
                if ($object->tracking_url != $object->tracking_number) {
                  $label .= " : ";
                  $label .= $object->tracking_url;
                }
                $pdf->SetFont('', 'B', $default_font_size - 2);
                $pdf->writeHTMLCell(60, 4, $this->posxdesc - 1, $tab_top_alt, $label, 0, 1, false, true, 'L');
 
                $tab_top_alt = $pdf->GetY();
              }
            }
          }
 
          // Notes
          if (!empty($object->note_public)) {
            $pdf->SetFont('', '', $default_font_size - 1); // Dans boucle pour gerer multi-page
            $pdf->writeHTMLCell(190, 3, $this->posxdesc - 1, $tab_top_alt, dol_htmlentitiesbr($object->note_public), 0, 1);
          }
 
          $nexY = $pdf->GetY();
          $height_note = $nexY - $tab_top;
 
          // Rect takes a length in 3rd parameter
          $pdf->SetDrawColor(192, 192, 192);
          $pdf->Rect($this->marge_gauche, $tab_top - 1, $this->page_largeur - $this->marge_gauche - $this->marge_droite, $height_note + 1);
 
          $tab_height = $tab_height - $height_note;
          $tab_top = $nexY + 6;
        } else {
          $height_note = 0;
        }
 
        $iniY = $tab_top + 7;
        $curY = $tab_top + 7;
        $nexY = $tab_top + 7;
 
        // Loop on each lines
        for ($i = 0; $i < $nblines; $i++) {
          $curY = $nexY;
          $pdf->SetFont('', '', $default_font_size - 1); // Into loop to work with multipage
          $pdf->SetTextColor(0, 0, 0);
 
          // Define size of image if we need it
          $imglinesize = array();
          if (!empty($realpatharray[$i])) {
            $imglinesize = pdf_getSizeForImage($realpatharray[$i]);
          }
 
          $pdf->setTopMargin($tab_top_newpage);
          $pdf->setPageOrientation('', 1, $heightforfooter + $heightforfreetext + $heightforinfotot); // The only function to edit the bottom margin of current page to set it.
          $pageposbefore = $pdf->getPage();
 
          $showpricebeforepagebreak = 1;
          $posYAfterImage = 0;
          $posYAfterDescription = 0;
 
          // We start with Photo of product line
          if (isset($imglinesize['width']) && isset($imglinesize['height']) && ($curY + $imglinesize['height']) > ($this->page_hauteur - ($heightforfooter + $heightforfreetext + $heightforinfotot))) {  // If photo too high, we moved completely on new page
            $pdf->AddPage('', '', true);
            if (!empty($tplidx)) {
              $pdf->useTemplate($tplidx);
            }
            if (empty($conf->global->MAIN_PDF_DONOTREPEAT_HEAD)) {
              $this->_pagehead($pdf, $object, 0, $outputlangs);
            }
            $pdf->setPage($pageposbefore + 1);
 
            $curY = $tab_top_newpage;
 
            // Allows data in the first page if description is long enough to break in multiples pages
            if (!empty($conf->global->MAIN_PDF_DATA_ON_FIRST_PAGE)) {
              $showpricebeforepagebreak = 1;
            } else {
              $showpricebeforepagebreak = 0;
            }
          }
 
          if (isset($imglinesize['width']) && isset($imglinesize['height'])) {
            $curX = $this->posxpicture - 1;
            $pdf->Image($realpatharray[$i], $curX + (($this->posxweightvol - $this->posxpicture - $imglinesize['width']) / 2), $curY, $imglinesize['width'], $imglinesize['height'], '', '', '', 2, 300); // Use 300 dpi
            // $pdf->Image does not increase value return by getY, so we save it manually
            $posYAfterImage = $curY + $imglinesize['height'];
          }
 
          // Description of product line
          $curX = $this->posxdesc - 1;
 
          $pdf->startTransaction();
          pdf_writelinedesc($pdf, $object, $i, $outputlangs, $this->posxpicture - $curX, 3, $curX, $curY, $hideref, $hidedesc);
 
          $pageposafter = $pdf->getPage();
          if ($pageposafter > $pageposbefore) { // There is a pagebreak
            $pdf->rollbackTransaction(true);
            $pageposafter = $pageposbefore;
            //print $pageposafter.'-'.$pageposbefore;exit;
            $pdf->setPageOrientation('', 1, $heightforfooter); // The only function to edit the bottom margin of current page to set it.
            pdf_writelinedesc($pdf, $object, $i, $outputlangs, $this->posxpicture - $curX, 3, $curX, $curY, $hideref, $hidedesc);
 
            $pageposafter = $pdf->getPage();
            $posyafter = $pdf->GetY();
            //var_dump($posyafter); var_dump(($this->page_hauteur - ($heightforfooter+$heightforfreetext+$heightforinfotot))); exit;
            if ($posyafter > ($this->page_hauteur - ($heightforfooter + $heightforfreetext + $heightforinfotot))) { // There is no space left for total+free text
              if ($i == ($nblines - 1)) { // No more lines, and no space left to show total, so we create a new page
                $pdf->AddPage('', '', true);
                if (!empty($tplidx)) {
                  $pdf->useTemplate($tplidx);
                }
                if (empty($conf->global->MAIN_PDF_DONOTREPEAT_HEAD)) {
                  $this->_pagehead($pdf, $object, 0, $outputlangs);
                }
                $pdf->setPage($pageposafter + 1);
              }
            } else {
              // We found a page break
 
              // Allows data in the first page if description is long enough to break in multiples pages
              if (!empty($conf->global->MAIN_PDF_DATA_ON_FIRST_PAGE)) {
                $showpricebeforepagebreak = 1;
              } else {
                $showpricebeforepagebreak = 0;
              }
            }
          } else // No pagebreak
          {
            $pdf->commitTransaction();
          }
          $posYAfterDescription = $pdf->GetY();
 
          $nexY = $pdf->GetY();
          $pageposafter = $pdf->getPage();
 
          $pdf->setPage($pageposbefore);
          $pdf->setTopMargin($this->marge_haute);
          $pdf->setPageOrientation('', 1, 0); // The only function to edit the bottom margin of current page to set it.
 
          // We suppose that a too long description or photo were moved completely on next page
          if ($pageposafter > $pageposbefore && empty($showpricebeforepagebreak)) {
            $pdf->setPage($pageposafter);
            $curY = $tab_top_newpage;
          }
 
          // We suppose that a too long description is moved completely on next page
          if ($pageposafter > $pageposbefore) {
            $pdf->setPage($pageposafter);
            $curY = $tab_top_newpage;
          }
 
          $pdf->SetFont('', '', $default_font_size - 1); // On repositionne la police par defaut
 
          $pdf->SetXY($this->posxweightvol, $curY);
          $weighttxt = '';
          if (empty($object->lines[$i]->fk_product_type) && $object->lines[$i]->weight) {
            $weighttxt = round($object->lines[$i]->weight * $object->lines[$i]->qty_shipped, 5).' '.measuringUnitString(0, "weight", $object->lines[$i]->weight_units, 1);
          }
          $voltxt = '';
          if (empty($object->lines[$i]->fk_product_type) && $object->lines[$i]->volume) {
            $voltxt = round($object->lines[$i]->volume * $object->lines[$i]->qty_shipped, 5).' '.measuringUnitString(0, "volume", $object->lines[$i]->volume_units ? $object->lines[$i]->volume_units : 0, 1);
          }
 
          if (empty($conf->global->SHIPPING_PDF_HIDE_WEIGHT_AND_VOLUME)) {
            $pdf->writeHTMLCell($this->posxqtyordered - $this->posxweightvol + 2, 3, $this->posxweightvol - 1, $curY, $weighttxt.(($weighttxt && $voltxt) ? '<br>' : '').$voltxt, 0, 0, false, true, 'C');
            //$pdf->MultiCell(($this->posxqtyordered - $this->posxweightvol), 3, $weighttxt.(($weighttxt && $voltxt)?'<br>':'').$voltxt,'','C');
          }
 
          if (empty($conf->global->SHIPPING_PDF_HIDE_ORDERED)) {
            $pdf->SetXY($this->posxqtyordered, $curY);
            $pdf->MultiCell(($this->posxqtytoship - $this->posxqtyordered), 3, $object->lines[$i]->qty_asked, '', 'C');
          }
 
          if (empty($conf->global->SHIPPING_PDF_HIDE_QTYTOSHIP)) {
            $pdf->SetXY($this->posxqtytoship, $curY);
            $pdf->MultiCell(($this->posxpuht - $this->posxqtytoship), 3, $object->lines[$i]->qty_shipped, '', 'C');
          }
 
          if (!empty($conf->global->SHIPPING_PDF_DISPLAY_AMOUNT_HT)) {
            $pdf->SetXY($this->posxpuht, $curY);
            $pdf->MultiCell(($this->posxtotalht - $this->posxpuht - 1), 3, price($object->lines[$i]->subprice, 0, $outputlangs), '', 'R');
 
            $pdf->SetXY($this->posxtotalht, $curY);
            $pdf->MultiCell(($this->page_largeur - $this->marge_droite - $this->posxtotalht), 3, price($object->lines[$i]->total_ht, 0, $outputlangs), '', 'R');
          }
 
          $nexY += 3;
          if ($weighttxt && $voltxt) {
            $nexY += 2;
          }
 
          // Add line
          if (!empty($conf->global->MAIN_PDF_DASH_BETWEEN_LINES) && $i < ($nblines - 1)) {
            $pdf->setPage($pageposafter);
            $pdf->SetLineStyle(array('dash'=>'1,1', 'color'=>array(80, 80, 80)));
            //$pdf->SetDrawColor(190,190,200);
            $pdf->line($this->marge_gauche, $nexY - 1, $this->page_largeur - $this->marge_droite, $nexY - 1);
            $pdf->SetLineStyle(array('dash'=>0));
          }
 
          // Detect if some page were added automatically and output _tableau for past pages
          while ($pagenb < $pageposafter) {
            $pdf->setPage($pagenb);
            if ($pagenb == 1) {
              $this->_tableau($pdf, $tab_top, $this->page_hauteur - $tab_top - $heightforfooter, 0, $outputlangs, 0, 1);
            } else {
              $this->_tableau($pdf, $tab_top_newpage, $this->page_hauteur - $tab_top_newpage - $heightforfooter, 0, $outputlangs, 1, 1);
            }
            $this->_pagefoot($pdf, $object, $outputlangs, 1);
            $pagenb++;
            $pdf->setPage($pagenb);
            $pdf->setPageOrientation('', 1, 0); // The only function to edit the bottom margin of current page to set it.
            if (empty($conf->global->MAIN_PDF_DONOTREPEAT_HEAD)) {
              $this->_pagehead($pdf, $object, 0, $outputlangs);
            }
            if (!empty($tplidx)) {
              $pdf->useTemplate($tplidx);
            }
          }
          if (isset($object->lines[$i + 1]->pagebreak) && $object->lines[$i + 1]->pagebreak) {
            if ($pagenb == 1) {
              $this->_tableau($pdf, $tab_top, $this->page_hauteur - $tab_top - $heightforfooter, 0, $outputlangs, 0, 1);
            } else {
              $this->_tableau($pdf, $tab_top_newpage, $this->page_hauteur - $tab_top_newpage - $heightforfooter, 0, $outputlangs, 1, 1);
            }
            $this->_pagefoot($pdf, $object, $outputlangs, 1);
            // New page
            $pdf->AddPage();
            if (!empty($tplidx)) {
              $pdf->useTemplate($tplidx);
            }
            $pagenb++;
            if (empty($conf->global->MAIN_PDF_DONOTREPEAT_HEAD)) {
              $this->_pagehead($pdf, $object, 0, $outputlangs);
            }
          }
        }
 
        // Show square
        if ($pagenb == 1) {
          $this->_tableau($pdf, $tab_top, $this->page_hauteur - $tab_top - $heightforinfotot - $heightforfreetext - $heightforfooter, 0, $outputlangs, 0, 0);
          $bottomlasttab = $this->page_hauteur - $heightforinfotot - $heightforfreetext - $heightforfooter + 1;
        } else {
          $this->_tableau($pdf, $tab_top_newpage, $this->page_hauteur - $tab_top_newpage - $heightforinfotot - $heightforfreetext - $heightforfooter, 0, $outputlangs, 1, 0);
          $bottomlasttab = $this->page_hauteur - $heightforinfotot - $heightforfreetext - $heightforfooter + 1;
        }
 
        // Affiche zone totaux
        $posy = $this->_tableau_tot($pdf, $object, 0, $bottomlasttab, $outputlangs);
 
        // Pied de page
        $this->_pagefoot($pdf, $object, $outputlangs);
        if (method_exists($pdf, 'AliasNbPages')) {
          $pdf->AliasNbPages();
        }
 
        $pdf->Close();
 
        $pdf->Output($file, 'F');
 
        // Add pdfgeneration hook
        $hookmanager->initHooks(array('pdfgeneration'));
        $parameters = array('file'=>$file, 'object'=>$object, 'outputlangs'=>$outputlangs);
        global $action;
        $reshook = $hookmanager->executeHooks('afterPDFCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
        if ($reshook < 0) {
          $this->error = $hookmanager->error;
          $this->errors = $hookmanager->errors;
        }
 
        if (!empty($conf->global->MAIN_UMASK)) {
          @chmod($file, octdec($conf->global->MAIN_UMASK));
        }
 
        $this->result = array('fullpath'=>$file);
 
        return 1; // No error
      } else {
        $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
        return 0;
      }
    } else {
      $this->error = $langs->transnoentities("ErrorConstantNotDefined", "EXP_OUTPUTDIR");
      return 0;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  protected function _tableau_tot(&$pdf, $object, $deja_regle, $posy, $outputlangs)
  {
    // phpcs:enable
    global $conf, $mysoc;
 
    $sign = 1;
 
    $default_font_size = pdf_getPDFFontSize($outputlangs);
 
    $tab2_top = $posy;
    $tab2_hl = 4;
    $pdf->SetFont('', 'B', $default_font_size - 1);
 
    // Tableau total
    $col1x = $this->posxweightvol - 50;
    $col2x = $this->posxweightvol;
    /*if ($this->page_largeur < 210) // To work with US executive format
    {
      $col2x-=20;
    }*/
    if (empty($conf->global->SHIPPING_PDF_HIDE_ORDERED)) {
      $largcol2 = ($this->posxqtyordered - $this->posxweightvol);
    } else {
      $largcol2 = ($this->posxqtytoship - $this->posxweightvol);
    }
 
    $useborder = 0;
    $index = 0;
 
    $totalWeighttoshow = '';
    $totalVolumetoshow = '';
 
    // Load dim data
    $tmparray = $object->getTotalWeightVolume();
    $totalWeight = $tmparray['weight'];
    $totalVolume = $tmparray['volume'];
    $totalOrdered = $tmparray['ordered'];
    $totalToShip = $tmparray['toship'];
    // Set trueVolume and volume_units not currently stored into database
    if ($object->trueWidth && $object->trueHeight && $object->trueDepth) {
      $object->trueVolume = price(($object->trueWidth * $object->trueHeight * $object->trueDepth), 0, $outputlangs, 0, 0);
      $object->volume_units = $object->size_units * 3;
    }
 
    if ($totalWeight != '') {
      $totalWeighttoshow = showDimensionInBestUnit($totalWeight, 0, "weight", $outputlangs);
    }
    if ($totalVolume != '') {
      $totalVolumetoshow = showDimensionInBestUnit($totalVolume, 0, "volume", $outputlangs);
    }
    if (!empty($object->trueWeight)) {
      $totalWeighttoshow = showDimensionInBestUnit($object->trueWeight, $object->weight_units, "weight", $outputlangs);
    }
    if (!empty($object->trueVolume)) {
      $totalVolumetoshow = showDimensionInBestUnit($object->trueVolume, $object->volume_units, "volume", $outputlangs);
    }
 
    $pdf->SetFillColor(255, 255, 255);
    $pdf->SetXY($col1x, $tab2_top + $tab2_hl * $index);
    $pdf->MultiCell($col2x - $col1x, $tab2_hl, $outputlangs->transnoentities("Total"), 0, 'L', 1);
 
    if (empty($conf->global->SHIPPING_PDF_HIDE_ORDERED)) {
      $pdf->SetXY($this->posxqtyordered, $tab2_top + $tab2_hl * $index);
      $pdf->MultiCell($this->posxqtytoship - $this->posxqtyordered, $tab2_hl, $totalOrdered, 0, 'C', 1);
    }
 
    if (empty($conf->global->SHIPPING_PDF_HIDE_QTYTOSHIP)) {
      $pdf->SetXY($this->posxqtytoship, $tab2_top + $tab2_hl * $index);
      $pdf->MultiCell($this->posxpuht - $this->posxqtytoship, $tab2_hl, $totalToShip, 0, 'C', 1);
    }
 
    if (!empty($conf->global->SHIPPING_PDF_DISPLAY_AMOUNT_HT)) {
      $pdf->SetXY($this->posxpuht, $tab2_top + $tab2_hl * $index);
      $pdf->MultiCell($this->posxtotalht - $this->posxpuht, $tab2_hl, '', 0, 'C', 1);
 
      $pdf->SetXY($this->posxtotalht, $tab2_top + $tab2_hl * $index);
      $pdf->MultiCell($this->page_largeur - $this->marge_droite - $this->posxtotalht, $tab2_hl, price($object->total_ht, 0, $outputlangs), 0, 'C', 1);
    }
 
    if (empty($conf->global->SHIPPING_PDF_HIDE_WEIGHT_AND_VOLUME)) {
      // Total Weight
      if ($totalWeighttoshow) {
        $pdf->SetXY($this->posxweightvol, $tab2_top + $tab2_hl * $index);
        $pdf->MultiCell(($this->posxqtyordered - $this->posxweightvol), $tab2_hl, $totalWeighttoshow, 0, 'C', 1);
 
        $index++;
      }
      if ($totalVolumetoshow) {
        $pdf->SetXY($this->posxweightvol, $tab2_top + $tab2_hl * $index);
        $pdf->MultiCell(($this->posxqtyordered - $this->posxweightvol), $tab2_hl, $totalVolumetoshow, 0, 'C', 1);
 
        $index++;
      }
      if (!$totalWeighttoshow && !$totalVolumetoshow) {
        $index++;
      }
    }
 
    $pdf->SetTextColor(0, 0, 0);
 
    return ($tab2_top + ($tab2_hl * $index));
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _tableau(&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop = 0, $hidebottom = 0)
  {
    global $conf;
 
    // Force to disable hidetop and hidebottom
    $hidebottom = 0;
    if ($hidetop) {
      $hidetop = -1;
    }
 
    $default_font_size = pdf_getPDFFontSize($outputlangs);
 
    // Amount in (at tab_top - 1)
    $pdf->SetTextColor(0, 0, 0);
    $pdf->SetFont('', '', $default_font_size - 2);
 
    // Output Rect
    $this->printRect($pdf, $this->marge_gauche, $tab_top, $this->page_largeur - $this->marge_gauche - $this->marge_droite, $tab_height, $hidetop, $hidebottom); // Rect takes a length in 3rd parameter and 4th parameter
 
    $pdf->SetDrawColor(128, 128, 128);
    $pdf->SetFont('', '', $default_font_size - 1);
 
    if (empty($hidetop)) {
      $pdf->line($this->marge_gauche, $tab_top + 5, $this->page_largeur - $this->marge_droite, $tab_top + 5);
 
      $pdf->SetXY($this->posxdesc - 1, $tab_top + 1);
      $pdf->MultiCell($this->posxqtyordered - $this->posxdesc, 2, $outputlangs->transnoentities("Description"), '', 'L');
    }
 
    if (empty($conf->global->SHIPPING_PDF_HIDE_WEIGHT_AND_VOLUME)) {
      $pdf->line($this->posxweightvol - 1, $tab_top, $this->posxweightvol - 1, $tab_top + $tab_height);
      if (empty($hidetop)) {
        $pdf->SetXY($this->posxweightvol - 1, $tab_top + 1);
        $pdf->MultiCell(($this->posxqtyordered - $this->posxweightvol), 2, $outputlangs->transnoentities("WeightVolShort"), '', 'C');
      }
    }
 
    if (empty($conf->global->SHIPPING_PDF_HIDE_ORDERED)) {
      $pdf->line($this->posxqtyordered - 1, $tab_top, $this->posxqtyordered - 1, $tab_top + $tab_height);
      if (empty($hidetop)) {
        $pdf->SetXY($this->posxqtyordered - 1, $tab_top + 1);
        $pdf->MultiCell(($this->posxqtytoship - $this->posxqtyordered), 2, $outputlangs->transnoentities("QtyOrdered"), '', 'C');
      }
    }
 
    if (empty($conf->global->SHIPPING_PDF_HIDE_QTYTOSHIP)) {
      $pdf->line($this->posxqtytoship - 1, $tab_top, $this->posxqtytoship - 1, $tab_top + $tab_height);
      if (empty($hidetop)) {
        $pdf->SetXY($this->posxqtytoship, $tab_top + 1);
        $pdf->MultiCell(($this->posxpuht - $this->posxqtytoship), 2, $outputlangs->transnoentities("QtyToShip"), '', 'C');
      }
    }
 
    if (!empty($conf->global->SHIPPING_PDF_DISPLAY_AMOUNT_HT)) {
      $pdf->line($this->posxpuht - 1, $tab_top, $this->posxpuht - 1, $tab_top + $tab_height);
      if (empty($hidetop)) {
        $pdf->SetXY($this->posxpuht - 1, $tab_top + 1);
        $pdf->MultiCell(($this->posxtotalht - $this->posxpuht), 2, $outputlangs->transnoentities("PriceUHT"), '', 'C');
      }
 
      $pdf->line($this->posxtotalht - 1, $tab_top, $this->posxtotalht - 1, $tab_top + $tab_height);
      if (empty($hidetop)) {
        $pdf->SetXY($this->posxtotalht - 1, $tab_top + 1);
        $pdf->MultiCell(($this->page_largeur - $this->marge_droite - $this->posxtotalht), 2, $outputlangs->transnoentities("TotalHT"), '', 'C');
      }
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _pagehead(&$pdf, $object, $showaddress, $outputlangs)
  {
    global $conf, $langs, $mysoc;
 
    $langs->load("orders");
 
    $default_font_size = pdf_getPDFFontSize($outputlangs);
 
    pdf_pagehead($pdf, $outputlangs, $this->page_hauteur);
 
    //Prepare la suite
    $pdf->SetTextColor(0, 0, 60);
    $pdf->SetFont('', 'B', $default_font_size + 3);
 
    $w = 110;
 
    $posy = $this->marge_haute;
    $posx = $this->page_largeur - $this->marge_droite - $w;
 
    $pdf->SetXY($this->marge_gauche, $posy);
 
    // Logo
    if ($this->emetteur->logo) {
      $logodir = $conf->mycompany->dir_output;
      if (!empty($conf->mycompany->multidir_output[$object->entity])) {
        $logodir = $conf->mycompany->multidir_output[$object->entity];
      }
      if (empty($conf->global->MAIN_PDF_USE_LARGE_LOGO)) {
        $logo = $logodir.'/logos/thumbs/'.$this->emetteur->logo_small;
      } else {
        $logo = $logodir.'/logos/'.$this->emetteur->logo;
      }
      if (is_readable($logo)) {
        $height = pdf_getHeightForLogo($logo);
        $pdf->Image($logo, $this->marge_gauche, $posy, 0, $height); // width=0 (auto)
      } else {
        $pdf->SetTextColor(200, 0, 0);
        $pdf->SetFont('', 'B', $default_font_size - 2);
        $pdf->MultiCell($w, 3, $outputlangs->transnoentities("ErrorLogoFileNotFound", $logo), 0, 'L');
        $pdf->MultiCell($w, 3, $outputlangs->transnoentities("ErrorGoToGlobalSetup"), 0, 'L');
      }
    } else {
      $text = $this->emetteur->name;
      $pdf->MultiCell($w, 4, $outputlangs->convToOutputCharset($text), 0, 'L');
    }
 
    // Show barcode
    if (!empty($conf->barcode->enabled)) {
      $posx = 105;
    } else {
      $posx = $this->marge_gauche + 3;
    }
    //$pdf->Rect($this->marge_gauche, $this->marge_haute, $this->page_largeur-$this->marge_gauche-$this->marge_droite, 30);
    if (!empty($conf->barcode->enabled)) {
      // TODO Build code bar with function writeBarCode of barcode module for sending ref $object->ref
      //$pdf->SetXY($this->marge_gauche+3, $this->marge_haute+3);
      //$pdf->Image($logo,10, 5, 0, 24);
    }
 
    $pdf->SetDrawColor(128, 128, 128);
    if (!empty($conf->barcode->enabled)) {
      // TODO Build code bar with function writeBarCode of barcode module for sending ref $object->ref
      //$pdf->SetXY($this->marge_gauche+3, $this->marge_haute+3);
      //$pdf->Image($logo,10, 5, 0, 24);
    }
 
 
    $posx = $this->page_largeur - $w - $this->marge_droite;
    $posy = $this->marge_haute;
 
    $pdf->SetFont('', 'B', $default_font_size + 2);
    $pdf->SetXY($posx, $posy);
    $pdf->SetTextColor(0, 0, 60);
    $title = $outputlangs->transnoentities("SendingSheet");
    $pdf->MultiCell($w, 4, $title, '', 'R');
 
    $pdf->SetFont('', '', $default_font_size + 1);
 
    $posy += 5;
 
    $pdf->SetXY($posx, $posy);
    $pdf->SetTextColor(0, 0, 60);
    $pdf->MultiCell($w, 4, $outputlangs->transnoentities("RefSending")." : ".$object->ref, '', 'R');
 
    // Date planned delivery
    if (!empty($object->date_delivery)) {
        $posy += 4;
        $pdf->SetXY($posx, $posy);
        $pdf->SetTextColor(0, 0, 60);
        $pdf->MultiCell($w, 4, $outputlangs->transnoentities("DateDeliveryPlanned")." : ".dol_print_date($object->date_delivery, "day", false, $outputlangs, true), '', 'R');
    }
 
    if (empty($conf->global->MAIN_PDF_HIDE_CUSTOMER_CODE) && !empty($object->thirdparty->code_client)) {
      $posy += 4;
      $pdf->SetXY($posx, $posy);
      $pdf->SetTextColor(0, 0, 60);
      $pdf->MultiCell($w, 3, $outputlangs->transnoentities("CustomerCode")." : ".$outputlangs->transnoentities($object->thirdparty->code_client), '', 'R');
    }
 
 
    $pdf->SetFont('', '', $default_font_size + 3);
    $Yoff = 25;
 
    // Add list of linked orders
    $origin = $object->origin;
    $origin_id = $object->origin_id;
 
    // TODO move to external function
    if (!empty($conf->$origin->enabled)) {     // commonly $origin='commande'
      $outputlangs->load('orders');
 
      $classname = ucfirst($origin);
      $linkedobject = new $classname($this->db);
      $result = $linkedobject->fetch($origin_id);
      if ($result >= 0) {
        //$linkedobject->fetchObjectLinked()   Get all linked object to the $linkedobject (commonly order) into $linkedobject->linkedObjects
 
        $pdf->SetFont('', '', $default_font_size - 2);
        $text = $linkedobject->ref;
        if ($linkedobject->ref_client) {
          $text .= ' ('.$linkedobject->ref_client.')';
        }
        $Yoff = $Yoff + 8;
        $pdf->SetXY($this->page_largeur - $this->marge_droite - $w, $Yoff);
        $pdf->MultiCell($w, 2, $outputlangs->transnoentities("RefOrder")." : ".$outputlangs->transnoentities($text), 0, 'R');
        $Yoff = $Yoff + 3;
        $pdf->SetXY($this->page_largeur - $this->marge_droite - $w, $Yoff);
        $pdf->MultiCell($w, 2, $outputlangs->transnoentities("OrderDate")." : ".dol_print_date($linkedobject->date, "day", false, $outputlangs, true), 0, 'R');
      }
    }
 
    if ($showaddress) {
      // Sender properties
      $carac_emetteur = '';
      // Add internal contact of origin element if defined
      $arrayidcontact = array();
      if (!empty($origin) && is_object($object->$origin)) {
        $arrayidcontact = $object->$origin->getIdContact('internal', 'SALESREPFOLL');
      }
      if (count($arrayidcontact) > 0) {
        $object->fetch_user(reset($arrayidcontact));
        $carac_emetteur .= ($carac_emetteur ? "\n" : '').$outputlangs->transnoentities("Name").": ".$outputlangs->convToOutputCharset($object->user->getFullName($outputlangs))."\n";
      }
 
      $carac_emetteur .= pdf_build_address($outputlangs, $this->emetteur, $object->thirdparty, '', 0, 'source', $object);
 
      // Show sender
      $posy = !empty($conf->global->MAIN_PDF_USE_ISO_LOCATION) ? 40 : 42;
      $posx = $this->marge_gauche;
      if (!empty($conf->global->MAIN_INVERT_SENDER_RECIPIENT)) {
        $posx = $this->page_largeur - $this->marge_droite - 80;
      }
 
      $hautcadre = !empty($conf->global->MAIN_PDF_USE_ISO_LOCATION) ? 38 : 40;
      $widthrecbox = !empty($conf->global->MAIN_PDF_USE_ISO_LOCATION) ? 92 : 82;
 
      // Show sender frame
      if (empty($conf->global->MAIN_PDF_NO_SENDER_FRAME)) {
        $pdf->SetTextColor(0, 0, 0);
        $pdf->SetFont('', '', $default_font_size - 2);
        $pdf->SetXY($posx, $posy - 5);
        $pdf->MultiCell($widthrecbox, 5, $outputlangs->transnoentities("Sender"), 0, 'L');
        $pdf->SetXY($posx, $posy);
        $pdf->SetFillColor(230, 230, 230);
        $pdf->MultiCell($widthrecbox, $hautcadre, "", 0, 'R', 1);
        $pdf->SetTextColor(0, 0, 60);
        $pdf->SetFillColor(255, 255, 255);
      }
 
      // Show sender name
      if (empty($conf->global->MAIN_PDF_HIDE_SENDER_NAME)) {
        $pdf->SetXY($posx + 2, $posy + 3);
        $pdf->SetFont('', 'B', $default_font_size);
        $pdf->MultiCell($widthrecbox - 2, 4, $outputlangs->convToOutputCharset($this->emetteur->name), 0, 'L');
        $posy = $pdf->getY();
      }
 
      // Show sender information
      $pdf->SetXY($posx + 2, $posy);
      $pdf->SetFont('', '', $default_font_size - 1);
      $pdf->MultiCell($widthrecbox - 2, 4, $carac_emetteur, 0, 'L');
 
 
      // If SHIPPING contact defined, we use it
      $usecontact = false;
      $arrayidcontact = $object->$origin->getIdContact('external', 'SHIPPING');
      if (count($arrayidcontact) > 0) {
        $usecontact = true;
        $result = $object->fetch_contact($arrayidcontact[0]);
      }
 
      // Recipient name
      if ($usecontact && ($object->contact->socid != $object->thirdparty->id && (!isset($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT) || !empty($conf->global->MAIN_USE_COMPANY_NAME_OF_CONTACT)))) {
        $thirdparty = $object->contact;
      } else {
        $thirdparty = $object->thirdparty;
      }
 
      $carac_client_name = pdfBuildThirdpartyName($thirdparty, $outputlangs);
 
      $carac_client = pdf_build_address($outputlangs, $this->emetteur, $object->thirdparty, (!empty($object->contact) ? $object->contact : null), $usecontact, 'targetwithdetails', $object);
 
      // Show recipient
      $widthrecbox = !empty($conf->global->MAIN_PDF_USE_ISO_LOCATION) ? 92 : 100;
      if ($this->page_largeur < 210) {
        $widthrecbox = 84; // To work with US executive format
      }
      $posy = !empty($conf->global->MAIN_PDF_USE_ISO_LOCATION) ? 40 : 42;
      $posx = $this->page_largeur - $this->marge_droite - $widthrecbox;
      if (!empty($conf->global->MAIN_INVERT_SENDER_RECIPIENT)) {
        $posx = $this->marge_gauche;
      }
 
      // Show recipient frame
      if (empty($conf->global->MAIN_PDF_NO_RECIPENT_FRAME)) {
        $pdf->SetTextColor(0, 0, 0);
        $pdf->SetFont('', '', $default_font_size - 2);
        $pdf->SetXY($posx + 2, $posy - 5);
        $pdf->MultiCell($widthrecbox, 5, $outputlangs->transnoentities("Recipient"), 0, 'L');
        $pdf->Rect($posx, $posy, $widthrecbox, $hautcadre);
      }
 
      // Show recipient name
      $pdf->SetXY($posx + 2, $posy + 3);
      $pdf->SetFont('', 'B', $default_font_size);
      $pdf->MultiCell($widthrecbox, 2, $carac_client_name, 0, 'L');
 
      $posy = $pdf->getY();
 
      // Show recipient information
      $pdf->SetFont('', '', $default_font_size - 1);
      $pdf->SetXY($posx + 2, $posy);
      $pdf->MultiCell($widthrecbox, 4, $carac_client, 0, 'L');
    }
 
    $pdf->SetTextColor(0, 0, 0);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _pagefoot(&$pdf, $object, $outputlangs, $hidefreetext = 0)
  {
    global $conf;
    $showdetails = empty($conf->global->MAIN_GENERATE_DOCUMENTS_SHOW_FOOT_DETAILS) ? 0 : $conf->global->MAIN_GENERATE_DOCUMENTS_SHOW_FOOT_DETAILS;
    return pdf_pagefoot($pdf, $outputlangs, 'SHIPPING_FREE_TEXT', $this->emetteur, $this->marge_basse, $this->marge_gauche, $this->page_hauteur, $object, $showdetails, $hidefreetext, $this->page_largeur, $this->watermark);
  }
}