modules_facture.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2003-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2011 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2004      Eric Seigne          <eric.seigne@ryxeo.com>
 * Copyright (C) 2005-2012 Regis Houssin        <regis.houssin@inodbox.com>
 * Copyright (C) 2014      Marcos García        <marcosgdf@gmail.com>
 * 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'; // Required because used in classes that inherit
 
// For the experimental feature using swiss QR invoice generated by composer lib sparin/swiss-qr-bill
use Sprain\SwissQrBill;
 
abstract class ModelePDFFactures extends CommonDocGenerator
{
  public $posxpicture;
  public $posxtva;
  public $posxup;
  public $posxqty;
  public $posxunit;
  public $posxdesc;
  public $posxdiscount;
  public $postotalht;
 
  public $tva;
  public $tva_array;
  public $localtax1;
  public $localtax2;
 
  public $atleastonediscount = 0;
  public $atleastoneratenotnull = 0;
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public static function liste_modeles($db, $maxfilenamelength = 0)
  {
    // phpcs:enable
    $type = 'invoice';
    $list = array();
 
    include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
    $list = getListOfModels($db, $type, $maxfilenamelength);
 
    return $list;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  abstract public function write_file($object, $outputlangs, $srctemplatepath = '', $hidedetails = 0, $hidedesc = 0, $hideref = 0);
  // phpcs:enable
 
 
  private function getSwissQrBill(Facture $object, Translate $langs)
  {
    global $conf;
 
    if (getDolGlobalString('INVOICE_ADD_SWISS_QR_CODE') != 'bottom') {
      return false;
    }
 
    if ($object->mode_reglement_code != 'VIR') {
      $this->error = $langs->transnoentities("SwissQrOnlyVIR");
      return false;
    }
 
    if (empty($object->fk_account)) {
      $this->error = 'Bank account must be defined to use this experimental feature';
      return false;
    }
 
    // Load the autoload file generated by composer
    if (file_exists(DOL_DOCUMENT_ROOT.'/includes/sprain/swiss-qr-bill/autoload.php')) {
      require_once DOL_DOCUMENT_ROOT.'/includes/sprain/swiss-qr-bill/autoload.php';
    } elseif (file_exists(DOL_DOCUMENT_ROOT.'/includes/autoload.php')) {
      require_once DOL_DOCUMENT_ROOT.'/includes/autoload.php';
    } else {
      $this->error = 'PHP library sprain/swiss-qr-bill was not found. Please install it with:<br>cd '.dirname(DOL_DOCUMENT_ROOT).'; cp composer.json.disabled composer.json; composer require sprain/swiss-qr-bill;';
      return false;
    }
 
    // Create a new instance of SwissQrBill, containing default headers with fixed values
    $qrBill = SwissQrBill\QrBill::create();
 
    // First, set creditor address
    $address = SwissQrBill\DataGroup\Element\CombinedAddress::create(
      $this->emetteur->name,
      $this->emetteur->address,
      $this->emetteur->zip . " " . $this->emetteur->town,
      $this->emetteur->country_code
    );
    if (!$address->isValid()) {
      $this->error = $langs->transnoentities("SwissQrCreditorAddressInvalid", (string) $address->getViolations());
      return false;
    }
    $qrBill->setCreditor($address);
 
    // Get IBAN from account.
    $account = new Account($this->db);
    $account->fetch($object->fk_account);
    $creditorInformation = SwissQrBill\DataGroup\Element\CreditorInformation::create($account->iban);
    if (!$creditorInformation->isValid()) {
      $langs->load("errors");
      $this->error = $langs->transnoentities("SwissQrCreditorInformationInvalid", $account->iban, (string) $creditorInformation->getViolations());
      return false;
    }
    $qrBill->setCreditorInformation($creditorInformation);
 
    if ($creditorInformation->containsQrIban()) {
      $this->error = $langs->transnoentities("SwissQrIbanNotImplementedYet", $account->iban);
      return false;
    }
 
    // Add payment reference CLASSIC-IBAN
    // This is what you will need to identify incoming payments.
    $qrBill->setPaymentReference(
      SwissQrBill\DataGroup\Element\PaymentReference::create(
        SwissQrBill\DataGroup\Element\PaymentReference::TYPE_NON
      )
    );
 
    $currencyinvoicecode = $object->multicurrency_code ? $object->multicurrency_code : $conf->currency;
 
    // Add payment amount, with currency
    $pai = SwissQrBill\DataGroup\Element\PaymentAmountInformation::create($currencyinvoicecode, $object->total_ttc);
    if (!$pai->isValid()) {
      $this->error = $langs->transnoentities("SwissQrPaymentInformationInvalid", $object->total_ttc, (string) $pai->getViolations());
      return false;
    }
    $qrBill->setPaymentAmountInformation($pai);
 
    // Add some human-readable information about what the bill is for.
    $qrBill->setAdditionalInformation(
      SwissQrBill\DataGroup\Element\AdditionalInformation::create(
        $object->ref
      )
    );
 
    // Set debtor address; We _know_ zip&town have to be filled, so skip that if unfilled.
    if (!empty($object->thirdparty->zip) && !empty($object->thirdparty->town)) {
      $address = SwissQrBill\DataGroup\Element\CombinedAddress::create(
        $object->thirdparty->name,
        $object->thirdparty->address,
        $object->thirdparty->zip . " " . $object->thirdparty->town,
        $object->thirdparty->country_code
      );
      if (!$address->isValid()) {
        $this->error = $langs->transnoentities("SwissQrDebitorAddressInvalid", (string) $address->getViolations());
        return false;
      }
      $qrBill->setUltimateDebtor($address);
    }
 
    return $qrBill;
  }
 
  protected function getHeightForQRInvoice(int $pagenbr, Facture $object, Translate $langs)
  {
    if (getDolGlobalString('INVOICE_ADD_SWISS_QR_CODE') == 'bottom') {
      // Keep it, to reset it after QRinvoice getter
      $error = $this->error;
 
      if (!$this->getSwissQrBill($object, $langs)) {
        // Reset error to previous one if exists
        if (!empty($error)) {
          $this->error = $error;
        }
        return 0;
      }
      // SWIFT's requirementis 105, but we get more room with 100 and the page number is in a nice place.
      return $pagenbr == 1 ? 100 : 0;
    }
 
    return 0;
  }
 
  public function addBottomQRInvoice(TCPDF $pdf, Facture $object, Translate $langs): bool
  {
    if (!($qrBill = $this->getSwissQrBill($object, $langs))) {
      return false;
    }
 
    try {
      $pdf->startTransaction();
 
      $pdf->setPage(1);
      $pdf->SetTextColor(0, 0, 0);
      $output = new SwissQrBill\PaymentPart\Output\TcPdfOutput\TcPdfOutput($qrBill, in_array($langs->shortlang, ['de', 'fr', 'it']) ? $langs->shortlang : 'en', $pdf);
      $output->setPrintable(false)->getPaymentPart();
    } catch (Exception $e) {
      $pdf->rollbackTransaction(true);
      return false;
    }
    return true;
  }
}
 
abstract class ModeleNumRefFactures extends CommonNumRefGenerator
{
  abstract public function getNextValue($objsoc, $invoice, $mode = 'next');
 
  abstract public function getExample();
}