Completed
Pull Request — 23 (#431)
by Harald
05:09
created
catalog/includes/apps/braintree/lib/Braintree/AddressGateway.php 1 patch
Doc Comments   +3 added lines, -4 removed lines patch added patch discarded remove patch
@@ -175,8 +175,7 @@  discard block
 block discarded – undo
175 175
      * customerOrId & addressId are not sent in object context.
176 176
      *
177 177
      * @access public
178
-     * @param array $transactionAttribs
179
-     * @param string $customerId
178
+     * @param string $customerOrId
180 179
      * @return Transaction
181 180
      * @throws Exception\ValidationsFailed
182 181
      * @see Address::update()
@@ -189,7 +188,7 @@  discard block
 block discarded – undo
189 188
 
190 189
     /**
191 190
      * creates a full array signature of a valid create request
192
-     * @return array gateway create request format
191
+     * @return string[] gateway create request format
193 192
      */
194 193
     public static function createSignature()
195 194
     {
@@ -202,7 +201,7 @@  discard block
 block discarded – undo
202 201
 
203 202
     /**
204 203
      * creates a full array signature of a valid update request
205
-     * @return array gateway update request format
204
+     * @return string[] gateway update request format
206 205
      */
207 206
     public static function updateSignature()
208 207
     {
Please login to merge, or discard this patch.
catalog/includes/apps/braintree/lib/Braintree/ClientTokenGateway.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -51,9 +51,9 @@
 block discarded – undo
51 51
      * sends the generate request to the gateway
52 52
      *
53 53
      * @ignore
54
-     * @param var $url
55 54
      * @param array $params
56
-     * @return mixed
55
+     * @param string $subPath
56
+     * @return string
57 57
      */
58 58
     public function _doGenerate($subPath, $params)
59 59
     {
Please login to merge, or discard this patch.
catalog/includes/apps/braintree/lib/Braintree/CredentialsParser.php 1 patch
Doc Comments   +4 added lines patch added patch discarded remove patch
@@ -82,6 +82,10 @@
 block discarded – undo
82 82
         }
83 83
     }
84 84
 
85
+    /**
86
+     * @param string $credentialType
87
+     * @param string $expectedValuePrefix
88
+     */
85 89
     private function _parseClientCredential($credentialType, $value, $expectedValuePrefix)
86 90
     {
87 91
         $explodedCredential = explode('$', $value);
Please login to merge, or discard this patch.
catalog/includes/apps/braintree/lib/Braintree/CreditCardGateway.php 1 patch
Doc Comments   +8 added lines, -6 removed lines patch added patch discarded remove patch
@@ -22,6 +22,9 @@  discard block
 block discarded – undo
22 22
     private $_config;
23 23
     private $_http;
24 24
 
25
+    /**
26
+     * @param Gateway $gateway
27
+     */
25 28
     public function __construct($gateway)
26 29
     {
27 30
         $this->_gateway = $gateway;
@@ -55,7 +58,6 @@  discard block
 block discarded – undo
55 58
      *
56 59
      * @deprecated since version 2.3.0
57 60
      * @access public
58
-     * @param array $attribs
59 61
      * @return Result\Successful|Result\Error
60 62
      */
61 63
     public function createFromTransparentRedirect($queryString)
@@ -190,7 +192,6 @@  discard block
 block discarded – undo
190 192
      * create a credit on the card for the passed transaction
191 193
      *
192 194
      * @access public
193
-     * @param array $attribs
194 195
      * @return Result\Successful|Result\Error
195 196
      */
196 197
     public function credit($token, $transactionAttribs)
@@ -210,7 +211,6 @@  discard block
 block discarded – undo
210 211
      * returns a Transaction object on success
211 212
      *
212 213
      * @access public
213
-     * @param array $attribs
214 214
      * @return Transaction
215 215
      * @throws Exception\ValidationError
216 216
      */
@@ -311,7 +311,6 @@  discard block
 block discarded – undo
311 311
      *
312 312
      * @deprecated since version 2.3.0
313 313
      * @access public
314
-     * @param array $attribs
315 314
      * @return object
316 315
      */
317 316
     public function updateFromTransparentRedirect($queryString)
@@ -340,6 +339,9 @@  discard block
 block discarded – undo
340 339
         return ['makeDefault', 'verificationMerchantAccountId', 'verifyCard', 'verificationAmount', 'venmoSdkSession'];
341 340
     }
342 341
 
342
+    /**
343
+     * @param string[] $options
344
+     */
343 345
     private static function baseSignature($options)
344 346
     {
345 347
          return [
@@ -423,7 +425,6 @@  discard block
 block discarded – undo
423 425
      * verifies that a valid credit card identifier is being used
424 426
      * @ignore
425 427
      * @param string $identifier
426
-     * @param Optional $string $identifierType type of identifier supplied, default "token"
427 428
      * @throws InvalidArgumentException
428 429
      */
429 430
     private function _validateId($identifier = null, $identifierType = "token")
@@ -444,8 +445,9 @@  discard block
 block discarded – undo
444 445
      * sends the update request to the gateway
445 446
      *
446 447
      * @ignore
447
-     * @param string $url
448 448
      * @param array $params
449
+     * @param string $httpVerb
450
+     * @param string $subPath
449 451
      * @return mixed
450 452
      */
451 453
     private function _doUpdate($httpVerb, $subPath, $params)
Please login to merge, or discard this patch.
catalog/includes/apps/braintree/lib/Braintree/Customer.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -38,7 +38,7 @@  discard block
 block discarded – undo
38 38
 {
39 39
     /**
40 40
      *
41
-     * @return Customer[]
41
+     * @return ResourceCollection
42 42
      */
43 43
     public static function all()
44 44
     {
@@ -190,7 +190,7 @@  discard block
 block discarded – undo
190 190
      * @throws Exception\Unexpected
191 191
      * @param int $customerId
192 192
      * @param array $attributes
193
-     * @return CustomerGateway
193
+     * @return Customer
194 194
      */
195 195
     public static function updateNoValidate($customerId, $attributes)
196 196
     {
Please login to merge, or discard this patch.
catalog/includes/apps/braintree/lib/Braintree/CustomerGateway.php 1 patch
Doc Comments   +11 added lines, -2 removed lines patch added patch discarded remove patch
@@ -21,6 +21,9 @@  discard block
 block discarded – undo
21 21
     private $_config;
22 22
     private $_http;
23 23
 
24
+    /**
25
+     * @param Gateway $gateway
26
+     */
24 27
     public function __construct($gateway)
25 28
     {
26 29
         $this->_gateway = $gateway;
@@ -42,6 +45,10 @@  discard block
 block discarded – undo
42 45
         return new ResourceCollection($response, $pager);
43 46
     }
44 47
 
48
+    /**
49
+     * @param string $query
50
+     * @param integer[] $ids
51
+     */
45 52
     public function fetch($query, $ids)
46 53
     {
47 54
         $criteria = [];
@@ -108,7 +115,7 @@  discard block
 block discarded – undo
108 115
      *
109 116
      * @deprecated since version 2.3.0
110 117
      * @access public
111
-     * @param array $attribs
118
+     * @param string $queryString
112 119
      * @return Customer
113 120
      */
114 121
     public function createFromTransparentRedirect($queryString)
@@ -190,6 +197,7 @@  discard block
 block discarded – undo
190 197
      *
191 198
      * @access public
192 199
      * @param string id customer Id
200
+     * @param string $id
193 201
      * @return Customer|boolean The customer object or false if the request fails.
194 202
      * @throws Exception\NotFound
195 203
      */
@@ -297,7 +305,7 @@  discard block
 block discarded – undo
297 305
      * If <b>query</b> is a hash, the search will be an advanced search.
298 306
      * For more detailed information and examples, see {@link http://www.braintreepayments.com/gateway/customer-api#searching http://www.braintreepaymentsolutions.com/gateway/customer-api}
299 307
      *
300
-     * @param mixed $query search query
308
+     * @param string $query search query
301 309
      * @return ResourceCollection
302 310
      * @throws InvalidArgumentException
303 311
      */
@@ -584,6 +592,7 @@  discard block
 block discarded – undo
584 592
      * @ignore
585 593
      * @param string $subPath
586 594
      * @param array $params
595
+     * @param string $httpVerb
587 596
      * @return mixed
588 597
      */
589 598
     private function _doUpdate($httpVerb, $subPath, $params)
Please login to merge, or discard this patch.
catalog/includes/apps/braintree/lib/Braintree/Http.php 1 patch
Doc Comments   +19 added lines patch added patch discarded remove patch
@@ -17,6 +17,9 @@  discard block
 block discarded – undo
17 17
         $this->_config = $config;
18 18
     }
19 19
 
20
+    /**
21
+     * @param string $path
22
+     */
20 23
     public function delete($path)
21 24
     {
22 25
         $response = $this->_doRequest('DELETE', $path);
@@ -27,6 +30,9 @@  discard block
 block discarded – undo
27 30
         }
28 31
     }
29 32
 
33
+    /**
34
+     * @param string $path
35
+     */
30 36
     public function get($path)
31 37
     {
32 38
         $response = $this->_doRequest('GET', $path);
@@ -37,6 +43,9 @@  discard block
 block discarded – undo
37 43
         }
38 44
     }
39 45
 
46
+    /**
47
+     * @param string $path
48
+     */
40 49
     public function post($path, $params = null)
41 50
     {
42 51
         $response = $this->_doRequest('POST', $path, $this->_buildXml($params));
@@ -48,6 +57,9 @@  discard block
 block discarded – undo
48 57
         }
49 58
     }
50 59
 
60
+    /**
61
+     * @param string $path
62
+     */
51 63
     public function put($path, $params = null)
52 64
     {
53 65
         $response = $this->_doRequest('PUT', $path, $this->_buildXml($params));
@@ -96,11 +108,18 @@  discard block
 block discarded – undo
96 108
         $this->_useClientCredentials = true;
97 109
     }
98 110
 
111
+    /**
112
+     * @param string $httpVerb
113
+     * @param string $requestBody
114
+     */
99 115
     private function _doRequest($httpVerb, $path, $requestBody = null)
100 116
     {
101 117
         return $this->_doUrlRequest($httpVerb, $this->_config->baseUrl() . $path, $requestBody);
102 118
     }
103 119
 
120
+    /**
121
+     * @param string $url
122
+     */
104 123
     public function _doUrlRequest($httpVerb, $url, $requestBody = null)
105 124
     {
106 125
         $curl = curl_init();
Please login to merge, or discard this patch.
catalog/includes/apps/braintree/lib/Braintree/MerchantAccountGateway.php 1 patch
Doc Comments   +9 added lines patch added patch discarded remove patch
@@ -7,6 +7,9 @@  discard block
 block discarded – undo
7 7
     private $_config;
8 8
     private $_http;
9 9
 
10
+    /**
11
+     * @param Gateway $gateway
12
+     */
10 13
     public function __construct($gateway)
11 14
     {
12 15
         $this->_gateway = $gateway;
@@ -119,6 +122,9 @@  discard block
 block discarded – undo
119 122
         ];
120 123
     }
121 124
 
125
+    /**
126
+     * @param string $subPath
127
+     */
122 128
     public function _doCreate($subPath, $params)
123 129
     {
124 130
         $fullPath = $this->_config->merchantPath() . $subPath;
@@ -127,6 +133,9 @@  discard block
 block discarded – undo
127 133
         return $this->_verifyGatewayResponse($response);
128 134
     }
129 135
 
136
+    /**
137
+     * @param string $subPath
138
+     */
130 139
     private function _doUpdate($subPath, $params)
131 140
     {
132 141
         $fullPath = $this->_config->merchantPath() . $subPath;
Please login to merge, or discard this patch.
catalog/includes/apps/braintree/lib/Braintree/OAuthGateway.php 1 patch
Doc Comments   +15 added lines patch added patch discarded remove patch
@@ -15,6 +15,9 @@  discard block
 block discarded – undo
15 15
     private $_config;
16 16
     private $_http;
17 17
 
18
+    /**
19
+     * @param Gateway $gateway
20
+     */
18 21
     public function __construct($gateway)
19 22
     {
20 23
         $this->_gateway = $gateway;
@@ -73,6 +76,9 @@  discard block
 block discarded – undo
73 76
         }
74 77
     }
75 78
 
79
+    /**
80
+     * @param Result\Error $result
81
+     */
76 82
     public function _mapError($result)
77 83
     {
78 84
         $error = $result->errors->deepAll()[0];
@@ -88,12 +94,18 @@  discard block
 block discarded – undo
88 94
         return $result;
89 95
     }
90 96
 
97
+    /**
98
+     * @param Result\Successful $result
99
+     */
91 100
     public function _mapAccessTokenRevokeSuccess($result)
92 101
     {
93 102
         $result->revocationResult = $result->success;
94 103
         return $result;
95 104
     }
96 105
 
106
+    /**
107
+     * @param Result\Successful $result
108
+     */
97 109
     public function _mapSuccess($result)
98 110
     {
99 111
         $credentials = $result->credentials;
@@ -114,6 +126,9 @@  discard block
 block discarded – undo
114 126
         return $url . '&signature=' . $this->computeSignature($url) . '&algorithm=SHA256';
115 127
     }
116 128
 
129
+    /**
130
+     * @param string $url
131
+     */
117 132
     public function computeSignature($url)
118 133
     {
119 134
         $key = hash('sha256', $this->_config->getClientSecret(), true);
Please login to merge, or discard this patch.