@@ -368,15 +368,15 @@ |
||
| 368 | 368 | } |
| 369 | 369 | |
| 370 | 370 | /** |
| 371 | - * Create candidature object |
|
| 372 | - * |
|
| 373 | - * @param array $request_data Request datas |
|
| 374 | - * @return int ID of candidature |
|
| 375 | - * |
|
| 376 | - * @throws RestException |
|
| 377 | - * |
|
| 378 | - * @url POST candidature/ |
|
| 379 | - */ |
|
| 371 | + * Create candidature object |
|
| 372 | + * |
|
| 373 | + * @param array $request_data Request datas |
|
| 374 | + * @return int ID of candidature |
|
| 375 | + * |
|
| 376 | + * @throws RestException |
|
| 377 | + * |
|
| 378 | + * @url POST candidature/ |
|
| 379 | + */ |
|
| 380 | 380 | public function postCandidature($request_data = null) |
| 381 | 381 | { |
| 382 | 382 | if (!DolibarrApiAccess::$user->rights->recruitment->recruitmentjobposition->write) { |
@@ -469,12 +469,12 @@ discard block |
||
| 469 | 469 | } |
| 470 | 470 | |
| 471 | 471 | /** |
| 472 | - * Receives the order, dispatches products. |
|
| 472 | + * Receives the order, dispatches products. |
|
| 473 | 473 | * |
| 474 | - * Example: |
|
| 475 | - * <code> { |
|
| 476 | - * "closeopenorder": 1, |
|
| 477 | - * "comment": "", |
|
| 474 | + * Example: |
|
| 475 | + * <code> { |
|
| 476 | + * "closeopenorder": 1, |
|
| 477 | + * "comment": "", |
|
| 478 | 478 | * "lines": [{ |
| 479 | 479 | * "id": 14, |
| 480 | 480 | * "fk_product": 112, |
@@ -487,20 +487,20 @@ discard block |
||
| 487 | 487 | * "batch": 0, |
| 488 | 488 | * "notrigger": 0 |
| 489 | 489 | * }] |
| 490 | - * }</code> |
|
| 490 | + * }</code> |
|
| 491 | 491 | * |
| 492 | - * @param int $id Order ID |
|
| 493 | - * @param integer $closeopenorder Close order if everything is received {@required false} |
|
| 494 | - * @param string $comment Comment {@required false} |
|
| 495 | - * @param array $lines Array of product dispatches |
|
| 496 | - * |
|
| 497 | - * @url POST {id}/receive |
|
| 498 | - * |
|
| 499 | - * @return array |
|
| 500 | - * FIXME An error 403 is returned if the request has an empty body. |
|
| 501 | - * Error message: "Forbidden: Content type `text/plain` is not supported." |
|
| 502 | - * |
|
| 503 | - */ |
|
| 492 | + * @param int $id Order ID |
|
| 493 | + * @param integer $closeopenorder Close order if everything is received {@required false} |
|
| 494 | + * @param string $comment Comment {@required false} |
|
| 495 | + * @param array $lines Array of product dispatches |
|
| 496 | + * |
|
| 497 | + * @url POST {id}/receive |
|
| 498 | + * |
|
| 499 | + * @return array |
|
| 500 | + * FIXME An error 403 is returned if the request has an empty body. |
|
| 501 | + * Error message: "Forbidden: Content type `text/plain` is not supported." |
|
| 502 | + * |
|
| 503 | + */ |
|
| 504 | 504 | public function receiveOrder($id, $closeopenorder, $comment, $lines) |
| 505 | 505 | { |
| 506 | 506 | if (empty(DolibarrApiAccess::$user->rights->fournisseur->commande->creer) && empty(DolibarrApiAccess::$user->rights->supplier_order->creer)) { |
@@ -156,7 +156,7 @@ |
||
| 156 | 156 | * $price Can be set to update AWP (Average Weighted Price) when you make a stock increase |
| 157 | 157 | * $dlc Eat-by date. Will be used if lot does not exists yet and will be created. |
| 158 | 158 | * $dluo Sell-by date. Will be used if lot does not exists yet and will be created. |
| 159 | - * |
|
| 159 | + * |
|
| 160 | 160 | * @param int $product_id Id product id {@min 1} {@from body} {@required true} |
| 161 | 161 | * @param int $warehouse_id Id warehouse {@min 1} {@from body} {@required true} |
| 162 | 162 | * @param float $qty Qty to add (Use negative value for a stock decrease) {@from body} {@required true} |
@@ -914,11 +914,11 @@ |
||
| 914 | 914 | |
| 915 | 915 | |
| 916 | 916 | /** |
| 917 | - * Load the info information in the object |
|
| 918 | - * |
|
| 919 | - * @param int $id Id of object |
|
| 920 | - * @return void |
|
| 921 | - */ |
|
| 917 | + * Load the info information in the object |
|
| 918 | + * |
|
| 919 | + * @param int $id Id of object |
|
| 920 | + * @return void |
|
| 921 | + */ |
|
| 922 | 922 | public function info($id) |
| 923 | 923 | { |
| 924 | 924 | $sql = 'SELECT rowid, date_creation as datec, tms as datem,'; |
@@ -44,7 +44,7 @@ discard block |
||
| 44 | 44 | public $reception; |
| 45 | 45 | |
| 46 | 46 | /** |
| 47 | - * Constructor |
|
| 47 | + * Constructor |
|
| 48 | 48 | */ |
| 49 | 49 | public function __construct() |
| 50 | 50 | { |
@@ -623,15 +623,15 @@ discard block |
||
| 623 | 623 | */ |
| 624 | 624 | |
| 625 | 625 | /** |
| 626 | - * Close a reception (Classify it as "Delivered") |
|
| 627 | - * |
|
| 628 | - * @param int $id Reception ID |
|
| 629 | - * @param int $notrigger Disabled triggers |
|
| 630 | - * |
|
| 631 | - * @url POST {id}/close |
|
| 632 | - * |
|
| 633 | - * @return int |
|
| 634 | - */ |
|
| 626 | + * Close a reception (Classify it as "Delivered") |
|
| 627 | + * |
|
| 628 | + * @param int $id Reception ID |
|
| 629 | + * @param int $notrigger Disabled triggers |
|
| 630 | + * |
|
| 631 | + * @url POST {id}/close |
|
| 632 | + * |
|
| 633 | + * @return int |
|
| 634 | + */ |
|
| 635 | 635 | public function close($id, $notrigger = 0) |
| 636 | 636 | { |
| 637 | 637 | if (!DolibarrApiAccess::$user->rights->reception->creer) { |
@@ -58,10 +58,10 @@ |
||
| 58 | 58 | public $isextrafieldmanaged = 1; |
| 59 | 59 | |
| 60 | 60 | /** |
| 61 | - * @var string Customer ref |
|
| 62 | - * @deprecated |
|
| 63 | - * @see $ref_customer |
|
| 64 | - */ |
|
| 61 | + * @var string Customer ref |
|
| 62 | + * @deprecated |
|
| 63 | + * @see $ref_customer |
|
| 64 | + */ |
|
| 65 | 65 | public $ref_client; |
| 66 | 66 | |
| 67 | 67 | /** |
@@ -34,11 +34,11 @@ |
||
| 34 | 34 | |
| 35 | 35 | |
| 36 | 36 | /** |
| 37 | - * Return clicable link of object (with eventually picto) |
|
| 38 | - * |
|
| 39 | - * @param string $option Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link) |
|
| 40 | - * @return string HTML Code for Kanban thumb. |
|
| 41 | - */ |
|
| 37 | + * Return clicable link of object (with eventually picto) |
|
| 38 | + * |
|
| 39 | + * @param string $option Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link) |
|
| 40 | + * @return string HTML Code for Kanban thumb. |
|
| 41 | + */ |
|
| 42 | 42 | public function getKanbanView($option = '') |
| 43 | 43 | { |
| 44 | 44 | global $langs, $conf; |
@@ -405,7 +405,6 @@ |
||
| 405 | 405 | * Load object lines in memory from the database by type of product |
| 406 | 406 | * |
| 407 | 407 | * @param int $typeproduct 0 type product, 1 type service |
| 408 | - |
|
| 409 | 408 | * @return int <0 if KO, 0 if not found, >0 if OK |
| 410 | 409 | */ |
| 411 | 410 | public function fetchLinesbytypeproduct($typeproduct = 0) |
@@ -919,11 +919,11 @@ |
||
| 919 | 919 | } |
| 920 | 920 | |
| 921 | 921 | /** |
| 922 | - * Return clicable link of object (with eventually picto) |
|
| 923 | - * |
|
| 924 | - * @param string $option Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link) |
|
| 925 | - * @return string HTML Code for Kanban thumb. |
|
| 926 | - */ |
|
| 922 | + * Return clicable link of object (with eventually picto) |
|
| 923 | + * |
|
| 924 | + * @param string $option Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link) |
|
| 925 | + * @return string HTML Code for Kanban thumb. |
|
| 926 | + */ |
|
| 927 | 927 | public function getKanbanView($option = '') |
| 928 | 928 | { |
| 929 | 929 | global $langs; |