expeditionligne.class.php

<?php
/* Copyright (C) 2003-2008  Rodolphe Quiedeville  <rodolphe@quiedeville.org>
 * Copyright (C) 2005-2012  Regis Houssin     <regis.houssin@inodbox.com>
 * Copyright (C) 2007   Franky Van Liedekerke <franky.van.liedekerke@telenet.be>
 * Copyright (C) 2006-2012  Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2011-2020  Juanjo Menent     <jmenent@2byte.es>
 * Copyright (C) 2013       Florian Henry       <florian.henry@open-concept.pro>
 * Copyright (C) 2014   Cedric GROSS      <c.gross@kreiz-it.fr>
 * Copyright (C) 2014-2015  Marcos García           <marcosgdf@gmail.com>
 * Copyright (C) 2014-2017  Francis Appels          <francis.appels@yahoo.com>
 * Copyright (C) 2015       Claudio Aschieri        <c.aschieri@19.coop>
 * Copyright (C) 2016-2024  Ferran Marcet     <fmarcet@2byte.es>
 * Copyright (C) 2018       Nicolas ZABOURI     <info@inovea-conseil.com>
 * Copyright (C) 2018-2024  Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2020       Lenin Rivas           <lenin@leninrivas.com>
 * 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/commonobjectline.class.php";
require_once DOL_DOCUMENT_ROOT.'/expedition/class/expeditionlinebatch.class.php';
 
class ExpeditionLigne extends CommonObjectLine
{
  public $element = 'expeditiondet';
 
  public $table_element = 'expeditiondet';
 
  public $parent_element = 'expedition';
 
  public $fk_parent_attribute = 'fk_expedition';
 
  public $line_id;  // deprecated
 
  public $fk_element;
 
  public $origin_id;
 
  public $fk_elementdet;
 
  public $origin_line_id;
 
  public $element_type;
 
 
  public $fk_origin;      // Example: 'orderline'
 
  public $fk_expedition;
 
  public $db;
 
  public $qty;
 
  public $qty_shipped;
 
  public $fk_product;
 
  public $detail_batch;
 
  public $details_entrepot;
 
 
  public $entrepot_id;
 
 
  public $qty_asked;
 
  public $ref;
 
  public $product_ref;
 
  public $libelle;
 
  public $product_label;
 
  public $desc;
 
  public $product_desc;
 
  public $product_type = 0;
 
  public $rang;
 
  public $weight;
 
  public $weight_units;
 
  public $length;
 
  public $length_units;
 
  public $width;
 
  public $width_units;
 
  public $height;
 
  public $height_units;
 
  public $surface;
 
  public $surface_units;
 
  public $volume;
 
  public $volume_units;
 
  public $remise_percent;
 
  public $tva_tx;
 
  public $total_ht;
 
  public $total_ttc;
 
  public $total_tva;
 
  public $total_localtax1;
 
  public $total_localtax2;
 
 
  public function __construct($db)
  {
    $this->db = $db;
  }
 
  public function fetch($rowid)
  {
    $sql = 'SELECT ed.rowid, ed.fk_expedition, ed.fk_entrepot, ed.fk_elementdet, ed.element_type, ed.qty, ed.rang';
    $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as ed';
    $sql .= ' WHERE ed.rowid = '.((int) $rowid);
    $result = $this->db->query($sql);
    if ($result) {
      $objp = $this->db->fetch_object($result);
      $this->id = $objp->rowid;
      $this->fk_expedition = $objp->fk_expedition;
      $this->entrepot_id = $objp->fk_entrepot;
      $this->fk_elementdet = $objp->fk_elementdet;
      $this->element_type = $objp->element_type;
      $this->qty = $objp->qty;
      $this->rang = $objp->rang;
 
      $this->db->free($result);
 
      return 1;
    } else {
      $this->errors[] = $this->db->lasterror();
      $this->error = $this->db->lasterror();
      return -1;
    }
  }
 
  public function insert($user, $notrigger = 0)
  {
    $error = 0;
 
    // Check parameters
    if (empty($this->fk_expedition) || empty($this->fk_elementdet) || !is_numeric($this->qty)) {
      $this->error = 'ErrorMandatoryParametersNotProvided';
      return -1;
    }
 
    $this->db->begin();
 
    if (empty($this->rang)) {
      $this->rang = 0;
    }
 
    // Rank to use
    $ranktouse = $this->rang;
    if ($ranktouse == -1) {
      $rangmax = $this->line_max($this->fk_expedition);
      $ranktouse = $rangmax + 1;
    }
 
    $sql = "INSERT INTO ".MAIN_DB_PREFIX."expeditiondet (";
    $sql .= "fk_expedition";
    $sql .= ", fk_entrepot";
    $sql .= ", fk_elementdet";
    $sql .= ", element_type";
    $sql .= ", qty";
    $sql .= ", rang";
    $sql .= ") VALUES (";
    $sql .= $this->fk_expedition;
    $sql .= ", ".(empty($this->entrepot_id) ? 'NULL' : $this->entrepot_id);
    $sql .= ", ".((int) $this->fk_elementdet);
    $sql .= ", '".(empty($this->element_type) ? 'order' : $this->db->escape($this->element_type))."'";
    $sql .= ", ".price2num($this->qty, 'MS');
    $sql .= ", ".((int) $ranktouse);
    $sql .= ")";
 
    dol_syslog(get_class($this)."::insert", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql) {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."expeditiondet");
 
      if (!$error) {
        $result = $this->insertExtraFields();
        if ($result < 0) {
          $error++;
        }
      }
 
      if (!$error && !$notrigger) {
        // Call trigger
        $result = $this->call_trigger('LINESHIPPING_INSERT', $user);
        if ($result < 0) {
          $error++;
        }
        // End call triggers
      }
 
      if ($error) {
        foreach ($this->errors as $errmsg) {
          dol_syslog(get_class($this)."::delete ".$errmsg, LOG_ERR);
          $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
        }
      }
    } else {
      $error++;
    }
 
    if ($error) {
      $this->db->rollback();
      return -1;
    } else {
      $this->db->commit();
      return $this->id;
    }
  }
 
  public function delete($user = null, $notrigger = 0)
  {
    $error = 0;
 
    $this->db->begin();
 
    // delete batch expedition line
    if (isModEnabled('productbatch')) {
      $sql = "DELETE FROM ".MAIN_DB_PREFIX."expeditiondet_batch";
      $sql .= " WHERE fk_expeditiondet = ".((int) $this->id);
 
      if (!$this->db->query($sql)) {
        $this->errors[] = $this->db->lasterror()." - sql=$sql";
        $error++;
      }
    }
 
    $sql = "DELETE FROM ".MAIN_DB_PREFIX."expeditiondet";
    $sql .= " WHERE rowid = ".((int) $this->id);
 
    if (!$error && $this->db->query($sql)) {
      // Remove extrafields
      if (!$error) {
        $result = $this->deleteExtraFields();
        if ($result < 0) {
          $this->errors[] = $this->error;
          $error++;
        }
      }
      if (!$error && !$notrigger) {
        // Call trigger
        $result = $this->call_trigger('LINESHIPPING_DELETE', $user);
        if ($result < 0) {
          $this->errors[] = $this->error;
          $error++;
        }
        // End call triggers
      }
    } else {
      $this->errors[] = $this->db->lasterror()." - sql=$sql";
      $error++;
    }
 
    if (!$error) {
      $this->db->commit();
      return 1;
    } else {
      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;
    }
  }
 
  public function update($user = null, $notrigger = 0)
  {
    $error = 0;
 
    dol_syslog(get_class($this)."::update id=$this->id, entrepot_id=$this->entrepot_id, product_id=$this->fk_product, qty=$this->qty");
 
    $this->db->begin();
 
    // Clean parameters
    if (empty($this->qty)) {
      $this->qty = 0;
    }
    $qty = price2num($this->qty);
    $remainingQty = 0;
    $batch = null;
    $batch_id = null;
    $expedition_batch_id = null;
    if (is_array($this->detail_batch)) {  // array of ExpeditionLineBatch
      if (count($this->detail_batch) > 1) {
        dol_syslog(get_class($this).'::update only possible for one batch', LOG_ERR);
        $this->errors[] = 'ErrorBadParameters';
        $error++;
      } else {
        $batch = $this->detail_batch[0]->batch;
        $batch_id = $this->detail_batch[0]->fk_origin_stock;
        $expedition_batch_id = $this->detail_batch[0]->id;
        if ($this->entrepot_id != $this->detail_batch[0]->entrepot_id) {
          dol_syslog(get_class($this).'::update only possible for batch of same warehouse', LOG_ERR);
          $this->errors[] = 'ErrorBadParameters';
          $error++;
        }
        $qty = price2num($this->detail_batch[0]->qty);
      }
    } elseif (!empty($this->detail_batch)) {
      $batch = $this->detail_batch->batch;
      $batch_id = $this->detail_batch->fk_origin_stock;
      $expedition_batch_id = $this->detail_batch->id;
      if ($this->entrepot_id != $this->detail_batch->entrepot_id) {
        dol_syslog(get_class($this).'::update only possible for batch of same warehouse', LOG_ERR);
        $this->errors[] = 'ErrorBadParameters';
        $error++;
      }
      $qty = price2num($this->detail_batch->qty);
    }
 
    // check parameters
    if (!isset($this->id) || !isset($this->entrepot_id)) {
      dol_syslog(get_class($this).'::update missing line id and/or warehouse id', LOG_ERR);
      $this->errors[] = 'ErrorMandatoryParametersNotProvided';
      $error++;
      return -1;
    }
 
    // update lot
 
    if (!empty($batch) && isModEnabled('productbatch')) {
      $batch_id_str = $batch_id ?? 'null';
      dol_syslog(get_class($this)."::update expedition batch id=$expedition_batch_id, batch_id=$batch_id_str, batch=$batch");
 
      if (empty($batch_id) || empty($this->fk_product)) {
        dol_syslog(get_class($this).'::update missing fk_origin_stock (batch_id) and/or fk_product', LOG_ERR);
        $this->errors[] = 'ErrorMandatoryParametersNotProvided';
        $error++;
      }
 
      // fetch remaining lot qty
      $shipmentlinebatch = new ExpeditionLineBatch($this->db);
      $lotArray = $shipmentlinebatch->fetchAll($this->id);
      if (!$error && $lotArray < 0) {
        $this->errors[] = $this->db->lasterror()." - ExpeditionLineBatch::fetchAll";
        $error++;
      } else {
        // calculate new total line qty
        foreach ($lotArray as $lot) {
          if ($expedition_batch_id != $lot->id) {
            $remainingQty += $lot->qty;
          }
        }
        $qty += $remainingQty;
 
        //fetch lot details
 
        // fetch from product_lot
        require_once DOL_DOCUMENT_ROOT.'/product/stock/class/productlot.class.php';
        $lot = new Productlot($this->db);
        if ($lot->fetch(0, $this->fk_product, $batch) < 0) {
          $this->errors = array_merge($this->errors, $lot->errors);
          $error++;
        }
        if (!$error && !empty($expedition_batch_id)) {
          // delete lot expedition line
          $sql = "DELETE FROM ".MAIN_DB_PREFIX."expeditiondet_batch";
          $sql .= " WHERE fk_expeditiondet = ".((int) $this->id);
          $sql .= " AND rowid = ".((int) $expedition_batch_id);
 
          if (!$this->db->query($sql)) {
            $this->errors[] = $this->db->lasterror()." - sql=$sql";
            $error++;
          }
        }
        if (!$error && $this->detail_batch->qty > 0) {
          // create lot expedition line
          if (isset($lot->id)) {
            $shipmentLot = new ExpeditionLineBatch($this->db);
            $shipmentLot->batch = $lot->batch;
            $shipmentLot->eatby = $lot->eatby;
            $shipmentLot->sellby = $lot->sellby;
            $shipmentLot->entrepot_id = $this->detail_batch->entrepot_id;
            $shipmentLot->qty = $this->detail_batch->qty;
            $shipmentLot->fk_origin_stock = $batch_id;
            if ($shipmentLot->create($this->id) < 0) {
              $this->errors = $shipmentLot->errors;
              $error++;
            }
          }
        }
      }
    }
    if (!$error) {
      // update line
      $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element." SET";
      $sql .= " fk_entrepot = ".($this->entrepot_id > 0 ? $this->entrepot_id : 'null');
      $sql .= " , qty = ".((float) price2num($qty, 'MS'));
      $sql .= " WHERE rowid = ".((int) $this->id);
 
      if (!$this->db->query($sql)) {
        $this->errors[] = $this->db->lasterror()." - sql=$sql";
        $error++;
      }
    }
 
    if (!$error) {
      $result = $this->insertExtraFields();
      if ($result < 0) {
        $this->errors[] = $this->error;
        $error++;
      }
    }
 
    if (!$error && !$notrigger) {
      // Call trigger
      $result = $this->call_trigger('LINESHIPPING_MODIFY', $user);
      if ($result < 0) {
        $this->errors[] = $this->error;
        $error++;
      }
      // End call triggers
    }
    if (!$error) {
      $this->db->commit();
      return 1;
    } else {
      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;
    }
  }
}