* Copyright (C) 2024 Frédéric France * * 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 . */ /** * \file compta/facture/class/paymentterm.class.php * \ingroup invoice * \brief This file is an example for a CRUD class file (Create/Read/Update/Delete) */ /** * Class to manage payment terms records in dictionary */ class PaymentTerm // extends CommonObject { /** * @var DoliDB Database handler. */ public $db; /** * @var string Error code (or message) */ public $error = ''; /** * @var string[] Error codes (or messages) */ public $errors = array(); //public $element='c_payment_term'; //!< Id that identify managed objects //public $table_element='c_payment_term'; //!< Name of table without prefix where object is stored public $context = array(); /** * @var int ID */ public $id; /** * @var int Entity ID */ public $entity; public $code; public $sortorder; public $active; public $libelle; public $libelle_facture; public $type_cdr; public $nbjour; public $decalage; /** * Constructor * * @param DoliDB $db Database handler */ public function __construct(DoliDB $db) { $this->db = $db; } /** * Create in database * * @param User $user User that create * @param int $notrigger 0=launch triggers after, 1=disable triggers * @return int Return integer <0 if KO, Id of created object if OK */ public function create($user, $notrigger = 0) { global $conf, $langs; $error = 0; // Clean parameters if (isset($this->code)) { $this->code = trim($this->code); } if (isset($this->sortorder)) { $this->sortorder = trim($this->sortorder); } if (isset($this->active)) { $this->active = trim($this->active); } if (isset($this->libelle)) { $this->libelle = trim($this->libelle); } if (isset($this->libelle_facture)) { $this->libelle_facture = trim($this->libelle_facture); } if (isset($this->type_cdr)) { $this->type_cdr = trim($this->type_cdr); } if (isset($this->nbjour)) { $this->nbjour = trim($this->nbjour); } if (isset($this->decalage)) { $this->decalage = trim($this->decalage); } // Check parameters // Put here code to add control on parameters values // Insert request $sql = "INSERT INTO ".MAIN_DB_PREFIX."c_payment_term("; $sql .= "entity,"; $sql .= "code,"; $sql .= "sortorder,"; $sql .= "active,"; $sql .= "libelle,"; $sql .= "libelle_facture,"; $sql .= "type_cdr,"; $sql .= "nbjour,"; $sql .= "decalage"; $sql .= ") VALUES ("; $sql .= " ".(!isset($this->entity) ? getEntity('c_payment_term') : "'".$this->db->escape($this->entity)."'").","; $sql .= " ".(!isset($this->code) ? 'NULL' : "'".$this->db->escape($this->code)."'").","; $sql .= " ".(!isset($this->sortorder) ? 'NULL' : "'".$this->db->escape($this->sortorder)."'").","; $sql .= " ".(!isset($this->active) ? 'NULL' : "'".$this->db->escape($this->active)."'").","; $sql .= " ".(!isset($this->libelle) ? 'NULL' : "'".$this->db->escape($this->libelle)."'").","; $sql .= " ".(!isset($this->libelle_facture) ? 'NULL' : "'".$this->db->escape($this->libelle_facture)."'").","; $sql .= " ".(!isset($this->type_cdr) ? 'NULL' : "'".$this->db->escape($this->type_cdr)."'").","; $sql .= " ".(!isset($this->nbjour) ? 'NULL' : "'".$this->db->escape($this->nbjour)."'").","; $sql .= " ".(!isset($this->decalage) ? 'NULL' : "'".$this->db->escape($this->decalage)."'"); $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."c_payment_term"); } // 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; } } /** * Load object in memory from database * * @param int $id Id object * @param string $code Code object * @return int Return integer <0 if KO, >0 if OK */ public function fetch($id, $code = '') { $sql = "SELECT"; $sql .= " t.rowid,"; $sql .= " t.entity,"; $sql .= " t.code,"; $sql .= " t.sortorder,"; $sql .= " t.active,"; $sql .= " t.libelle,"; $sql .= " t.libelle_facture,"; $sql .= " t.type_cdr,"; $sql .= " t.nbjour,"; $sql .= " t.decalage"; $sql .= " FROM ".MAIN_DB_PREFIX."c_payment_term as t"; if ($id) { $sql .= " WHERE t.rowid = ".((int) $id); } if ($code) { $sql .= " WHERE t.code='".$this->db->escape($code)."' AND t.entity IN (".getEntity('payment_term').")"; } 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->code = $obj->code; $this->sortorder = $obj->sortorder; $this->active = $obj->active; $this->libelle = $obj->libelle; $this->libelle_facture = $obj->libelle_facture; $this->type_cdr = $obj->type_cdr; $this->nbjour = $obj->nbjour; $this->decalage = $obj->decalage; } $this->db->free($resql); return 1; } else { $this->error = "Error ".$this->db->lasterror(); return -1; } } /** * Return id of default payment term * * @return int Return integer <0 if KO, >0 if OK */ public function getDefaultId() { global $langs; $ret = 0; $sql = "SELECT"; $sql .= " t.rowid"; $sql .= " FROM ".MAIN_DB_PREFIX."c_payment_term as t"; $sql .= " WHERE t.code = 'RECEP'"; $sql .= " AND t.entity IN (".getEntity('c_payment_term').")"; dol_syslog(get_class($this)."::getDefaultId", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { if ($this->db->num_rows($resql)) { $obj = $this->db->fetch_object($resql); if ($obj) { $ret = $obj->rowid; } } $this->db->free($resql); return $ret; } else { $this->error = "Error ".$this->db->lasterror(); return -1; } } /** * Update database * * @param User $user User that modify * @param int $notrigger 0=launch triggers after, 1=disable triggers * @return int Return integer <0 if KO, >0 if OK */ public function update($user = null, $notrigger = 0) { global $conf, $langs; $error = 0; // Clean parameters if (isset($this->code)) { $this->code = trim($this->code); } if (isset($this->sortorder)) { $this->sortorder = trim($this->sortorder); } if (isset($this->active)) { $this->active = trim($this->active); } if (isset($this->libelle)) { $this->libelle = trim($this->libelle); } if (isset($this->libelle_facture)) { $this->libelle_facture = trim($this->libelle_facture); } if (isset($this->type_cdr)) { $this->type_cdr = trim($this->type_cdr); } if (isset($this->nbjour)) { $this->nbjour = trim($this->nbjour); } if (isset($this->decalage)) { $this->decalage = trim($this->decalage); } // Check parameters // Put here code to add control on parameters values // Update request $sql = "UPDATE ".MAIN_DB_PREFIX."c_payment_term SET"; $sql .= " code=".(isset($this->code) ? "'".$this->db->escape($this->code)."'" : "null").","; $sql .= " sortorder=".(isset($this->sortorder) ? $this->sortorder : "null").","; $sql .= " active=".(isset($this->active) ? $this->active : "null").","; $sql .= " libelle=".(isset($this->libelle) ? "'".$this->db->escape($this->libelle)."'" : "null").","; $sql .= " libelle_facture=".(isset($this->libelle_facture) ? "'".$this->db->escape($this->libelle_facture)."'" : "null").","; $sql .= " type_cdr=".(isset($this->type_cdr) ? $this->type_cdr : "null").","; $sql .= " nbjour=".(isset($this->nbjour) ? $this->nbjour : "null").","; $sql .= " decalage=".(isset($this->decalage) ? $this->decalage : "null"); $sql .= " WHERE rowid = ".((int) $this->id); $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; } } /** * Delete object in database * * @param User $user User that delete * @param int $notrigger 0=launch triggers after, 1=disable triggers * @return int Return integer <0 if KO, >0 if OK */ public function delete($user, $notrigger = 0) { global $conf, $langs; $error = 0; $sql = "DELETE FROM ".MAIN_DB_PREFIX."c_payment_term"; $sql .= " WHERE rowid = ".((int) $this->id); $this->db->begin(); dol_syslog(get_class($this)."::delete", 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)."::delete ".$errmsg, LOG_ERR); $this->error .= ($this->error ? ', '.$errmsg : $errmsg); } $this->db->rollback(); return -1 * $error; } else { $this->db->commit(); return 1; } } /** * Load an object from its id and create a new one in database * * @param User $user User making the clone * @param int $fromid Id of object to clone * @return int New id of clone */ public function createFromClone(User $user, $fromid) { $error = 0; $object = new PaymentTerm($this->db); $this->db->begin(); // Load source object $object->fetch($fromid); $object->id = 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; } } /** * Initialise an instance with random values. * Used to build previews or test instances. * id must be 0 if object instance is a specimen. * * @return int */ public function initAsSpecimen() { $this->id = 0; $this->code = ''; $this->sortorder = ''; $this->active = ''; $this->libelle = ''; $this->libelle_facture = ''; $this->type_cdr = ''; $this->nbjour = ''; $this->decalage = ''; return 1; } }