From 08abc60a5e49e9149dbf83ce9468b9ba150f9d2f Mon Sep 17 00:00:00 2001
From: MDW <mdeweerd@users.noreply.github.com>
Date: Tue, 13 Feb 2024 08:50:57 +0100
Subject: [PATCH] Qual: Improve typing hints (#28158)

# Qual: Improve typing hints

Improve some typing hints (helps phan).
---
 htdocs/webservices/server_payment.php | 45 ++++++++++++++-------------
 1 file changed, 23 insertions(+), 22 deletions(-)

diff --git a/htdocs/webservices/server_payment.php b/htdocs/webservices/server_payment.php
index db26fc970e0..1136b457b83 100644
--- a/htdocs/webservices/server_payment.php
+++ b/htdocs/webservices/server_payment.php
@@ -1,5 +1,6 @@
 <?php
 /* Copyright (C) 2006-2010 Laurent Destailleur  <eldy@users.sourceforge.net>
+ * Copyright (C) 2024		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
@@ -87,11 +88,11 @@ $server->wsdl->addComplexType(
 	'all',
 	'',
 	array(
-		'dolibarrkey'       => array('name'=>'dolibarrkey', 'type'=>'xsd:string'),
-	   'sourceapplication' => array('name'=>'sourceapplication', 'type'=>'xsd:string'),
-	   'login'             => array('name'=>'login', 'type'=>'xsd:string'),
-		'password'          => array('name'=>'password', 'type'=>'xsd:string'),
-		'entity'            => array('name'=>'entity', 'type'=>'xsd:string')
+		'dolibarrkey'       => array('name' => 'dolibarrkey', 'type' => 'xsd:string'),
+	   'sourceapplication' => array('name' => 'sourceapplication', 'type' => 'xsd:string'),
+	   'login'             => array('name' => 'login', 'type' => 'xsd:string'),
+		'password'          => array('name' => 'password', 'type' => 'xsd:string'),
+		'entity'            => array('name' => 'entity', 'type' => 'xsd:string')
 	)
 );
 // Define WSDL Return object
@@ -102,8 +103,8 @@ $server->wsdl->addComplexType(
 	'all',
 	'',
 	array(
-		'result_code'  => array('name'=>'result_code', 'type'=>'xsd:string'),
-		'result_label' => array('name'=>'result_label', 'type'=>'xsd:string'),
+		'result_code'  => array('name' => 'result_code', 'type' => 'xsd:string'),
+		'result_label' => array('name' => 'result_label', 'type' => 'xsd:string'),
 	)
 );
 
@@ -115,15 +116,15 @@ $server->wsdl->addComplexType(
 	'all',
 	'',
 	array(
-		'amount'          => array('name'=>'amount', 'type'=>'xsd:double'),
-		'num_payment'     => array('name'=>'num_payment', 'type'=>'xsd:string'),
-		'thirdparty_id'   => array('name'=>'thirdparty_id', 'type'=>'xsd:int'),
-			   'bank_account'    => array('name'=>'bank_account', 'type'=>'xsd:int'),
-			   'payment_mode_id' => array('name'=>'payment_mode_id', 'type'=>'xsd:int'),
-			   'invoice_id'      => array('name'=>'invoice_id', 'type'=>'xsd:int'),
-			   'int_label'       => array('name'=>'int_label', 'type'=>'xsd:string'),
-			   'emitter'         => array('name'=>'emitter', 'type'=>'xsd:string'),
-			   'bank_source'     => array('name'=>'bank_source', 'type'=>'xsd:string'),
+		'amount'          => array('name' => 'amount', 'type' => 'xsd:double'),
+		'num_payment'     => array('name' => 'num_payment', 'type' => 'xsd:string'),
+		'thirdparty_id'   => array('name' => 'thirdparty_id', 'type' => 'xsd:int'),
+			   'bank_account'    => array('name' => 'bank_account', 'type' => 'xsd:int'),
+			   'payment_mode_id' => array('name' => 'payment_mode_id', 'type' => 'xsd:int'),
+			   'invoice_id'      => array('name' => 'invoice_id', 'type' => 'xsd:int'),
+			   'int_label'       => array('name' => 'int_label', 'type' => 'xsd:string'),
+			   'emitter'         => array('name' => 'emitter', 'type' => 'xsd:string'),
+			   'bank_source'     => array('name' => 'bank_source', 'type' => 'xsd:string'),
 	)
 );
 
@@ -138,9 +139,9 @@ $styleuse = 'encoded'; // encoded/literal/literal wrapped
 $server->register(
 	'createPayment',
 	// Entry values
-	array('authentication'=>'tns:authentication', 'payment'=>'tns:payment'),
+	array('authentication' => 'tns:authentication', 'payment' => 'tns:payment'),
 	// Exit values
-	array('result'=>'tns:result', 'id'=>'xsd:string', 'ref'=>'xsd:string', 'ref_ext'=>'xsd:string'),
+	array('result' => 'tns:result', 'id' => 'xsd:string', 'ref' => 'xsd:string', 'ref_ext' => 'xsd:string'),
 	$ns,
 	$ns.'#createPayment',
 	$styledoc,
@@ -153,8 +154,8 @@ $server->register(
  * Create a payment
  *
  * @param      array           $authentication         Array of authentication information
- * @param      Object          $payment                Payment
- * @return     array                                   Array result
+ * @param      array{id:int,thirdparty_id:int|string,amount:float|string,num_payment:string,bank_account:int|string,payment_mode_id?:int|string,invoice_id?:int|string,int_label?:string,emitter:string,bank_source:string} $payment	Payment
+ * @return     array{result:array{result_code:string,result_label:string},id?:int}	Array result
  */
 function createPayment($authentication, $payment)
 {
@@ -213,7 +214,7 @@ function createPayment($authentication, $payment)
 
 		if (!$error) {
 			$db->commit();
-			$objectresp = array('result'=>array('result_code'=>'OK', 'result_label'=>''), 'id'=>$new_payment->id);
+			$objectresp = array('result' => array('result_code' => 'OK', 'result_label' => ''), 'id' => $new_payment->id);
 		} else {
 			$db->rollback();
 			$error++;
@@ -224,7 +225,7 @@ function createPayment($authentication, $payment)
 	}
 
 	if ($error) {
-		$objectresp = array('result'=>array('result_code' => $errorcode, 'result_label' => $errorlabel));
+		$objectresp = array('result' => array('result_code' => $errorcode, 'result_label' => $errorlabel));
 	}
 
 	return $objectresp;