mod_chequereceipt_thyme.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2015       Juanjo Menent         <jmenent@2byte.es>
 * Copyright (C) 2019-2025  Frédéric France         <frederic.france@free.fr>
 * 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/modules/cheque/modules_chequereceipts.php';
 
 
class mod_chequereceipt_thyme extends ModeleNumRefChequeReceipts
{
  public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr'
 
  public $error = '';
 
  public $name = 'Thyme';
 
 
  public function info($langs)
  {
    global $langs, $db;
 
    $langs->load("bills");
 
    $form = new Form($db);
 
    $texte = $langs->trans('GenericNumRefModelDesc')."<br>\n";
    $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST">';
    $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
    $texte .= '<input type="hidden" name="action" value="updateMask">';
    $texte .= '<input type="hidden" name="maskconstchequereceipts" value="CHEQUERECEIPTS_THYME_MASK">';
    $texte .= '<input type="hidden" name="page_y" value="">';
 
    $texte .= '<table class="nobordernopadding centpercent">';
 
    $tooltip = $langs->trans("GenericMaskCodes", $langs->transnoentities("CheckReceiptShort"), $langs->transnoentities("CheckReceiptShort"));
    $tooltip .= $langs->trans("GenericMaskCodes1");
    $tooltip .= '<br>';
    $tooltip .= $langs->trans("GenericMaskCodes2");
    $tooltip .= '<br>';
    $tooltip .= $langs->trans("GenericMaskCodes3");
    $tooltip .= $langs->trans("GenericMaskCodes4a", $langs->transnoentities("CheckReceiptShort"), $langs->transnoentities("CheckReceiptShort"));
    $tooltip .= $langs->trans("GenericMaskCodes5");
    //$tooltip .= '<br>'.$langs->trans("GenericMaskCodes5b");
 
    // Setting of prefix
    $texte .= '<tr><td>'.$langs->trans("Mask").':</td>';
    $texte .= '<td class="right">'.$form->textwithpicto('<input type="text" class="flat minwidth175" name="maskchequereceipts" value="' . getDolGlobalString('CHEQUERECEIPTS_THYME_MASK').'">', $tooltip, 1, 'help', 'valignmiddle', 0, 3, $this->name).'</td>';
 
    $texte .= '<td class="left" rowspan="2">&nbsp;<input type="submit" class="button button-edit reposition smallpaddingimp" name="Button" value="'.$langs->trans("Save").'"></td>';
 
    $texte .= '</tr>';
 
    $texte .= '</table>';
    $texte .= '</form>';
 
    return $texte;
  }
 
  public function getExample()
  {
    global $db, $langs;
 
    require_once DOL_DOCUMENT_ROOT . '/compta/paiement/cheque/class/remisecheque.class.php';
    require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
 
    $remise = new RemiseCheque($db);
    $remise->initAsSpecimen();
    $thirdparty = new Societe($db);
    $thirdparty->initAsSpecimen();
 
    $numExample = $this->getNextValue($thirdparty, $remise);
 
    if (!$numExample) {
      $numExample = $langs->trans('NotConfigured');
    }
 
    return $numExample;
  }
 
  public function getNextValue($objsoc, $object)
  {
    global $db;
 
    require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
 
    // We get cursor rule
    $mask = getDolGlobalString('CHEQUERECEIPTS_THYME_MASK');
 
    if (!$mask) {
      $this->error = 'NotConfigured';
      return 0;
    }
 
    $date = (empty($object) ? dol_now() : $object->date_bordereau);
 
    $numFinal = get_next_value($db, $mask, 'bordereau_cheque', 'ref', '', $objsoc, $date);
 
    return  $numFinal;
  }
}