pdf_standard_actions.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2004       Rodolphe Quiedeville   <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2012  Laurent Destailleur    <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2009  Regis Houssin          <regis.houssin@inodbox.com>
 * Copyright (C) 2024-2025  MDW            <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024-2025  Frédéric France        <frederic.france@free.fr>
 * Copyright (C) 2024     Nick Fragoulis
 *
 * 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/lib/pdf.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
require_once DOL_DOCUMENT_ROOT.'/comm/action/class/actioncomm.class.php';
require_once DOL_DOCUMENT_ROOT.'/projet/class/project.class.php';
 
class pdf_standard_actions
{
  public $db;
 
  public $error;
 
  public $errors;
 
  public $warnings;
 
  public $description;
 
  public $date_edition;
 
  public $year;
 
  public $month;
 
  public $title;
 
  public $subject;
 
  public $marge_gauche;
 
  public $marge_droite;
 
  public $marge_haute;
 
  public $marge_basse;
 
  public $format;
 
  public $type;
 
  public $page_hauteur;
 
  public $page_largeur;
 
  public $corner_radius;
 
  public $result;
 
  public function __construct($db, $month, $year)
  {
    global $langs;
 
    // Load translation files required by the page
    $langs->loadLangs(array("commercial", "projects"));
 
    $this->db = $db;
    $this->description = "";
    $this->date_edition = time();
    $this->month = $month;
    $this->year = $year;
    $this->corner_radius = getDolGlobalInt('MAIN_PDF_FRAME_CORNER_RADIUS', 0);
    // 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->title = $langs->transnoentitiesnoconv("ActionsReport").' '.$this->year."-".$this->month;
    $this->subject = $langs->transnoentitiesnoconv("ActionsReport").' '.$this->year."-".$this->month;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_file($object, $outputlangs)
  {
    // phpcs:enable
    global $user, $conf, $langs, $hookmanager;
 
    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", "bills", "products"));
 
    $dir = $conf->agenda->dir_temp."/";
    $file = $dir."actions-".sprintf("%04d", $this->year)."-".sprintf("%02d", $this->month).".pdf";
 
    if (!file_exists($dir)) {
      if (dol_mkdir($dir) < 0) {
        $this->error = $langs->trans("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'));
 
      global $action;
      $object = new stdClass();
 
      $parameters = array('file' => $file, 'outputlangs' => $outputlangs);
      $reshook = $hookmanager->executeHooks('beforePDFCreation', $parameters, $object, $action); // Note that $action and $object may have been modified by some hooks
 
      $pdf = pdf_getInstance($this->format);
      $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)
      $pdf->setAutoPageBreak(true, 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->SetFillColor(220, 220, 220);
 
      $pdf->SetTitle($outputlangs->convToOutputCharset($this->title));
      $pdf->SetSubject($outputlangs->convToOutputCharset($this->subject));
      $pdf->SetCreator("Dolibarr ".DOL_VERSION);
      $pdf->SetAuthor($outputlangs->convToOutputCharset($user->getFullName($outputlangs)));
      $pdf->SetKeywords($outputlangs->convToOutputCharset($this->title." ".$this->subject));
 
      // @phan-suppress-next-line PhanPluginSuspiciousParamOrder
      $pdf->SetMargins($this->marge_gauche, $this->marge_haute, $this->marge_droite); // Left, Top, Right
 
      $nbpage = $this->_pages($pdf, $outputlangs); // Write content
 
      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
      $this->warnings = $hookmanager->warnings;
      if ($reshook < 0) {
        $this->error = $hookmanager->error;
        $this->errors = $hookmanager->errors;
        dolChmod($file);
        return -1;
      }
 
      dolChmod($file);
 
      $this->result = array('fullpath' => $file);
 
      return 1;
    }
    return 0;
  }
 
  private function _pages(&$pdf, $outputlangs)
  {
    global $conf;
 
    $height = 3; // height for text separation
    $pagenb = 1;
 
    $y = $this->_pagehead($pdf, $outputlangs, $pagenb);
    $y++;
    $pdf->SetFont('', '', 8);
 
    $sql = "SELECT s.nom as thirdparty, s.rowid as socid, s.client,";
    $sql .= " a.id, a.datep as dp, a.datep2 as dp2,";
    $sql .= " a.fk_contact, a.note, a.percent as percent, a.fulldayevent, a.label, a.fk_project,";
    $sql .= " c.code, c.libelle as label_type,";
    $sql .= " u.login";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_actioncomm as c, ".MAIN_DB_PREFIX."user as u, ".MAIN_DB_PREFIX."actioncomm as a";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."societe as s ON a.fk_soc = s.rowid";
    $sql .= " WHERE c.id=a.fk_action AND a.fk_user_author = u.rowid";
    $sql .= " AND a.datep BETWEEN '".$this->db->idate(dol_get_first_day($this->year, $this->month, false))."'";
    $sql .= " AND '".$this->db->idate(dol_get_last_day($this->year, $this->month, false))."'";
    $sql .= " AND a.entity = ".$conf->entity;
    $sql .= " ORDER BY a.datep DESC";
 
    $eventstatic = new ActionComm($this->db);
    $projectstatic = new Project($this->db);
 
    dol_syslog(get_class($this)."::_page", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql) {
      $num = $this->db->num_rows($resql);
      $i = 0;
      $y0 = $y1 = $y2 = $y3 = 0;
 
      while ($i < $num) {
        $obj = $this->db->fetch_object($resql);
 
        $eventstatic->id = $obj->id;
        $eventstatic->percentage = $obj->percent;
        $eventstatic->fulldayevent = $obj->fulldayevent;
 
        $y = max($y, $pdf->GetY(), $y0, $y1, $y2, $y3);
 
        // Calculate height of text
        $text = '';
        if (!preg_match('/^'.preg_quote($obj->label, '/').'/', $obj->note)) {
          $text = $obj->label."\n";
        }
        $text .= dolGetFirstLineOfText(dol_string_nohtmltag($obj->note), 1);
        // Add status to text
        $text .= "\n";
        $status = $outputlangs->trans("Status").': '.dol_htmlentitiesbr_decode($eventstatic->getLibStatut(1, 1));
        $text .= $status;
        if ($obj->fk_project > 0) {
          $projectstatic->fetch($obj->fk_project);
          if ($projectstatic->ref) {
            $text .= ($status ? ' - ' : '').$outputlangs->transnoentitiesnoconv("Project").": ".dol_htmlentitiesbr_decode($projectstatic->ref);
          }
        }
 
        //print 'd'.$text; exit;
        $nboflines = dol_nboflines($text);
 
        $heightlinemax = max(2 * $height, $nboflines * $height);
        // Check if there is enough space to print record
        if ((1 + $y + $heightlinemax) >= ($this->page_hauteur - $this->marge_haute)) {
          // We need to break page
          $pagenb++;
          $y = $this->_pagehead($pdf, $outputlangs, $pagenb);
          $y++;
          $pdf->SetFont('', '', 8);
        }
        $y++;
 
        // Date
        $pdf->SetXY($this->marge_gauche, $y);
        $textdate = dol_print_date($this->db->jdate($obj->dp), "day")."\n".dol_print_date($this->db->jdate($obj->dp), "hour");
        if ($obj->dp2) {
          if (dol_print_date($this->db->jdate($obj->dp), "day") != dol_print_date($this->db->jdate($obj->dp2), "day")) {
            $textdate .= " -> ".dol_print_date($this->db->jdate($obj->dp2), "day")." - ".dol_print_date($this->db->jdate($obj->dp2), "hour");
          } else {
            $textdate .= " -> ".dol_print_date($this->db->jdate($obj->dp2), "hour");
          }
        }
        $textdate = $outputlangs->trans("ID").' '.$obj->id.' - '.$textdate;
        $pdf->MultiCell(45 - $this->marge_gauche, $height, $textdate, 0, 'L', false);
        $y0 = $pdf->GetY();
 
        // Third party
        $pdf->SetXY(45, $y);
        $pdf->MultiCell(28, $height, dol_trunc($outputlangs->convToOutputCharset($obj->thirdparty), 28), 0, 'L', false);
        $y1 = $pdf->GetY();
 
        // Action code
        $code = $obj->code;
        if (!getDolGlobalString('AGENDA_USE_EVENT_TYPE')) {
          if ($code == 'AC_OTH') {
            $code = 'AC_MANUAL';
          }
          if ($code == 'AC_OTH_AUTO') {
            $code = 'AC_AUTO';
          }
        }
        $pdf->SetXY(73, $y);
        $labelactiontype = $outputlangs->transnoentitiesnoconv("Action".$code);
        $labelactiontypeshort = $outputlangs->transnoentitiesnoconv("Action".$code.'Short');
        $pdf->MultiCell(32, $height, dol_trunc($outputlangs->convToOutputCharset($labelactiontypeshort == "Action".$code.'Short' ? $labelactiontype : $labelactiontypeshort), 32), 0, 'L', false);
        $y2 = $pdf->GetY();
 
        // Description of event
        $pdf->SetXY(106, $y);
        $pdf->MultiCell(94, $height, $outputlangs->convToOutputCharset(dol_trunc(dol_string_nohtmltag($text, 0), 250, 'right', 'UTF-8', 0)), 0, 'L', false);
        $y3 = $pdf->GetY();
 
        $i++;
      }
    }
 
    return 1;
  }
 
  private function _pagehead(&$pdf, $outputlangs, $pagenb)
  {
    // Do not add the BACKGROUND as this is a report
    //pdf_pagehead($pdf,$outputlangs,$this->page_hauteur);
 
    // New page
    $pdf->AddPage();
 
    // Show title
    $pdf->SetFont('', 'B', 10);
    $pdf->SetXY($this->marge_gauche, $this->marge_haute);
    $pdf->MultiCell(120, 1, $outputlangs->convToOutputCharset($this->title), 0, 'L', false);
    // Show page nb only on iso languages (so default Helvetica font)
    if (pdf_getPDFFont($outputlangs) == 'Helvetica') {
      $pdf->SetXY($this->page_largeur - $this->marge_droite - 40, $this->marge_haute);
      $pdf->MultiCell(40, 1, $pagenb.'/'.$pdf->getAliasNbPages(), 0, 'R', false);
    }
 
    $y = $pdf->GetY() + 2;
 
    $pdf->RoundedRect($this->marge_gauche, $y, ($this->page_largeur - $this->marge_gauche - $this->marge_droite), ($this->page_hauteur - $this->marge_haute - $this->marge_basse), $this->corner_radius, '1234', 'D');
    $y = $pdf->GetY() + 1;
 
    return $y;
  }
}