pdf_espadon.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';


class pdf_espadon extends ModelePdfExpedition
{
  public $db;

  public $name;

  public $description;

  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($db = 0)
  {
    global $conf, $langs, $mysoc;

    $this->db = $db;
    $this->name = "espadon";
    $this->description = $langs->trans("DocumentModelStandardPDF");

    $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;

    // Get source company
    $this->emetteur = $mysoc;
    if (!$this->emetteur->country_code) $this->emetteur->country_code = substr($langs->defaultlang, -2); // By default if not defined

    $this->tabTitleHeight = 5; // default height
  }

  // 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", "orders", "products", "dict", "companies", "propal", "deliveries", "sendings", "productbatch"));

    global $outputlangsbis;
    $outputlangsbis = null;
    if (!empty($conf->global->PDF_USE_ALSO_LANGUAGE_CODE) && $outputlangs->defaultlang != $conf->global->PDF_USE_ALSO_LANGUAGE_CODE) {
      $outputlangsbis = new Translate('', $conf);
      $outputlangsbis->setDefaultLang($conf->global->PDF_USE_ALSO_LANGUAGE_CODE);
      $outputlangsbis->loadLangs(array("main", "bills", "orders", "products", "dict", "companies", "propal", "deliveries", "sendings", "productbatch"));
    }

    $nblines = count($object->lines);

