modules_chequereceipts.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2003-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2009 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2004      Eric Seigne          <eric.seigne@ryxeo.com>
 * Copyright (C) 2005-2009 Regis Houssin        <regis.houssin@inodbox.com>
 * Copyright (C) 2016      Juanjo Menent    <jmenent@2byte.es>
 * Copyright (C) 2024   MDW             <mdeweerd@users.noreply.github.com>
 *
 * 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/class/commondocgenerator.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/commonnumrefgenerator.class.php';
require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php'; // Requis car utilise dans les classes qui heritent
 
abstract class ModeleNumRefChequeReceipts extends CommonNumRefGenerator
{
  // No overload code
  abstract public function getNextValue($objsoc, $object);
 
  abstract public function getExample();
}
 
abstract class ModeleChequeReceipts extends CommonDocGenerator
{
  public $account;
 
  public $amount;
  public $date;
  public $nbcheque;
  public $ref;
  public $lines;
  public $error = '';
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public static function liste_modeles($db, $maxfilenamelength = 0)
  {
    // phpcs:enable
    $type = 'chequereceipt';
    $list = array();
 
    include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
    $list = getListOfModels($db, $type, $maxfilenamelength);
    // TODO Remove this to use getListOfModels only
    $list = array('blochet' => 'blochet');
 
    return $list;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  abstract public function write_file($object, $_dir, $number, $outputlangs);
  // phpcs:enable
}
 
 
function chequereceipt_pdf_create($db, $id, $message, $modele, $outputlangs)
{
  global $conf, $langs;
  $langs->load("bills");
 
  $dir = DOL_DOCUMENT_ROOT."/core/modules/cheque/doc/";
 
  // Positionne modele sur le nom du modele a utiliser
  if (!dol_strlen($modele)) {
    if (getDolGlobalString('CHEQUERECEIPT_ADDON_PDF')) {
      $modele = getDolGlobalString('CHEQUERECEIPT_ADDON_PDF');
    } else {
      //print $langs->trans("Error")." ".$langs->trans("Error_FACTURE_ADDON_PDF_NotDefined");
      //return 0;
      $modele = 'blochet';
    }
  }
 
  // Charge le modele
  $file = "pdf_".$modele.".modules.php";
  if (file_exists($dir.$file)) {
    $classname = "pdf_".$modele;
    require_once $dir.$file;
 
    $obj = new $classname($db);
    '@phan-var-force ModeleChequeReceipts $obj';
 
    // We save charset_output to restore it because write_file can change it if needed for
    // output format that does not support UTF8.
    $sav_charset_output = $outputlangs->charset_output;
    // TODO: write_file seems invalid, function is likely no longer used - delete ?
    if ($obj->write_file($id, $outputlangs) > 0) { // @phan-suppress-current-line PhanParamTooFew,PhanPluginSuspiciousParamPosition
      $outputlangs->charset_output = $sav_charset_output;
      return 1;
    } else {
      $outputlangs->charset_output = $sav_charset_output;
      dol_print_error($db, "chequereceipt_pdf_create Error: ".$obj->error);
      return -1;
    }
  } else {
    dol_print_error(null, $langs->trans("Error")." ".$langs->trans("ErrorFileDoesNotExists", $dir.$file));
    return -1;
  }
}