mod_payment_cicada.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2015      Juanjo Menent      <jmenent@2byte.es>
 * Copyright (C) 2024   MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025       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/payment/modules_payment.php';
 
class mod_payment_cicada extends ModeleNumRefPayments
{
  public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr'
 
  public $prefix = 'PAY';
 
  public $error = '';
 
  public $nom = 'Cicada';
 
  public $name = 'Cicada';
 
  public $position = 30;
 
 
  public function info($langs)
  {
    global $langs;
    return $langs->trans("SimpleNumRefModelDesc", $this->prefix);
  }
 
 
  public function getExample()
  {
    return $this->prefix."0501-0001";
  }
 
 
  public function canBeActivated($object)
  {
    global $conf, $langs, $db;
 
    $payyymm = '';
    $max = '';
 
    $posindice = strlen($this->prefix) + 6;
    $sql = "SELECT MAX(CAST(SUBSTRING(ref FROM ".$posindice.") AS SIGNED)) as max";
    $sql .= " FROM ".MAIN_DB_PREFIX."paiement";
    $sql .= " WHERE ref LIKE '".$db->escape($this->prefix)."____-%'";
    $sql .= " AND entity = ".$conf->entity;
 
    $resql = $db->query($sql);
    if ($resql) {
      $row = $db->fetch_row($resql);
      if ($row) {
        $payyymm = substr($row[0], 0, 6);
        $max = $row[0];
      }
    }
    if ($payyymm && !preg_match('/'.$this->prefix.'[0-9][0-9][0-9][0-9]/i', $payyymm)) {
      $langs->load("errors");
      $this->error = $langs->trans('ErrorNumRefModel', $max);
      return false;
    }
 
    return true;
  }
 
  public function getNextValue($objsoc, $object)
  {
    global $db, $conf;
 
    // First, we get the max value
    $posindice = strlen($this->prefix) + 6;
    $sql = "SELECT MAX(CAST(SUBSTRING(ref FROM ".$posindice.") AS SIGNED)) as max";
    $sql .= " FROM ".MAIN_DB_PREFIX."paiement";
    $sql .= " WHERE ref LIKE '".$db->escape($this->prefix)."____-%'";
    $sql .= " AND entity = ".$conf->entity;
 
    $resql = $db->query($sql);
    if ($resql) {
      $obj = $db->fetch_object($resql);
      if ($obj) {
        $max = intval($obj->max);
      } else {
        $max = 0;
      }
    } else {
      dol_syslog(__METHOD__, LOG_DEBUG);
      return -1;
    }
 
    //$date=time();
    $date = $object->datepaye;
    $yymm = dol_print_date($date, "%y%m");
 
    if ($max >= (pow(10, 4) - 1)) {
      $num = $max + 1; // If counter > 9999, we do not format on 4 chars, we take number as it is
    } else {
      $num = sprintf("%04d", $max + 1);
    }
 
    dol_syslog(__METHOD__." return ".$this->prefix.$yymm."-".$num);
    return $this->prefix.$yymm."-".$num;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function payment_get_num($objsoc, $objforref)
  {
    // phpcs:enable
    return $this->getNextValue($objsoc, $objforref);
  }
}