api_supplier_proposals.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.'/supplier_proposal/class/supplier_proposal.class.php';
 
 
class SupplierProposals extends DolibarrApi
{
 
  public static $FIELDS = array(
    'socid'
  );
 
  public $supplier_proposal;
 
  public function __construct()
  {
    global $db, $conf;
    $this->db = $db;
    $this->supplier_proposal = new SupplierProposal($this->db);
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->rights->supplier_proposal->lire) {
      throw new RestException(401);
    }
 
    $result = $this->supplier_proposal->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Supplier Proposal not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('supplier_proposal', $this->supplier_proposal->id)) {
      throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $this->supplier_proposal->fetchObjectLinked();
    return $this->_cleanObjectDatas($this->supplier_proposal);
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $sqlfilters = '')
  {
    global $db, $conf;
 
    if (!DolibarrApiAccess::$user->rights->supplier_proposal->lire) {
      throw new RestException(401);
    }
 
    $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."supplier_proposal AS t LEFT JOIN ".MAIN_DB_PREFIX."supplier_proposal_extrafields AS ef ON (ef.fk_object = t.rowid)"; // Modification VMR Global Solutions to include extrafields as search parameters in the API GET call, so we will be able to filter on extrafields
 
    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
    }
 
    $sql .= ' WHERE t.entity IN ('.getEntity('propal').')';
    if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) || $search_sale > 0) {
      $sql .= " AND t.fk_soc = sc.fk_soc";
    }
    if ($socids) {
      $sql .= " AND t.fk_soc IN (".$this->db->sanitize($socids).")";
    }
    if ($search_sale > 0) {
      $sql .= " AND t.rowid = sc.fk_soc"; // Join for the needed table to filter by sale
    }
    // Insert sale filter
    if ($search_sale > 0) {
      $sql .= " AND sc.fk_user = ".((int) $search_sale);
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $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) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      $i = 0;
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $propal_static = new SupplierProposal($this->db);
        if ($propal_static->fetch($obj->rowid)) {
          $obj_ret[] = $this->_cleanObjectDatas($propal_static);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieving supplier proposal list : '.$this->db->lasterror());
    }
    if (!count($obj_ret)) {
      throw new RestException(404, 'No supplier proposal found');
    }
    return $obj_ret;
  }
 
 
  private function _validate($data)
  {
    $propal = array();
    foreach (SupplierProposals::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $propal[$field] = $data[$field];
    }
    return $propal;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->name);
    unset($object->lastname);
    unset($object->firstname);
    unset($object->civility_id);
    unset($object->address);
    unset($object->datec);
    unset($object->datev);
 
    return $object;
  }
}