productbatch.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2007-2023  Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2013-2014  Cedric GROSS            <c.gross@kreiz-it.fr>
 * Copyright (C) 2024-2025  Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2024       Ferran Marcet           <fmarcet@2byte.es>
 * Copyright (C) 2024-2025  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 Productbatch extends CommonObject
{
  const BATCH_RULE_SELLBY_EATBY_DATES_FIRST = 1;
 
  public $element = 'productbatch';
 
  private static $_table_element = 'product_batch'; 
 
  public $fk_product_stock;
 
  public $batch = '';
 
  public $qty;
 
  public $warehouseid;
 
  public $fk_product;
 
  public $lotid;
 
  public $sellby = '';  // dlc
 
  public $eatby = '';   // dmd/dluo
 
 
  public function __construct($db)
  {
    $this->db = $db;
  }
 
 
  public function create($user, $notrigger = 0)
  {
    $error = 0;
 
    // Clean parameters
    $this->cleanParam();
 
    // Check parameters
    // Put here code to add control on parameters values
 
    // Insert request
    $sql = "INSERT INTO ".$this->db->prefix()."product_batch (";
    $sql .= "fk_product_stock,";
    $sql .= "sellby,";        // no more used
    $sql .= "eatby,";       // no more used
    $sql .= "batch,";
    $sql .= "qty,";
    $sql .= "import_key";
    $sql .= ") VALUES (";
    $sql .= " ".(!isset($this->fk_product_stock) ? 'NULL' : $this->fk_product_stock).",";
    $sql .= " ".(!isset($this->sellby) || dol_strlen($this->sellby) == 0 ? 'NULL' : "'".$this->db->idate($this->sellby)."'").",";   // no more used
    $sql .= " ".(!isset($this->eatby) || dol_strlen($this->eatby) == 0 ? 'NULL' : "'".$this->db->idate($this->eatby)."'").",";      // no more used
    $sql .= " ".(!isset($this->batch) ? 'NULL' : "'".$this->db->escape($this->batch)."'").",";
    $sql .= " ".(!isset($this->qty) ? 'NULL' : $this->qty).",";
    $sql .= " ".(!isset($this->import_key) ? 'NULL' : "'".$this->db->escape($this->import_key)."'");
    $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($this->db->prefix().self::$_table_element);
    }
 
    // Commit or rollback
    if ($error) {
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return $this->id;
    }
  }
 
 
  public function fetch($id)
  {
    $sql = "SELECT";
    $sql .= " t.rowid,";
    $sql .= " t.tms,";
    $sql .= " t.fk_product_stock,";
    $sql .= " t.sellby as oldsellby,";
    $sql .= " t.eatby as oldeatby,";
    $sql .= " t.batch,";
    $sql .= " t.qty,";
    $sql .= " t.import_key,";
    $sql .= " w.fk_entrepot,";
    $sql .= " w.fk_product,";
    $sql .= " pl.eatby,";
    $sql .= " pl.sellby";
    $sql .= " FROM ".$this->db->prefix()."product_batch as t";
    $sql .= " INNER JOIN ".$this->db->prefix()."product_stock w on t.fk_product_stock = w.rowid"; // llx_product_stock is a parent table so this link does NOT generate duplicate record
    $sql .= " LEFT JOIN ".$this->db->prefix()."product_lot as pl on pl.fk_product = w.fk_product and pl.batch = t.batch";
    $sql .= " WHERE t.rowid = ".((int) $id);
 
    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->tms = $this->db->jdate($obj->tms);
        $this->fk_product_stock = $obj->fk_product_stock;
        $this->sellby = $this->db->jdate($obj->sellby ? $obj->sellby : $obj->oldsellby);
        $this->eatby = $this->db->jdate($obj->eatby ? $obj->eatby : $obj->oldeatby);
        $this->batch = $obj->batch;
        $this->qty = $obj->qty;
        $this->import_key = $obj->import_key;
        $this->warehouseid = $obj->fk_entrepot;
        $this->fk_product = $obj->fk_product;
      }
      $this->db->free($resql);
 
      return 1;
    } else {
      $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
  }
 
  public function update($user = null, $notrigger = 0)
  {
    $error = 0;
 
    // Clean parameters
    $this->cleanParam();
 
    // TODO Check qty is ok for stock move. Negative may not be allowed.
    /*
    if ($this->qty < 0) {
    }
    */
 
    // Update request
    $sql = "UPDATE ".$this->db->prefix().self::$_table_element." SET";
    $sql .= " fk_product_stock=".(isset($this->fk_product_stock) ? $this->fk_product_stock : "null").",";
    $sql .= " sellby=".(dol_strlen($this->sellby) != 0 ? "'".$this->db->idate($this->sellby)."'" : 'null').",";
    $sql .= " eatby=".(dol_strlen($this->eatby) != 0 ? "'".$this->db->idate($this->eatby)."'" : 'null').",";
    $sql .= " batch=".(isset($this->batch) ? "'".$this->db->escape($this->batch)."'" : "null").",";
    $sql .= " qty=".(isset($this->qty) ? $this->qty : "null").",";
    $sql .= " import_key=".(isset($this->import_key) ? "'".$this->db->escape($this->import_key)."'" : "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;
    }
  }
 
  public function delete($user, $notrigger = 0)
  {
    $error = 0;
 
    $this->db->begin();
 
    if (!$error) {
      $sql = "DELETE FROM ".$this->db->prefix().self::$_table_element;
      $sql .= " WHERE rowid=".((int) $this->id);
 
      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;
    }
  }
 
 
 
  public function createFromClone(User $user, $fromid)
  {
    $error = 0;
 
    $object = new Productbatch($this->db);
 
    $this->db->begin();
 
    // Load source object
    $object->fetch($fromid);
    $object->id = 0;
    $object->statut = 0;
 
    // Clear fields
    // ...
 
    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->create($user);
 
    // Other options
    if ($result < 0) {
      $this->setErrorsFromObject($object);
      $error++;
    }
 
    if (!$error) {
    }
 
    unset($object->context['createfromclone']);
 
    // End
    if (!$error) {
      $this->db->commit();
      return $object->id;
    } else {
      $this->db->rollback();
      return -1;
    }
  }
 
 
  public function initAsSpecimen()
  {
    $this->id = 0;
 
    $this->tms = dol_now();
    $this->fk_product_stock = 0;
    $this->sellby = '';
    $this->eatby = '';
    $this->batch = '';
    $this->import_key = '';
 
    return 1;
  }
 
  private function cleanParam()
  {
    if (isset($this->fk_product_stock)) {
      $this->fk_product_stock = (int) trim((string) $this->fk_product_stock);
    }
    if (isset($this->batch)) {
      $this->batch = trim($this->batch);
    }
    if (isset($this->qty)) {
      $this->qty = (float) trim((string) $this->qty);
    }
    if (isset($this->import_key)) {
      $this->import_key = trim($this->import_key);
    }
  }
 
  public function find($fk_product_stock = 0, $eatby = '', $sellby = '', $batch_number = '', $fk_warehouse = 0, $fk_product = 0)
  {
    $where = array();
 
    $sql = "SELECT";
    $sql .= " t.rowid,";
    $sql .= " t.tms,";
    $sql .= " t.fk_product_stock,";
    $sql .= " t.sellby,"; // deprecated
    $sql .= " t.eatby,"; // deprecated
    $sql .= " t.batch,";
    $sql .= " t.qty,";
    $sql .= " t.import_key";
    $sql .= " FROM ".$this->db->prefix().self::$_table_element." as t";
    if ($fk_product_stock > 0 || empty($fk_warehouse)) {
      $sql .= " WHERE t.fk_product_stock = ".((int) $fk_product_stock);
    } else {
      $sql .= ", ".$this->db->prefix()."product_stock as ps";
      $sql .= " WHERE t.fk_product_stock = ps.rowid AND ps.fk_entrepot = ".((int) $fk_warehouse);
      if ($fk_product > 0) {
         $sql .= " AND ps.fk_product = ".((int) $fk_product);
      }
    }
    if (!empty($eatby)) {
      array_push($where, " eatby = '".$this->db->idate($eatby)."'"); // deprecated
    }
    if (!empty($sellby)) {
      array_push($where, " sellby = '".$this->db->idate($sellby)."'"); // deprecated
    }
 
    if (!empty($batch_number)) {
      $sql .= " AND batch = '".$this->db->escape($batch_number)."'";
    }
 
    if (!empty($where)) {
      $sql .= " AND (".$this->db->sanitize(implode(" OR ", $where), 1, 1, 1).")";
    }
    // Take the first one found
    $sql .= $this->db->order("t.tms,t.rowid");
    $sql .= $this->db->plimit(1);
 
    $resql = $this->db->query($sql);
    if ($resql) {
      if ($this->db->num_rows($resql)) {
        $obj = $this->db->fetch_object($resql);
 
        $this->id = $obj->rowid;
 
        $this->tms = $this->db->jdate($obj->tms);
        $this->fk_product_stock = $obj->fk_product_stock;
        $this->sellby = $this->db->jdate($obj->sellby); // deprecated. do not use this data.
        $this->eatby = $this->db->jdate($obj->eatby); // deprecated. do not use this data.
        $this->batch = $obj->batch;
        $this->qty = $obj->qty;
        $this->import_key = $obj->import_key;
      }
      $this->db->free($resql);
 
      return 1;
    } else {
      $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
  }
  public static function findAll($dbs, $fk_product_stock, $with_qty = 0, $fk_product = 0)
  {
    global $conf;
 
    $ret = array();
 
    $sql = "SELECT";
    $sql .= " t.rowid,";
    $sql .= " t.tms,";
    $sql .= " t.fk_product_stock,";
    $sql .= " t.sellby as oldsellby,"; // deprecated but may not be migrated into new table
    $sql .= " t.eatby as oldeatby,"; // deprecated but may not be migrated into new table
    $sql .= " t.batch,";
    $sql .= " t.qty,";
    if (getDolGlobalString('SHIPPING_DISPLAY_STOCK_ENTRY_DATE')) {
      $sql .= " MAX(sm.datem) as date_entree,";
    }
    $sql .= " t.import_key";
    if ($fk_product > 0) {
      $sql .= ", pl.rowid as lotid, pl.eatby as eatby, pl.sellby as sellby";
      // TODO May add extrafields to ?
    }
    $sql .= " FROM ".$dbs->prefix()."product_batch as t";
    if ($fk_product > 0) {  // Add link to the table of details of a lot
      $sql .= " LEFT JOIN ".$dbs->prefix()."product_lot as pl ON pl.fk_product = ".((int) $fk_product)." AND pl.batch = t.batch";
      // TODO May add extrafields to ?
    }
    if (getDolGlobalString('SHIPPING_DISPLAY_STOCK_ENTRY_DATE')) {
      $sql .= ' LEFT JOIN '.MAIN_DB_PREFIX.'product_stock AS ps ON (ps.rowid = fk_product_stock)';
      $sql .= ' LEFT JOIN '.MAIN_DB_PREFIX.'stock_mouvement AS sm ON (sm.batch = t.batch AND ps.fk_entrepot=sm.fk_entrepot AND sm.type_mouvement IN (0,3))';
    }
    $sql .= " WHERE fk_product_stock=".((int) $fk_product_stock);
    if ($with_qty) {
      $sql .= " AND t.qty <> 0";
    }
    if (getDolGlobalString('SHIPPING_DISPLAY_STOCK_ENTRY_DATE')) {
      $sql .= ' GROUP BY t.rowid, t.tms, t.fk_product_stock,t.sellby,t.eatby , t.batch,t.qty,t.import_key';
      if ($fk_product > 0) {
        $sql .= ', pl.rowid, pl.eatby, pl.sellby';
      }
    }
    $sql .= " ORDER BY ";
    // TODO : use product lifo and fifo when product will implement it
    if (getDolGlobalString('SHIPPING_DISPLAY_STOCK_ENTRY_DATE')) {
      $sql .= 'date_entree ASC,t.batch ASC,';
    }
    if ($fk_product > 0) {
      $sql .= "pl.eatby ASC, pl.sellby ASC, ";
    }
    $sql .= "t.eatby ASC, t.sellby ASC ";
    $sql .= ", t.qty ".(!getDolGlobalString('DO_NOT_TRY_TO_DEFRAGMENT_STOCKS_WAREHOUSE') ? 'ASC' : 'DESC'); // Note : qty ASC is important for expedition card, to avoid stock fragmentation
    $sql .= ", t.batch ASC";
 
    dol_syslog("productbatch::findAll", LOG_DEBUG);
 
    $resql = $dbs->query($sql);
    if ($resql) {
      $num = $dbs->num_rows($resql);
      $i = 0;
      while ($i < $num) {
        $obj = $dbs->fetch_object($resql);
 
        $tmp = new Productbatch($dbs);
        $tmp->id    = $obj->rowid;
        $tmp->tms = $dbs->jdate($obj->tms);
        $tmp->fk_product_stock = $obj->fk_product_stock;
        $tmp->batch = $obj->batch;
        $tmp->qty = $obj->qty;
        $tmp->import_key = $obj->import_key;
 
        if (getDolGlobalString('SHIPPING_DISPLAY_STOCK_ENTRY_DATE')) {
          $tmp->context['stock_entry_date'] = $dbs->jdate($obj->date_entree);
        }
 
        if ($fk_product > 0) {
          // Some properties of the lot
          $tmp->lotid = $obj->lotid;  // ID in table of the details of properties of each lots
          $tmp->sellby = $dbs->jdate($obj->sellby ? $obj->sellby : $obj->oldsellby);
          $tmp->eatby = $dbs->jdate($obj->eatby ? $obj->eatby : $obj->oldeatby);
        }
 
        $ret[$tmp->batch] = $tmp; // $ret is for a $fk_product_stock and unique key is on $fk_product_stock+batch
        $i++;
      }
      $dbs->free($resql);
 
      return $ret;
    } else {
      //$error = "Error ".$dbs->lasterror();
      return -1;
    }
  }
 
  public function findAllForProduct($fk_product, $fk_warehouse = 0, $qty_min = null, $sortfield = null, $sortorder = null)
  {
    $productBatchList = array();
 
    dol_syslog(__METHOD__.' fk_product='.$fk_product.', fk_warehouse='.$fk_warehouse.', qty_min='.$qty_min.', sortfield='.$sortfield.', sortorder='.$sortorder, LOG_DEBUG);
 
    $sql  = "SELECT";
    $sql .= " pl.rowid";
    $sql .= ", pl.fk_product";
    $sql .= ", pl.batch";
    $sql .= ", pl.sellby";
    $sql .= ", pl.eatby";
    $sql .= ", pb.qty";
    $sql .= " FROM ".$this->db->prefix()."product_lot as pl";
    $sql .= " LEFT JOIN ".$this->db->prefix()."product as p ON p.rowid = pl.fk_product";
    $sql .= " LEFT JOIN ".$this->db->prefix()."product_batch AS pb ON pl.batch = pb.batch";
    $sql .= " LEFT JOIN ".$this->db->prefix()."product_stock AS ps ON ps.rowid = pb.fk_product_stock AND ps.fk_product = ".((int) $fk_product);
    $sql .= " WHERE p.entity IN (".getEntity('product').")";
    $sql .= " AND pl.fk_product = ".((int) $fk_product);
    if ($fk_warehouse > 0) {
      $sql .= " AND ps.fk_entrepot = ".((int) $fk_warehouse);
    }
    if ($qty_min !== null) {
      $sql .= " AND pb.qty > ".((float) price2num($qty_min, 'MS'));
    }
    $sql .= $this->db->order($sortfield, $sortorder);
 
    $resql = $this->db->query($sql);
    if ($resql) {
      while ($obj = $this->db->fetch_object($resql)) {
        $productBatch             = new self($this->db);
        $productBatch->id         = $obj->rowid;
        $productBatch->fk_product = $obj->fk_product;
        $productBatch->batch      = $obj->batch;
        $productBatch->eatby      = $this->db->jdate($obj->eatby);
        $productBatch->sellby     = $this->db->jdate($obj->sellby);
        $productBatch->qty        = $obj->qty;
        $productBatchList[]       = $productBatch;
      }
      $this->db->free($resql);
 
      return $productBatchList;
    } else {
      dol_syslog(__METHOD__.' Error: '.$this->db->lasterror(), LOG_ERR);
      return -1;
    }
  }
}