    // Loop on each lines to detect if there is at least one image to show
    $realpatharray = array();
    $this->atleastonephoto = false;
    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;
          $this->atleastonephoto = true;
          break;
        }

        if ($realpath) $realpatharray[$i] = $realpath;
      }
    }

    if (count($realpatharray) == 0) $this->posxpicture = $this->posxweightvol;

    if ($conf->expedition->dir_output)
    {
      // Definition of $dir and $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 = 130;
        $tab_height_newpage = 150;

        $this->posxdesc = $this->marge_gauche + 1;

        // Incoterm
        $height_incoterms = 0;
        if (!empty($conf->incoterm->enabled))
        {
          $desc_incoterms = $object->getIncotermsForPDF();
          if ($desc_incoterms)
          {
            $tab_top = 88;

            $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;
          }
        }

        // display note
        $notetoshow = empty($object->note_public) ? '' : $object->note_public;

        // Extrafields in note
        $extranote = $this->getExtrafieldsInHtml($object, $outputlangs);
        if (!empty($extranote))
        {
          $notetoshow = dol_concatdesc($notetoshow, $extranote);
        }

        if (!empty($notetoshow) || !empty($object->tracking_number))
        {
          $tab_top = 88 + $height_incoterms;
          $tab_top_alt = $tab_top;

          $pdf->SetFont('', 'B', $default_font_size - 2);
          $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();
          //$tab_top_alt += 1;

          // Tracking number
          if (!empty($object->tracking_number))
          {
            $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($notetoshow))
          {
            $pdf->SetFont('', '', $default_font_size - 1); // In loop to manage multi-page
            $pdf->writeHTMLCell(190, 3, $this->posxdesc - 1, $tab_top_alt, dol_htmlentitiesbr($notetoshow), 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;
        }


        // Use new auto column system
        $this->prepareArrayColumnField($object, $outputlangs, $hidedetails, $hidedesc, $hideref);

        // Table simulation to know the height of the title line
        $pdf->startTransaction();
        $this->pdfTabTitles($pdf, $tab_top, $tab_height, $outputlangs, $hidetop);
        $pdf->rollbackTransaction(true);


        $nexY = $tab_top + $this->tabTitleHeight;

        // 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;

          if ($this->getColumnStatus('photo'))
          {
            // We start with Photo of product line
            if (isset($imglinesize['width']) && isset($imglinesize['height']) && ($curY + $imglinesize['height']) > ($this->page_hauteur - ($heightforfooter + $heightforfreetext + $heightforsignature + $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 (!empty($this->cols['photo']) && isset($imglinesize['width']) && isset($imglinesize['height']))
            {
              $pdf->Image($realpatharray[$i], $this->getColumnContentXStart('photo'), $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
          if ($this->getColumnStatus('desc'))
          {
            $pdf->startTransaction();

            $this->printColDescContent($pdf, $curY, 'desc', $object, $i, $outputlangs, $hideref, $hidedesc);

            $pageposafter = $pdf->getPage();
            if ($pageposafter > $pageposbefore) // There is a pagebreak
            {
              $pdf->rollbackTransaction(true);

              $this->printColDescContent($pdf, $curY, 'desc', $object, $i, $outputlangs, $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 + $heightforsignature + $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); // We reposition the default font

          // weight

          $weighttxt = '';
          if ($object->lines[$i]->fk_product_type == 0 && $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 ($object->lines[$i]->fk_product_type == 0 && $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 ($this->getColumnStatus('weight'))
          {
            $this->printStdColumnContent($pdf, $curY, 'weight', $weighttxt.(($weighttxt && $voltxt) ? '<br>' : '').$voltxt, array('html'=>1));
            $nexY = max($pdf->GetY(), $nexY);
          }

          if ($this->getColumnStatus('qty_asked'))
          {
            $this->printStdColumnContent($pdf, $curY, 'qty_asked', $object->lines[$i]->qty_asked);
            $nexY = max($pdf->GetY(), $nexY);
          }

          if ($this->getColumnStatus('qty_shipped'))
          {
            $this->printStdColumnContent($pdf, $curY, 'qty_shipped', $object->lines[$i]->qty_shipped);
            $nexY = max($pdf->GetY(), $nexY);
          }

          if ($this->getColumnStatus('subprice'))
          {
            $this->printStdColumnContent($pdf, $curY, 'subprice', price($object->lines[$i]->subprice, 0, $outputlangs));
            $nexY = max($pdf->GetY(), $nexY);
          }

          // Extrafields
          if (!empty($object->lines[$i]->array_options)) {
            foreach ($object->lines[$i]->array_options as $extrafieldColKey => $extrafieldValue) {
              if ($this->getColumnStatus($extrafieldColKey))
              {
                $extrafieldValue = $this->getExtrafieldContent($object->lines[$i], $extrafieldColKey);
                $this->printStdColumnContent($pdf, $curY, $extrafieldColKey, $extrafieldValue);
                $nexY = max($pdf->GetY(), $nexY);
              }
            }
          }

          // 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, $this->page_largeur - $this->marge_droite, $nexY);
            $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 (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;
        }

        // Display total area
        $posy = $this->_tableau_tot($pdf, $object, 0, $bottomlasttab, $outputlangs);

        // Pagefoot
        $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);

    // Total table
    $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 ($object->trueWeight) $totalWeighttoshow = showDimensionInBestUnit($object->trueWeight, $object->weight_units, "weight", $outputlangs);
    if ($object->trueVolume) $totalVolumetoshow = showDimensionInBestUnit($object->trueVolume, $object->volume_units, "volume", $outputlangs);




    if ($this->getColumnStatus('desc'))
    {
      $this->printStdColumnContent($pdf, $tab2_top, 'desc', $outputlangs->transnoentities("Total"));
    }


    if ($this->getColumnStatus('weight'))
    {
      if ($totalWeighttoshow)
      {
        $this->printStdColumnContent($pdf, $tab2_top, 'weight', $totalWeighttoshow);
        $index++;
      }

      if ($totalVolumetoshow)
      {
        $y = $tab2_top + ($tab2_hl * $index);
        $this->printStdColumnContent($pdf, $y, 'weight', $totalVolumetoshow);
      }
    }

    if ($this->getColumnStatus('qty_asked') && $totalOrdered)
    {
      $this->printStdColumnContent($pdf, $tab2_top, 'qty_asked', $totalOrdered);
    }

    if ($this->getColumnStatus('qty_shipped') && $totalToShip)
    {
      $this->printStdColumnContent($pdf, $tab2_top, 'qty_shipped', $totalToShip);
    }

    if ($this->getColumnStatus('subprice'))
    {
      $this->printStdColumnContent($pdf, $tab2_top, 'subprice', price($object->total_ht, 0, $outputlangs));
    }

    $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;

    $currency = !empty($currency) ? $currency : $conf->currency;
    $default_font_size = pdf_getPDFFontSize($outputlangs);

    // Amount in (at tab_top - 1)
    $pdf->SetTextColor(0, 0, 0);
    $pdf->SetFont('', '', $default_font_size - 2);

    if (empty($hidetop))
    {
      //$conf->global->MAIN_PDF_TITLE_BACKGROUND_COLOR='230,230,230';
      if (!empty($conf->global->MAIN_PDF_TITLE_BACKGROUND_COLOR)) {
        $pdf->Rect($this->marge_gauche, $tab_top, $this->page_largeur - $this->marge_droite - $this->marge_gauche, $this->tabTitleHeight, 'F', null, explode(',', $conf->global->MAIN_PDF_TITLE_BACKGROUND_COLOR));
      }
    }

    $pdf->SetDrawColor(128, 128, 128);
    $pdf->SetFont('', '', $default_font_size - 1);

    // 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


    $this->pdfTabTitles($pdf, $tab_top, $tab_height, $outputlangs, $hidetop);

    if (empty($hidetop)) {
      $pdf->line($this->marge_gauche, $tab_top + $this->tabTitleHeight, $this->page_largeur - $this->marge_droite, $tab_top + $this->tabTitleHeight); // line takes a position y in 2nd parameter and 4th parameter
    }
  }

  // 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);

    // Show Draft Watermark
    if ($object->statut == 0 && (!empty($conf->global->SHIPPING_DRAFT_WATERMARK)))
    {
          pdf_watermark($pdf, $outputlangs, $this->page_hauteur, $this->page_largeur, 'mm', $conf->global->SHIPPING_DRAFT_WATERMARK);
    }

    //Prepare next
    $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
    $logo = $conf->mycompany->dir_output.'/logos/'.$this->emetteur->logo;
    if ($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($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 (is_array($arrayidcontact) && 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
      $pdf->SetTextColor(0, 0, 0);
      $pdf->SetFont('', '', $default_font_size - 2);
      $pdf->SetXY($posx, $posy - 5);
      $pdf->MultiCell(66, 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
      $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->fk_soc != $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
      $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);
  }

  public function defineColumnField($object, $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0)
  {
    global $conf, $hookmanager;

    // Default field style for content
    $this->defaultContentsFieldsStyle = array(
      'align' => 'R', // R,C,L
      'padding' => array(1, 0.5, 1, 0.5), // Like css 0 => top , 1 => right, 2 => bottom, 3 => left
    );

    // Default field style for content
    $this->defaultTitlesFieldsStyle = array(
      'align' => 'C', // R,C,L
      'padding' => array(0.5, 0, 0.5, 0), // Like css 0 => top , 1 => right, 2 => bottom, 3 => left
    );

    /*
       * For exemple
       $this->cols['theColKey'] = array(
       'rank' => $rank, // int : use for ordering columns
       'width' => 20, // the column width in mm
       'title' => array(
       'textkey' => 'yourLangKey', // if there is no label, yourLangKey will be translated to replace label
       'label' => ' ', // the final label : used fore final generated text
       'align' => 'L', // text alignement :  R,C,L
       'padding' => array(0.5,0.5,0.5,0.5), // Like css 0 => top , 1 => right, 2 => bottom, 3 => left
       ),
       'content' => array(
       'align' => 'L', // text alignement :  R,C,L
       'padding' => array(0.5,0.5,0.5,0.5), // Like css 0 => top , 1 => right, 2 => bottom, 3 => left
       ),
       );
       */

    $rank = 0; // do not use negative rank
    $this->cols['desc'] = array(
      'rank' => $rank,
      'width' => false, // only for desc
      'status' => true,
      'title' => array(
        'textkey' => 'Designation', // use lang key is usefull in somme case with module
        'align' => 'L',
        // 'textkey' => 'yourLangKey', // if there is no label, yourLangKey will be translated to replace label
        // 'label' => ' ', // the final label
        'padding' => array(0.5, 1, 0.5, 1.5), // Like css 0 => top , 1 => right, 2 => bottom, 3 => left
      ),
      'content' => array(
        'padding' => array(1, 0.5, 1, 1.5), // Like css 0 => top , 1 => right, 2 => bottom, 3 => left
      ),
    );

    $rank = $rank + 10;
    $this->cols['photo'] = array(
      'rank' => $rank,
      'width' => (empty($conf->global->MAIN_DOCUMENTS_WITH_PICTURE_WIDTH) ? 20 : $conf->global->MAIN_DOCUMENTS_WITH_PICTURE_WIDTH), // in mm
      'status' => false,
      'title' => array(
        'textkey' => 'Photo',
        'label' => ' '
      ),
      'content' => array(
        'padding' => array(0, 0, 0, 0), // Like css 0 => top , 1 => right, 2 => bottom, 3 => left
      ),
      'border-left' => false, // remove left line separator
    );

    if (!empty($conf->global->MAIN_GENERATE_SHIPMENT_WITH_PICTURE) && !empty($this->atleastonephoto))
    {
      $this->cols['photo']['status'] = true;
    }

    $rank = $rank + 10;
    $this->cols['weight'] = array(
      'rank' => $rank,
      'width' => 30, // in mm
      'status' => true,
      'title' => array(
        'textkey' => 'WeightVolShort'
      ),
      'border-left' => true, // add left line separator
    );


    $rank = $rank + 10;
    $this->cols['subprice'] = array(
      'rank' => $rank,
      'width' => 19, // in mm
      'status' => !empty($conf->global->MAIN_PDF_SHIPPING_DISPLAY_AMOUNT_HT) ? 1 : 0,
      'title' => array(
        'textkey' => 'PriceUHT'
      ),
      'border-left' => true, // add left line separator
    );

    $rank = $rank + 10;
    $this->cols['totalexcltax'] = array(
      'rank' => $rank,
      'width' => 26, // in mm
      'status' => !empty($conf->global->MAIN_PDF_SHIPPING_DISPLAY_AMOUNT_HT) ? 1 : 0,
      'title' => array(
        'textkey' => 'TotalHT'
      ),
      'border-left' => true, // add left line separator
    );

    $rank = $rank + 10;
    $this->cols['qty_asked'] = array(
      'rank' => $rank,
      'width' => 30, // in mm
      'status' => empty($conf->global->SHIPPING_PDF_HIDE_ORDERED) ? 1 : 0,
      'title' => array(
        'textkey' => 'QtyOrdered'
      ),
      'border-left' => true, // add left line separator
      'content' => array(
        'align' => 'C',
      ),
    );

    $rank = $rank + 10;
    $this->cols['qty_shipped'] = array(
      'rank' => $rank,
      'width' => 30, // in mm
      'status' => true,
      'title' => array(
        'textkey' => 'QtyToShip'
      ),
      'border-left' => true, // add left line separator
      'content' => array(
        'align' => 'C',
      ),
    );

    // Add extrafields cols
    if (!empty($object->lines)) {
      $line = reset($object->lines);
      $this->defineColumnExtrafield($line, $outputlangs, $hidedetails);
    }

    $parameters = array(
      'object' => $object,
      'outputlangs' => $outputlangs,
      'hidedetails' => $hidedetails,
      'hidedesc' => $hidedesc,
      'hideref' => $hideref
    );

    $reshook = $hookmanager->executeHooks('defineColumnField', $parameters, $this); // Note that $object may have been modified by hook
    if ($reshook < 0)
    {
      setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
    } elseif (empty($reshook))
    {
      $this->cols = array_replace($this->cols, $hookmanager->resArray); // array_replace is used to preserve keys
    } else {
      $this->cols = $hookmanager->resArray;
    }
  }
}