receptionlinebatch.class.php

<?php
/* Copyright (C) 2015 Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2014 Juanjo Menent       <jmenent@2byte.es>
 * Copyright (C) 2024       Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2024  Christophe Battarel  <christophe@altairis.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/>.
 */
 
// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT."/core/class/commonobject.class.php";
require_once DOL_DOCUMENT_ROOT."/reception/class/reception.class.php";
 
 
class ReceptionLineBatch extends CommonObjectLine
{
  public $db;
 
  public $element = 'receptionlinebatch';
 
  public $table_element = 'receptiondet_batch'; 
  public $lines = array();
 
  public $id;
 
  public $fk_reception;
 
  public $fk_element;
 
  public $origin_id;
 
  public $fk_elementdet;
 
  public $origin_line_id;
 
  public $element_type;
 
  public $fk_product;
 
  public $qty;
 
  public $qty_asked;
 
  public $libelle;
  public $label;
  public $desc;
  public $tva_tx;
  public $vat_src_code;
  public $ref_supplier;
 
  public $fk_entrepot;
 
  public $fk_user;
 
  public $datec = '';
  public $comment;
 
  public $status;
 
  public $batch;
  public $eatby = null;
  public $sellby = null;
  public $cost_price = 0;
 
 
 
 
  public function __construct($db)
  {
    $this->db = $db;
 
    // List of language codes for status
    $this->labelStatus[0] = 'Received';
    $this->labelStatus[1] = 'Verified';
    $this->labelStatus[2] = 'Denied';
    $this->labelStatusShort[0] = 'Received';
    $this->labelStatusShort[1] = 'Verified';
    $this->labelStatusShort[2] = 'Denied';
  }
 
 
  public function create($user, $notrigger = 0)
  {
    $error = 0;
 
    // Clean parameters
    if (isset($this->fk_element)) {
      $this->fk_element = (int) $this->fk_element;
    }
    if (isset($this->fk_product)) {
      $this->fk_product = (int) $this->fk_product;
    }
    if (isset($this->fk_elementdet)) {
      $this->fk_elementdet = (int) $this->fk_elementdet;
    }
    if (isset($this->qty)) {
      $this->qty = (float) $this->qty;
    }
    if (isset($this->fk_entrepot)) {
      $this->fk_entrepot = (int) $this->fk_entrepot;
    }
    if (isset($this->fk_user)) {
      $this->fk_user = (int) $this->fk_user;
    }
    if (isset($this->comment)) {
      $this->comment = trim($this->comment);
    }
    if (isset($this->status)) {
      $this->status = (int) $this->status;
    }
    if (isset($this->batch)) {
      $this->batch = trim($this->batch);
    }
    if (empty($this->datec)) {
      $this->datec = dol_now();
    }
 
    // Check parameters
    if (empty($this->fk_product)) {
      $this->error = 'Error, property ->fk_product must not be empty to create a line of reception';
      return -1;
    }
    if (empty($this->fk_reception)) {
      $this->error = 'Error, property ->fk_reception must not be empty to create a line of reception';
      return -1;
    }
 
    // Insert request
    $sql = "INSERT INTO ".MAIN_DB_PREFIX.$this->table_element."(";
    $sql .= "fk_product,";
    $sql .= "fk_element,";
    $sql .= "fk_elementdet,";
    $sql .= "element_type,";
    $sql .= "qty,";
    $sql .= "fk_entrepot,";
    $sql .= "fk_user,";
    $sql .= "datec,";
    $sql .= "comment,";
    $sql .= "status,";
    $sql .= "batch,";
    $sql .= "eatby,";
    $sql .= "sellby,";
    $sql .= "fk_reception,";
    $sql .= "cost_price";
    $sql .= ") VALUES (";
    $sql .= " ".(!isset($this->fk_product) ? 'NULL' : (int) $this->fk_product).",";
    $sql .= " ".(!isset($this->fk_element) ? 'NULL' : (int) $this->fk_element).",";
    $sql .= " ".(!isset($this->fk_elementdet) ? 'NULL' : (int) $this->fk_elementdet).",";
    $sql .= " '".(!isset($this->element_type) ? "supplier_order" : $this->db->escape($this->element_type))."',";
    $sql .= " ".(!isset($this->qty) ? 'NULL' : (float) $this->qty).",";
    $sql .= " ".(!isset($this->fk_entrepot) ? 'NULL' : (int) $this->fk_entrepot).",";
    $sql .= " ".(!isset($this->fk_user) ? 'NULL' : (int) $this->fk_user).",";
    $sql .= " ".(!isset($this->datec) || dol_strlen($this->datec) == 0 ? 'NULL' : "'".$this->db->idate($this->datec)."'").",";
    $sql .= " ".(!isset($this->comment) ? 'NULL' : "'".$this->db->escape($this->comment)."'").",";
    $sql .= " ".(!isset($this->status) ? 'NULL' : (int) $this->status).",";
    $sql .= " ".(!isset($this->batch) ? 'NULL' : "'".$this->db->escape($this->batch)."'").",";
    $sql .= " ".(!isset($this->eatby) || dol_strlen((string) $this->eatby) == 0 ? 'NULL' : "'".$this->db->idate($this->eatby)."'").",";
    $sql .= " ".(!isset($this->sellby) || dol_strlen((string) $this->sellby) == 0 ? 'NULL' : "'".$this->db->idate($this->sellby)."'").",";
    $sql .= " ".((int) $this->fk_reception).",";
    $sql .= " ".(!isset($this->cost_price) ? '0' : (float) $this->cost_price);
    $sql .= ")";
 
    $this->db->begin();
 
    dol_syslog(__METHOD__, 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.$this->table_element);
 
      if (!$notrigger) {
        // Call triggers
        $result = $this->call_trigger('LINERECEPTION_CREATE', $user);
        if ($result < 0) {
          $error++;
        }
        // End call triggers
      }
    }
 
