subscription.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2002-2004 Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2006-2015 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2024-2025  MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024       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/>.
 */
 
//namespace DolibarrMember;
 
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
 
 
class Subscription extends CommonObject
{
  public $element = 'subscription';
 
  public $table_element = 'subscription';
 
  public $picto = 'payment';
 
  public $datec;
 
  public $datem;
 
  public $dateh;
 
  public $datef;
 
  public $fk_type;
 
  public $fk_adherent;
 
  public $amount;
 
  public $fk_bank;
 
  public $fields = array(
    'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'visible' => -1, 'notnull' => 1, 'position' => 10),
    'tms' => array('type' => 'timestamp', 'label' => 'DateModification', 'enabled' => 1, 'visible' => -1, 'notnull' => 1, 'position' => 15),
    'datec' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'visible' => -1, 'position' => 20),
    'fk_adherent' => array('type' => 'integer', 'label' => 'Member', 'enabled' => 1, 'visible' => -1, 'position' => 25),
    'dateadh' => array('type' => 'datetime', 'label' => 'DateSubscription', 'enabled' => 1, 'visible' => -1, 'position' => 30),
    'datef' => array('type' => 'datetime', 'label' => 'DateEndSubscription', 'enabled' => 1, 'visible' => -1, 'position' => 35),
    'subscription' => array('type' => 'double(24,8)', 'label' => 'Amount', 'enabled' => 1, 'visible' => -1, 'position' => 40, 'isameasure' => 1),
    'fk_bank' => array('type' => 'integer', 'label' => 'BankId', 'enabled' => 1, 'visible' => -1, 'position' => 45),
    'note' => array('type' => 'html', 'label' => 'Note', 'enabled' => 1, 'visible' => -1, 'position' => 50),
    'fk_type' => array('type' => 'integer', 'label' => 'MemberType', 'enabled' => 1, 'visible' => -1, 'position' => 55),
    'fk_user_creat' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserAuthor', 'enabled' => 1, 'visible' => -2, 'position' => 60),
    'fk_user_valid' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserValidation', 'enabled' => 1, 'visible' => -1, 'position' => 65),
  );
 
 
  public function __construct($db)
  {
    $this->db = $db;
 
    $this->ismultientitymanaged = 'fk_adherent@adherent';
  }
 
 
  public function create($user, $notrigger = 0)
  {
    global $langs;
 
    $error = 0;
 
    $now = dol_now();
 
    // Check parameters
    if ($this->datef <= $this->dateh) {
      $this->error = $langs->trans("ErrorBadValueForDate");
      return -1;
    }
    if (empty($this->datec)) {
      $this->datec = $now;
    }
 
    $this->db->begin();
 
    require_once DOL_DOCUMENT_ROOT.'/adherents/class/adherent.class.php';
    $member = new Adherent($this->db);
    $result = $member->fetch($this->fk_adherent);
 
    if ($this->fk_type == null) { // If type not defined, we use the type of member
      $type = $member->typeid;
    } else {
      $type = $this->fk_type;
    }
 
    $sql = "INSERT INTO ".MAIN_DB_PREFIX."subscription (fk_adherent, fk_type, datec, dateadh, datef, subscription, note, fk_user_creat)";
    $sql .= " VALUES (".((int) $this->fk_adherent).", '".$this->db->escape((string) $type)."', '".$this->db->idate($now)."',";
    $sql .= " '".$this->db->idate($this->dateh)."',";
    $sql .= " '".$this->db->idate($this->datef)."',";
    $sql .= " ".((float) $this->amount).",";
    $sql .= " '".$this->db->escape($this->note_public ? $this->note_public : $this->note)."',";
    $sql .= " ".((int) ($this->user_creation_id > 0 ? $this->user_creation_id : $user->id));
    $sql .= ")";
 
    $resql = $this->db->query($sql);
    if (!$resql) {
      $error++;
      $this->errors[] = $this->db->lasterror();
    }
 
    if (!$error) {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX.$this->table_element);
      $this->fk_type = $type;
    }
 
    // Update the denormalized end date of subscription of the member, like update() and delete() do
    if (!$error) {
      $result = $member->update_end_date($user);
      if ($result < 0) {
        $error++;
        $this->error = $member->error;
        $this->errors[] = $this->error;
      }
    }
 
    if (!empty($this->linkedObjectsIds) && empty($this->linked_objects)) {  // To use new linkedObjectsIds instead of old linked_objects
      $this->linked_objects = $this->linkedObjectsIds; // TODO Replace linked_objects with linkedObjectsIds
    }
 
    // Add object linked
    if (!$error && $this->id && !empty($this->linked_objects) && is_array($this->linked_objects)) {
      foreach ($this->linked_objects as $origin => $tmp_origin_id) {
        if (is_array($tmp_origin_id)) {       // New behaviour, if linked_object can have several links per type, so is something like array('contract'=>array(id1, id2, ...))
          foreach ($tmp_origin_id as $origin_id) {
            $ret = $this->add_object_linked($origin, $origin_id);
            if (!$ret) {
              $this->error = $this->db->lasterror();
              $error++;
            }
          }
        } else { // Old behaviour, if linked_object has only one link per type, so is something like array('contract'=>id1))
          $origin_id = $tmp_origin_id;
          $ret = $this->add_object_linked($origin, $origin_id);
          if (!$ret) {
            $this->error = $this->db->lasterror();
            $error++;
          }
        }
      }
    }
 
    if (!$error && !$notrigger) {
      $this->context = array('member' => $member);
      // Call triggers
      $result = $this->call_trigger('MEMBER_SUBSCRIPTION_CREATE', $user);
      if ($result < 0) {
        $error++;
      }
      // End call triggers
    }
 
    // Commit or rollback
    if ($error) {
      $this->db->rollback();
      return -1;
    } else {
      $this->db->commit();
      return $this->id;
    }
  }
 
 
  public function fetch($rowid)
  {
    $sql = "SELECT rowid, fk_type, fk_adherent, datec,";
    $sql .= " tms,";
    $sql .= " dateadh as dateh,";
    $sql .= " datef,";
    $sql .= " subscription, note as note_public, fk_bank";
    $sql .= " FROM ".MAIN_DB_PREFIX."subscription";
    $sql .= " WHERE rowid = ".((int) $rowid);
 
    dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql) {
      if ($this->db->num_rows($resql)) {
        $obj = $this->db->fetch_object($resql);
 
        $this->id             = $obj->rowid;
        $this->ref            = $obj->rowid;
 
        $this->fk_type        = $obj->fk_type;
        $this->fk_adherent    = $obj->fk_adherent;
        $this->datec          = $this->db->jdate($obj->datec);
        $this->datem          = $this->db->jdate($obj->tms);
        $this->dateh          = $this->db->jdate($obj->dateh);
        $this->datef          = $this->db->jdate($obj->datef);
        $this->amount         = $obj->subscription;
        $this->note           = $obj->note_public;  // deprecated
        $this->note_public    = $obj->note_public;
        $this->fk_bank        = $obj->fk_bank;
        return 1;
      } else {
        return 0;
      }
    } else {
      $this->error = $this->db->lasterror();
      return -1;
    }
  }
 
 
  public function update($user, $notrigger = 0)
  {
    $error = 0;
 
    $this->db->begin();
 
    if (!is_numeric($this->amount)) {
      $this->error = 'BadValueForParameterAmount';
      return -1;
    }
 
    if (empty($this->note_public) && !empty($this->note)) { // For backward compatibility
      $this->note_public = $this->note;
    }
 
    $sql = "UPDATE ".MAIN_DB_PREFIX."subscription SET ";
    $sql .= " fk_type = ".((int) $this->fk_type).",";
    $sql .= " fk_adherent = ".((int) $this->fk_adherent).",";
    $sql .= " note = ".($this->note_public ? "'".$this->db->escape($this->note_public)."'" : 'null').",";
    $sql .= " subscription = ".(float) price2num($this->amount).",";
    $sql .= " dateadh = '".$this->db->idate($this->dateh)."',";
    $sql .= " datef = '".$this->db->idate($this->datef)."',";
    $sql .= " datec = '".$this->db->idate($this->datec)."',";
    $sql .= " fk_bank = ".($this->fk_bank ? ((int) $this->fk_bank) : 'null');
    $sql .= " WHERE rowid = ".((int) $this->id);
 
    dol_syslog(get_class($this)."::update", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql) {
      require_once DOL_DOCUMENT_ROOT.'/adherents/class/adherent.class.php';
      $member = new Adherent($this->db);
      $result = $member->fetch($this->fk_adherent);
      $result = $member->update_end_date($user);
 
      if (!$error && !$notrigger) {
        $this->context = array('member' => $member);
        // Call triggers
        $result = $this->call_trigger('MEMBER_SUBSCRIPTION_MODIFY', $user);
        if ($result < 0) {
          $error++;
        } //Do also here what you must do to rollback action if trigger fail
        // End call triggers
      }
    } else {
      $error++;
      $this->error = $this->db->lasterror();
    }
 
    // Commit or rollback
    if ($error) {
      $this->db->rollback();
      return -1;
    } else {
      $this->db->commit();
      return $this->id;
    }
  }
 
  public function delete($user, $notrigger = 0)
  {
    $error = 0;
 
    // It subscription is linked to a bank transaction, we get it
    if ($this->fk_bank > 0) {
      require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php';
      $accountline = new AccountLine($this->db);
      $result = $accountline->fetch($this->fk_bank);
    } else {
      $accountline = null;
    }
 
    $this->db->begin();
 
    if (!$error) {
      if (!$notrigger) {
        // Call triggers
        $result = $this->call_trigger('MEMBER_SUBSCRIPTION_DELETE', $user);
        if ($result < 0) {
          $error++;
        } // Do also here what you must do to rollback action if trigger fail
        // End call triggers
      }
    }
 
    if (!$error) {
      $sql = "DELETE FROM ".MAIN_DB_PREFIX."subscription WHERE rowid = ".((int) $this->id);
      dol_syslog(get_class($this)."::delete", LOG_DEBUG);
      $resql = $this->db->query($sql);
      if ($resql) {
        $num = $this->db->affected_rows($resql);
        if ($num) {
          require_once DOL_DOCUMENT_ROOT.'/adherents/class/adherent.class.php';
          $member = new Adherent($this->db);
          $result = $member->fetch($this->fk_adherent);
          $result = $member->update_end_date($user);
 
          if ($this->fk_bank > 0 && is_object($accountline) && $accountline->id > 0) {  // If we found bank account line (this means this->fk_bank defined)
            $result = $accountline->delete($user); // Return false if refused because line is reconciled
            if ($result > 0) {
              $this->db->commit();
              return 1;
            } else {
              $this->error = $accountline->error;
              $this->db->rollback();
              return -1;
            }
          } else {
            $this->db->commit();
            return 1;
          }
        } else {
          $this->db->commit();
          return 0;
        }
      } else {
        $error++;
        $this->error = $this->db->lasterror();
      }
    }
 
    // Commit or rollback
    if ($error) {
      $this->db->rollback();
      return -1;
    } else {
      $this->db->commit();
      return 1;
    }
  }
 
 
  public function getNomUrl($withpicto = 0, $notooltip = 0, $option = '', $morecss = '', $save_lastsearch_value = -1)
  {
    global $langs;
 
    $result = '';
 
    $langs->load("members");
 
    $label = img_picto('', $this->picto).' <u class="paddingrightonly">'.$langs->trans("Subscription").'</u>';
    /*if (isset($this->statut)) {
      $label .= ' '.$this->getLibStatut(5);
    }*/
    $label .= '<br><b>'.$langs->trans('Ref').':</b> '.$this->ref;
    if (!empty($this->dateh)) {
      $label .= '<br><b>'.$langs->trans('DateStart').':</b> '.dol_print_date($this->dateh, 'day');
    }
    if (!empty($this->datef)) {
      $label .= '<br><b>'.$langs->trans('DateEnd').':</b> '.dol_print_date($this->datef, 'day');
    }
 
    $url = DOL_URL_ROOT.'/adherents/subscription/card.php?rowid='.((int) $this->id);
 
    if ($option != 'nolink') {
      // Add param to save lastsearch_values or not
      $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
      if ($save_lastsearch_value == -1 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
        $add_save_lastsearch_values = 1;
      }
      if ($add_save_lastsearch_values) {
        $url .= '&save_lastsearch_values=1';
      }
    }
 
    $linkstart = '<a href="'.$url.'" class="classfortooltip" title="'.dol_escape_htmltag($label, 1).'">';
    $linkend = '</a>';
 
    $result .= $linkstart;
    if ($withpicto) {
      $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'classfortooltip"'), 0, 0, $notooltip ? 0 : 1);
    }
    if ($withpicto != 2) {
      $result .= $this->ref;
    }
    $result .= $linkend;
 
    return $result;
  }
 
 
  public function getLibStatut($mode = 0)
  {
    return '';
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
 
    //$langs->load("members");
 
    return '';
  }
 
  public function info($id)
  {
    $sql = "SELECT c.rowid, c.datec, c.tms as datem, c.fk_user_creat";
    $sql .= " FROM ".MAIN_DB_PREFIX."subscription as c";
    $sql .= " WHERE c.rowid = ".((int) $id);
 
    $resql = $this->db->query($sql);
    if ($resql) {
      if ($this->db->num_rows($resql)) {
        $obj = $this->db->fetch_object($resql);
        $this->id = $obj->rowid;
 
        $this->date_creation = $this->db->jdate($obj->datec);
        $this->date_modification = $this->db->jdate($obj->datem);
 
        $this->user_creation_id = $obj->fk_user_creat;
      }
 
      $this->db->free($resql);
    } else {
      dol_print_error($this->db);
    }
  }
 
  public function getKanbanView($option = '', $arraydata = null)
  {
    $selected = (empty($arraydata['selected']) ? 0 : $arraydata['selected']);
 
    $return = '<div class="box-flex-item box-flex-grow-zero">';
    $return .= '<div class="info-box info-box-sm">';
    $return .= '<span class="info-box-icon bg-infobox-action">';
    $return .= img_picto('', $this->picto);
    $return .= '</span>';
 
    $return .= '<div class="info-box-content">';
    $return .= '<span class="info-box-ref inline-block tdoverflowmax150 valignmiddle">';
    $return .= $this->getNomUrl(0);
    $return .= '</span>';
    if ($selected >= 0) {
      $return .= '<input id="cb'.$this->id.'" class="flat checkforselect fright" type="checkbox" name="toselect[]" value="'.$this->id.'"'.($selected ? ' checked="checked"' : '').'>';
    }
    if (property_exists($this, 'dateh') || property_exists($this, 'datef')) {
      $return .= '<br><span class="info-box-status opacitymedium small">'.dol_print_date($this->dateh, 'day').' - '.dol_print_date($this->datef, 'day').'</span>';
    }
 
    if (!empty($arraydata['member']) && is_object($arraydata['member'])) {
      $return .= '<br><div class="inline-block tdoverflowmax150">'.$arraydata['member']->getNomUrl(-4).'</div>';
    }
 
    if (property_exists($this, 'amount')) {
      $return .= '<br><span class="amount inline-block">'.price($this->amount).'</span>';
      if (!empty($arraydata['bank'])) {
        $return .= ' &nbsp; <span class="info-box-label ">'.$arraydata['bank']->getNomUrl(-1).'</span>';
      }
    }
    $return .= '</div>';
    $return .= '</div>';
    $return .= '</div>';
    return $return;
  }
}