adherent_type.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2002   Rodolphe Quiedeville  <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2008  Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2009-2017  Regis Houssin     <regis.houssin@inodbox.com>
 * Copyright (C) 2016   Charlie Benke     <charlie@patas-monkey.com>
 * Copyright (C) 2018-2019  Thibault Foucart    <support@ptibogxiv.net>
 * Copyright (C) 2021       Waël Almoman            <info@almoman.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/>.
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
 
 
class AdherentType extends CommonObject
{
  public $table_element = 'adherent_type';
 
  public $element = 'adherent_type';
 
  public $picto = 'members';
 
  public $ismultientitymanaged = 1;
 
  public $libelle;
 
  public $label;
 
  public $morphy;
 
  public $duration;
 
  /*
  * type expiration
  */
  public $duration_value;
 
  public $duration_unit;
 
  public $subscription;
 
  public $amount;
 
  public $note;
 
  public $note_public;
 
  public $vote;
 
  public $mail_valid;
 
  public $mail_subscription = '';
 
  public $mail_resiliate = '';
 
  public $mail_exclude = '';
 
  public $members = array();
 
  public $other = array();
 
  public $multilangs = array();
 
 
  public function __construct($db)
  {
    $this->db = $db;
    $this->status = 1;
  }
 
  public function getMultiLangs()
  {
    global $langs;
 
    $current_lang = $langs->getDefaultLang();
 
    $sql = "SELECT lang, label, description, email";
    $sql .= " FROM ".MAIN_DB_PREFIX."adherent_type_lang";
    $sql .= " WHERE fk_type = ".((int) $this->id);
 
    $result = $this->db->query($sql);
    if ($result) {
      while ($obj = $this->db->fetch_object($result)) {
        //print 'lang='.$obj->lang.' current='.$current_lang.'<br>';
        if ($obj->lang == $current_lang) {  // si on a les traduct. dans la langue courante on les charge en infos principales.
          $this->label        = $obj->label;
          $this->description = $obj->description;
          $this->email        = $obj->email;
        }
        $this->multilangs["$obj->lang"]["label"] = $obj->label;
        $this->multilangs["$obj->lang"]["description"] = $obj->description;
        $this->multilangs["$obj->lang"]["email"] = $obj->email;
      }
      return 1;
    } else {
      $this->error = "Error: ".$this->db->lasterror()." - ".$sql;
      return -1;
    }
  }
 
  public function setMultiLangs($user)
  {
    global $conf, $langs;
 
    $langs_available = $langs->get_available_languages(DOL_DOCUMENT_ROOT, 0, 2);
    $current_lang = $langs->getDefaultLang();
 
    foreach ($langs_available as $key => $value) {
      if ($key == $current_lang) {
        $sql = "SELECT rowid";
        $sql .= " FROM ".MAIN_DB_PREFIX."adherent_type_lang";
        $sql .= " WHERE fk_type = ".((int) $this->id);
        $sql .= " AND lang = '".$this->db->escape($key)."'";
 
        $result = $this->db->query($sql);
 
        if ($this->db->num_rows($result)) { // if there is already a description line for this language
          $sql2 = "UPDATE ".MAIN_DB_PREFIX."adherent_type_lang";
          $sql2 .= " SET";
          $sql2 .= " label = '".$this->db->escape($this->label)."',";
          $sql2 .= " description = '".$this->db->escape($this->description)."'";
          $sql2 .= " WHERE fk_type = ".((int) $this->id)." AND lang='".$this->db->escape($key)."'";
        } else {
          $sql2 = "INSERT INTO ".MAIN_DB_PREFIX."adherent_type_lang (fk_type, lang, label, description";
          $sql2 .= ")";
          $sql2 .= " VALUES(".((int) $this->id).",'".$this->db->escape($key)."','".$this->db->escape($this->label)."',";
          $sql2 .= " '".$this->db->escape($this->description)."'";
          $sql2 .= ")";
        }
        dol_syslog(get_class($this).'::setMultiLangs key = current_lang = '.$key);
        if (!$this->db->query($sql2)) {
          $this->error = $this->db->lasterror();
          return -1;
        }
      } elseif (isset($this->multilangs[$key])) {
        $sql = "SELECT rowid";
        $sql .= " FROM ".MAIN_DB_PREFIX."adherent_type_lang";
        $sql .= " WHERE fk_type = ".((int) $this->id);
        $sql .= " AND lang = '".$this->db->escape($key)."'";
 
        $result = $this->db->query($sql);
 
        if ($this->db->num_rows($result)) { // if there is already a description line for this language
          $sql2 = "UPDATE ".MAIN_DB_PREFIX."adherent_type_lang";
          $sql2 .= " SET ";
          $sql2 .= " label = '".$this->db->escape($this->multilangs["$key"]["label"])."',";
          $sql2 .= " description = '".$this->db->escape($this->multilangs["$key"]["description"])."'";
          $sql2 .= " WHERE fk_type = ".((int) $this->id)." AND lang='".$this->db->escape($key)."'";
        } else {
          $sql2 = "INSERT INTO ".MAIN_DB_PREFIX."adherent_type_lang (fk_type, lang, label, description";
          $sql2 .= ")";
          $sql2 .= " VALUES(".$this->id.",'".$this->db->escape($key)."','".$this->db->escape($this->multilangs["$key"]["label"])."',";
          $sql2 .= " '".$this->db->escape($this->multilangs["$key"]["description"])."'";
          $sql2 .= ")";
        }
 
        // We do not save if main fields are empty
        if ($this->multilangs["$key"]["label"] || $this->multilangs["$key"]["description"]) {
          if (!$this->db->query($sql2)) {
            $this->error = $this->db->lasterror();
            return -1;
          }
        }
      } else {
        // language is not current language and we didn't provide a multilang description for this language
      }
    }
 
    // Call trigger
    $result = $this->call_trigger('MEMBER_TYPE_SET_MULTILANGS', $user);
    if ($result < 0) {
      $this->error = $this->db->lasterror();
      return -1;
    }
    // End call triggers
 
    return 1;
  }
 
