deplacement.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2003   Rodolphe Quiedeville  <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2011  Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2009-2012  Regis Houssin     <regis.houssin@inodbox.com>
 * Copyright (C) 2013       Florian Henry       <florian.henry@open-concept.pro>
 * Copyright (C) 2019-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/>.
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
 
class Deplacement extends CommonObject
{
  public $element = 'deplacement';
 
  public $table_element = 'deplacement';
 
  public $table_element_line = '';
 
  public $fk_element = '';
 
  public $fk_soc;
  public $date;
  public $type;
 
  public $datec;
 
  public $dated;
 
  public $fk_user_author;
 
  public $fk_user;
 
  public $km;
 
  public $socid;
 
  public $statut;
  public $extraparams = array();
 
 
  const STATUS_DRAFT = 0;
 
  const STATUS_VALIDATED = 1;
 
  const STATUS_REFUNDED = 2;
 
  public function __construct(DoliDB $db)
  {
    $this->db = $db;
 
    $this->ismultientitymanaged = 0;
  }
 
  public function create($user)
  {
    global $conf;
 
    // Check parameters
    if (empty($this->type) || $this->type < 0) {
      $this->error = 'ErrorBadParameter';
      return -1;
    }
    if (empty($this->fk_user) || $this->fk_user < 0) {
      $this->error = 'ErrorBadParameter';
      return -1;
    }
 
    $now = dol_now();
 
    $this->db->begin();
 
    $sql = "INSERT INTO ".MAIN_DB_PREFIX."deplacement (";
    $sql .= "datec";
    //$sql.= ", dated";
    $sql .= ", entity";
    $sql .= ", fk_user_author";
    $sql .= ", fk_user";
    $sql .= ", type";
    $sql .= ", note_private";
    $sql .= ", note_public";
    $sql .= ", fk_projet";
    $sql .= ", fk_soc";
    $sql .= ") VALUES (";
    $sql .= " '".$this->db->idate($now)."'";
    $sql .= ", ".((int) $conf->entity);
    $sql .= ", ".((int) $user->id);
    $sql .= ", ".((int) $this->fk_user);
    $sql .= ", '".$this->db->escape($this->type)."'";
    $sql .= ", ".($this->note_private ? "'".$this->db->escape($this->note_private)."'" : "null");
    $sql .= ", ".($this->note_public ? "'".$this->db->escape($this->note_public)."'" : "null");
    $sql .= ", ".($this->fk_project > 0 ? ((int) $this->fk_project) : 0);
    $sql .= ", ".($this->fk_soc > 0 ? ((int) $this->fk_soc) : "null");
    $sql .= ")";
 
    dol_syslog(get_class($this)."::create", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."deplacement");
 
      // Call trigger
      $result = $this->call_trigger('DEPLACEMENT_CREATE', $user);
      if ($result < 0) {
        $this->db->rollback();
        return -2;
      }
      // End call triggers
 
      $result = $this->update($user);
      if ($result > 0) {
        $this->db->commit();
        return $this->id;
      } else {
        $this->error = $this->db->error();
        $this->db->rollback();
        return $result;
      }
    } else {
      $this->error = $this->db->error()." sql=".$sql;
      $this->db->rollback();
      return -1;
    }
  }
 
  public function update($user)
  {
    // Clean parameters
    $this->km = (float) price2num($this->km);
 
    // Check parameters
    if (!is_numeric($this->km)) {
      $this->km = 0;
    }
    if (empty($this->date)) {
      $this->error = 'ErrorBadParameter';
      return -1;
    }
    if (empty($this->type) || $this->type < 0) {
      $this->error = 'ErrorBadParameter';
      return -1;
    }
    if (empty($this->fk_user) || $this->fk_user < 0) {
      $this->error = 'ErrorBadParameter';
      return -1;
    }
 
    $this->db->begin();
 
    $sql = "UPDATE ".MAIN_DB_PREFIX."deplacement ";
    $sql .= " SET km = ".((float) $this->km); // This is a distance or amount
    $sql .= " , dated = '".$this->db->idate($this->date)."'";
    $sql .= " , type = '".$this->db->escape($this->type)."'";
    $sql .= " , fk_statut = '".$this->db->escape($this->statut)."'";
    $sql .= " , fk_user = ".((int) $this->fk_user);
    $sql .= " , fk_user_modif = ".((int) $user->id);
    $sql .= " , fk_soc = ".($this->socid > 0 ? $this->socid : 'null');
    $sql .= " , note_private = ".($this->note_private ? "'".$this->db->escape($this->note_private)."'" : "null");
    $sql .= " , note_public = ".($this->note_public ? "'".$this->db->escape($this->note_public)."'" : "null");
    $sql .= " , fk_projet = ".($this->fk_project > 0 ? $this->fk_project : 0);
    $sql .= " WHERE rowid = ".((int) $this->id);
 
    dol_syslog(get_class($this)."::update", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      $this->db->commit();
      return 1;
    } else {
      $this->error = $this->db->lasterror();
      $this->db->rollback();
      return -1;
    }
  }
 
  public function fetch($id, $ref = '')
  {
    $sql = "SELECT rowid, fk_user, type, fk_statut, km, fk_soc, dated, note_private, note_public, fk_projet as fk_project, extraparams";
    $sql .= " FROM ".MAIN_DB_PREFIX."deplacement";
    $sql .= " WHERE entity IN (".getEntity('deplacement').")";
    if ($ref) {
      $sql .= " AND ref ='".$this->db->escape($ref)."'";
    } else {
      $sql .= " AND rowid = ".((int) $id);
    }
 
    dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      $obj = $this->db->fetch_object($result);
 
      $this->id = $obj->rowid;
      $this->ref = $obj->rowid;
      $this->date     = $this->db->jdate($obj->dated);
      $this->fk_user = $obj->fk_user;
      $this->socid    = $obj->fk_soc;
      $this->km = $obj->km;
      $this->type     = $obj->type;
      $this->statut     = $obj->fk_statut;
      $this->note_private = $obj->note_private;
      $this->note_public  = $obj->note_public;
      $this->fk_project = $obj->fk_project;
 
      $this->extraparams  = (array) json_decode($obj->extraparams, true);
 
      return 1;
    } else {
      $this->error = $this->db->error();
      return -1;
    }
  }
 
  public function delete($user)
  {
    $this->db->begin();
 
    $id = $this->id;
 
    $sql = "DELETE FROM ".MAIN_DB_PREFIX."deplacement WHERE rowid = ".((int) $id);
 
    dol_syslog(get_class($this)."::delete", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      $this->db->commit();
      return 1;
    } else {
      $this->error = $this->db->error();
      $this->db->rollback();
      return -1;
    }
  }
 
 
  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->statut, $mode);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;
 
    if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
      global $langs;
      //$langs->load("mymodule@mymodule");
      $this->labelStatus[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
      $this->labelStatus[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Validated');
      $this->labelStatus[self::STATUS_REFUNDED] = $langs->transnoentitiesnoconv('Refunded');
      $this->labelStatusShort[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
      $this->labelStatusShort[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Validated');
      $this->labelStatusShort[self::STATUS_REFUNDED] = $langs->transnoentitiesnoconv('Refunded');
    }
 
    $status_logo = array(0 => 'status0', 1 => 'status4', 2 => 'status1', 4 => 'status6', 5 => 'status4', 6 => 'status6', 99 => 'status5');
    $statusType = $status_logo[$status];
 
    return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
  }
 
  public function getNomUrl($withpicto = 0)
  {
    global $langs;
 
    $result = '';
    $label = $langs->trans("Show").': '.$this->ref;
 
    $link = '<a href="'.DOL_URL_ROOT.'/compta/deplacement/card.php?id='.$this->id.'" title="'.dol_escape_htmltag($label, 1).'" class="classfortooltip">';
    $linkend = '</a>';
 
    $picto = 'trip';
 
 
    if ($withpicto) {
      $result .= ($link.img_object($label, $picto, 'class="classfortooltip"').$linkend);
    }
    if ($withpicto && $withpicto != 2) {
      $result .= ' ';
    }
    if ($withpicto != 2) {
      $result .= $link.$this->ref.$linkend;
    }
    return $result;
  }
 
 
  public function listOfTypes($active = 1)
  {
    global $langs;
 
    $ret = array();
 
    $sql = "SELECT id, code, label";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_type_fees";
    $sql .= " WHERE active = ".((int) $active);
 
    dol_syslog(get_class($this)."::listOfTypes", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      $num = $this->db->num_rows($result);
      $i = 0;
      while ($i < $num) {
        $obj = $this->db->fetch_object($result);
        $ret[$obj->code] = (($langs->trans($obj->code) != $obj->code) ? $langs->trans($obj->code) : $obj->label);
        $i++;
      }
    } else {
      dol_print_error($this->db);
    }
 
    return $ret;
  }
 
  public function info($id)
  {
    $sql = 'SELECT c.rowid, c.datec, c.fk_user_author, c.fk_user_modif,';
    $sql .= ' c.tms as datem';
    $sql .= ' FROM '.MAIN_DB_PREFIX.'deplacement as c';
    $sql .= ' WHERE c.rowid = '.((int) $id);
 
    dol_syslog(get_class($this).'::info', LOG_DEBUG);
    $result = $this->db->query($sql);
 
    if ($result) {
      if ($this->db->num_rows($result)) {
        $obj = $this->db->fetch_object($result);
 
        $this->id = $obj->rowid;
 
        $this->user_creation_id = $obj->fk_user_author;
        $this->user_modification_id = $obj->fk_user_modif;
        $this->date_creation     = $this->db->jdate($obj->datec);
        $this->date_modification = empty($obj->datem) ? '' : $this->db->jdate($obj->datem);
      }
      $this->db->free($result);
    } else {
      dol_print_error($this->db);
    }
  }
}