pdf_ban.modules.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2016 Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2024   MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024       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/>.
 * or see https://www.gnu.org/
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/modules/bank/modules_bank.php';
require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.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/date.lib.php';
 
 
class pdf_ban extends ModeleBankAccountDoc
{
  public $version = 'development';
 
  public $posxdatestart;
 
  public $posxdateend;
 
  public function __construct($db)
  {
    global $langs, $mysoc;
 
    // Load translation files required by the page
    $langs->loadLangs(array("main", "bank", "withdrawals", "companies"));
 
    $this->db = $db;
    $this->name = "ban";
    $this->description = $langs->trans("DocumentModelBan").' (Volunteer wanted to finish)';
 
    // Page size for A4 format
    $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 = getDolGlobalInt('MAIN_PDF_MARGIN_LEFT', 10);
    $this->marge_droite = getDolGlobalInt('MAIN_PDF_MARGIN_RIGHT', 10);
    $this->marge_haute = getDolGlobalInt('MAIN_PDF_MARGIN_TOP', 10);
    $this->marge_basse = getDolGlobalInt('MAIN_PDF_MARGIN_BOTTOM', 10);
 
    $this->option_logo = 1; // Display logo FAC_PDF_LOGO
    $this->option_tva = 1; // Manage the vat option FACTURE_TVAOPTION
 
    // Retrieves transmitter
    $this->emetteur = $mysoc;
    if (!$this->emetteur->country_code) {
      $this->emetteur->country_code = substr($langs->defaultlang, -2); // By default if not defined
    }
 
    // Define column position
    $this->posxref = $this->marge_gauche + 1;
    $this->posxlabel = $this->marge_gauche + 25;
    $this->posxworkload = $this->marge_gauche + 100;
    $this->posxdatestart = $this->marge_gauche + 150;
    $this->posxdateend = $this->marge_gauche + 170;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_file($object, $outputlangs)
  {
    // phpcs:enable
    global $conf, $hookmanager, $langs, $user;
 
    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", "projects"));
 
    if ($conf->bank->dir_output) {
      //$nblines = count($object->lines);  // This is set later with array of tasks
 
      // Definition of $dir and $file
      if ($object->specimen) {
        $dir = $conf->bank->dir_output;
        $file = $dir."/SPECIMEN.pdf";
      } else {
        $objectref = dol_sanitizeFileName($object->ref);
        $dir = $conf->bank->dir_output."/".$objectref;
        $file = $dir."/".$objectref.".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
 
        $pdf = pdf_getInstance($this->format);
        $default_font_size = pdf_getPDFFontSize($outputlangs); // Must be after pdf_getInstance
        $heightforinfotot = 50; // Height reserved to output the info and total part
        $heightforfreetext = getDolGlobalInt('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 (getDolGlobalString('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));
 
        $pdf->Open();
        $pagenb = 0;
        $pdf->SetDrawColor(128, 128, 128);
 
        $pdf->SetTitle($outputlangs->convToOutputCharset($object->ref));
        $pdf->SetSubject($outputlangs->transnoentities("BAN"));
        $pdf->SetCreator("Dolibarr ".DOL_VERSION);
        $pdf->SetAuthor($outputlangs->convToOutputCharset($user->getFullName($outputlangs)));
        $pdf->SetKeyWords($outputlangs->convToOutputCharset($object->ref)." ".$outputlangs->transnoentities("BAN"));
        if (getDolGlobalString('MAIN_DISABLE_PDF_COMPRESSION')) {
          $pdf->SetCompression(false);
        }
 
        // @phan-suppress-next-line PhanPluginSuspiciousParamOrder
        $pdf->SetMargins($this->marge_gauche, $this->marge_haute, $this->marge_droite); // Left, Top, Right
 
        // New page
        $pdf->AddPage();
        $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 = 50;
        $tab_top_newpage = 40;
 
        $tab_height = $this->page_hauteur - $tab_top - $heightforfooter - $heightforfreetext;
 
        // Affiche notes
        if (!empty($object->note_public)) {
          $pdf->SetFont('', '', $default_font_size - 1);
          $pdf->writeHTMLCell(190, 3, $this->posxref - 1, $tab_top - 2, dol_htmlentitiesbr($object->note_public), 0, 1);
          $nexY = $pdf->GetY();
          $height_note = $nexY - ($tab_top - 2);
 
          // Rect takes a length in 3rd parameter
          $pdf->SetDrawColor(192, 192, 192);
          $pdf->Rect($this->marge_gauche, $tab_top - 3, $this->page_largeur - $this->marge_gauche - $this->marge_droite, $height_note + 1);
 
          $tab_height -= $height_note;
          $tab_top = $nexY + 6;
        } else {
          $height_note = 0;
        }
 
        $iniY = $tab_top + 7;
        $curY = $tab_top + 7;
        $nexY = $tab_top + 7;
 
        $pdf->SetXY($this->marge_gauche, $curY);
        $pdf->MultiCell(200, 3, $outputlangs->trans("BAN").' : '.$object->account_number, 0, 'L');
 
 
 
        // 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;
        }
 
        /*
         * Footer of the page
         */
        $this->_pagefoot($pdf, $object, $outputlangs);
        if (method_exists($pdf, 'AliasNbPages')) {
          $pdf->AliasNbPages();  // @phan-suppress-current-line PhanUndeclaredMethod
        }
 
        $pdf->Close();
 
        $pdf->Output($file, 'F');
 
        // 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('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;
        }
 
        dolChmod($file);
 
        $this->result = array('fullpath' => $file);
 
        return 1; // No error
      } else {
        $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
        return 0;
      }
    }
 
    $this->error = $langs->transnoentities("ErrorConstantNotDefined", "DELIVERY_OUTPUTDIR");
    return 0;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _tableau(&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop = 0, $hidebottom = 0)
  {
    // phpcs:enable
    global $conf, $mysoc;
 
    $default_font_size = pdf_getPDFFontSize($outputlangs);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _pagehead(&$pdf, $object, $showaddress, $outputlangs)
  {
    global $langs, $conf, $mysoc;
    // phpcs:enable
 
    $default_font_size = pdf_getPDFFontSize($outputlangs);
 
    pdf_pagehead($pdf, $outputlangs, $this->page_hauteur);
 
    $pdf->SetTextColor(0, 0, 60);
    $pdf->SetFont('', 'B', $default_font_size + 3);
 
    $posx = $this->page_largeur - $this->marge_droite - 100;
    $posy = $this->marge_haute;
 
    $pdf->SetXY($this->marge_gauche, $posy);
 
    // Logo
    $logo = $conf->mycompany->dir_output.'/logos/'.$mysoc->logo;
    if ($mysoc->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(100, 3, $langs->transnoentities("ErrorLogoFileNotFound", $logo), 0, 'L');
        $pdf->MultiCell(100, 3, $langs->transnoentities("ErrorGoToModuleSetup"), 0, 'L');
      }
    } else {
      $pdf->MultiCell(100, 4, $outputlangs->transnoentities($this->emetteur->name), 0, 'L');
    }
 
    $pdf->SetFont('', 'B', $default_font_size + 3);
    $pdf->SetXY($posx, $posy);
    $pdf->SetTextColor(0, 0, 60);
    $pdf->MultiCell(100, 4, $outputlangs->transnoentities("BAN")." ".$outputlangs->convToOutputCharset($object->ref), '', 'R');
    $pdf->SetFont('', '', $default_font_size + 2);
 
    $posy += 6;
    $pdf->SetXY($posx, $posy);
    $pdf->SetTextColor(0, 0, 60);
    $pdf->MultiCell(100, 4, $outputlangs->transnoentities("Date")." : ".dol_print_date(dol_now(), 'day', false, $outputlangs, true), '', 'R');
    /*$posy+=6;
    $pdf->SetXY($posx,$posy);
    $pdf->MultiCell(100, 4, $outputlangs->transnoentities("DateEnd")." : " . dol_print_date($object->date_end,'day',false,$outputlangs,true), '', 'R');
    */
 
    $pdf->SetTextColor(0, 0, 60);
 
    // Add list of linked objects
    /* Removed: A project can have more than thousands linked objects (orders, invoices, proposals, etc....
    $object->fetchObjectLinked();
 
    foreach($object->linkedObjects as $objecttype => $objects)
    {
      //var_dump($objects);exit;
      if ($objecttype == 'commande')
      {
        $outputlangs->load('orders');
        $num=count($objects);
        for ($i=0;$i<$num;$i++)
        {
          $posy+=4;
          $pdf->SetXY($posx,$posy);
          $pdf->SetFont('','', $default_font_size - 1);
          $text=$objects[$i]->ref;
          if ($objects[$i]->ref_client) $text.=' ('.$objects[$i]->ref_client.')';
          $pdf->MultiCell(100, 4, $outputlangs->transnoentities("RefOrder")." : ".$outputlangs->transnoentities($text), '', 'R');
        }
      }
    }
    */
 
    return 0;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _pagefoot(&$pdf, $object, $outputlangs, $hidefreetext = 0)
  {
    // phpcs:enable
    global $conf;
 
    $showdetails = !getDolGlobalString('MAIN_GENERATE_DOCUMENTS_SHOW_FOOT_DETAILS') ? 0 : $conf->global->MAIN_GENERATE_DOCUMENTS_SHOW_FOOT_DETAILS;
    return 1;
  }
}