  public function delMultiLangs($langtodelete, $user)
  {
    $sql = "DELETE FROM ".MAIN_DB_PREFIX."adherent_type_lang";
    $sql .= " WHERE fk_type = ".((int) $this->id)." AND lang = '".$this->db->escape($langtodelete)."'";
 
    dol_syslog(get_class($this).'::delMultiLangs', LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      // Call trigger
      $result = $this->call_trigger('MEMBER_TYPE_DEL_MULTILANGS', $user);
      if ($result < 0) {
        $this->error = $this->db->lasterror();
        dol_syslog(get_class($this).'::delMultiLangs error='.$this->error, LOG_ERR);
        return -1;
      }
      // End call triggers
      return 1;
    } else {
      $this->error = $this->db->lasterror();
      dol_syslog(get_class($this).'::delMultiLangs error='.$this->error, LOG_ERR);
      return -1;
    }
  }
 
  public function create($user, $notrigger = 0)
  {
    global $langs, $conf;
 
    $error = 0;
 
    $this->status = (int) $this->status;
    $this->label = trim($this->label);
 
    $this->db->begin();
 
    $sql = "INSERT INTO ".MAIN_DB_PREFIX."adherent_type (";
    $sql .= " morphy";
    $sql .= ", libelle";
    $sql .= ", entity";
    $sql .= ") VALUES (";
    $sql .= "'".$this->db->escape($this->morphy)."'";
    $sql .= ", '".$this->db->escape($this->label)."'";
    $sql .= ", ".$conf->entity;
    $sql .= ")";
 
    dol_syslog("Adherent_type::create", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."adherent_type");
 
      $result = $this->update($user, 1);
      if ($result < 0) {
        $this->db->rollback();
        return -3;
      }
 
      if (!$notrigger) {
        // Call trigger
        $result = $this->call_trigger('MEMBER_TYPE_CREATE', $user);
        if ($result < 0) {
          $error++;
        }
        // End call triggers
      }
 
      if (!$error) {
        $this->db->commit();
        return $this->id;
      } else {
        dol_syslog(get_class($this)."::create ".$this->error, LOG_ERR);
        $this->db->rollback();
        return -2;
      }
    } else {
      $this->error = $this->db->lasterror();
      $this->db->rollback();
      return -1;
    }
  }
 
  public function update($user, $notrigger = 0)
  {
    global $langs, $conf, $hookmanager;
 
    $error = 0;
 
    $this->label = trim($this->label);
 
    if (empty($this->note_public) && !empty($this->note)) {   // For backward compatibility
      $this->note_public = $this->note;
    }
 
    $this->db->begin();
 
    $sql = "UPDATE ".MAIN_DB_PREFIX."adherent_type ";
    $sql .= "SET ";
    $sql .= "statut = ".((int) $this->status).",";
    $sql .= "libelle = '".$this->db->escape($this->label)."',";
    $sql .= "morphy = '".$this->db->escape($this->morphy)."',";
    $sql .= "subscription = '".$this->db->escape($this->subscription)."',";
    $sql .= "amount = ".((empty($this->amount) && $this->amount == '') ? 'null' : ((float) $this->amount)).",";
    $sql .= "duration = '".$this->db->escape($this->duration_value.$this->duration_unit)."',";
    $sql .= "note = '".$this->db->escape($this->note_public)."',";
    $sql .= "vote = ".(integer) $this->db->escape($this->vote).",";
    $sql .= "mail_valid = '".$this->db->escape($this->mail_valid)."'";
    $sql .= " WHERE rowid =".((int) $this->id);
 
    $result = $this->db->query($sql);
    if ($result) {
      $this->description = $this->db->escape($this->note_public);
 
      // Multilangs
      if (!empty($conf->global->MAIN_MULTILANGS)) {
        if ($this->setMultiLangs($user) < 0) {
          $this->error = $langs->trans("Error")." : ".$this->db->error()." - ".$sql;
          return -2;
        }
      }
 
      $action = 'update';
 
      // Actions on extra fields
      if (!$error) {
        $result = $this->insertExtraFields();
        if ($result < 0) {
          $error++;
        }
      }
 
      if (!$error && !$notrigger) {
        // Call trigger
        $result = $this->call_trigger('MEMBER_TYPE_MODIFY', $user);
        if ($result < 0) {
          $error++;
        }
        // End call triggers
      }
 
      if (!$error) {
        $this->db->commit();
        return 1;
      } else {
        $this->db->rollback();
        dol_syslog(get_class($this)."::update ".$this->error, LOG_ERR);
        return -$error;
      }
    } else {
      $this->error = $this->db->lasterror();
      $this->db->rollback();
      return -1;
    }
  }
 
  public function delete()
  {
    global $user;
 
    $error = 0;
 
    $sql = "DELETE FROM ".MAIN_DB_PREFIX."adherent_type";
    $sql .= " WHERE rowid = ".((int) $this->id);
 
    $resql = $this->db->query($sql);
    if ($resql) {
      // Call trigger
      $result = $this->call_trigger('MEMBER_TYPE_DELETE', $user);
      if ($result < 0) {
        $error++; $this->db->rollback(); return -2;
      }
      // End call triggers
 
      $this->db->commit();
      return 1;
    } else {
      $this->db->rollback();
      $this->error = $this->db->lasterror();
      return -1;
    }
  }
 
  public function fetch($rowid)
  {
    global $langs, $conf;
 
    $sql = "SELECT d.rowid, d.libelle as label, d.morphy, d.statut as status, d.duration, d.subscription, d.amount, d.mail_valid, d.note as note_public, d.vote";
    $sql .= " FROM ".MAIN_DB_PREFIX."adherent_type as d";
    $sql .= " WHERE d.rowid = ".(int) $rowid;
 
    dol_syslog("Adherent_type::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->label          = $obj->label;
        $this->morphy         = $obj->morphy;
        $this->status         = $obj->status;
        $this->duration       = $obj->duration;
        $this->duration_value = substr($obj->duration, 0, dol_strlen($obj->duration) - 1);
        $this->duration_unit  = substr($obj->duration, -1);
        $this->subscription   = $obj->subscription;
        $this->amount         = $obj->amount;
        $this->mail_valid     = $obj->mail_valid;
        $this->note           = $obj->note_public;  // deprecated
        $this->note_public    = $obj->note_public;
        $this->vote           = $obj->vote;
 
        // multilangs
        if (!empty($conf->global->MAIN_MULTILANGS)) {
          $this->getMultiLangs();
        }
 
        // fetch optionals attributes and labels
        $this->fetch_optionals();
      }
 
      return 1;
    } else {
      $this->error = $this->db->lasterror();
      return -1;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function liste_array($status = -1)
  {
    // phpcs:enable
    global $conf, $langs;
 
    $adherenttypes = array();
 
    $sql = "SELECT rowid, libelle as label";
    $sql .= " FROM ".MAIN_DB_PREFIX."adherent_type";
    $sql .= " WHERE entity IN (".getEntity('member_type').")";
    if ($status >= 0) {
      $sql .= " AND statut = ".((int) $status);
    }
 
    $resql = $this->db->query($sql);
    if ($resql) {
      $nump = $this->db->num_rows($resql);
 
      if ($nump) {
        $i = 0;
        while ($i < $nump) {
          $obj = $this->db->fetch_object($resql);
 
          $adherenttypes[$obj->rowid] = $langs->trans($obj->label);
          $i++;
        }
      }
    } else {
      print $this->db->error();
    }
    return $adherenttypes;
  }
 
  public function amountByType($status = null)
  {
    global $conf, $langs;
 
    $amountbytype = array();
 
    $sql = "SELECT rowid, amount";
    $sql .= " FROM ".MAIN_DB_PREFIX."adherent_type";
    $sql .= " WHERE entity IN (".getEntity('member_type').")";
    if ($status !== null) {
      $sql .= " AND statut = ".((int) $status);
    }
 
    $resql = $this->db->query($sql);
    if ($resql) {
      $nump = $this->db->num_rows($resql);
 
      if ($nump) {
        $i = 0;
        while ($i < $nump) {
          $obj = $this->db->fetch_object($resql);
 
          $amountbytype[$obj->rowid] = $obj->amount;
          $i++;
        }
      }
    } else {
      print $this->db->error();
    }
 
    return $amountbytype;
  }
 
  public function listMembersForMemberType($excludefilter = '', $mode = 0)
  {
    global $conf, $user;
 
    $ret = array();
 
    $sql = "SELECT a.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."adherent as a";
    $sql .= " WHERE a.entity IN (".getEntity('member').")";
    $sql .= " AND a.fk_adherent_type = ".((int) $this->id);
    if (!empty($excludefilter)) {
      $sql .= ' AND ('.$excludefilter.')';
    }
 
    dol_syslog(get_class($this)."::listUsersForGroup", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql) {
      while ($obj = $this->db->fetch_object($resql)) {
        if (!array_key_exists($obj->rowid, $ret)) {
          if ($mode < 2) {
            $memberstatic = new Adherent($this->db);
            if ($mode == 1) {
              $memberstatic->fetch($obj->rowid, '', '', '', false, false);
            } else {
              $memberstatic->fetch($obj->rowid);
            }
            $ret[$obj->rowid] = $memberstatic;
          } else {
            $ret[$obj->rowid] = $obj->rowid;
          }
        }
      }
 
      $this->db->free($resql);
 
      $this->members = $ret;
 
      return $ret;
    } else {
      $this->error = $this->db->lasterror();
      return -1;
    }
  }
 
  public function getmorphylib($morphy = '')
  {
    global $langs;
    if ($morphy == 'phy') {
      return $langs->trans("Physical");
    } elseif ($morphy == 'mor') {
      return $langs->trans("Moral");
    } else {
      return $langs->trans("MorAndPhy");
    }
    //return $morphy;
  }
 
  public function getNomUrl($withpicto = 0, $maxlen = 0, $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
  {
    global $langs;
 
    $result = '';
 
    $label = img_picto('', $this->picto).' <u class="paddingrightonly">'.$langs->trans("MemberType").'</u>';
    $label .= ' '.$this->getLibStatut(4);
    $label .= '<br>'.$langs->trans("Label").': '.$this->label;
    if (isset($this->subscription)) {
      $label .= '<br>'.$langs->trans("SubscriptionRequired").': '.yn($this->subscription);
    }
 
    $option = '';
 
    $url = DOL_URL_ROOT.'/adherents/type.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 && 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.'" title="'.dol_escape_htmltag($label, 1).'" class="classfortooltip">';
    $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 .= ($maxlen ?dol_trunc($this->label, $maxlen) : $this->label);
    }
    $result .= $linkend;
 
    return $result;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->status, $mode);
  }
 
  public function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;
    $langs->load('companies');
 
    $statusType = 'status4';
    if ($status == 0) {
      $statusType = 'status5';
    }
 
    if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
      $this->labelStatus[0] = $langs->transnoentitiesnoconv("ActivityCeased");
      $this->labelStatus[1] = $langs->transnoentitiesnoconv("InActivity");
      $this->labelStatusShort[0] = $langs->transnoentitiesnoconv("ActivityCeased");
      $this->labelStatusShort[1] = $langs->transnoentitiesnoconv("InActivity");
    }
 
    return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  public function _load_ldap_dn($info, $mode = 0)
  {
    // phpcs:enable
    global $conf;
    $dn = '';
    if ($mode == 0) {
      $dn = $conf->global->LDAP_KEY_MEMBERS_TYPES."=".$info[$conf->global->LDAP_KEY_MEMBERS_TYPES].",".$conf->global->LDAP_MEMBER_TYPE_DN;
    }
    if ($mode == 1) {
      $dn = $conf->global->LDAP_MEMBER_TYPE_DN;
    }
    if ($mode == 2) {
      $dn = $conf->global->LDAP_KEY_MEMBERS_TYPES."=".$info[$conf->global->LDAP_KEY_MEMBERS_TYPES];
    }
    return $dn;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  public function _load_ldap_info()
  {
    // phpcs:enable
    global $conf, $langs;
 
    $info = array();
 
    // Object classes
    $info["objectclass"] = explode(',', $conf->global->LDAP_MEMBER_TYPE_OBJECT_CLASS);
 
    if (empty($this->note_public) && !empty($this->note)) {   // For backward compatibility
      $this->note_public = $this->note;
    }
 
    // Champs
    if ($this->label && !empty($conf->global->LDAP_MEMBER_TYPE_FIELD_FULLNAME)) {
      $info[$conf->global->LDAP_MEMBER_TYPE_FIELD_FULLNAME] = $this->label;
    }
    if ($this->note_public && !empty($conf->global->LDAP_MEMBER_TYPE_FIELD_DESCRIPTION)) {
      $info[$conf->global->LDAP_MEMBER_TYPE_FIELD_DESCRIPTION] = dol_string_nohtmltag($this->note_public, 0, 'UTF-8', 1);
    }
    if (!empty($conf->global->LDAP_MEMBER_TYPE_FIELD_GROUPMEMBERS)) {
      $valueofldapfield = array();
      foreach ($this->members as $key => $val) {    // This is array of users for group into dolibarr database.
        $member = new Adherent($this->db);
        $member->fetch($val->id, '', '', '', false, false);
        $info2 = $member->_load_ldap_info();
        $valueofldapfield[] = $member->_load_ldap_dn($info2);
      }
      $info[$conf->global->LDAP_MEMBER_TYPE_FIELD_GROUPMEMBERS] = (!empty($valueofldapfield) ? $valueofldapfield : '');
    }
    return $info;
  }
 
  public function initAsSpecimen()
  {
    global $user;
 
    // Initialise parametres
    $this->id = 0;
    $this->ref = 'MTSPEC';
    $this->specimen = 1;
 
    $this->label = 'MEMBERS TYPE SPECIMEN';
    $this->note_public = 'This is a public note';
    $this->mail_valid = 'This is welcome email';
    $this->subscription = 1;
    $this->vote = 0;
 
    $this->status = 1;
 
    // Members of this member type is just me
    $this->members = array(
      $user->id => $user
    );
  }
 
  public function getMailOnValid()
  {
    if (!empty($this->mail_valid) && trim(dol_htmlentitiesbr_decode($this->mail_valid))) {
      return $this->mail_valid;
    }
 
    return '';
  }
 
  public function getMailOnSubscription()
  {
    // mail_subscription not  defined so never used
    if (!empty($this->mail_subscription) && trim(dol_htmlentitiesbr_decode($this->mail_subscription))) {  // Property not yet defined
      return $this->mail_subscription;
    }
 
    return '';
  }
 
  public function getMailOnResiliate()
  {
    // NOTE mail_resiliate not defined so never used
    if (!empty($this->mail_resiliate) && trim(dol_htmlentitiesbr_decode($this->mail_resiliate))) {  // Property not yet defined
      return $this->mail_resiliate;
    }
 
    return '';
  }
 
  public function getMailOnExclude()
  {
    // NOTE mail_exclude not defined so never used
    if (!empty($this->mail_exclude) && trim(dol_htmlentitiesbr_decode($this->mail_exclude))) {  // Property not yet defined
      return $this->mail_exclude;
    }
 
    return '';
  }
}