    // Create extrafields
    if (!$error) {
      $result = $this->insertExtraFields();
      if ($result < 0) {
        $error++;
      }
    }
 
    // Commit or rollback
    if ($error) {
      foreach ($this->errors as $errmsg) {
        dol_syslog(__METHOD__." ".$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, $ref = '')
  {
    $sql = "SELECT";
    $sql .= " t.rowid,";
    $sql .= " t.fk_element,";
    $sql .= " t.fk_elementdet,";
    $sql .= " t.element_type,";
    $sql .= " t.fk_product,";
    $sql .= " t.qty,";
    $sql .= " t.fk_entrepot,";
    $sql .= " t.fk_user,";
    $sql .= " t.datec,";
    $sql .= " t.comment,";
    $sql .= " t.status,";
    $sql .= " t.tms,";
    $sql .= " t.batch,";
    $sql .= " t.eatby,";
    $sql .= " t.sellby,";
    $sql .= " t.fk_reception";
    $sql .= " FROM ".MAIN_DB_PREFIX.$this->table_element." as t";
    if ($ref) {
      $sql .= " WHERE t.ref = '".$this->db->escape($ref)."'";
    } else {
      $sql .= " WHERE t.rowid = ".((int) $id);
    }
 
    dol_syslog(get_class($this)."::fetch");
    $resql = $this->db->query($sql);
    if ($resql) {
      if ($this->db->num_rows($resql)) {
        $obj = $this->db->fetch_object($resql);
 
        $this->id = $obj->rowid;
 
        $this->fk_element = $obj->fk_element;
        $this->origin_id = $obj->fk_element;
        $this->fk_elementdet = $obj->fk_elementdet;
        $this->origin_line_id = $obj->fk_elementdet;
        $this->element_type = $obj->element_type;
        $this->origin_type = $obj->element_type;
 
        $this->fk_product = $obj->fk_product;
        $this->qty = $obj->qty;
        $this->fk_entrepot = $obj->fk_entrepot;
        $this->fk_user = $obj->fk_user;
        $this->datec = $this->db->jdate($obj->datec);
        $this->comment = $obj->comment;
        $this->status = $obj->status;
        $this->tms = $this->db->jdate($obj->tms);
        $this->batch = $obj->batch;
        $this->eatby = $this->db->jdate($obj->eatby);
        $this->sellby = $this->db->jdate($obj->sellby);
        $this->fk_reception = $obj->fk_reception;
 
        $this->fetch_optionals();
      }
      $this->db->free($resql);
 
      return 1;
    } else {
      $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
  }
 
 
  public function update($user, $notrigger = 0)
  {
    $error = 0;
 
    // Clean parameters
 
    if (isset($this->fk_element)) {
      $this->fk_element = (int) $this->fk_element;
    }
    if (isset($this->fk_product)) {
      $this->fk_product = (int) $this->fk_product;
    }
    if (isset($this->fk_elementdet)) {
      $this->fk_elementdet = (int) $this->fk_elementdet;
    }
    if (isset($this->qty)) {
      $this->qty = (float) $this->qty;
    }
    if (isset($this->fk_entrepot)) {
      $this->fk_entrepot = (int) $this->fk_entrepot;
    }
    if (isset($this->fk_user)) {
      $this->fk_user = (int) $this->fk_user;
    }
    if (isset($this->comment)) {
      $this->comment = trim($this->comment);
    }
    if (isset($this->status)) {
      $this->status = (int) $this->status;
    }
    if (isset($this->batch)) {
      $this->batch = trim($this->batch);
    }
 
 
 
    // Check parameters
    // Put here code to add a control on parameters values
 
    // Update request
    $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element." SET";
    $sql .= " fk_element=".(isset($this->fk_element) ? $this->fk_element : "null").",";
    $sql .= " fk_product=".(isset($this->fk_product) ? $this->fk_product : "null").",";
    $sql .= " fk_elementdet=".(isset($this->fk_elementdet) ? $this->fk_elementdet : "null").",";
    $sql .= " qty=".(isset($this->qty) ? $this->qty : "null").",";
    $sql .= " fk_entrepot=".(isset($this->fk_entrepot) ? $this->fk_entrepot : "null").",";
    $sql .= " fk_user=".(isset($this->fk_user) ? $this->fk_user : "null").",";
    $sql .= " datec=".(dol_strlen($this->datec) != 0 ? "'".$this->db->idate($this->datec)."'" : 'null').",";
    $sql .= " comment=".(isset($this->comment) ? "'".$this->db->escape($this->comment)."'" : "null").",";
    $sql .= " status=".(isset($this->status) ? $this->status : "null").",";
    $sql .= " tms=".(dol_strlen((string) $this->tms) != 0 ? "'".$this->db->idate($this->tms)."'" : 'null').",";
    $sql .= " batch=".(isset($this->batch) ? "'".$this->db->escape($this->batch)."'" : "null").",";
    $sql .= " eatby=".(dol_strlen((string) $this->eatby) != 0 ? "'".$this->db->idate($this->eatby)."'" : 'null').",";
    $sql .= " sellby=".(dol_strlen((string) $this->sellby) != 0 ? "'".$this->db->idate($this->sellby)."'" : 'null');
    $sql .= " WHERE rowid=".((int) $this->id);
 
    $this->db->begin();
 
    dol_syslog(__METHOD__);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $error++;
      $this->errors[] = "Error ".$this->db->lasterror();
    }
 
    if (!$error) {
      if (empty($this->id) && !empty($this->rowid)) {
        $this->id = $this->rowid;
      }
      $result = $this->insertExtraFields();
      if ($result < 0) {
        $error++;
      }
 
      if (!$notrigger) {
        // Call triggers
        $result = $this->call_trigger('LINERECEPTION_MODIFY', $user);
        if ($result < 0) {
          $error++;
        }
        // End call triggers
      }
    }
 
    // Commit or rollback
    if ($error) {
      foreach ($this->errors as $errmsg) {
        dol_syslog(__METHOD__." ".$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) {
      if (!$notrigger) {
        // Call triggers
        $result = $this->call_trigger('LINERECEPTION_DELETE', $user);
        if ($result < 0) {
          $error++;
        }
        // End call triggers
      }
    }
 
    // Remove extrafields
    if (!$error) {
      $result = $this->deleteExtraFields();
      if ($result < 0) {
        $error++;
        dol_syslog(get_class($this)."::delete error deleteExtraFields ".$this->error, LOG_ERR);
      }
    }
 
    if (!$error) {
      $sql = "DELETE FROM ".MAIN_DB_PREFIX.$this->table_element;
      $sql .= " WHERE rowid=".((int) $this->id);
 
      dol_syslog(__METHOD__);
      $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(__METHOD__." ".$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 ReceptionLineBatch($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->error = $object->error;
      $error++;
    }
 
    if (!$error) {
    }
 
    unset($object->context['createfromclone']);
 
    // End
    if (!$error) {
      $this->db->commit();
      return $object->id;
    } else {
      $this->db->rollback();
      return -1;
    }
  }
 
 
 
  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->status, $mode);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;
    $langs->load('orders');
 
    if ($mode == 0) {
      return $langs->trans($this->labelStatus[$status]);
    } elseif ($mode == 1) {
      return $langs->trans($this->labelStatusShort[$status]);
    } elseif ($mode == 2) {
      return $langs->trans($this->labelStatus[$status]);
    } elseif ($mode == 3) {
      if ($status == 0) {
        return img_picto($langs->trans($this->labelStatus[$status]), 'statut0');
      } elseif ($status == 1) {
        return img_picto($langs->trans($this->labelStatus[$status]), 'statut4');
      } elseif ($status == 2) {
        return img_picto($langs->trans($this->labelStatus[$status]), 'statut8');
      }
    } elseif ($mode == 4) {
      if ($status == 0) {
        return img_picto($langs->trans($this->labelStatus[$status]), 'statut0').' '.$langs->trans($this->labelStatus[$status]);
      } elseif ($status == 1) {
        return img_picto($langs->trans($this->labelStatus[$status]), 'statut4').' '.$langs->trans($this->labelStatus[$status]);
      } elseif ($status == 2) {
        return img_picto($langs->trans($this->labelStatus[$status]), 'statut8').' '.$langs->trans($this->labelStatus[$status]);
      }
    } elseif ($mode == 5) {
      if ($status == 0) {
        return '<span class="hideonsmartphone">'.$langs->trans($this->labelStatusShort[$status]).' </span>'.img_picto($langs->trans($this->labelStatus[$status]), 'statut0');
      } elseif ($status == 1) {
        return '<span class="hideonsmartphone">'.$langs->trans($this->labelStatusShort[$status]).' </span>'.img_picto($langs->trans($this->labelStatus[$status]), 'statut4');
      } elseif ($status == 2) {
        return '<span class="hideonsmartphone">'.$langs->trans($this->labelStatusShort[$status]).' </span>'.img_picto($langs->trans($this->labelStatus[$status]), 'statut8');
      }
    }
    return "";
  }
 
 
  public function initAsSpecimen()
  {
    $this->id = 0;
 
    $this->fk_element = 0;
    $this->fk_product = 0;
    $this->fk_elementdet = 0;
    $this->qty = 0;
    $this->fk_entrepot = 0;
    $this->fk_user = 0;
    $this->datec = '';
    $this->comment = '';
    $this->status = 0;
    $this->tms = dol_now();
    $this->batch = '';
    $this->eatby = null;
    $this->sellby = null;
 
    return 1;
  }
 
  public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, $filter = '', $filtermode = 'AND')
  {
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $sql = "SELECT";
    $sql .= " t.rowid,";
    $sql .= " t.fk_element,";
    $sql .= " t.fk_product,";
    $sql .= " t.fk_elementdet,";
    $sql .= " t.qty,";
    $sql .= " t.fk_entrepot,";
    $sql .= " t.fk_user,";
    $sql .= " t.datec,";
    $sql .= " t.comment,";
    $sql .= " t.status,";
    $sql .= " t.tms,";
    $sql .= " t.batch,";
    $sql .= " t.eatby,";
    $sql .= " t.sellby";
    $sql .= " FROM ".MAIN_DB_PREFIX.$this->table_element." as t";
 
    // Manage filter
    if (is_array($filter)) {
      $sqlwhere = array();
      if (count($filter) > 0) {
        foreach ($filter as $key => $value) {
          if ($key == 't.comment') {
            $sqlwhere [] = $this->db->sanitize($key)." LIKE '%".$this->db->escape($this->db->escapeforlike($value))."%'";
          } elseif ($key == 't.datec' || $key == 't.tms' || $key == 't.eatby' || $key == 't.sellby' || $key == 't.batch') {
            $sqlwhere [] = $this->db->sanitize($key)." = '".$this->db->escape($value)."'";
          } elseif ($key == 'qty') {
            $sqlwhere [] = $this->db->sanitize($key)." = ".((float) $value);
          } else {
            $sqlwhere [] = $this->db->sanitize($key)." = ".((int) $value);
          }
        }
      }
      if (count($sqlwhere) > 0) {
        $sql .= ' WHERE '.implode(' '.$this->db->escape($filtermode).' ', $sqlwhere);
      }
 
      $filter = '';
    }
 
    // Manage filter
    $errormessage = '';
    $sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
    if ($errormessage) {
      $this->errors[] = $errormessage;
      dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
      return -1;
    }
 
    if (!empty($sortfield)) {
      $sql .= $this->db->order($sortfield, $sortorder);
    }
    if (!empty($limit)) {
      $sql .= $this->db->plimit($limit, $offset);
    }
    $this->lines = array();
 
    $resql = $this->db->query($sql);
    if ($resql) {
      $num = $this->db->num_rows($resql);
 
      while ($obj = $this->db->fetch_object($resql)) {
        $line = new self($this->db);
 
        $line->id = $obj->rowid;
 
        $line->fk_element = $obj->fk_element;
        $line->fk_product = $obj->fk_product;
        $line->fk_elementdet = $obj->fk_elementdet;
        $line->qty = $obj->qty;
        $line->fk_entrepot = $obj->fk_entrepot;
        $line->fk_user = $obj->fk_user;
        $line->datec = $this->db->jdate($obj->datec);
        $line->comment = $obj->comment;
        $line->status = $obj->status;
        $line->tms = $this->db->jdate($obj->tms);
        $line->batch = $obj->batch;
        $line->eatby = $this->db->jdate($obj->eatby);
        $line->sellby = $this->db->jdate($obj->sellby);
        $line->fetch_optionals();
 
        $this->lines[$line->id] = $line;
      }
      $this->db->free($resql);
 
      return $num;
    } else {
      $this->errors[] = 'Error '.$this->db->lasterror();
      dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
 
      return -1;
    }
  }
}