From 3e16fac9ea6c1b921d83228a1a22d8034e3ff245 Mon Sep 17 00:00:00 2001 From: William Mead Date: Sun, 7 Dec 2025 11:52:13 +0100 Subject: [PATCH 1/2] Added postLine method to expense report API. Added mandatory expense report line fields check. --- .../class/api_expensereports.class.php | 130 +++++++++++------- 1 file changed, 77 insertions(+), 53 deletions(-) diff --git a/htdocs/expensereport/class/api_expensereports.class.php b/htdocs/expensereport/class/api_expensereports.class.php index 3a8ae5f764d..338c0fab66c 100644 --- a/htdocs/expensereport/class/api_expensereports.class.php +++ b/htdocs/expensereport/class/api_expensereports.class.php @@ -23,7 +23,7 @@ use Luracast\Restler\RestException; require_once DOL_DOCUMENT_ROOT.'/expensereport/class/expensereport.class.php'; require_once DOL_DOCUMENT_ROOT.'/expensereport/class/paymentexpensereport.class.php'; - +require_once DOL_DOCUMENT_ROOT.'/core/lib/price.lib.php'; /** * API class for Expense Reports @@ -44,6 +44,17 @@ class ExpenseReports extends DolibarrApi 'date_fin', ); + /** + * @var string[] Mandatory fields, checked when create and update object + */ + public static $FIELDSLINE = array( + 'date', + 'fk_c_type_fees', + 'qty', + 'total_ttc', + 'vatrate' + ); + /** * @var string[] Mandatory fields, checked when create and update object */ @@ -278,73 +289,63 @@ class ExpenseReports extends DolibarrApi */ /** - * Add a line to given Expense Report + * Add a line to an expense report * - * @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 + * @param int $id ID of expense report to update + * @param array $request_data Expense Report line data + * @phan-param ?array $request_data + * @phpstan-param ?array $request_data * - * @url POST {id}/lines + * @url POST {id}/line * * @return int + * + * @throws RestException */ - /* public function postLine($id, $request_data = null) { - if(! DolibarrApiAccess::$user->hasRight('expensereport', 'creer')) { - throw new RestException(403); - } + if (!DolibarrApiAccess::$user->hasRight('expensereport', 'creer')) { + throw new RestException(403); + } - $result = $this->expensereport->fetch($id); - if( ! $result ) { - throw new RestException(404, 'expensereport not found'); - } + $result = $this->_validateLine($request_data); - if( ! DolibarrApi::_checkAccessToResource('expensereport',$this->expensereport->id)) { - throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login); - } + $result = $this->expensereport->fetch($id); + if (!$result) { + throw new RestException(404, 'Expense report not found'); + } - $request_data = (object) $request_data; + if (!DolibarrApi::_checkAccessToResource('expensereport', $this->expensereport->id)) { + throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login); + } - $request_data->desc = sanitizeVal($request_data->desc, 'restricthtml'); - $request_data->label = sanitizeVal($request_data->label); + if ($this->expensereport->status != ExpenseReport::STATUS_DRAFT) { + throw new RestException(403, 'Expense report must be in draft status to add lines'); + } - $updateRes = $this->expensereport->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, - $this->element, - $request_data->id - ); + $request_data = (object) $request_data; - if ($updateRes > 0) { - return $updateRes; + $request_data->comments = sanitizeVal($request_data->comments, 'restricthtml'); - } - return false; + $result = $this->expensereport->addline( + $request_data->qty, + $request_data->total_ttc, + (int) $request_data->fk_c_type_fees, + $request_data->vatrate, + $request_data->date, + $request_data->comments, + $request_data->fk_project, + $request_data->fk_c_exp_tax_cat, + $request_data->type, + $request_data->fk_ecm_files + ); + + if ($result > 0) { + return $result; + } else { + throw new RestException(500, 'Error adding line to expense report: '.$this->expensereport->error); + } } - */ /** * Update a line to given Expense Report @@ -988,4 +989,27 @@ class ExpenseReports extends DolibarrApi } return $expensereport; } + + /** + * Validate fields before create or update object + * + * @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(); + } + $expenseReport = array(); + foreach (ExpenseReports::$FIELDSLINE as $field) { + if (!isset($data[$field])) { + throw new RestException(400, "$field field missing"); + } + $expenseReport[$field] = $data[$field]; + } + return $expenseReport; + } } From a1a4b2a43b7b4909f174369b95d2d72e5dfe4764 Mon Sep 17 00:00:00 2001 From: William Mead Date: Sun, 7 Dec 2025 14:16:11 +0100 Subject: [PATCH 2/2] Updated PHPDoc --- htdocs/expensereport/class/api_expensereports.class.php | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/htdocs/expensereport/class/api_expensereports.class.php b/htdocs/expensereport/class/api_expensereports.class.php index 338c0fab66c..f3a1c0c5f39 100644 --- a/htdocs/expensereport/class/api_expensereports.class.php +++ b/htdocs/expensereport/class/api_expensereports.class.php @@ -291,7 +291,9 @@ class ExpenseReports extends DolibarrApi /** * Add a line to an expense report * - * @param int $id ID of expense report to update + * @since 23.0.0 Initial implementation + * + * @param int $id ID of the expense report to update * @param array $request_data Expense Report line data * @phan-param ?array $request_data * @phpstan-param ?array $request_data