2015-05-05 01:44:46 +00:00
< ? php
/* Copyright ( C ) 2015 Jean - François Ferry < jfefe @ aternatik . fr >
2016-09-26 00:18:11 +00:00
* Copyright ( C ) 2016 Laurent Destailleur < eldy @ users . sourceforge . net >
2015-05-05 01:44:46 +00:00
*
* 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
2019-09-23 19:55:30 +00:00
* along with this program . If not , see < https :// www . gnu . org / licenses />.
2015-05-05 01:44:46 +00:00
*/
2019-03-06 17:04:36 +00:00
use Luracast\Restler\RestException ;
2015-05-05 01:44:46 +00:00
2019-03-06 17:04:36 +00:00
require_once DOL_DOCUMENT_ROOT . '/commande/class/commande.class.php' ;
2015-05-05 01:44:46 +00:00
/**
2016-06-14 22:52:09 +00:00
* API class for orders
2015-05-05 01:44:46 +00:00
*
2016-09-26 07:34:51 +00:00
* @ access protected
2015-05-05 01:44:46 +00:00
* @ class DolibarrApiAccess { @ requires user , external }
*/
2016-06-14 22:52:09 +00:00
class Orders extends DolibarrApi
2015-05-05 22:55:42 +00:00
{
2015-05-05 01:44:46 +00:00
/**
2016-09-26 07:34:51 +00:00
* @ var array $FIELDS Mandatory fields , checked when create and update object
2015-05-05 01:44:46 +00:00
*/
static $FIELDS = array (
'socid'
);
/**
* @ var Commande $commande { @ type Commande }
*/
public $commande ;
/**
* Constructor
*/
2019-02-24 23:56:48 +00:00
public function __construct ()
2015-05-05 01:44:46 +00:00
{
2019-02-24 23:56:48 +00:00
global $db , $conf ;
$this -> db = $db ;
2015-05-05 01:44:46 +00:00
$this -> commande = new Commande ( $this -> db );
}
/**
2017-10-19 10:30:36 +00:00
* Get properties of an order object
2015-05-05 01:44:46 +00:00
*
2017-10-19 10:30:36 +00:00
* Return an array with order informations
2016-09-26 07:34:51 +00:00
*
2019-02-12 16:54:59 +00:00
* @ param int $id ID of order
2019-02-13 15:39:45 +00:00
* @ param int $contact_list 0 : Returned array of contacts / addresses contains all properties , 1 : Return array contains just id
2015-05-05 01:44:46 +00:00
* @ return array | mixed data without useless information
2015-05-05 22:55:42 +00:00
*
2015-05-05 01:44:46 +00:00
* @ throws RestException
*/
2019-02-24 23:56:48 +00:00
public function get ( $id , $contact_list = 1 )
2016-09-26 07:34:51 +00:00
{
2015-05-05 01:44:46 +00:00
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> lire ) {
throw new RestException ( 401 );
}
2016-09-26 07:34:51 +00:00
2015-05-05 01:44:46 +00:00
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2016-09-26 07:34:51 +00:00
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2015-05-05 01:44:46 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
2016-09-26 07:34:51 +00:00
2018-05-29 08:04:20 +00:00
// Add external contacts ids
2019-02-12 16:54:59 +00:00
$this -> commande -> contacts_ids = $this -> commande -> liste_contact ( - 1 , 'external' , $contact_list );
2018-05-29 08:04:20 +00:00
$this -> commande -> fetchObjectLinked ();
2015-05-05 01:44:46 +00:00
return $this -> _cleanObjectDatas ( $this -> commande );
2018-05-29 08:04:20 +00:00
}
2015-05-05 01:44:46 +00:00
2017-07-28 08:16:17 +00:00
2015-05-05 01:44:46 +00:00
/**
* List orders
2016-09-26 07:34:51 +00:00
*
2015-05-05 01:44:46 +00:00
* Get a list of orders
2016-09-26 07:34:51 +00:00
*
2016-10-25 16:33:45 +00:00
* @ param string $sortfield Sort field
* @ param string $sortorder Sort order
* @ param int $limit Limit for list
* @ param int $page Page number
2019-08-30 15:14:59 +00:00
* @ param string $thirdparty_ids Thirdparty ids to filter orders of ( example '1' or '1,2,3' ) { @ pattern /^ [ 0 - 9 ,] * $ / i }
2016-10-25 16:33:45 +00:00
* @ param string $sqlfilters Other criteria to filter answers separated by a comma . Syntax example " (t.ref:like:'SO-%') and (t.date_creation:<:'20160101') "
* @ return array Array of order objects
2016-12-05 12:31:29 +00:00
*
2018-08-15 12:28:34 +00:00
* @ throws RestException
2015-05-05 01:44:46 +00:00
*/
2019-02-24 23:56:48 +00:00
public function index ( $sortfield = " t.rowid " , $sortorder = 'ASC' , $limit = 100 , $page = 0 , $thirdparty_ids = '' , $sqlfilters = '' )
2018-08-15 12:28:34 +00:00
{
2015-05-05 01:44:46 +00:00
global $db , $conf ;
2016-09-26 07:34:51 +00:00
2015-05-05 01:44:46 +00:00
$obj_ret = array ();
2017-07-28 08:16:17 +00:00
2016-12-07 18:02:39 +00:00
// case of external user, $thirdparty_ids param is ignored and replaced by user's socid
2019-09-06 08:53:05 +00:00
$socids = DolibarrApiAccess :: $user -> socid ? DolibarrApiAccess :: $user -> socid : $thirdparty_ids ;
2016-09-26 07:34:51 +00:00
2015-05-05 01:44:46 +00:00
// If the internal user must only see his customers, force searching by him
2016-12-07 18:02:39 +00:00
$search_sale = 0 ;
2016-09-09 18:05:45 +00:00
if ( ! DolibarrApiAccess :: $user -> rights -> societe -> client -> voir && ! $socids ) $search_sale = DolibarrApiAccess :: $user -> id ;
2015-05-05 01:44:46 +00:00
2016-10-25 16:33:45 +00:00
$sql = " SELECT t.rowid " ;
2016-09-09 18:05:45 +00:00
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)
2016-10-25 16:33:45 +00:00
$sql .= " FROM " . MAIN_DB_PREFIX . " commande as t " ;
2016-09-26 07:34:51 +00:00
2016-09-09 18:05:45 +00:00
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
2015-05-05 01:44:46 +00:00
2017-05-30 16:50:54 +00:00
$sql .= ' WHERE t.entity IN (' . getEntity ( 'commande' ) . ')' ;
2016-10-25 16:33:45 +00:00
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 ( " . $socids . " ) " ;
if ( $search_sale > 0 ) $sql .= " AND t.rowid = sc.fk_soc " ; // Join for the needed table to filter by sale
2015-05-05 01:44:46 +00:00
// Insert sale filter
if ( $search_sale > 0 )
{
$sql .= " AND sc.fk_user = " . $search_sale ;
}
2016-10-25 16:33:45 +00:00
// Add sql filters
2017-07-28 08:16:17 +00:00
if ( $sqlfilters )
2015-05-05 01:44:46 +00:00
{
2016-10-25 16:33:45 +00:00
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 ) . " ) " ;
2015-05-05 01:44:46 +00:00
}
2017-07-28 08:16:17 +00:00
2015-05-05 01:44:46 +00:00
$sql .= $db -> order ( $sortfield , $sortorder );
if ( $limit ) {
if ( $page < 0 )
{
$page = 0 ;
}
$offset = $limit * $page ;
$sql .= $db -> plimit ( $limit + 1 , $offset );
}
2016-10-25 16:33:45 +00:00
dol_syslog ( " API Rest request " );
2015-05-05 01:44:46 +00:00
$result = $db -> query ( $sql );
2016-09-26 07:34:51 +00:00
2015-05-05 01:44:46 +00:00
if ( $result )
{
$num = $db -> num_rows ( $result );
2017-05-22 08:45:02 +00:00
$min = min ( $num , ( $limit <= 0 ? $num : $limit ));
2018-02-01 09:51:01 +00:00
$i = 0 ;
2017-05-22 08:45:02 +00:00
while ( $i < $min )
2015-05-05 01:44:46 +00:00
{
$obj = $db -> fetch_object ( $result );
$commande_static = new Commande ( $db );
if ( $commande_static -> fetch ( $obj -> rowid )) {
2018-05-29 08:04:20 +00:00
// Add external contacts ids
2019-01-27 10:55:16 +00:00
$commande_static -> contacts_ids = $commande_static -> liste_contact ( - 1 , 'external' , 1 );
2016-12-05 12:31:29 +00:00
$obj_ret [] = $this -> _cleanObjectDatas ( $commande_static );
2015-05-05 01:44:46 +00:00
}
$i ++ ;
}
}
else {
2016-12-05 12:31:29 +00:00
throw new RestException ( 503 , 'Error when retrieve commande list : ' . $db -> lasterror ());
2015-05-05 01:44:46 +00:00
}
if ( ! count ( $obj_ret )) {
2016-07-29 00:28:51 +00:00
throw new RestException ( 404 , 'No order found' );
2015-05-05 01:44:46 +00:00
}
return $obj_ret ;
}
2016-04-10 11:57:53 +00:00
2015-05-05 01:44:46 +00:00
/**
* Create order object
*
2016-06-14 22:52:09 +00:00
* @ param array $request_data Request data
2017-10-19 10:30:36 +00:00
* @ return int ID of order
2015-05-05 01:44:46 +00:00
*/
2019-02-24 23:56:48 +00:00
public function post ( $request_data = null )
2015-05-05 01:44:46 +00:00
{
2018-08-09 09:31:48 +00:00
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
throw new RestException ( 401 , " Insuffisant rights " );
2019-02-24 23:56:48 +00:00
}
2015-05-05 01:44:46 +00:00
// Check mandatory fields
$result = $this -> _validate ( $request_data );
2016-04-11 16:07:02 +00:00
2015-05-05 01:44:46 +00:00
foreach ( $request_data as $field => $value ) {
$this -> commande -> $field = $value ;
}
2016-07-29 00:28:51 +00:00
/* if ( isset ( $request_data [ " lines " ])) {
2016-04-11 16:07:02 +00:00
$lines = array ();
foreach ( $request_data [ " lines " ] as $line ) {
2016-04-11 21:27:43 +00:00
array_push ( $lines , ( object ) $line );
2016-04-11 16:07:02 +00:00
}
$this -> commande -> lines = $lines ;
2016-07-29 00:28:51 +00:00
} */
2017-10-19 17:06:48 +00:00
2016-12-23 01:08:22 +00:00
if ( $this -> commande -> create ( DolibarrApiAccess :: $user ) < 0 ) {
throw new RestException ( 500 , " Error creating order " , array_merge ( array ( $this -> commande -> error ), $this -> commande -> errors ));
2015-05-05 01:44:46 +00:00
}
2016-09-26 07:34:51 +00:00
2016-04-11 16:07:02 +00:00
return $this -> commande -> id ;
}
2016-06-14 22:52:09 +00:00
2016-04-11 20:41:35 +00:00
/**
* Get lines of an order
*
* @ param int $id Id of order
2016-09-26 07:34:51 +00:00
*
2016-06-14 22:52:09 +00:00
* @ url GET { id } / lines
2016-09-26 07:34:51 +00:00
*
* @ return int
2016-04-11 20:41:35 +00:00
*/
2019-02-24 23:56:48 +00:00
public function getLines ( $id )
2018-08-15 12:28:34 +00:00
{
2018-08-09 09:31:48 +00:00
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> lire ) {
throw new RestException ( 401 );
}
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
$this -> commande -> getLinesArray ();
$result = array ();
foreach ( $this -> commande -> lines as $line ) {
2019-01-27 10:55:16 +00:00
array_push ( $result , $this -> _cleanObjectDatas ( $line ));
2018-08-09 09:31:48 +00:00
}
return $result ;
2016-04-11 20:41:35 +00:00
}
2016-06-14 22:52:09 +00:00
2016-04-11 16:07:02 +00:00
/**
* Add a line to given order
*
2017-10-19 10:30:36 +00:00
* @ param int $id Id of order to update
* @ param array $request_data OrderLine data
2016-09-26 07:34:51 +00:00
*
2016-06-14 22:52:09 +00:00
* @ url POST { id } / lines
2016-09-26 07:34:51 +00:00
*
* @ return int
2016-04-11 16:07:02 +00:00
*/
2019-02-24 23:56:48 +00:00
public function postLine ( $id , $request_data = null )
2018-08-15 12:28:34 +00:00
{
2018-08-09 09:31:48 +00:00
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
throw new RestException ( 401 );
}
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
$request_data = ( object ) $request_data ;
$updateRes = $this -> commande -> addline (
2016-04-11 16:07:02 +00:00
$request_data -> desc ,
$request_data -> subprice ,
$request_data -> qty ,
$request_data -> tva_tx ,
$request_data -> localtax1_tx ,
$request_data -> localtax2_tx ,
$request_data -> fk_product ,
$request_data -> remise_percent ,
$request_data -> info_bits ,
$request_data -> fk_remise_except ,
'HT' ,
0 ,
$request_data -> date_start ,
$request_data -> date_end ,
$request_data -> product_type ,
$request_data -> rang ,
$request_data -> special_code ,
2018-02-01 09:51:01 +00:00
$request_data -> fk_parent_line ,
2016-04-11 16:07:02 +00:00
$request_data -> fk_fournprice ,
$request_data -> pa_ht ,
$request_data -> label ,
$request_data -> array_options ,
$request_data -> fk_unit ,
2017-10-19 10:30:36 +00:00
$request_data -> origin ,
$request_data -> origin_id ,
$request_data -> multicurrency_subprice
2018-08-09 09:31:48 +00:00
);
2016-04-11 16:07:02 +00:00
2018-08-09 09:31:48 +00:00
if ( $updateRes > 0 ) {
return $updateRes ;
} else {
2019-02-28 21:07:48 +00:00
throw new RestException ( 400 , $this -> commande -> error );
2018-08-09 09:31:48 +00:00
}
2016-04-11 20:41:35 +00:00
}
2016-06-14 22:52:09 +00:00
2016-04-11 20:41:35 +00:00
/**
* Update a line to given order
*
2017-10-19 10:30:36 +00:00
* @ param int $id Id of order to update
2016-04-11 20:41:35 +00:00
* @ param int $lineid Id of line to update
2017-10-19 10:30:36 +00:00
* @ param array $request_data OrderLine data
2016-09-26 07:34:51 +00:00
*
2016-06-14 22:52:09 +00:00
* @ url PUT { id } / lines / { lineid }
2016-09-26 07:34:51 +00:00
*
2019-09-30 19:41:07 +00:00
* @ return array | bool
2016-04-11 20:41:35 +00:00
*/
2019-02-24 23:56:48 +00:00
public function putLine ( $id , $lineid , $request_data = null )
2018-08-15 12:28:34 +00:00
{
2018-08-09 09:31:48 +00:00
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
throw new RestException ( 401 );
}
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
$request_data = ( object ) $request_data ;
$updateRes = $this -> commande -> updateline (
$lineid ,
$request_data -> desc ,
$request_data -> subprice ,
$request_data -> qty ,
$request_data -> remise_percent ,
$request_data -> tva_tx ,
$request_data -> localtax1_tx ,
$request_data -> localtax2_tx ,
'HT' ,
$request_data -> info_bits ,
$request_data -> date_start ,
$request_data -> date_end ,
$request_data -> product_type ,
$request_data -> fk_parent_line ,
0 ,
$request_data -> fk_fournprice ,
$request_data -> pa_ht ,
$request_data -> label ,
$request_data -> special_code ,
$request_data -> array_options ,
$request_data -> fk_unit ,
$request_data -> multicurrency_subprice
);
if ( $updateRes > 0 ) {
$result = $this -> get ( $id );
unset ( $result -> line );
return $this -> _cleanObjectDatas ( $result );
}
return false ;
2016-04-11 20:41:35 +00:00
}
2016-06-14 22:52:09 +00:00
2016-04-11 20:41:35 +00:00
/**
* Delete a line to given order
*
*
2017-10-07 12:11:01 +00:00
* @ param int $id Id of order to update
2016-04-11 20:41:35 +00:00
* @ param int $lineid Id of line to delete
2016-09-26 07:34:51 +00:00
*
2016-06-14 22:52:09 +00:00
* @ url DELETE { id } / lines / { lineid }
2016-09-26 07:34:51 +00:00
*
* @ return int
2017-10-07 12:11:01 +00:00
* @ throws 401
* @ throws 404
2016-04-11 20:41:35 +00:00
*/
2019-02-24 23:56:48 +00:00
public function deleteLine ( $id , $lineid )
2018-08-15 12:28:34 +00:00
{
2018-08-09 09:31:48 +00:00
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
throw new RestException ( 401 );
}
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
// TODO Check the lineid $lineid is a line of ojbect
2019-01-27 10:55:16 +00:00
$updateRes = $this -> commande -> deleteline ( DolibarrApiAccess :: $user , $lineid );
2018-08-09 09:31:48 +00:00
if ( $updateRes > 0 ) {
return $this -> get ( $id );
} else {
throw new RestException ( 405 , $this -> commande -> error );
}
2015-05-05 01:44:46 +00:00
}
2019-02-24 23:56:48 +00:00
2019-02-13 23:36:35 +00:00
/**
* Add a contact type of given order
*
* @ param int $id Id of order to update
* @ param int $contactid Id of contact to add
* @ param string $type Type of the contact ( BILLING , SHIPPING , CUSTOMER )
*
* @ url POST { id } / contact / { contactid } / { type }
*
* @ return int
* @ throws 401
* @ throws 404
*/
2019-02-24 23:56:48 +00:00
public function postContact ( $id , $contactid , $type )
2019-02-13 23:36:35 +00:00
{
2019-06-16 12:18:26 +00:00
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
throw new RestException ( 401 );
2019-02-13 23:36:35 +00:00
}
2019-06-16 12:18:26 +00:00
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
2019-02-13 23:36:35 +00:00
}
2019-06-16 12:18:26 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2019-02-13 23:36:35 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
$result = $this -> commande -> add_contact ( $contactid , $type , 'external' );
if ( ! $result ) {
throw new RestException ( 500 , 'Error when added the contact' );
}
return $this -> commande ;
}
/**
* Delete a contact type of given order
*
2019-02-13 23:42:00 +00:00
* @ param int $id Id of order to update
2019-02-13 23:36:35 +00:00
* @ param int $rowid Row key of the contact in the array contact_ids .
*
* @ url DELETE { id } / contact / { rowid }
*
* @ return int
* @ throws 401
* @ throws 404
* @ throws 500
*/
2019-02-24 23:56:48 +00:00
public function deleteContact ( $id , $rowid )
2019-02-13 23:36:35 +00:00
{
2019-06-16 12:18:26 +00:00
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
throw new RestException ( 401 );
}
2019-02-13 23:36:35 +00:00
$result = $this -> commande -> fetch ( $id );
2019-06-16 12:18:26 +00:00
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2019-02-13 23:36:35 +00:00
2019-06-16 12:18:26 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2019-02-13 23:36:35 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
$result = $this -> commande -> delete_contact ( $rowid );
if ( ! $result ) {
throw new RestException ( 500 , 'Error when deleted the contact' );
}
return $this -> commande ;
}
2015-05-05 01:44:46 +00:00
/**
2016-04-11 20:41:35 +00:00
* Update order general fields ( won ' t touch lines of order )
2015-05-05 01:44:46 +00:00
*
2017-10-18 13:34:03 +00:00
* @ param int $id Id of order to update
2016-09-26 07:34:51 +00:00
* @ param array $request_data Datas
*
* @ return int
2015-05-05 01:44:46 +00:00
*/
2019-02-24 23:56:48 +00:00
public function put ( $id , $request_data = null )
2018-08-15 12:28:34 +00:00
{
2018-08-09 09:31:48 +00:00
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
throw new RestException ( 401 );
}
2016-09-26 07:34:51 +00:00
2015-05-05 01:44:46 +00:00
$result = $this -> commande -> fetch ( $id );
2017-11-14 00:19:04 +00:00
if ( ! $result ) {
2017-10-19 17:06:48 +00:00
throw new RestException ( 404 , 'Order not found' );
2015-05-05 01:44:46 +00:00
}
2016-09-26 07:34:51 +00:00
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2015-05-05 01:44:46 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
foreach ( $request_data as $field => $value ) {
2016-11-19 15:08:27 +00:00
if ( $field == 'id' ) continue ;
2015-05-05 01:44:46 +00:00
$this -> commande -> $field = $value ;
}
2016-09-26 07:34:51 +00:00
2017-12-01 14:39:18 +00:00
// Update availability
if ( ! empty ( $this -> commande -> availability_id )) {
if ( $this -> commande -> availability ( $this -> commande -> availability_id ) < 0 )
throw new RestException ( 400 , 'Error while updating availability' );
}
2017-12-19 13:16:51 +00:00
2017-12-01 14:39:18 +00:00
if ( $this -> commande -> update ( DolibarrApiAccess :: $user ) > 0 )
{
2016-04-11 16:07:02 +00:00
return $this -> get ( $id );
2017-12-01 14:39:18 +00:00
}
else
{
2017-12-21 15:50:18 +00:00
throw new RestException ( 500 , $this -> commande -> error );
2017-12-01 14:39:18 +00:00
}
2015-05-05 01:44:46 +00:00
}
2016-09-26 07:34:51 +00:00
2015-05-05 01:44:46 +00:00
/**
2015-05-05 22:55:42 +00:00
* Delete order
2015-05-05 01:44:46 +00:00
*
2015-05-05 22:55:42 +00:00
* @ param int $id Order ID
* @ return array
2015-05-05 01:44:46 +00:00
*/
2019-02-24 23:56:48 +00:00
public function delete ( $id )
2015-05-05 01:44:46 +00:00
{
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> supprimer ) {
throw new RestException ( 401 );
}
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2016-09-26 07:34:51 +00:00
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2015-05-05 01:44:46 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
2016-09-26 07:34:51 +00:00
2015-05-05 01:44:46 +00:00
if ( ! $this -> commande -> delete ( DolibarrApiAccess :: $user )) {
2019-03-06 17:04:36 +00:00
throw new RestException ( 500 , 'Error when deleting order : ' . $this -> commande -> error );
2015-05-05 01:44:46 +00:00
}
2016-09-26 07:34:51 +00:00
2015-05-05 01:44:46 +00:00
return array (
'success' => array (
'code' => 200 ,
'message' => 'Order deleted'
)
);
}
2016-09-26 07:34:51 +00:00
2015-05-05 01:44:46 +00:00
/**
* Validate an order
2017-12-28 11:43:26 +00:00
*
2018-02-03 19:58:26 +00:00
* If you get a bad value for param notrigger check , provide this in body
2017-12-28 11:43:26 +00:00
* {
* " idwarehouse " : 0 ,
* " notrigger " : 0
* }
2016-09-26 07:34:51 +00:00
*
2015-05-05 22:55:42 +00:00
* @ param int $id Order ID
* @ param int $idwarehouse Warehouse ID
2016-09-24 05:18:38 +00:00
* @ param int $notrigger 1 = Does not execute triggers , 0 = execute triggers
2016-09-24 21:06:09 +00:00
*
2016-06-17 15:42:46 +00:00
* @ url POST { id } / validate
2017-12-28 11:43:26 +00:00
*
* @ throws 304
* @ throws 401
* @ throws 404
* @ throws 500
2016-09-26 07:34:51 +00:00
*
2015-05-05 22:55:42 +00:00
* @ return array
2015-05-05 01:44:46 +00:00
*/
2019-02-24 23:56:48 +00:00
public function validate ( $id , $idwarehouse = 0 , $notrigger = 0 )
2015-05-05 01:44:46 +00:00
{
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
throw new RestException ( 401 );
}
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2016-09-26 07:34:51 +00:00
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2015-05-05 01:44:46 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
2016-09-26 07:34:51 +00:00
2016-09-22 10:53:44 +00:00
$result = $this -> commande -> valid ( DolibarrApiAccess :: $user , $idwarehouse , $notrigger );
if ( $result == 0 ) {
2017-11-14 00:21:06 +00:00
throw new RestException ( 304 , 'Error nothing done. May be object is already validated' );
2016-09-22 10:53:44 +00:00
}
if ( $result < 0 ) {
2017-11-14 00:21:06 +00:00
throw new RestException ( 500 , 'Error when validating Order: ' . $this -> commande -> error );
2016-09-22 10:53:44 +00:00
}
2017-12-28 11:43:26 +00:00
$result = $this -> commande -> fetch ( $id );
2017-11-10 14:46:53 +00:00
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2016-09-26 07:34:51 +00:00
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2017-11-10 14:46:53 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
2017-12-28 11:43:26 +00:00
}
2017-11-10 14:46:53 +00:00
$this -> commande -> fetchObjectLinked ();
2017-12-28 11:43:26 +00:00
2017-11-10 14:46:53 +00:00
return $this -> _cleanObjectDatas ( $this -> commande );
2015-05-05 01:44:46 +00:00
}
2016-09-26 07:34:51 +00:00
2017-12-28 11:43:26 +00:00
/**
2017-11-15 09:55:39 +00:00
* Tag the order as validated ( opened )
*
* Function used when order is reopend after being closed .
*
* @ param int $id Id of the order
*
* @ url POST { id } / reopen
*
* @ return int
2017-12-21 15:50:18 +00:00
*
2017-11-15 09:55:39 +00:00
* @ throws 304
* @ throws 400
* @ throws 401
* @ throws 404
* @ throws 405
*/
2019-02-24 23:56:48 +00:00
public function reopen ( $id )
2018-08-15 12:28:34 +00:00
{
2017-11-15 09:55:39 +00:00
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 401 );
2017-12-21 15:50:18 +00:00
}
2017-11-15 09:55:39 +00:00
if ( empty ( $id )) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 400 , 'Order ID is mandatory' );
2017-11-15 09:55:39 +00:00
}
2017-11-15 11:14:28 +00:00
$result = $this -> commande -> fetch ( $id );
2017-11-15 09:55:39 +00:00
if ( ! $result ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 404 , 'Order not found' );
2017-11-15 09:55:39 +00:00
}
$result = $this -> commande -> set_reopen ( DolibarrApiAccess :: $user );
if ( $result < 0 ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 405 , $this -> commande -> error );
2019-01-27 09:49:34 +00:00
} elseif ( $result == 0 ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 304 );
2017-11-15 09:55:39 +00:00
}
2017-12-28 11:43:26 +00:00
2017-11-15 09:55:39 +00:00
return $result ;
}
2017-11-15 11:14:28 +00:00
/**
2018-01-04 20:14:45 +00:00
* Classify the order as invoiced . Could be also called setbilled
2017-11-15 11:14:28 +00:00
*
* @ param int $id Id of the order
*
* @ url POST { id } / setinvoiced
*
* @ return int
2017-12-21 15:50:18 +00:00
*
2017-11-15 11:14:28 +00:00
* @ throws 400
* @ throws 401
* @ throws 404
* @ throws 405
*/
2019-02-24 23:56:48 +00:00
public function setinvoiced ( $id )
2018-08-15 12:28:34 +00:00
{
2017-11-15 11:14:28 +00:00
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 401 );
2017-12-21 15:50:18 +00:00
}
2017-11-15 11:14:28 +00:00
if ( empty ( $id )) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 400 , 'Order ID is mandatory' );
2017-11-15 11:14:28 +00:00
}
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 404 , 'Order not found' );
2017-11-15 11:14:28 +00:00
}
2017-12-19 12:06:28 +00:00
$result = $this -> commande -> classifyBilled ( DolibarrApiAccess :: $user );
2017-11-15 11:14:28 +00:00
if ( $result < 0 ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 400 , $this -> commande -> error );
2017-11-15 11:14:28 +00:00
}
2018-01-04 20:14:45 +00:00
2018-01-05 01:01:57 +00:00
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2018-01-05 01:01:57 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
$this -> commande -> fetchObjectLinked ();
return $this -> _cleanObjectDatas ( $this -> commande );
2017-11-15 11:14:28 +00:00
}
2017-10-18 13:34:03 +00:00
/**
* Close an order ( Classify it as " Delivered " )
*
* @ param int $id Order ID
* @ param int $notrigger Disabled triggers
*
* @ url POST { id } / close
*
2017-12-28 11:43:26 +00:00
* @ return int
2017-10-18 13:34:03 +00:00
*/
2019-02-24 23:56:48 +00:00
public function close ( $id , $notrigger = 0 )
2017-10-18 13:34:03 +00:00
{
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
throw new RestException ( 401 );
}
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2017-10-18 13:34:03 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
$result = $this -> commande -> cloture ( DolibarrApiAccess :: $user , $notrigger );
if ( $result == 0 ) {
2017-11-14 00:26:02 +00:00
throw new RestException ( 304 , 'Error nothing done. May be object is already closed' );
2017-10-18 13:34:03 +00:00
}
if ( $result < 0 ) {
throw new RestException ( 500 , 'Error when closing Order: ' . $this -> commande -> error );
}
2018-01-05 01:01:57 +00:00
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2018-01-05 01:01:57 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
$this -> commande -> fetchObjectLinked ();
return $this -> _cleanObjectDatas ( $this -> commande );
2017-10-18 13:34:03 +00:00
}
2017-11-10 15:22:20 +00:00
/**
* Set an order to draft
*
* @ param int $id Order ID
2017-11-14 00:29:28 +00:00
* @ param int $idwarehouse Warehouse ID to use for stock change ( Used only if option STOCK_CALCULATE_ON_VALIDATE_ORDER is on )
2017-11-10 15:22:20 +00:00
*
* @ url POST { id } / settodraft
*
* @ return array
*/
2019-02-24 23:56:48 +00:00
public function settodraft ( $id , $idwarehouse = - 1 )
2017-11-10 15:22:20 +00:00
{
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 401 );
2017-11-10 15:22:20 +00:00
}
$result = $this -> commande -> fetch ( $id );
if ( ! $result ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 404 , 'Order not found' );
2017-11-10 15:22:20 +00:00
}
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
2017-11-10 15:22:20 +00:00
}
2019-03-15 19:42:49 +00:00
$result = $this -> commande -> setDraft ( DolibarrApiAccess :: $user , $idwarehouse );
2017-11-10 15:22:20 +00:00
if ( $result == 0 ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 304 , 'Nothing done. May be object is already closed' );
2017-11-10 15:22:20 +00:00
}
if ( $result < 0 ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 500 , 'Error when closing Order: ' . $this -> commande -> error );
2017-11-10 15:22:20 +00:00
}
2017-11-14 00:29:28 +00:00
$result = $this -> commande -> fetch ( $id );
2017-11-10 15:22:20 +00:00
if ( ! $result ) {
throw new RestException ( 404 , 'Order not found' );
}
2019-01-27 10:55:16 +00:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'commande' , $this -> commande -> id )) {
2017-11-10 15:22:20 +00:00
throw new RestException ( 401 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
$this -> commande -> fetchObjectLinked ();
2017-12-28 11:43:26 +00:00
2017-11-10 15:22:20 +00:00
return $this -> _cleanObjectDatas ( $this -> commande );
}
2017-10-18 13:34:03 +00:00
2018-08-15 12:28:34 +00:00
/**
* Create an order using an existing proposal .
*
*
* @ param int $proposalid Id of the proposal
*
* @ url POST / createfromproposal / { proposalid }
*
* @ return int
* @ throws 400
* @ throws 401
* @ throws 404
* @ throws 405
*/
2019-02-24 23:56:48 +00:00
public function createOrderFromProposal ( $proposalid )
2018-08-15 12:28:34 +00:00
{
2017-12-18 15:13:54 +00:00
require_once DOL_DOCUMENT_ROOT . '/comm/propal/class/propal.class.php' ;
if ( ! DolibarrApiAccess :: $user -> rights -> propal -> lire ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 401 );
2017-12-18 15:13:54 +00:00
}
if ( ! DolibarrApiAccess :: $user -> rights -> commande -> creer ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 401 );
2017-12-18 15:13:54 +00:00
}
if ( empty ( $proposalid )) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 400 , 'Proposal ID is mandatory' );
2017-12-18 15:13:54 +00:00
}
$propal = new Propal ( $this -> db );
$result = $propal -> fetch ( $proposalid );
if ( ! $result ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 404 , 'Proposal not found' );
2017-12-18 15:13:54 +00:00
}
$result = $this -> commande -> createFromProposal ( $propal , DolibarrApiAccess :: $user );
if ( $result < 0 ) {
2018-08-09 09:31:48 +00:00
throw new RestException ( 405 , $this -> commande -> error );
2017-12-18 15:13:54 +00:00
}
$this -> commande -> fetchObjectLinked ();
2017-12-28 11:43:26 +00:00
2017-12-18 15:13:54 +00:00
return $this -> _cleanObjectDatas ( $this -> commande );
}
2019-03-04 18:57:46 +00:00
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
2017-05-16 16:12:10 +00:00
/**
* Clean sensible object datas
*
* @ param object $object Object to clean
* @ return array Array of cleaned object properties
*/
2019-03-04 18:57:46 +00:00
protected function _cleanObjectDatas ( $object )
2018-08-15 12:28:34 +00:00
{
2019-03-04 18:57:46 +00:00
// phpcs:enable
2017-05-16 16:12:10 +00:00
$object = parent :: _cleanObjectDatas ( $object );
2017-07-28 08:16:17 +00:00
2017-11-06 10:06:31 +00:00
unset ( $object -> note );
2017-05-16 16:12:10 +00:00
unset ( $object -> address );
2017-10-18 13:34:03 +00:00
unset ( $object -> barcode_type );
unset ( $object -> barcode_type_code );
unset ( $object -> barcode_type_label );
unset ( $object -> barcode_type_coder );
2017-07-28 08:16:17 +00:00
2017-05-16 16:12:10 +00:00
return $object ;
}
2017-07-28 08:16:17 +00:00
2015-05-05 01:44:46 +00:00
/**
* Validate fields before create or update object
2016-09-26 07:34:51 +00:00
*
2015-05-05 22:55:42 +00:00
* @ param array $data Array with data to verify
2016-09-26 07:34:51 +00:00
* @ return array
2015-05-05 22:55:42 +00:00
* @ throws RestException
2015-05-05 01:44:46 +00:00
*/
2019-02-24 23:56:48 +00:00
private function _validate ( $data )
2015-05-05 01:44:46 +00:00
{
$commande = array ();
2016-06-14 22:52:09 +00:00
foreach ( Orders :: $FIELDS as $field ) {
2015-05-05 01:44:46 +00:00
if ( ! isset ( $data [ $field ]))
2018-08-09 09:31:48 +00:00
throw new RestException ( 400 , $field . " field missing " );
2015-05-05 01:44:46 +00:00
$commande [ $field ] = $data [ $field ];
}
return $commande ;
}
}