From f594f6817942962e85cec330d3de46ff26c00903 Mon Sep 17 00:00:00 2001 From: 719media Date: Wed, 18 Jan 2023 14:09:03 -0800 Subject: [PATCH] Update TransactionGateway.php Just some examples of bad phpdoc: Not using @throws, putting the @throws into the return (crazy lol). If the method could throw many/multiple things, I left as `@throws Exception` as a generic, but if desired you could go deeper --- lib/Braintree/TransactionGateway.php | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/lib/Braintree/TransactionGateway.php b/lib/Braintree/TransactionGateway.php index 537c54b9..b34bcc94 100644 --- a/lib/Braintree/TransactionGateway.php +++ b/lib/Braintree/TransactionGateway.php @@ -399,7 +399,9 @@ public function creditNoValidate($attribs) * * @param string $id unique identifier of the transaction * - * @return Transaction|Exception\NotFound + * @return Transaction + * + * @throws Exception\NotFound */ public function find($id) { @@ -453,6 +455,8 @@ public function saleNoValidate($attribs) * @param mixed $query search query * * @return ResourceCollection + * + * @throws Exception\RequestTimeout */ public function search($query) { @@ -483,6 +487,8 @@ public function search($query) * @param array $ids to use in searching * * @return array + * + * @throws Exception\RequestTimeout */ public function fetch($query, $ids) { @@ -542,7 +548,9 @@ public function void($transactionId) * * @param string $transactionId unique identifier * - * @return Transaction|Result\Error + * @return Transaction + * + * @throws Exception */ public function voidNoValidate($transactionId) { @@ -577,7 +585,9 @@ public function submitForSettlement($transactionId, $amount = null, $attribs = [ * @param string|null $amount to be submitted for settlement * @param array $attribs containing any additional request parameters * - * @return Transaction|Exception + * @return Transaction + * + * @throws Exception */ public function submitForSettlementNoValidate($transactionId, $amount = null, $attribs = []) { @@ -610,7 +620,9 @@ public function updateDetails($transactionId, $attribs = []) * @param string $amount optional * @param mixed $attribs any additional request parameters * - * @return Result\Successful|Exception\NotFound + * @return Result\Successful|Result\Error + * + * @throws Exception */ public function submitForPartialSettlement($transactionId, $amount, $attribs = []) {