bankcateg.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2008 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2009 Regis Houssin        <regis.houssin@inodbox.com>
 * Copyright (C) 2016 Marcos García        <marcosgdf@gmail.com>
 * Copyright (C) 2024       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/>.
 */
 
class BankCateg // extends CommonObject
{
  //public $element='category_bank';      //!< Id that identify managed objects
  //public $table_element='category_bank';  //!< Name of table without prefix where object is stored
  public $picto = 'generic';
 
  public $id;
 
  public $label;
 
  protected $db;
 
  public $error;
 
  public $errors;
 
  public $context;
 
 
  public function __construct(DoliDB $db)
  {
    $this->db = $db;
  }
 
 
  public function create(User $user, $notrigger = 0)
  {
    global $conf;
 
    include_once DOL_DOCUMENT_ROOT . '/categories/class/categorie.class.php';
    $cats = new Categorie($this->db);
    $catTypeID = $cats->getMapId()[Categorie::TYPE_BANK_LINE];
 
    $error = 0;
 
    // Clean parameters
    if (isset($this->label)) {
      $this->label = trim($this->label);
    }
 
    // Insert request
    $sql = "INSERT INTO ".MAIN_DB_PREFIX."categorie (";
    $sql .= "label";
    $sql .= ", entity";
    $sql .= ", type";
    $sql .= ") VALUES (";
    $sql .= " ".(!isset($this->label) ? 'NULL' : "'".$this->db->escape($this->label)."'");
    $sql .= ", ".((int) $conf->entity);
    $sql .= ", ".((int) $catTypeID);
    $sql .= ")";
 
    $this->db->begin();
 
    dol_syslog(get_class($this)."::create", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $error++;
      $this->errors[] = "Error ".$this->db->lasterror();
    }
 
    if (!$error) {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."categorie");
    }
 
    // Commit or rollback
    if ($error) {
      foreach ($this->errors as $errmsg) {
        dol_syslog(get_class($this)."::create ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return $this->id;
    }
  }
 
 
  public function fetch($id)
  {
    global $conf;
 
    include_once DOL_DOCUMENT_ROOT . '/categories/class/categorie.class.php';
    $cats = new Categorie($this->db);
    $catTypeID = $cats->getMapId()[Categorie::TYPE_BANK_LINE];
 
    $sql = "SELECT";
    $sql .= " t.rowid,";
    $sql .= " t.label";
    $sql .= " FROM ".MAIN_DB_PREFIX."categorie as t";
    $sql .= " WHERE t.rowid = ".((int) $id);
    $sql .= " AND t.entity = ".$conf->entity." AND t.type = " . ((int) $catTypeID);
 
    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->label = $obj->label;
      }
      $this->db->free($resql);
 
      return 1;
    } else {
      $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
  }
 
  public function update($user = null, $notrigger = 0)
  {
    global $conf;
    $error = 0;
 
    // Clean parameters
    if (isset($this->label)) {
      $this->label = trim($this->label);
    }
 
    // Check parameters
    // Put here code to add control on parameters values
 
    // Update request
    $sql = "UPDATE ".MAIN_DB_PREFIX."categorie SET";
    $sql .= " label=".(isset($this->label) ? "'".$this->db->escape($this->label)."'" : "null");
    $sql .= " WHERE rowid=".((int) $this->id);
    $sql .= " AND entity = ".$conf->entity;
 
    $this->db->begin();
 
    dol_syslog(get_class($this)."::update", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $error++;
      $this->errors[] = "Error ".$this->db->lasterror();
    }
 
    // Commit or rollback
    if ($error) {
      foreach ($this->errors as $errmsg) {
        dol_syslog(get_class($this)."::update ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return 1;
    }
  }
 
  public function delete(User $user, $notrigger = 0)
  {
    global $conf;
    $error = 0;
 
    $this->db->begin();
 
    // Delete link between tag and bank account
    if (!$error) {
      $sql = "DELETE FROM ".MAIN_DB_PREFIX."categorie_account";
      $sql .= " WHERE fk_categorie = ".((int) $this->id);
 
      $resql = $this->db->query($sql);
      if (!$resql) {
        $error++;
        $this->errors[] = "Error ".$this->db->lasterror();
      }
    }
 
    // Delete link between tag and bank lines
    if (!$error) {
      $sql = "DELETE FROM ".MAIN_DB_PREFIX."category_bankline";
      $sql .= " WHERE fk_categ = ".((int) $this->id);
 
      $resql = $this->db->query($sql);
      if (!$resql) {
        $error++;
        $this->errors[] = "Error ".$this->db->lasterror();
      }
    }
 
    // Delete bank categ
    if (!$error) {
      $sql = "DELETE FROM ".MAIN_DB_PREFIX."categorie";
      $sql .= " WHERE rowid=".((int) $this->id);
 
      $resql = $this->db->query($sql);
      if (!$resql) {
        $error++;
        $this->errors[] = "Error ".$this->db->lasterror();
      }
    }
 
    // Commit or rollback
    if ($error) {
      foreach ($this->errors as $errmsg) {
        dol_syslog(get_class($this)."::delete ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return 1;
    }
  }
 
  public function createFromClone(User $user, $fromid)
  {
    $error = 0;
 
    $object = new BankCateg($this->db);
 
    $this->db->begin();
 
    // Load source object
    $object->fetch($fromid);
    $object->id = 0;
    // $object->statut = 0;
 
    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->create($user);
 
    // Other options
    if ($result < 0) {
      $this->error = $object->error;
      $error++;
    }
 
    unset($object->context['createfromclone']);
 
    // End
    if (!$error) {
      $this->db->commit();
      return $object->id;
    } else {
      $this->db->rollback();
      return -1;
    }
  }
 
  public function fetchAll()
  {
    global $conf;
 
    include_once DOL_DOCUMENT_ROOT . '/categories/class/categorie.class.php';
    $cats = new Categorie($this->db);
    $catTypeID = $cats->getMapId()[Categorie::TYPE_BANK_LINE];
 
    $return = array();
 
    $sql = "SELECT rowid, label FROM ".MAIN_DB_PREFIX."categorie WHERE entity = ".$conf->entity." AND type = ".((int) $catTypeID)." ORDER BY label";
    $resql = $this->db->query($sql);
 
    if ($resql) {
      while ($obj = $this->db->fetch_object($resql)) {
        $tmp = new BankCateg($this->db);
        $tmp->id = $obj->rowid;
        $tmp->label = $obj->label;
 
        $return[] = $tmp;
      }
    }
 
    return $return;
  }
 
  public function initAsSpecimen()
  {
    $this->id = 0;
    $this->label = '';
 
    return 1;
  }
}