api_supplier_orders.class.php

<?php
/* Copyright (C) 2015   Jean-François Ferry     <jfefe@aternatik.fr>
 * Copyright (C) 2016   Laurent Destailleur     <eldy@users.sourceforge.net>
 *
 * 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.'/fourn/class/fournisseur.commande.class.php';

class SupplierOrders extends DolibarrApi
{
  static $FIELDS = array(
    'socid'
  );

  public $order;

  public function __construct()
  {
    global $db, $conf;
    $this->db = $db;
    $this->order = new CommandeFournisseur($this->db);
  }

  public function get($id)
  {
    if (!DolibarrApiAccess::$user->rights->fournisseur->commande->lire) {
      throw new RestException(401);
    }

    $result = $this->order->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('fournisseur', $this->order->id, '', 'commande')) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $this->order->fetchObjectLinked();
    return $this->_cleanObjectDatas($this->order);
  }

  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $product_ids = '', $status = '', $sqlfilters = '')
  {
    global $db, $conf;

    $obj_ret = array();

    // case of external user, $thirdparty_ids param is ignored and replaced by user's socid
    $socids = DolibarrApiAccess::$user->socid ? DolibarrApiAccess::$user->socid : $thirdparty_ids;

    // If the internal user must only see his customers, force searching by him
    $search_sale = 0;
    if (!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) $search_sale = DolibarrApiAccess::$user->id;

    $sql = "SELECT t.rowid";
    if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) || $search_sale > 0) $sql .= ", sc.fk_soc, sc.fk_user"; // We need these fields in order to filter by sale (including the case where the user can only see his prospects)
    $sql .= " FROM ".MAIN_DB_PREFIX."commande_fournisseur as t";

    if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) || $search_sale > 0) $sql .= ", ".MAIN_DB_PREFIX."societe_commerciaux as sc"; // We need this table joined to the select in order to filter by sale

      if (!empty($product_ids)) $sql .= ", ".MAIN_DB_PREFIX."commande_fournisseurdet as cd"; // We need this table joined to the select in order to filter by product

    $sql .= ' WHERE t.entity IN ('.getEntity('supplier_order').')';
    if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) || $search_sale > 0) $sql .= " AND t.fk_soc = sc.fk_soc";
    if (!empty($product_ids)) $sql .= " AND cd.fk_commande = t.rowid AND cd.fk_product IN (".$product_ids.")";
    if ($socids) $sql .= " AND t.fk_soc IN (".$socids.")";
    if ($search_sale > 0) $sql .= " AND t.rowid = sc.fk_soc"; // Join for the needed table to filter by sale

    // Filter by status
    if ($status == 'draft')     $sql .= " AND t.fk_statut IN (0)";
    if ($status == 'validated') $sql .= " AND t.fk_statut IN (1)";
    if ($status == 'approved')  $sql .= " AND t.fk_statut IN (2)";
    if ($status == 'running')   $sql .= " AND t.fk_statut IN (3)";
    if ($status == 'received_start') $sql .= " AND t.fk_statut IN (4)";
    if ($status == 'received_end')   $sql .= " AND t.fk_statut IN (5)";
    if ($status == 'cancelled') $sql .= " AND t.fk_statut IN (6,7)";
    if ($status == 'refused')   $sql .= " AND t.fk_statut IN (9)";
    // Insert sale filter
    if ($search_sale > 0)
    {
      $sql .= " AND sc.fk_user = ".$search_sale;
    }
    // Add sql filters
    if ($sqlfilters)
    {
      if (!DolibarrApi::_checkFilters($sqlfilters))
      {
        throw new RestException(503, 'Error when validating parameter sqlfilters '.$sqlfilters);
      }
      $regexstring = '\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
      $sql .= " AND (".preg_replace_callback('/'.$regexstring.'/', 'DolibarrApi::_forge_criteria_callback', $sqlfilters).")";
    }

    $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);
        $order_static = new CommandeFournisseur($this->db);
        if ($order_static->fetch($obj->rowid)) {
          $obj_ret[] = $this->_cleanObjectDatas($order_static);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve supplier order list : '.$this->db->lasterror());
    }
    if (!count($obj_ret)) {
      throw new RestException(404, 'No supplier order found');
    }
    return $obj_ret;
  }

  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->fournisseur->commande->creer) {
      throw new RestException(401, "Insuffisant rights");
    }
    // Check mandatory fields
    $result = $this->_validate($request_data);

    foreach ($request_data as $field => $value) {
      $this->order->$field = $value;
    }
    if (!array_keys($request_data, 'date')) {
      $this->order->date = dol_now();
    }
    /* We keep lines as an array
         if (isset($request_data["lines"])) {
            $lines = array();
            foreach ($request_data["lines"] as $line) {
                array_push($lines, (object) $line);
            }
            $this->order->lines = $lines;
        }*/

    if ($this->order->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, "Error creating order", array_merge(array($this->order->error), $this->order->errors));
    }
    return $this->order->id;
  }

  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->rights->fournisseur->commande->creer) {
      throw new RestException(401);
    }

    $result = $this->order->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('fournisseur', $this->order->id, '', 'commande')) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    foreach ($request_data as $field => $value) {
      if ($field == 'id') continue;
      $this->order->$field = $value;
    }

    if ($this->order->update($id, DolibarrApiAccess::$user))
      return $this->get($id);

    return false;
  }

  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->rights->fournisseur->commande->supprimer) {
      throw new RestException(401);
    }
    $result = $this->order->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('fournisseur', $this->order->id, '', 'commande')) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    if ($this->order->delete(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500);
    }

    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Supplier order deleted'
      )
    );
  }


  public function validate($id, $idwarehouse = 0, $notrigger = 0)
  {
    if (!DolibarrApiAccess::$user->rights->fournisseur->commande->creer) {
      throw new RestException(401);
    }
    $result = $this->order->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Order not found');
    }

    if (!DolibarrApi::_checkAccessToResource('fournisseur', $this->order->id, '', 'commande')) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }

    $result = $this->order->valid(DolibarrApiAccess::$user, $idwarehouse, $notrigger);
    if ($result == 0) {
      throw new RestException(304, 'Error nothing done. May be object is already validated');
    }
    if ($result < 0) {
      throw new RestException(500, 'Error when validating Order: '.$this->order->error);
    }

    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Order validated (Ref='.$this->order->ref.')'
      )
    );
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);

    unset($object->rowid);
    unset($object->barcode_type);
    unset($object->barcode_type_code);
    unset($object->barcode_type_label);
    unset($object->barcode_type_coder);

    return $object;
  }

  private function _validate($data)
  {
    $order = array();
    foreach (SupplierOrders::$FIELDS as $field) {
      if (!isset($data[$field]))
        throw new RestException(400, "$field field missing");
      $order[$field] = $data[$field];
    }
    return $order;
  }
}