api_stockmovements.class.php

<?php
/* Copyright (C) 2016   Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2025   MDW         <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025 William Mead      <william@m34d.com>
 * Copyright (C) 2025       Frédéric France         <frederic.france@free.fr>
 *
 * 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/>.
 */
 
use Luracast\Restler\RestException;
 
require_once DOL_DOCUMENT_ROOT.'/product/stock/class/mouvementstock.class.php';
 
 
class StockMovements extends DolibarrApi
{
  public static $FIELDS = array(
    'product_id',
    'warehouse_id',
    'qty'
  );
 
  public $stockmovement;
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
    $this->stockmovement = new MouvementStock($this->db);
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('stock', 'mouvement', 'lire')) {
      throw new RestException(403);
    }
    if ($id == 0) {
      throw new RestException(400, 'No stock movement with id 0 can exist');
    }
    $result = $this->stockmovement->fetch($id);
    if (!$result ) {
      throw new RestException(404, 'stock movement not found');
    }
 
    if (! DolibarrApi::_checkAccessToResource('stockmovement', $this->stockmovement, 'stock_mouvement', '', '', 'rowid', 'fk_entrepot@entrepot')) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    return $this->_cleanObjectDatas($this->stockmovement);
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $sqlfilters = '', $properties = '', $pagination_data = false)
  {
    $obj_ret = array();
 
    if (!DolibarrApiAccess::$user->hasRight('stock', 'lire')) {
      throw new RestException(403);
    }
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."stock_mouvement AS t";
    $sql .= " INNER JOIN ".MAIN_DB_PREFIX."entrepot as e ON t.fk_entrepot = e.rowid";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."stock_mouvement_extrafields AS ef ON (ef.fk_object = t.rowid)";
    $sql .= " WHERE e.entity IN (".getEntity('stock').")";
 
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    // this query will return total stock movements with the filters given
    $sqlTotals = str_replace('SELECT t.rowid', 'SELECT count(t.rowid) as total', $sql);
 
    $sql .= $this->db->order($sortfield, $sortorder);
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit + 1, $offset);
    }
 
    $result = $this->db->query($sql);
    if ($result) {
      $i = 0;
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $stockmovement_static = new MouvementStock($this->db);
        if ($stockmovement_static->fetch($obj->rowid)) {
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($stockmovement_static), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve stock movement list : '.$this->db->lasterror());
    }
 
    // if $pagination_data is true the response will contain element data with all values and element pagination with pagination data(total,page,limit)
    if ($pagination_data) {
      $totalsResult = $this->db->query($sqlTotals);
      $total = $this->db->fetch_object($totalsResult)->total;
 
      $tmp = $obj_ret;
      $obj_ret = [];
 
      $obj_ret['data'] = $tmp;
      $obj_ret['pagination'] = [
        'total' => (int) $total,
        'page' => $page, //count starts from 0
        'page_count' => ceil((int) $total / $limit),
        'limit' => $limit
      ];
    }
 
    return $obj_ret;
  }
 
  public function post($product_id, $warehouse_id, $qty, $type = 2, $batch = '', $movementcode = '', $label = '', $price = '', $datem = '', $sellBy = '', $eatBy = '', $origin_type = '', $origin_id = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('stock', 'creer')) {
      throw new RestException(403);
    }
 
    if ($qty == 0) {
      throw new RestException(503, "Making a stock movement with a quantity of 0 is not possible");
    }
 
    // Type increase or decrease
    if ($type == 1 && $qty >= 0) {
      $type = 0;
    }
    if ($type == 2 && $qty >= 0) {
      $type = 3;
    }
 
    require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
    $dluo = empty($eatBy) ? '' : dol_stringtotime($eatBy);
    $dlc = empty($sellBy) ? '' : dol_stringtotime($sellBy);
    $dateMvt = empty($datem) ? '' : dol_stringtotime($datem);
 
    $this->stockmovement->setOrigin($origin_type, $origin_id);
    if ($this->stockmovement->_create(DolibarrApiAccess::$user, $product_id, $warehouse_id, $qty, $type, (float) $price, $label, $movementcode, $dateMvt, $dluo, $dlc, $batch) <= 0) {
      $errormessage = $this->stockmovement->error;
      if (empty($errormessage)) {
        $errormessage = implode(',', $this->stockmovement->errors);
      }
      throw new RestException(503, 'Error when create stock movement : '.$errormessage);
    }
 
    return $this->stockmovement->id;
  }
 
  /*
  public function put($id, $request_data = null)
  {
    if(! DolibarrApiAccess::$user->hasRight('stock', 'creer')) {
      throw new RestException(403);
    }
 
    $result = $this->stockmovement->fetch($id);
    if( ! $result ) {
      throw new RestException(404, 'stock movement not found');
    }
 
    if( ! DolibarrApi::_checkAccessToResource('stock', $this->stockmovement)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    foreach($request_data as $field => $value) {
      if ($field == 'id') continue;
      $this->stockmovement->$field = $this->_checkValForAPI($field, $value, $this->stockmovement);
    }
 
    if ($this->stockmovement->update($id, DolibarrApiAccess::$user)) {
      return $this->get ($id);
    }
 
    return false;
  }*/
 
  /*
  public function delete($id)
  {
    if (! DolibarrApiAccess::$user->hasRight('stock', 'supprimer')) {
      throw new RestException(403);
    }
    $result = $this->stockmovement->fetch($id);
    if (! $result ) {
      throw new RestException(404, 'stock movement not found');
    }
 
    if (! DolibarrApi::_checkAccessToResource('stock', $this->stockmovement)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if (! $this->stockmovement->delete(DolibarrApiAccess::$user)) {
      throw new RestException(403,'error when delete stock movement');
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Warehouse deleted'
      )
    );
  }*/
 
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    // Remove useless data
    unset($object->civility_id);
    unset($object->firstname);
    unset($object->lastname);
    unset($object->name);
    unset($object->location_incoterms);
    unset($object->label_incoterms);
    unset($object->fk_incoterms);
    unset($object->lines);
    unset($object->total_ht);
    unset($object->total_ttc);
    unset($object->total_tva);
    unset($object->total_localtax1);
    unset($object->total_localtax2);
    unset($object->note);
    unset($object->note_private);
    unset($object->note_public);
    unset($object->shipping_method_id);
    unset($object->fk_account);
    unset($object->model_pdf);
    unset($object->fk_delivery_address);
    unset($object->cond_reglement);
    unset($object->cond_reglement_id);
    unset($object->mode_reglement_id);
    unset($object->barcode_type_coder);
    unset($object->barcode_type_label);
    unset($object->barcode_type_code);
    unset($object->barcode_type);
    unset($object->country_code);
    unset($object->country_id);
    unset($object->country);
    unset($object->thirdparty);
    unset($object->contact);
    unset($object->contact_id);
    unset($object->user);
    unset($object->fk_project);
    unset($object->project);
    unset($object->canvas);
 
    //unset($object->eatby);        Filled correctly in read mode
    //unset($object->sellby);       Filled correctly in read mode
 
    return $object;
  }
 
  private function _validate($data) // @phpstan-ignore-line
  {
    if ($data === null) {
      $data = array();
    }
    $stockmovement = array();
    foreach (self::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $stockmovement[$field] = $data[$field];
    }
    return $stockmovement;
  }
}