Wavyzz/dolibarr
2
0
Fork 1
mirror of https://github.com/Dolibarr/dolibarr.git synced 2026-02-08 00:52:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Qual: Add phpdoc for request_data param

Browse Source
This commit is contained in:
MDW
2025-03-02 12:13:32 +01:00
parent 21e5457e19
commit c02293a880
28 changed files with 325 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
htdocs/commande/class/api_orders.class.php
View File

@@ -2,6 +2,7 @@
/* Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
* Copyright (C) 2016 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
* Copyright (C) 2025 MDW <mdeweerd@users.noreply.github.com>
*
* 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
@@ -30,7 +31,7 @@ require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
class Orders extends DolibarrApi
{
/**
* @var array $FIELDS Mandatory fields, checked when create and update object
* @var array Mandatory fields, checked when create and update object
*/
public static $FIELDS = array(
'socid',
@@ -38,7 +39,7 @@ class Orders extends DolibarrApi
);
/**
* @var Commande $commande {@type Commande}
* @var Commande {@type Commande}
*/
public $commande;
@@ -291,6 +292,8 @@ class Orders extends DolibarrApi
* Example: { "socid": 2, "date": 1595196000, "type": 0, "lines": [{ "fk_product": 2, "qty": 1 }] }
*
* @param array $request_data Request data
* @phan-param ?array<string,string> $request_data
* @phpstan-param ?array<string,string> $request_data
* @return int ID of order
*/
public function post($request_data = null)
@@ -361,6 +364,8 @@ class Orders extends DolibarrApi
*
* @param int $id Id of order to update
* @param array $request_data OrderLine data
* @phan-param ?array<string,string> $request_data
* @phpstan-param ?array<string,string> $request_data
*
* @url POST {id}/lines
*
@@ -429,6 +434,8 @@ class Orders extends DolibarrApi
* @param int $id Id of order to update
* @param int $lineid Id of line to update
* @param array $request_data OrderLine data
* @phan-param ?array<string,string> $request_data
* @phpstan-param ?array<string,string> $request_data
* @return Object|false Object with cleaned properties
*
* @url PUT {id}/lines/{lineid}
@@ -657,7 +664,9 @@ class Orders extends DolibarrApi
* Update order general fields (won't touch lines of order)
*
* @param int $id Id of order to update
* @param array $request_data Datas
* @param array $request_data Data
* @phan-param ?array<string,string> $request_data
* @phpstan-param ?array<string,string> $request_data
* @return Object Object with cleaned properties
*/
public function put($id, $request_data = null)
@@ -759,7 +768,6 @@ class Orders extends DolibarrApi
* @throws RestException 401
* @throws RestException 404
* @throws RestException 500 System error
*
*/
public function validate($id, $idwarehouse = 0, $notrigger = 0)
{