diff --git a/htdocs/adherents/class/api_members.class.php b/htdocs/adherents/class/api_members.class.php index 0261be16cb6..e78430ffbfd 100644 --- a/htdocs/adherents/class/api_members.class.php +++ b/htdocs/adherents/class/api_members.class.php @@ -508,7 +508,7 @@ class Members extends DolibarrApi /** * Validate fields before creating an object * - * @param array $data Data to validate + * @param ?array $data Data to validate * @return array Return array with validated mandatory fields and their value * @phan-return array Return array with validated mandatory fields and their value * @@ -516,6 +516,9 @@ class Members extends DolibarrApi */ private function _validate($data) { + if ($data === null) { + $data = array(); + } $member = array(); $mandatoryfields = array( diff --git a/htdocs/bom/class/api_boms.class.php b/htdocs/bom/class/api_boms.class.php index 24d16d6bcf2..6510e9063bc 100644 --- a/htdocs/bom/class/api_boms.class.php +++ b/htdocs/bom/class/api_boms.class.php @@ -3,6 +3,7 @@ * Copyright (C) 2019 Maxime Kohlhaas * Copyright (C) 2020-2024 Frédéric France * Copyright (C) 2022 Christian Humpel + * Copyright (C) 2025 MDW * * 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 @@ -38,7 +39,7 @@ require_once DOL_DOCUMENT_ROOT.'/bom/class/bom.class.php'; class Boms extends DolibarrApi { /** - * @var BOM $bom {@type BOM} + * @var BOM {@type BOM} */ public $bom; @@ -179,7 +180,9 @@ class Boms extends DolibarrApi /** * Create bom object * - * @param array $request_data Request datas + * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of bom * * @throws RestException 403 Access denied @@ -215,7 +218,9 @@ class Boms extends DolibarrApi * Update bom * * @param int $id Id of bom to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Object after update * * @throws RestException 403 Access denied @@ -340,6 +345,8 @@ class Boms extends DolibarrApi * * @param int $id Id of BOM to update * @param array $request_data BOMLine data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @url POST {id}/lines * @@ -393,6 +400,8 @@ class Boms extends DolibarrApi * @param int $id Id of BOM to update * @param int $lineid Id of line to update * @param array $request_data BOMLine data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @url PUT {id}/lines/{lineid} * diff --git a/htdocs/categories/class/api_categories.class.php b/htdocs/categories/class/api_categories.class.php index b9ad4005ad8..6141084e699 100644 --- a/htdocs/categories/class/api_categories.class.php +++ b/htdocs/categories/class/api_categories.class.php @@ -2,6 +2,7 @@ /* Copyright (C) 2015 Jean-François Ferry * Copyright (C) 2024 Jose MARTINEZ * Copyright (C) 2024 Frédéric France + * Copyright (C) 2025 MDW * * 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 @@ -38,7 +39,7 @@ require_once DOL_DOCUMENT_ROOT.'/projet/class/api_projects.class.php'; class Categories extends DolibarrApi { /** - * @var string[] $FIELDS Mandatory fields, checked when create and update object + * @var string[] Mandatory fields, checked when create and update object */ public static $FIELDS = array( 'label', @@ -46,7 +47,7 @@ class Categories extends DolibarrApi ); /** - * @var Categorie $category {@type Categorie} + * @var Categorie {@type Categorie} */ public $category; @@ -180,6 +181,8 @@ class Categories extends DolibarrApi * Create category object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of category */ public function post($request_data = null) @@ -210,7 +213,9 @@ class Categories extends DolibarrApi * Update category * * @param int $id Id of category to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Updated object */ public function put($id, $request_data = null) diff --git a/htdocs/comm/action/class/api_agendaevents.class.php b/htdocs/comm/action/class/api_agendaevents.class.php index d2dd06c919c..001bd6776cc 100644 --- a/htdocs/comm/action/class/api_agendaevents.class.php +++ b/htdocs/comm/action/class/api_agendaevents.class.php @@ -1,7 +1,7 @@ * Copyright (C) 2016 Laurent Destailleur - * Copyright (C) 2024 MDW + * Copyright (C) 2024-2025 MDW * * 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 @@ -31,13 +31,13 @@ require_once DOL_DOCUMENT_ROOT.'/comm/action/class/actioncomm.class.php'; class AgendaEvents extends DolibarrApi { /** - * @var string[] $FIELDS Mandatory fields, checked when create and update object + * @var string[] Mandatory fields, checked when create and update object */ public static $FIELDS = array( ); /** - * @var ActionComm $actioncomm {@type ActionComm} + * @var ActionComm {@type ActionComm} */ public $actioncomm; @@ -209,6 +209,8 @@ class AgendaEvents extends DolibarrApi * Create Agenda Event object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of Agenda Event */ public function post($request_data = null) @@ -252,7 +254,9 @@ class AgendaEvents extends DolibarrApi * Update Agenda Event general fields * * @param int $id Id of Agenda Event to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object|false Object with cleaned properties */ public function put($id, $request_data = null) diff --git a/htdocs/comm/propal/class/api_proposals.class.php b/htdocs/comm/propal/class/api_proposals.class.php index 18439f484a3..b24c12be8ca 100644 --- a/htdocs/comm/propal/class/api_proposals.class.php +++ b/htdocs/comm/propal/class/api_proposals.class.php @@ -4,7 +4,7 @@ * Copyright (C) 2020 Thibault FOUCART * Copyright (C) 2022 ATM Consulting * Copyright (C) 2022 OpenDSI - * Copyright (C) 2024 MDW + * Copyright (C) 2024-2025 MDW * Copyright (C) 2024 Frédéric France * * This program is free software; you can redistribute it and/or modify @@ -35,14 +35,14 @@ require_once DOL_DOCUMENT_ROOT.'/comm/propal/class/propal.class.php'; class Proposals 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' ); /** - * @var Propal $propal {@type Propal} + * @var Propal {@type Propal} */ public $propal; @@ -271,6 +271,8 @@ class Proposals extends DolibarrApi * Create commercial proposal object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of proposal */ public function post($request_data = null) @@ -351,6 +353,8 @@ class Proposals extends DolibarrApi * * @param int $id Id of commercial proposal to update * @param array $request_data Commercial proposal line data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @url POST {id}/line * @@ -417,6 +421,8 @@ class Proposals extends DolibarrApi * * @param int $id Id of commercial proposal to update * @param array $request_data Commercial proposal line data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @url POST {id}/lines * @@ -499,6 +505,8 @@ class Proposals extends DolibarrApi * @param int $id Id of commercial proposal to update * @param int $lineid Id of line to update * @param array $request_data Commercial proposal line data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object|false Object with cleaned properties * * @url PUT {id}/lines/{lineid} @@ -710,6 +718,8 @@ class Proposals extends DolibarrApi * * @param int $id Id of commercial proposal to update * @param array $request_data Datas + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Object with cleaned properties */ public function put($id, $request_data = null) diff --git a/htdocs/commande/class/api_orders.class.php b/htdocs/commande/class/api_orders.class.php index 583e77a0ece..41cd7865981 100644 --- a/htdocs/commande/class/api_orders.class.php +++ b/htdocs/commande/class/api_orders.class.php @@ -2,6 +2,7 @@ /* Copyright (C) 2015 Jean-François Ferry * Copyright (C) 2016 Laurent Destailleur * Copyright (C) 2024 Frédéric France + * Copyright (C) 2025 MDW * * 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 $request_data + * @phpstan-param ?array $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 $request_data + * @phpstan-param ?array $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 $request_data + * @phpstan-param ?array $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 $request_data + * @phpstan-param ?array $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) { diff --git a/htdocs/compta/bank/class/api_bankaccounts.class.php b/htdocs/compta/bank/class/api_bankaccounts.class.php index 4f8f7ad6b94..45c7a0c1973 100644 --- a/htdocs/compta/bank/class/api_bankaccounts.class.php +++ b/htdocs/compta/bank/class/api_bankaccounts.class.php @@ -1,7 +1,7 @@ - * Copyright (C) 2024 MDW + * Copyright (C) 2024-2025 MDW * Copyright (C) 2024 Frédéric France * * This program is free software; you can redistribute it and/or modify @@ -148,6 +148,8 @@ class BankAccounts extends DolibarrApi * Create account object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of account */ public function post($request_data = null) @@ -324,6 +326,8 @@ class BankAccounts extends DolibarrApi * * @param int $id ID of account * @param array $request_data data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Object with cleaned properties */ public function put($id, $request_data = null) @@ -598,7 +602,6 @@ class BankAccounts extends DolibarrApi * @throws RestException * * @url GET {id}/lines/{line_id}/links - * */ public function getLinks($id, $line_id) { diff --git a/htdocs/compta/facture/class/api_invoices.class.php b/htdocs/compta/facture/class/api_invoices.class.php index d58000dd683..d805d98eaae 100644 --- a/htdocs/compta/facture/class/api_invoices.class.php +++ b/htdocs/compta/facture/class/api_invoices.class.php @@ -3,7 +3,7 @@ * Copyright (C) 2020 Thibault FOUCART * Copyright (C) 2023 Joachim Kueter * Copyright (C) 2024 Frédéric France - * Copyright (C) 2024 MDW + * Copyright (C) 2024-2025 MDW * * 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 @@ -34,20 +34,19 @@ require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture-rec.class.php'; class Invoices 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', ); /** - * @var Facture $invoice {@type Facture} + * @var Facture {@type Facture} */ private $invoice; /** - * @var FactureRec $template_invoice {@type FactureRec} + * @var FactureRec {@type FactureRec} */ private $template_invoice; @@ -321,6 +320,8 @@ class Invoices extends DolibarrApi * Create invoice object * * @param array $request_data Request datas + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of invoice */ public function post($request_data = null) @@ -400,18 +401,18 @@ class Invoices extends DolibarrApi } /** - * Create an invoice using a contract. - * - * @param int $contractid Id of the contract - * @return Object Object with cleaned properties - * - * @url POST /createfromcontract/{contractid} - * - * @throws RestException 400 - * @throws RestException 401 - * @throws RestException 404 - * @throws RestException 405 - */ + * Create an invoice using a contract. + * + * @param int $contractid Id of the contract + * @return Object Object with cleaned properties + * + * @url POST /createfromcontract/{contractid} + * + * @throws RestException 400 + * @throws RestException 401 + * @throws RestException 404 + * @throws RestException 405 + */ public function createInvoiceFromContract($contractid) { require_once DOL_DOCUMENT_ROOT.'/contrat/class/contrat.class.php'; @@ -476,6 +477,8 @@ class Invoices extends DolibarrApi * @param int $id Id of invoice to update * @param int $lineid Id of line to update * @param array $request_data InvoiceLine data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Object with cleaned properties * * @url PUT {id}/lines/{lineid} @@ -679,6 +682,8 @@ class Invoices extends DolibarrApi * * @param int $id Id of invoice to update * @param array $request_data Datas + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object|false Object with cleaned properties */ public function put($id, $request_data = null) @@ -782,6 +787,8 @@ class Invoices extends DolibarrApi * * @param int $id Id of invoice * @param array $request_data InvoiceLine data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @url POST {id}/lines * @@ -878,7 +885,6 @@ class Invoices extends DolibarrApi * @throws RestException 401 * @throws RestException 404 * @throws RestException 500 System error - * */ public function addContact($id, $fk_socpeople, $type_contact, $source, $notrigger = 0) { @@ -926,7 +932,6 @@ class Invoices extends DolibarrApi * @throws RestException 401 * @throws RestException 404 * @throws RestException 500 System error - * */ public function settodraft($id, $idwarehouse = -1) { diff --git a/htdocs/contrat/class/api_contracts.class.php b/htdocs/contrat/class/api_contracts.class.php index 5637279b9d7..e6b638784d2 100644 --- a/htdocs/contrat/class/api_contracts.class.php +++ b/htdocs/contrat/class/api_contracts.class.php @@ -2,6 +2,7 @@ /* Copyright (C) 2015 Jean-François Ferry * Copyright (C) 2016 Laurent Destailleur * Copyright (C) 2018-2024 Frédéric France + * Copyright (C) 2025 MDW * * 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 @@ -17,9 +18,9 @@ * along with this program. If not, see . */ - use Luracast\Restler\RestException; +use Luracast\Restler\RestException; - require_once DOL_DOCUMENT_ROOT.'/contrat/class/contrat.class.php'; +require_once DOL_DOCUMENT_ROOT.'/contrat/class/contrat.class.php'; /** * API class for contracts @@ -30,7 +31,7 @@ class Contracts 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', @@ -40,7 +41,7 @@ class Contracts extends DolibarrApi ); /** - * @var Contrat $contract {@type Contrat} + * @var Contrat {@type Contrat} */ public $contract; @@ -198,6 +199,8 @@ class Contracts extends DolibarrApi * Create contract object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of contrat */ public function post($request_data = null) @@ -267,6 +270,8 @@ class Contracts extends DolibarrApi * * @param int $id Id of contrat to update * @param array $request_data Contractline data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @url POST {id}/lines * @@ -325,6 +330,8 @@ class Contracts extends DolibarrApi * @param int $id Id of contrat to update * @param int $lineid Id of line to update * @param array $request_data Contractline data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @url PUT {id}/lines/{lineid} * @@ -500,7 +507,9 @@ class Contracts extends DolibarrApi * Update contract general fields (won't touch lines of contract) * * @param int $id Id of contract to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Updated object */ public function put($id, $request_data = null) diff --git a/htdocs/don/class/api_donations.class.php b/htdocs/don/class/api_donations.class.php index 6eb89871470..161f850b5e3 100644 --- a/htdocs/don/class/api_donations.class.php +++ b/htdocs/don/class/api_donations.class.php @@ -1,6 +1,7 @@ * Copyright (C) 2019 Laurent Destailleur + * Copyright (C) 2025 MDW * * 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 @@ -29,14 +30,14 @@ require_once DOL_DOCUMENT_ROOT.'/don/class/don.class.php'; class Donations 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( 'amount' ); /** - * @var Don $don {@type Don} + * @var Don {@type Don} */ public $don; @@ -190,6 +191,8 @@ class Donations extends DolibarrApi * Create donation object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of order */ public function post($request_data = null) @@ -229,7 +232,9 @@ class Donations 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 $request_data + * @phpstan-param ?array $request_data * @return Object Updated object */ public function put($id, $request_data = null) diff --git a/htdocs/expedition/class/api_shipments.class.php b/htdocs/expedition/class/api_shipments.class.php index 1bd9b78a711..98bcacfdd1d 100644 --- a/htdocs/expedition/class/api_shipments.class.php +++ b/htdocs/expedition/class/api_shipments.class.php @@ -1,6 +1,7 @@ * Copyright (C) 2016 Laurent Destailleur + * Copyright (C) 2025 MDW * * 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 @@ -16,9 +17,9 @@ * along with this program. If not, see . */ - use Luracast\Restler\RestException; +use Luracast\Restler\RestException; - require_once DOL_DOCUMENT_ROOT.'/expedition/class/expedition.class.php'; +require_once DOL_DOCUMENT_ROOT.'/expedition/class/expedition.class.php'; /** * API class for shipments @@ -29,7 +30,7 @@ class Shipments 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 Shipments extends DolibarrApi ); /** - * @var Expedition $shipment {@type Expedition} + * @var Expedition {@type Expedition} */ public $shipment; @@ -197,6 +198,8 @@ class Shipments extends DolibarrApi * Create shipment object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of shipment created */ public function post($request_data = null) @@ -282,6 +285,8 @@ class Shipments extends DolibarrApi // * // * @param int $id Id of shipment to update // * @param array $request_data ShipmentLine data + // * @phan-param ?array $request_data + // * @phpstan-param ?array $request_data // * // * @url POST {id}/lines // * @@ -457,7 +462,9 @@ class Shipments extends DolibarrApi * Update shipment general fields (won't touch lines of shipment) * * @param int $id Id of shipment to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Updated object */ public function put($id, $request_data = null) @@ -665,15 +672,15 @@ class Shipments extends DolibarrApi */ /** - * Close a shipment (Classify it as "Delivered") - * - * @param int $id Expedition ID - * @param int $notrigger Disabled triggers - * - * @url POST {id}/close - * - * @return object - */ + * Close a shipment (Classify it as "Delivered") + * + * @param int $id Expedition ID + * @param int $notrigger Disabled triggers + * + * @url POST {id}/close + * + * @return object + */ public function close($id, $notrigger = 0) { if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) { diff --git a/htdocs/expensereport/class/api_expensereports.class.php b/htdocs/expensereport/class/api_expensereports.class.php index d4d20084e2e..5a2841c0da7 100644 --- a/htdocs/expensereport/class/api_expensereports.class.php +++ b/htdocs/expensereport/class/api_expensereports.class.php @@ -2,6 +2,7 @@ /* Copyright (C) 2015 Jean-François Ferry * Copyright (C) 2016 Laurent Destailleur * Copyright (C) 2020-2024 Frédéric France + * Copyright (C) 2025 MDW * * 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 @@ -32,14 +33,14 @@ require_once DOL_DOCUMENT_ROOT.'/expensereport/class/paymentexpensereport.class. class ExpenseReports 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( 'fk_user_author' ); /** - * @var array $FIELDS Mandatory fields, checked when create and update object + * @var array Mandatory fields, checked when create and update object */ public static $FIELDSPAYMENT = array( "fk_typepayment", @@ -48,7 +49,7 @@ class ExpenseReports extends DolibarrApi ); /** - * @var ExpenseReport $expensereport {@type ExpenseReport} + * @var ExpenseReport {@type ExpenseReport} */ public $expensereport; @@ -190,6 +191,8 @@ class ExpenseReports extends DolibarrApi * Create Expense Report object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of Expense Report */ public function post($request_data = null) @@ -262,6 +265,8 @@ class ExpenseReports extends DolibarrApi * * @param int $id Id of Expense Report to update * @param array $request_data Expense Report data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @url POST {id}/lines * @@ -330,6 +335,8 @@ class ExpenseReports extends DolibarrApi * @param int $id Id of Expense Report to update * @param int $lineid Id of line to update * @param array $request_data Expense Report data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @url PUT {id}/lines/{lineid} * @@ -430,6 +437,8 @@ class ExpenseReports extends DolibarrApi * * @param int $id Id of Expense Report to update * @param array $request_data Datas + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Updated object * * @throws RestException 401 Not allowed @@ -641,6 +650,8 @@ class ExpenseReports extends DolibarrApi * * @param int $id ID of expense report * @param array $request_data {@from body} Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of paymentExpenseReport * * @url POST {id}/payments @@ -681,6 +692,8 @@ class ExpenseReports extends DolibarrApi * * @param int $id ID of paymentExpenseReport * @param array $request_data data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return object * * @url PUT {id}/payments diff --git a/htdocs/fichinter/class/api_interventions.class.php b/htdocs/fichinter/class/api_interventions.class.php index 7a86225622e..f165ca015bf 100644 --- a/htdocs/fichinter/class/api_interventions.class.php +++ b/htdocs/fichinter/class/api_interventions.class.php @@ -459,13 +459,16 @@ class Interventions extends DolibarrApi /** * Validate fields before create or update object * - * @param array $data Data to validate + * @param ?array $data Data to validate * @return array Return array with validated mandatory fields and their value * * @throws RestException */ private function _validateLine($data) { + if ($data === null) { + $data = array(); + } $fichinter = array(); foreach (Interventions::$FIELDSLINE as $field) { if (!isset($data[$field])) { diff --git a/htdocs/fourn/class/api_supplier_invoices.class.php b/htdocs/fourn/class/api_supplier_invoices.class.php index 76c286cbcb4..8ac35076f27 100644 --- a/htdocs/fourn/class/api_supplier_invoices.class.php +++ b/htdocs/fourn/class/api_supplier_invoices.class.php @@ -2,7 +2,7 @@ /* Copyright (C) 2015 Jean-François Ferry * Copyright (C) 2016 Laurent Destailleur * Copyright (C) 2023 Joachim Kueter - * Copyright (C) 2024 MDW + * Copyright (C) 2024-2025 MDW * Copyright (C) 2024 Frédéric France * * This program is free software; you can redistribute it and/or modify @@ -34,15 +34,14 @@ require_once DOL_DOCUMENT_ROOT . '/fourn/class/paiementfourn.class.php'; class SupplierInvoices extends DolibarrApi { /** - * - * @var string[] $FIELDS Mandatory fields, checked when create and update object + * @var string[] Mandatory fields, checked when create and update object */ public static $FIELDS = array( 'socid', ); /** - * @var FactureFournisseur $invoice {@type FactureFournisseur} + * @var FactureFournisseur {@type FactureFournisseur} */ public $invoice; @@ -218,7 +217,9 @@ class SupplierInvoices extends DolibarrApi * * Example: {'ref': 'auto', 'ref_supplier': '7985630', 'socid': 1, 'note': 'Inserted with Python', 'order_supplier': 1, 'date': '2021-07-28'} * - * @param array $request_data Request datas + * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @return int ID of supplier invoice * @@ -256,7 +257,9 @@ class SupplierInvoices extends DolibarrApi * Update supplier invoice * * @param int $id Id of supplier invoice to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object|false Updated object * * @throws RestException 403 @@ -572,6 +575,8 @@ class SupplierInvoices extends DolibarrApi * * @param int $id Id of supplier invoice to update * @param array $request_data supplier invoice line data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @url POST {id}/lines * @@ -638,6 +643,8 @@ class SupplierInvoices extends DolibarrApi * @param int $id Id of supplier invoice to update * @param int $lineid Id of line to update * @param array $request_data InvoiceLine data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @url PUT {id}/lines/{lineid} * diff --git a/htdocs/fourn/class/api_supplier_orders.class.php b/htdocs/fourn/class/api_supplier_orders.class.php index 972c81da5ff..1c805b156f2 100644 --- a/htdocs/fourn/class/api_supplier_orders.class.php +++ b/htdocs/fourn/class/api_supplier_orders.class.php @@ -1,6 +1,7 @@ * Copyright (C) 2016 Laurent Destailleur + * Copyright (C) 2025 MDW * * 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 @@ -29,15 +30,14 @@ require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.commande.class.php'; class SupplierOrders 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' ); /** - * @var CommandeFournisseur $order {@type CommandeFournisseur} + * @var CommandeFournisseur {@type CommandeFournisseur} */ public $order; @@ -237,7 +237,9 @@ class SupplierOrders extends DolibarrApi * * Example: {"ref": "auto", "ref_supplier": "1234", "socid": "1", "multicurrency_code": "SEK", "multicurrency_tx": 1, "tva_tx": 25, "note": "Imported via the REST API"} * - * @param array $request_data Request datas + * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of supplier order */ public function post($request_data = null) @@ -279,7 +281,9 @@ class SupplierOrders extends DolibarrApi * Update supplier order * * @param int $id Id of supplier order to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object|false Updated object */ public function put($id, $request_data = null) @@ -683,7 +687,6 @@ class SupplierOrders extends DolibarrApi * @return array * FIXME An error 403 is returned if the request has an empty body. * Error message: "Forbidden: Content type `text/plain` is not supported." - * */ public function receiveOrder($id, $closeopenorder, $comment, $lines) { @@ -700,9 +703,9 @@ class SupplierOrders extends DolibarrApi } foreach ($lines as $line) { - $lineObj =(object) $line; + $lineObj = (object) $line; - $result=$this->order->dispatchProduct( + $result = $this->order->dispatchProduct( DolibarrApiAccess::$user, $lineObj->fk_product, $lineObj->qty, diff --git a/htdocs/knowledgemanagement/class/api_knowledgemanagement.class.php b/htdocs/knowledgemanagement/class/api_knowledgemanagement.class.php index 21c0fe2a59b..9ad0a3f0c1e 100644 --- a/htdocs/knowledgemanagement/class/api_knowledgemanagement.class.php +++ b/htdocs/knowledgemanagement/class/api_knowledgemanagement.class.php @@ -1,6 +1,7 @@ * Copyright (C) 2021 SuperAdmin + * Copyright (C) 2025 MDW * * 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 @@ -38,7 +39,7 @@ dol_include_once('/categories/class/categorie.class.php'); class KnowledgeManagement extends DolibarrApi { /** - * @var KnowledgeRecord $knowledgerecord {@type KnowledgeRecord} + * @var KnowledgeRecord {@type KnowledgeRecord} */ public $knowledgerecord; @@ -46,7 +47,6 @@ class KnowledgeManagement extends DolibarrApi * Constructor * * @url GET / - * */ public function __construct() { @@ -240,7 +240,9 @@ class KnowledgeManagement extends DolibarrApi /** * Create knowledgerecord object * - * @param array $request_data Request datas + * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of knowledgerecord * * @throws RestException @@ -269,7 +271,7 @@ class KnowledgeManagement extends DolibarrApi // Clean data // $this->knowledgerecord->abc = sanitizeVal($this->knowledgerecord->abc, 'alphanohtml'); - if ($this->knowledgerecord->create(DolibarrApiAccess::$user)<0) { + if ($this->knowledgerecord->create(DolibarrApiAccess::$user) < 0) { throw new RestException(500, "Error creating KnowledgeRecord", array_merge(array($this->knowledgerecord->error), $this->knowledgerecord->errors)); } return $this->knowledgerecord->id; @@ -279,7 +281,9 @@ class KnowledgeManagement extends DolibarrApi * Update knowledgerecord * * @param int $id Id of knowledgerecord to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Updated object * * @throws RestException diff --git a/htdocs/multicurrency/class/api_multicurrencies.class.php b/htdocs/multicurrency/class/api_multicurrencies.class.php index ade16c56664..82617fd1830 100644 --- a/htdocs/multicurrency/class/api_multicurrencies.class.php +++ b/htdocs/multicurrency/class/api_multicurrencies.class.php @@ -1,6 +1,6 @@ - * Copyright (C) 2024 MDW + * Copyright (C) 2024-2025 MDW * * 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 @@ -194,6 +194,8 @@ class MultiCurrencies extends DolibarrApi * Create Currency object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of Currency * * @throws RestException @@ -246,7 +248,9 @@ class MultiCurrencies extends DolibarrApi * Update Currency * * @param int $id Id of Currency to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object The updated Currency * * @throws RestException @@ -320,6 +324,8 @@ class MultiCurrencies extends DolibarrApi * * @param int $id Currency ID * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object|false Object with cleaned properties * * @throws RestException diff --git a/htdocs/partnership/class/api_partnerships.class.php b/htdocs/partnership/class/api_partnerships.class.php index 5a72c67ea5d..f00b71d37a3 100644 --- a/htdocs/partnership/class/api_partnerships.class.php +++ b/htdocs/partnership/class/api_partnerships.class.php @@ -1,5 +1,6 @@ + * Copyright (C) 2025 MDW * * 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 @@ -36,7 +37,7 @@ dol_include_once('/partnership/class/partnership.class.php'); class Partnerships extends DolibarrApi { /** - * @var Partnership $partnership {@type Partnership} + * @var Partnership {@type Partnership} */ public $partnership; @@ -44,7 +45,6 @@ class Partnerships extends DolibarrApi * Constructor * * @url GET / - * */ public function __construct() { @@ -179,7 +179,9 @@ class Partnerships extends DolibarrApi /** * Create partnership object * - * @param array $request_data Request datas + * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of partnership * * @throws RestException @@ -208,7 +210,7 @@ class Partnerships extends DolibarrApi // Clean data // $this->partnership->abc = sanitizeVal($this->partnership->abc, 'alphanohtml'); - if ($this->partnership->create(DolibarrApiAccess::$user)<0) { + if ($this->partnership->create(DolibarrApiAccess::$user) < 0) { throw new RestException(500, "Error creating Partnership", array_merge(array($this->partnership->error), $this->partnership->errors)); } return $this->partnership->id; @@ -218,7 +220,9 @@ class Partnerships extends DolibarrApi * Update partnership * * @param int $id Id of partnership to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Updated object * * @throws RestException diff --git a/htdocs/product/class/api_products.class.php b/htdocs/product/class/api_products.class.php index 8e1bb74e0d7..fd425243af8 100644 --- a/htdocs/product/class/api_products.class.php +++ b/htdocs/product/class/api_products.class.php @@ -2,7 +2,7 @@ /* Copyright (C) 2015 Jean-François Ferry * Copyright (C) 2019 Cedric Ancelin * Copyright (C) 2024 Frédéric France - * Copyright (C) 2024 MDW + * Copyright (C) 2024-2025 MDW * * 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 @@ -37,7 +37,7 @@ require_once DOL_DOCUMENT_ROOT.'/variants/class/ProductCombination2ValuePair.cla class Products 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( 'ref', @@ -45,12 +45,12 @@ class Products extends DolibarrApi ); /** - * @var Product $product {@type Product} + * @var Product {@type Product} */ public $product; /** - * @var ProductFournisseur $productsupplier {@type ProductFournisseur} + * @var ProductFournisseur {@type ProductFournisseur} */ public $productsupplier; @@ -304,6 +304,8 @@ class Products extends DolibarrApi * Create product object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of product */ public function post($request_data = null) @@ -359,7 +361,9 @@ class Products extends DolibarrApi * See other APIs for other price modes. * * @param int $id Id of product to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Updated object * * @throws RestException 401 @@ -897,7 +901,6 @@ class Products extends DolibarrApi * * @throws RestException 401 * @throws RestException 404 - * */ public function deletePurchasePrice($id, $priceid) { @@ -1043,7 +1046,6 @@ class Products extends DolibarrApi * @throws RestException 401 * @throws RestException 403 * @throws RestException 404 - * */ public function getPurchasePrices($id, $ref = '', $ref_ext = '', $barcode = '') { @@ -1329,7 +1331,9 @@ class Products extends DolibarrApi * Update attributes by id. * * @param int $id ID of Attribute - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Object with cleaned properties * * @throws RestException @@ -1643,7 +1647,9 @@ class Products extends DolibarrApi * Update attribute value. * * @param int $id ID of Attribute - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Object with cleaned properties * * @throws RestException 401 @@ -1916,7 +1922,9 @@ class Products extends DolibarrApi * Put product variants. * * @param int $id ID of Variant - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int * * @throws RestException 500 System error diff --git a/htdocs/product/stock/class/api_warehouses.class.php b/htdocs/product/stock/class/api_warehouses.class.php index bca43d80a40..1a7cb9a550a 100644 --- a/htdocs/product/stock/class/api_warehouses.class.php +++ b/htdocs/product/stock/class/api_warehouses.class.php @@ -1,5 +1,6 @@ + * Copyright (C) 2025 MDW * * 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 @@ -15,10 +16,10 @@ * along with this program. If not, see . */ - use Luracast\Restler\RestException; +use Luracast\Restler\RestException; - require_once DOL_DOCUMENT_ROOT.'/product/stock/class/entrepot.class.php'; - require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php'; +require_once DOL_DOCUMENT_ROOT.'/product/stock/class/entrepot.class.php'; +require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php'; /** * API class for warehouses @@ -29,14 +30,14 @@ class Warehouses 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( 'label', ); /** - * @var Entrepot $warehouse {@type Entrepot} + * @var Entrepot {@type Entrepot} */ public $warehouse; @@ -159,6 +160,8 @@ class Warehouses extends DolibarrApi * Create warehouse object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of warehouse */ public function post($request_data = null) @@ -189,7 +192,9 @@ class Warehouses extends DolibarrApi * Update warehouse * * @param int $id Id of warehouse to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Updated object */ public function put($id, $request_data = null) diff --git a/htdocs/projet/class/api_tasks.class.php b/htdocs/projet/class/api_tasks.class.php index e51899beae2..08b0facb0ea 100644 --- a/htdocs/projet/class/api_tasks.class.php +++ b/htdocs/projet/class/api_tasks.class.php @@ -2,6 +2,7 @@ /* Copyright (C) 2015 Jean-François Ferry * Copyright (C) 2016 Laurent Destailleur * Copyright (C) 2024 Frédéric France + * Copyright (C) 2025 MDW * * 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 @@ -32,7 +33,7 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php'; class Tasks 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( 'ref', @@ -41,7 +42,7 @@ class Tasks extends DolibarrApi ); /** - * @var Task $task {@type Task} + * @var Task {@type Task} */ public $task; @@ -186,6 +187,8 @@ class Tasks extends DolibarrApi * Create task object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of project */ public function post($request_data = null) @@ -269,7 +272,6 @@ class Tasks extends DolibarrApi * @return array Array of roles * * @url GET {id}/roles - * */ public function getRoles($id, $userid = 0) { @@ -308,6 +310,8 @@ class Tasks extends DolibarrApi // * // * @param int $id Id of project to update // * @param array $request_data Projectline data + // * @phan-param ?array $request_data + // * @phpstan-param ?array $request_data // * // * @url POST {id}/tasks // * @@ -375,6 +379,8 @@ class Tasks extends DolibarrApi // * @param int $id Id of project to update // * @param int $taskid Id of task to update // * @param array $request_data Projectline data + // * @phan-param ?array $request_data + // * @phpstan-param ?array $request_data // * // * @url PUT {id}/tasks/{taskid} // * @@ -437,7 +443,9 @@ class Tasks extends DolibarrApi * Update task general fields (won't touch time spent of task) * * @param int $id Id of task to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Updated object */ public function put($id, $request_data = null) diff --git a/htdocs/reception/class/api_receptions.class.php b/htdocs/reception/class/api_receptions.class.php index 35f4624317c..e536919e8aa 100644 --- a/htdocs/reception/class/api_receptions.class.php +++ b/htdocs/reception/class/api_receptions.class.php @@ -292,6 +292,8 @@ class Receptions extends DolibarrApi // * // * @param int $id Id of reception to update // * @param array $request_data ShipmentLine data + // * @phan-param ?array $request_data + // * @phpstan-param ?array $request_data // * // * @url POST {id}/lines // * @@ -360,6 +362,8 @@ class Receptions extends DolibarrApi // * @param int $id Id of reception to update // * @param int $lineid Id of line to update // * @param array $request_data ShipmentLine data + // * @phan-param ?array $request_data + // * @phpstan-param ?array $request_data // * // * @url PUT {id}/lines/{lineid} // * diff --git a/htdocs/salaries/class/api_salaries.class.php b/htdocs/salaries/class/api_salaries.class.php index 648d7d0efaf..d55c3debb7d 100644 --- a/htdocs/salaries/class/api_salaries.class.php +++ b/htdocs/salaries/class/api_salaries.class.php @@ -1,6 +1,7 @@ + * Copyright (C) 2025 MDW * * 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 @@ -31,9 +32,9 @@ require_once DOL_DOCUMENT_ROOT.'/salaries/class/paymentsalary.class.php'; class Salaries extends DolibarrApi { /** - * @var array $FIELDS Mandatory fields, checked when creating an object + * @var array Mandatory fields, checked when creating an object */ - static $FIELDS = array( + public static $FIELDS = array( 'fk_user', 'label', 'amount', @@ -42,7 +43,7 @@ class Salaries extends DolibarrApi /** * array $FIELDS Mandatory fields, checked when creating an object */ - static $FIELDSPAYMENT = array( + public static $FIELDSPAYMENT = array( "paiementtype", 'datepaye', 'chid', @@ -138,6 +139,8 @@ class Salaries extends DolibarrApi * Create salary object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of salary */ public function post($request_data = null) @@ -164,6 +167,8 @@ class Salaries extends DolibarrApi * * @param int $id ID of salary * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Updated object */ public function put($id, $request_data = null) @@ -307,6 +312,8 @@ class Salaries extends DolibarrApi * * @param int $id Id of salary * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of paymentsalary * * @url POST {id}/payments @@ -348,6 +355,8 @@ class Salaries extends DolibarrApi * * @param int $id ID of paymentsalary * @param array $request_data data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object PaymentSalary object * * @url POST {id}/payments @@ -444,7 +453,9 @@ class Salaries extends DolibarrApi { $paymentsalary = array(); $fields = Salaries::$FIELDSPAYMENT; - if (isModEnabled("bank")) array_push($fields, "accountid"); + if (isModEnabled("bank")) { + array_push($fields, "accountid"); + } foreach ($fields as $field) { if (!isset($data[$field])) { throw new RestException(400, "$field field missing"); diff --git a/htdocs/societe/class/api_thirdparties.class.php b/htdocs/societe/class/api_thirdparties.class.php index d42054361b6..f5972267cc1 100644 --- a/htdocs/societe/class/api_thirdparties.class.php +++ b/htdocs/societe/class/api_thirdparties.class.php @@ -4,7 +4,7 @@ * Copyright (C) 2019 Cedric Ancelin * Copyright (C) 2020-2024 Frédéric France * Copyright (C) 2023 Alexandre Janniaux - * Copyright (C) 2024 MDW + * Copyright (C) 2024-2025 MDW * Copyright (C) 2024 Jon Bendtsen * * This program is free software; you can redistribute it and/or modify @@ -28,20 +28,18 @@ use Luracast\Restler\RestException; * * @access protected * @class DolibarrApiAccess {@requires user,external} - * */ class Thirdparties extends DolibarrApi { /** - * - * @var array $FIELDS Mandatory fields, checked when we create and update the object + * @var array Mandatory fields, checked when we create and update the object */ public static $FIELDS = array( 'name' ); /** - * @var Societe $company {@type Societe} + * @var Societe {@type Societe} */ public $company; @@ -263,7 +261,9 @@ class Thirdparties extends DolibarrApi /** * Create thirdparty object * - * @param array $request_data Request datas + * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of thirdparty */ public function post($request_data = null) @@ -298,7 +298,9 @@ class Thirdparties extends DolibarrApi * Update thirdparty * * @param int $id Id of thirdparty to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object|false Updated object * * @throws RestException 401 @@ -1176,8 +1178,11 @@ class Thirdparties extends DolibarrApi /** * Create CompanyNotification object for thirdparty + * * @param int $id ID of thirdparty * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @return array|mixed Notification of thirdparty * @@ -1230,9 +1235,12 @@ class Thirdparties extends DolibarrApi /** * Create CompanyNotification object for thirdparty using action trigger code + * * @param int $id ID of thirdparty * @param string $code Action Trigger code * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @return array|mixed Notification of thirdparty * @phan-return Notify @@ -1330,6 +1338,8 @@ class Thirdparties extends DolibarrApi * @param int $id ID of thirdparty * @param int $notification_id ID of CompanyNotification * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @return array|mixed Notification of thirdparty * @@ -1445,8 +1455,11 @@ class Thirdparties extends DolibarrApi /** * Create CompanyBankAccount object for thirdparty + * * @param int $id ID of thirdparty * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @return array|mixed BankAccount of thirdparty * @@ -1498,6 +1511,8 @@ class Thirdparties extends DolibarrApi * @param int $id ID of thirdparty * @param int $bankaccount_id ID of CompanyBankAccount * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @return array|mixed BankAccount of thirdparty * @@ -1759,10 +1774,10 @@ class Thirdparties extends DolibarrApi $result = $this->db->query($sql); if ($result && $this->db->num_rows($result) == 1) { - $obj = $this->db->fetch_object($result); - $returnThirdparty = $this->_fetch($obj->fk_soc); + $obj = $this->db->fetch_object($result); + $returnThirdparty = $this->_fetch($obj->fk_soc); } else { - throw new RestException(404, 'This account have many thirdparties attached or does not exist.'); + throw new RestException(404, 'This account have many thirdparties attached or does not exist.'); } if (!DolibarrApi::_checkAccessToResource('societe', $returnThirdparty->id)) { @@ -1781,6 +1796,8 @@ class Thirdparties extends DolibarrApi * * @param int $id ID of thirdparty * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @return array|mixed * @@ -1846,6 +1863,8 @@ class Thirdparties extends DolibarrApi * @param int $id ID of thirdparty * @param string $site Site key * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @return array|mixed * @@ -1939,6 +1958,8 @@ class Thirdparties extends DolibarrApi * @param int $id Id of thirdparty * @param string $site Site key * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * * @return array|mixed * diff --git a/htdocs/supplier_proposal/class/api_supplier_proposals.class.php b/htdocs/supplier_proposal/class/api_supplier_proposals.class.php index f5aa912e1f1..a7b91c68681 100644 --- a/htdocs/supplier_proposal/class/api_supplier_proposals.class.php +++ b/htdocs/supplier_proposal/class/api_supplier_proposals.class.php @@ -1,6 +1,7 @@ * Copyright (C) 2016 Laurent Destailleur + * Copyright (C) 2025 MDW * * 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,14 +31,14 @@ require_once DOL_DOCUMENT_ROOT.'/supplier_proposal/class/supplier_proposal.class class SupplierProposals 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' ); /** - * @var SupplierProposal $supplier_proposal {@type SupplierProposal} + * @var SupplierProposal {@type SupplierProposal} */ public $supplier_proposal; @@ -116,6 +117,8 @@ class SupplierProposals extends DolibarrApi * Create supplier proposal (price request) object * * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of supplier proposal */ public function post($request_data = null) @@ -153,7 +156,9 @@ class SupplierProposals extends DolibarrApi * Update supplier proposal general fields (won't touch lines of supplier proposal) * * @param int $id Id of supplier proposal to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Object with cleaned properties */ public function put($id, $request_data = null) diff --git a/htdocs/ticket/class/api_tickets.class.php b/htdocs/ticket/class/api_tickets.class.php index 6b2d9e759c9..fafc67c469d 100644 --- a/htdocs/ticket/class/api_tickets.class.php +++ b/htdocs/ticket/class/api_tickets.class.php @@ -32,7 +32,7 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/ticket.lib.php'; class Tickets 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( 'subject', @@ -40,7 +40,7 @@ class Tickets extends DolibarrApi ); /** - * @var array $FIELDS_MESSAGES Mandatory fields, checked when create and update object + * @var array Mandatory fields, checked when create and update object */ public static $FIELDS_MESSAGES = array( 'track_id', @@ -48,7 +48,7 @@ class Tickets extends DolibarrApi ); /** - * @var Ticket $ticket {@type Ticket} + * @var Ticket {@type Ticket} */ public $ticket; @@ -202,7 +202,6 @@ class Tickets extends DolibarrApi * @param bool $pagination_data If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0* * * @return array Array of ticket objects - * */ public function index($socid = 0, $sortfield = "t.rowid", $sortorder = "ASC", $limit = 100, $page = 0, $sqlfilters = '', $properties = '', $pagination_data = false) { @@ -303,7 +302,9 @@ class Tickets extends DolibarrApi /** * Create ticket object * - * @param array $request_data Request datas + * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of ticket */ public function post($request_data = null) @@ -341,9 +342,10 @@ class Tickets extends DolibarrApi /** * Add a new message to an existing ticket identified by property ->track_id into request. * - * @param array $request_data Request datas + * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of ticket - * */ public function postNewMessage($request_data = null) { @@ -379,7 +381,9 @@ class Tickets extends DolibarrApi * Update ticket * * @param int $id Id of ticket to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object Updated object */ public function put($id, $request_data = null) @@ -429,7 +433,6 @@ class Tickets extends DolibarrApi * * @param int $id Ticket ID * @return array - * */ public function delete($id) { @@ -505,7 +508,6 @@ class Tickets extends DolibarrApi * @return Object Object with cleaned properties * * @todo use an array for properties to clean - * */ protected function _cleanObjectDatas($object) { diff --git a/htdocs/webhook/class/api_webhook.class.php b/htdocs/webhook/class/api_webhook.class.php index 90b133cc0fd..55d7ae209f9 100644 --- a/htdocs/webhook/class/api_webhook.class.php +++ b/htdocs/webhook/class/api_webhook.class.php @@ -1,5 +1,6 @@ + * Copyright (C) 2025 MDW * * 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 @@ -22,13 +23,11 @@ use Luracast\Restler\RestException; * * @access protected * @class DolibarrApiAccess {@requires user} - * */ class Webhook extends DolibarrApi { /** - * - * @var array $FIELDS Mandatory fields, checked when we create and update the object + * @var array Mandatory fields, checked when we create and update the object */ public static $FIELDS = array( 'url', @@ -36,7 +35,7 @@ class Webhook extends DolibarrApi ); /** - * @var Target $target {@type Target} + * @var Target {@type Target} */ public $target; @@ -158,7 +157,9 @@ class Webhook extends DolibarrApi /** * Create target object * - * @param array $request_data Request datas + * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return int ID of target */ public function post($request_data = null) @@ -188,7 +189,9 @@ class Webhook extends DolibarrApi * Update target * * @param int $id Id of target to update - * @param array $request_data Datas + * @param array $request_data Data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return Object|false Updated object * * @throws RestException 401 diff --git a/htdocs/zapier/class/api_zapier.class.php b/htdocs/zapier/class/api_zapier.class.php index 63c22ef7b74..1416009cdc2 100644 --- a/htdocs/zapier/class/api_zapier.class.php +++ b/htdocs/zapier/class/api_zapier.class.php @@ -1,7 +1,7 @@ * Copyright (C) 2019-2024 Frédéric France - * Copyright (C) 2024 MDW + * Copyright (C) 2024-2025 MDW * * 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 @@ -37,7 +37,7 @@ require_once DOL_DOCUMENT_ROOT.'/zapier/class/hook.class.php'; class Zapier 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( 'url', @@ -45,7 +45,7 @@ class Zapier extends DolibarrApi /** - * @var Hook $hook {@type Hook} + * @var Hook {@type Hook} */ public $hook; @@ -53,7 +53,6 @@ class Zapier extends DolibarrApi * Constructor * * @url GET / - * */ public function __construct() { @@ -221,7 +220,9 @@ class Zapier extends DolibarrApi /** * Create hook object * - * @param array $request_data Request datas + * @param array $request_data Request data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * @return array ID of hook * * @url POST /hook/