/
api_receptions.class.php
740 lines (650 loc) · 21.5 KB
/
api_receptions.class.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
<?php
/* Copyright (C) 2022 Quatadah Nasdami <quatadah.nasdami@gmail.com>
* Copyright (C) 2022 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.'/reception/class/reception.class.php';
require_once DOL_DOCUMENT_ROOT.'/reception/class/receptionlinebatch.class.php';
/**
* API class for receptions
*
* @access protected
* @class DolibarrApiAccess {@requires user,external}
*/
class Receptions extends DolibarrApi
{
/**
* @var array $FIELDS Mandatory fields, checked when create and update object
*/
public static $FIELDS = array(
'socid',
'origin_id',
'origin_type',
);
/**
* @var Reception $reception {@type Reception}
*/
public $reception;
/**
* Constructor
*/
public function __construct()
{
global $db, $conf;
$this->db = $db;
$this->reception = new Reception($this->db);
}
/**
* Get properties of a reception object
*
* Return an array with reception information
*
* @param int $id ID of reception
* @return Object Object with cleaned properties
* @throws RestException
*/
public function get($id)
{
if (!DolibarrApiAccess::$user->hasRight('reception', 'lire')) {
throw new RestException(403);
}
$result = $this->reception->fetch($id);
if (!$result) {
throw new RestException(404, 'Reception not found');
}
if (!DolibarrApi::_checkAccessToResource('reception', $this->reception->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$this->reception->fetchObjectLinked();
return $this->_cleanObjectDatas($this->reception);
}
/**
* List receptions
*
* Get a list of receptions
*
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Limit for list
* @param int $page Page number
* @param string $thirdparty_ids Thirdparty ids to filter receptions of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
* @param string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
* @param string $properties Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
* @return array Array of reception objects
*
* @throws RestException
*/
public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $sqlfilters = '', $properties = '')
{
if (!DolibarrApiAccess::$user->hasRight('reception', 'lire')) {
throw new RestException(403);
}
$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->hasRight('societe', 'client', 'voir') && !$socids) {
$search_sale = DolibarrApiAccess::$user->id;
}
$sql = "SELECT t.rowid";
$sql .= " FROM ".MAIN_DB_PREFIX."reception AS t";
$sql .= " LEFT JOIN ".MAIN_DB_PREFIX."reception_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
$sql .= ' WHERE t.entity IN ('.getEntity('reception').')';
if ($socids) {
$sql .= " AND t.fk_soc IN (".$this->db->sanitize($socids).")";
}
// Search on sale representative
if ($search_sale && $search_sale != '-1') {
if ($search_sale == -2) {
$sql .= " AND NOT EXISTS (SELECT sc.fk_soc FROM ".MAIN_DB_PREFIX."societe_commerciaux as sc WHERE sc.fk_soc = t.fk_soc)";
} elseif ($search_sale > 0) {
$sql .= " AND EXISTS (SELECT sc.fk_soc FROM ".MAIN_DB_PREFIX."societe_commerciaux as sc WHERE sc.fk_soc = t.fk_soc 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);
}
dol_syslog("API Rest request");
$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);
$reception_static = new Reception($this->db);
if ($reception_static->fetch($obj->rowid)) {
$obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($reception_static), $properties);
}
$i++;
}
} else {
throw new RestException(503, 'Error when retrieve commande list : '.$this->db->lasterror());
}
return $obj_ret;
}
/**
* Create reception object
*
* @param array $request_data Request data
* @return int ID of reception created
*/
public function post($request_data = null)
{
if (!DolibarrApiAccess::$user->hasRight('reception', 'creer')) {
throw new RestException(403, "Insuffisant rights");
}
// Check mandatory fields
$result = $this->_validate($request_data);
foreach ($request_data as $field => $value) {
if ($field === 'caller') {
// Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
$this->reception->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
continue;
}
$this->reception->$field = $this->_checkValForAPI($field, $value, $this->reception);
}
if (isset($request_data["lines"])) {
$lines = array();
foreach ($request_data["lines"] as $line) {
$receptionline = new ReceptionLineBatch($this->db);
$receptionline->fk_product = $line['fk_product'];
$receptionline->fk_entrepot = $line['fk_entrepot'];
$receptionline->fk_element = $line['fk_element'] ?? $line['origin_id']; // example: purchase order id. this->origin is 'supplier_order'
$receptionline->origin_line_id = $line['fk_elementdet'] ?? $line['origin_line_id']; // example: purchase order id
$receptionline->fk_elementdet = $line['fk_elementdet'] ?? $line['origin_line_id']; // example: purchase order line id
$receptionline->origin_type = $line['element_type'] ?? $line['origin_type']; // example 'supplier_order'
$receptionline->element_type = $line['element_type'] ?? $line['origin_type']; // example 'supplier_order'
$receptionline->qty = $line['qty'];
//$receptionline->rang = $line['rang'];
$receptionline->array_options = $line['array_options'];
$receptionline->batch = $line['batch'];
$receptionline->eatby = $line['eatby'];
$receptionline->sellby = $line['sellby'];
$receptionline->cost_price = $line['cost_price'];
$receptionline->status = $line['status'];
$lines[] = $receptionline;
}
$this->reception->lines = $lines;
}
if ($this->reception->create(DolibarrApiAccess::$user) < 0) {
throw new RestException(500, "Error creating reception", array_merge(array($this->reception->error), $this->reception->errors));
}
return $this->reception->id;
}
// /**
// * Get lines of an reception
// *
// * @param int $id Id of reception
// *
// * @url GET {id}/lines
// *
// * @return int
// */
/*
public function getLines($id)
{
if (!DolibarrApiAccess::$user->hasRight('reception', 'lire')) {
throw new RestException(403);
}
$result = $this->reception->fetch($id);
if (! $result) {
throw new RestException(404, 'Reception not found');
}
if (!DolibarrApi::_checkAccessToResource('reception',$this->reception->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$this->reception->getLinesArray();
$result = array();
foreach ($this->reception->lines as $line) {
array_push($result,$this->_cleanObjectDatas($line));
}
return $result;
}
*/
// /**
// * Add a line to given reception
// *
// * @param int $id Id of reception to update
// * @param array $request_data ShipmentLine data
// *
// * @url POST {id}/lines
// *
// * @return int
// */
/*
public function postLine($id, $request_data = null)
{
if (!DolibarrApiAccess::$user->hasRight('reception', 'creer')) {
throw new RestException(403);
}
$result = $this->reception->fetch($id);
if (! $result) {
throw new RestException(404, 'Reception not found');
}
if (!DolibarrApi::_checkAccessToResource('reception',$this->reception->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$request_data = (object) $request_data;
$request_data->desc = sanitizeVal($request_data->desc, 'restricthtml');
$request_data->label = sanitizeVal($request_data->label);
$updateRes = $this->reception->addline(
$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,
$fk_parent_line,
$request_data->fk_fournprice,
$request_data->pa_ht,
$request_data->label,
$request_data->array_options,
$request_data->fk_unit,
$request_data->origin,
$request_data->origin_id,
$request_data->multicurrency_subprice
);
if ($updateRes > 0) {
return $updateRes;
}
return false;
}*/
// /**
// * Update a line to given reception
// *
// * @param int $id Id of reception to update
// * @param int $lineid Id of line to update
// * @param array $request_data ShipmentLine data
// *
// * @url PUT {id}/lines/{lineid}
// *
// * @return object
// */
/*
public function putLine($id, $lineid, $request_data = null)
{
if (!DolibarrApiAccess::$user->hasRight('reception', 'creer')) {
throw new RestException(403);
}
$result = $this->reception->fetch($id);
if (! $result) {
throw new RestException(404, 'Reception not found');
}
if (!DolibarrApi::_checkAccessToResource('reception',$this->reception->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$request_data = (object) $request_data;
$request_data->desc = sanitizeVal($request_data->desc, 'restricthtml');
$request_data->label = sanitizeVal($request_data->label);
$updateRes = $this->reception->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;
}*/
/**
* Delete a line to given reception
*
* @param int $id Id of reception to update
* @param int $lineid Id of line to delete
* @return array
*
* @url DELETE {id}/lines/{lineid}
*
* @throws RestException 401
* @throws RestException 404
*/
public function deleteLine($id, $lineid)
{
if (!DolibarrApiAccess::$user->hasRight('reception', 'creer')) {
throw new RestException(403);
}
$result = $this->reception->fetch($id);
if (!$result) {
throw new RestException(404, 'Reception not found');
}
if (!DolibarrApi::_checkAccessToResource('reception', $this->reception->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
// TODO Check the lineid $lineid is a line of object
$updateRes = $this->reception->deleteLine(DolibarrApiAccess::$user, $lineid);
if ($updateRes < 0) {
throw new RestException(405, $this->reception->error);
}
return array(
'success' => array(
'code' => 200,
'message' => 'Line deleted'
)
);
}
/**
* Update reception general fields (won't touch lines of reception)
*
* @param int $id Id of reception to update
* @param array $request_data Datas
* @return Object Object with cleaned properties
*/
public function put($id, $request_data = null)
{
if (!DolibarrApiAccess::$user->hasRight('reception', 'creer')) {
throw new RestException(403);
}
$result = $this->reception->fetch($id);
if (!$result) {
throw new RestException(404, 'Reception not found');
}
if (!DolibarrApi::_checkAccessToResource('reception', $this->reception->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
foreach ($request_data as $field => $value) {
if ($field == 'id') {
continue;
}
if ($field === 'caller') {
// Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
$this->reception->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
continue;
}
$this->reception->$field = $this->_checkValForAPI($field, $value, $this->reception);
}
if ($this->reception->update(DolibarrApiAccess::$user) > 0) {
return $this->get($id);
} else {
throw new RestException(500, $this->reception->error);
}
}
/**
* Delete reception
*
* @param int $id Reception ID
* @return array
*/
public function delete($id)
{
if (!DolibarrApiAccess::$user->hasRight('reception', 'supprimer')) {
throw new RestException(403);
}
$result = $this->reception->fetch($id);
if (!$result) {
throw new RestException(404, 'Reception not found');
}
if (!DolibarrApi::_checkAccessToResource('reception', $this->reception->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
if (!$this->reception->delete(DolibarrApiAccess::$user)) {
throw new RestException(500, 'Error when deleting reception : '.$this->reception->error);
}
return array(
'success' => array(
'code' => 200,
'message' => 'Reception deleted'
)
);
}
/**
* Validate a reception
*
* This may record stock movements if module stock is enabled and option to
* decrease stock on reception is on.
*
* @param int $id Reception ID
* @param int $notrigger 1=Does not execute triggers, 0= execute triggers
*
* @url POST {id}/validate
*
* @return Object
* \todo An error 403 is returned if the request has an empty body.
* Error message: "Forbidden: Content type `text/plain` is not supported."
* Workaround: send this in the body
* {
* "notrigger": 0
* }
*/
public function validate($id, $notrigger = 0)
{
if (!DolibarrApiAccess::$user->hasRight('reception', 'creer')) {
throw new RestException(403);
}
$result = $this->reception->fetch($id);
if (!$result) {
throw new RestException(404, 'Reception not found');
}
if (!DolibarrApi::_checkAccessToResource('reception', $this->reception->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$result = $this->reception->valid(DolibarrApiAccess::$user, $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 Reception: '.$this->reception->error);
}
// Reload reception
$result = $this->reception->fetch($id);
$this->reception->fetchObjectLinked();
return $this->_cleanObjectDatas($this->reception);
}
// /**
// * Classify the reception as invoiced
// *
// * @param int $id Id of the reception
// *
// * @url POST {id}/setinvoiced
// *
// * @return int
// *
// * @throws RestException 400
// * @throws RestException 401
// * @throws RestException 404
// * @throws RestException 405
// */
/*
public function setinvoiced($id)
{
if (!DolibarrApiAccess::$user->hasRight('reception', 'creer')) {
throw new RestException(403);
}
if (empty($id)) {
throw new RestException(400, 'Reception ID is mandatory');
}
$result = $this->reception->fetch($id);
if (!$result) {
throw new RestException(404, 'Reception not found');
}
$result = $this->reception->classifyBilled(DolibarrApiAccess::$user);
if ($result < 0) {
throw new RestException(400, $this->reception->error);
}
return $result;
}
*/
// /**
// * Create a reception using an existing order.
// *
// * @param int $orderid Id of the order
// *
// * @url POST /createfromorder/{orderid}
// *
// * @return int
// * @throws RestException 400
// * @throws RestException 401
// * @throws RestException 404
// * @throws RestException 405
// */
/*
public function createShipmentFromOrder($orderid)
{
require_once DOL_DOCUMENT_ROOT . '/commande/class/commande.class.php';
if (!DolibarrApiAccess::$user->hasRight('reception', 'lire')) {
throw new RestException(403);
}
if (!DolibarrApiAccess::$user->hasRight('reception', 'creer')) {
throw new RestException(403);
}
if (empty($proposalid)) {
throw new RestException(400, 'Order ID is mandatory');
}
$order = new Commande($this->db);
$result = $order->fetch($proposalid);
if (!$result) {
throw new RestException(404, 'Order not found');
}
$result = $this->reception->createFromOrder($order, DolibarrApiAccess::$user);
if( $result < 0) {
throw new RestException(405, $this->reception->error);
}
$this->reception->fetchObjectLinked();
return $this->_cleanObjectDatas($this->reception);
}
*/
/**
* Close a reception (Classify it as "Delivered")
*
* @param int $id Reception ID
* @param int $notrigger Disabled triggers
*
* @url POST {id}/close
*
* @return Object
*/
public function close($id, $notrigger = 0)
{
if (!DolibarrApiAccess::$user->hasRight('reception', 'creer')) {
throw new RestException(403);
}
$result = $this->reception->fetch($id);
if (!$result) {
throw new RestException(404, 'Reception not found');
}
if (!DolibarrApi::_checkAccessToResource('reception', $this->reception->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$result = $this->reception->setClosed();
if ($result == 0) {
throw new RestException(304, 'Error nothing done. May be object is already closed');
}
if ($result < 0) {
throw new RestException(500, 'Error when closing Reception: '.$this->reception->error);
}
// Reload reception
$result = $this->reception->fetch($id);
$this->reception->fetchObjectLinked();
return $this->_cleanObjectDatas($this->reception);
}
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
/**
* Clean sensible object datas
*
* @param Object $object Object to clean
* @return Object Object with cleaned properties
*/
protected function _cleanObjectDatas($object)
{
// phpcs:enable
$object = parent::_cleanObjectDatas($object);
unset($object->thirdparty); // id already returned
unset($object->note);
unset($object->address);
unset($object->barcode_type);
unset($object->barcode_type_code);
unset($object->barcode_type_label);
unset($object->barcode_type_coder);
if (!empty($object->lines) && is_array($object->lines)) {
foreach ($object->lines as $line) {
unset($line->canvas);
unset($line->tva_tx);
unset($line->vat_src_code);
unset($line->total_ht);
unset($line->total_ttc);
unset($line->total_tva);
unset($line->total_localtax1);
unset($line->total_localtax2);
unset($line->remise_percent);
}
}
return $object;
}
/**
* Validate fields before create or update object
*
* @param array $data Array with data to verify
* @return array
* @throws RestException
*/
private function _validate($data)
{
$reception = array();
foreach (Receptions::$FIELDS as $field) {
if (!isset($data[$field])) {
throw new RestException(400, "$field field missing");
}
$reception[$field] = $data[$field];
}
return $reception;
}
}