Mini Shell
<?php
/* Copyright (C) 2004 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2010-2013 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2012 Regis Houssin <regis.houssin@inodbox.com>
* Copyright (C) 2013 Peter Fontaine <contact@peterfontaine.fr>
* Copyright (C) 2016 Marcos García <marcosgdf@gmail.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/>.
*/
/**
* \file htdocs/societe/class/companybankaccount.class.php
* \ingroup societe
* \brief File of class to manage bank accounts description of third parties
*/
require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php';
/**
* Class to manage bank accounts description of third parties
*/
class CompanyBankAccount extends Account
{
public $socid;
/**
* @var string ID to identify managed object
*/
public $element = 'societe_rib';
/**
* @var string Name of table without prefix where object is stored
*/
public $table_element = 'societe_rib';
/** @var bool $default_rib 1 = this object is the third party's default bank information */
public $default_rib;
/**
* Value 'FRST' or 'RCUR' (For SEPA mandate). Warning, in database, we store 'RECUR'.
*
* @var string
*/
public $frstrecur;
public $rum;
public $date_rum;
public $stripe_card_ref; // ID of BAN into an external payment system
public $stripe_account; // Account of the external payment system
/**
* Date creation record (datec)
*
* @var integer
*/
public $datec;
/**
* Date modification record (tms)
*
* @var integer
*/
public $datem;
/**
* @var string TRIGGER_PREFIX Dolibarr 16.0 and above use the prefix to prevent the creation of inconsistently
* named triggers
* @see CommonObject::call_trigger()
*/
const TRIGGER_PREFIX = 'COMPANY_RIB';
/**
* Constructor
*
* @param DoliDB $db Database handler
*/
public function __construct(DoliDB $db)
{
$this->db = $db;
$this->socid = 0;
$this->solde = 0;
$this->error_number = 0;
$this->default_rib = 0;
}
/**
* Create bank information record.
*
* @param User $user User
* @param int $notrigger 1=Disable triggers
* @return int <0 if KO, > 0 if OK (ID of newly created company bank account information)
*/
public function create(User $user = null, $notrigger = 0)
{
$now = dol_now();
$error = 0;
// Check paramaters
if (empty($this->socid)) {
$this->error = 'BadValueForParameter';
$this->errors[] = $this->error;
return -1;
}
// Correct ->default_rib to not set the new account as default, if there is already 1. We want to be sure to have always 1 default for type = 'ban'.
// If we really want the new bank account to be the default, we must set it by calling setDefault() after creation.
$sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."societe_rib where fk_soc = ".((int) $this->socid)." AND default_rib = 1 AND type = 'ban'";
$result = $this->db->query($sql);
if ($result) {
$numrows = $this->db->num_rows($result);
if ($this->default_rib && $numrows > 0) {
$this->default_rib = 0;
}
if (empty($this->default_rib) && $numrows == 0) {
$this->default_rib = 1;
}
}
$this->db->begin();
$sql = "INSERT INTO ".MAIN_DB_PREFIX."societe_rib (fk_soc, type, datec)";
$sql .= " VALUES (".((int) $this->socid).", 'ban', '".$this->db->idate($now)."')";
$resql = $this->db->query($sql);
if ($resql) {
if ($this->db->affected_rows($resql)) {
$this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."societe_rib");
if (!$notrigger) {
// Call trigger
$result = $this->call_trigger('COMPANY_RIB_CREATE', $user);
if ($result < 0) {
$error++;
}
// End call triggers
}
}
} else {
$error++;
$this->error = $this->db->lasterror();
$this->errors[] = $this->error;
}
if (!$error) {
$this->db->commit();
return $this->id;
} else {
$this->db->rollback();
return -1;
}
}
/**
* Update bank account
*
* @param User $user Object user
* @param int $notrigger 1=Disable triggers
* @return int <=0 if KO, >0 if OK
*/
public function update(User $user = null, $notrigger = 0)
{
global $conf, $langs;
$error = 0;
if (!$this->id) {
return -1;
}
if (dol_strlen($this->domiciliation) > 255) {
$this->domiciliation = dol_trunc($this->domiciliation, 254, 'right', 'UTF-8', 1);
}
if (dol_strlen($this->owner_address) > 255) {
$this->owner_address = dol_trunc($this->owner_address, 254, 'right', 'UTF-8', 1);
}
$this->db->begin();
$sql = "UPDATE ".MAIN_DB_PREFIX."societe_rib SET";
$sql .= " bank = '".$this->db->escape($this->bank)."'";
$sql .= ",code_banque='".$this->db->escape($this->code_banque)."'";
$sql .= ",code_guichet='".$this->db->escape($this->code_guichet)."'";
$sql .= ",number='".$this->db->escape($this->number)."'";
$sql .= ",cle_rib='".$this->db->escape($this->cle_rib)."'";
$sql .= ",bic='".$this->db->escape($this->bic)."'";
$sql .= ",iban_prefix = '".$this->db->escape($this->iban)."'";
$sql .= ",domiciliation = '".$this->db->escape($this->domiciliation)."'";
$sql .= ",proprio = '".$this->db->escape($this->proprio)."'";
$sql .= ",owner_address = '".$this->db->escape($this->owner_address)."'";
$sql .= ",default_rib = ".((int) $this->default_rib);
if (!empty($conf->prelevement->enabled)) {
$sql .= ",frstrecur = '".$this->db->escape($this->frstrecur)."'";
$sql .= ",rum = '".$this->db->escape($this->rum)."'";
$sql .= ",date_rum = ".($this->date_rum ? "'".$this->db->idate($this->date_rum)."'" : "null");
}
if (trim($this->label) != '') {
$sql .= ",label = '".$this->db->escape($this->label)."'";
} else {
$sql .= ",label = NULL";
}
$sql .= ",stripe_card_ref = '".$this->db->escape($this->stripe_card_ref)."'";
$sql .= ",stripe_account = '".$this->db->escape($this->stripe_account)."'";
$sql .= " WHERE rowid = ".((int) $this->id);
$result = $this->db->query($sql);
if ($result) {
if (!$notrigger) {
// Call trigger
$result = $this->call_trigger('COMPANY_RIB_MODIFY', $user);
if ($result < 0) {
$error++;
}
// End call triggers
}
} else {
$error++;
if ($this->db->errno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
$this->error = $langs->trans('ErrorDuplicateField');
} else {
$this->error = $this->db->lasterror();
}
$this->errors[] = $this->error;
}
if (!$error) {
$this->db->commit();
return 1;
} else {
$this->db->rollback();
return -1;
}
}
/**
* Load record from database
*
* @param int $id Id of record
* @param int $socid Id of company. If this is filled, function will return the first entry found (matching $default and $type)
* @param int $default If id of company filled, we say if we want first record among all (-1), default record (1) or non default record (0)
* @param int $type If id of company filled, we say if we want record of this type only
* @return int <0 if KO, >0 if OK
*/
public function fetch($id, $socid = 0, $default = 1, $type = 'ban')
{
if (empty($id) && empty($socid)) {
return -1;
}
$sql = "SELECT rowid, type, fk_soc, bank, number, code_banque, code_guichet, cle_rib, bic, iban_prefix as iban, domiciliation, proprio,";
$sql .= " owner_address, default_rib, label, datec, tms as datem, rum, frstrecur, date_rum,";
$sql .= " stripe_card_ref, stripe_account";
$sql .= " FROM ".MAIN_DB_PREFIX."societe_rib";
if ($id) {
$sql .= " WHERE rowid = ".((int) $id);
} elseif ($socid > 0) {
$sql .= " WHERE fk_soc = ".((int) $socid);
if ($default > -1) {
$sql .= " AND default_rib = ".((int) $default);
}
if ($type) {
$sql .= " AND type = '".$this->db->escape($type)."'";
}
}
$resql = $this->db->query($sql);
if ($resql) {
if ($this->db->num_rows($resql)) {
$obj = $this->db->fetch_object($resql);
$this->ref = $obj->fk_soc.'-'.$obj->label; // Generate an artificial ref
$this->id = $obj->rowid;
$this->type = $obj->type;
$this->socid = $obj->fk_soc;
$this->bank = $obj->bank;
$this->code_banque = $obj->code_banque;
$this->code_guichet = $obj->code_guichet;
$this->number = $obj->number;
$this->cle_rib = $obj->cle_rib;
$this->bic = $obj->bic;
$this->iban = $obj->iban;
$this->domiciliation = $obj->domiciliation;
$this->proprio = $obj->proprio;
$this->owner_address = $obj->owner_address;
$this->label = $obj->label;
$this->default_rib = $obj->default_rib;
$this->datec = $this->db->jdate($obj->datec);
$this->datem = $this->db->jdate($obj->datem);
$this->rum = $obj->rum;
$this->frstrecur = $obj->frstrecur;
$this->date_rum = $this->db->jdate($obj->date_rum);
$this->stripe_card_ref = $obj->stripe_card_ref;
$this->stripe_account = $obj->stripe_account;
}
$this->db->free($resql);
return 1;
} else {
dol_print_error($this->db);
return -1;
}
}
/**
* Delete a rib from database
*
* @param User $user User deleting
* @param int $notrigger 1=Disable triggers
* @return int <0 if KO, >0 if OK
*/
public function delete(User $user = null, $notrigger = 0)
{
$error = 0;
dol_syslog(get_class($this)."::delete ".$this->id, LOG_DEBUG);
$this->db->begin();
if (!$error && !$notrigger) {
// Call trigger
$result = $this->call_trigger('COMPANY_RIB_DELETE', $user);
if ($result < 0) {
$error++;
}
// End call triggers
}
if (!$error) {
$sql = "DELETE FROM ".MAIN_DB_PREFIX."societe_rib";
$sql .= " WHERE rowid = ".((int) $this->id);
if (!$this->db->query($sql)) {
$error++;
$this->errors[] = $this->db->lasterror();
}
}
if (!$error) {
$this->db->commit();
return 1;
} else {
$this->db->rollback();
return -1 * $error;
}
}
/**
* Return RIB
*
* @param boolean $displayriblabel Prepend or Hide Label
* @return string RIB
*/
public function getRibLabel($displayriblabel = true)
{
$rib = '';
if ($this->code_banque || $this->code_guichet || $this->number || $this->cle_rib || $this->iban || $this->bic) {
if ($this->label && $displayriblabel) {
$rib = $this->label." : ";
}
$rib .= $this->iban;
}
return $rib;
}
/**
* Set a BAN as Default
*
* @param int $rib RIB id
* @param string $resetolddefaultfor Reset if we have already a default value for type = 'ban'
* @return int 0 if KO, 1 if OK
*/
public function setAsDefault($rib = 0, $resetolddefaultfor = 'ban')
{
$sql1 = "SELECT rowid as id, fk_soc FROM ".MAIN_DB_PREFIX."societe_rib";
$sql1 .= " WHERE rowid = ".($rib ? $rib : $this->id);
dol_syslog(get_class($this).'::setAsDefault', LOG_DEBUG);
$result1 = $this->db->query($sql1);
if ($result1) {
if ($this->db->num_rows($result1) == 0) {
return 0;
} else {
$obj = $this->db->fetch_object($result1);
$this->db->begin();
$sql2 = "UPDATE ".MAIN_DB_PREFIX."societe_rib SET default_rib = 0";
$sql2 .= " WHERE fk_soc = ".((int) $obj->fk_soc);
if ($resetolddefaultfor) {
$sql2 .= " AND type = '".$this->db->escape($resetolddefaultfor)."'";
}
$result2 = $this->db->query($sql2);
$sql3 = "UPDATE ".MAIN_DB_PREFIX."societe_rib SET default_rib = 1";
$sql3 .= " WHERE rowid = ".((int) $obj->id);
$result3 = $this->db->query($sql3);
if (!$result2 || !$result3) {
dol_print_error($this->db);
$this->db->rollback();
return -1;
} else {
$this->db->commit();
return 1;
}
}
} else {
dol_print_error($this->db);
return -1;
}
}
/**
* Initialise an instance with random values.
* Used to build previews or test instances.
* id must be 0 if object instance is a specimen.
*
* @return void
*/
public function initAsSpecimen()
{
$this->specimen = 1;
$this->ref = 'CBA';
$this->label = 'CustomerCorp Bank account';
$this->bank = 'CustomerCorp Bank';
$this->courant = Account::TYPE_CURRENT;
$this->clos = Account::STATUS_OPEN;
$this->code_banque = '123';
$this->code_guichet = '456';
$this->number = 'CUST12345';
$this->cle_rib = 50;
$this->bic = 'CC12';
$this->iban = 'FR999999999';
$this->domiciliation = 'Bank address of customer corp';
$this->proprio = 'Owner';
$this->owner_address = 'Owner address';
$this->country_id = 1;
$this->rum = 'UMR-CU1212-0007-5-1475405262';
$this->date_rum = dol_now() - 10000;
$this->frstrecur = 'FRST';
$this->socid = 1;
}
}
Zerion Mini Shell 1.0