@@ -1572,6 +1572,7 @@ |
||
| 1572 | 1572 | /** |
| 1573 | 1573 | * Actually connect to the server and call the requested methods, parsing the result |
| 1574 | 1574 | * You should never have to call this function manually |
| 1575 | + * @param string $method |
|
| 1575 | 1576 | */ |
| 1576 | 1577 | function callServer($method, $params) { |
| 1577 | 1578 | //Always include the apikey if we are not logging in |
@@ -493,6 +493,9 @@ discard block |
||
| 493 | 493 | return defined('MODULE_PAYMENT_BRAINTREE_CC_STATUS'); |
| 494 | 494 | } |
| 495 | 495 | |
| 496 | + /** |
|
| 497 | + * @param string $parameter |
|
| 498 | + */ |
|
| 496 | 499 | function install($parameter = null) { |
| 497 | 500 | $OSCOM_Db = Registry::get('Db'); |
| 498 | 501 | |
@@ -665,6 +668,9 @@ discard block |
||
| 665 | 668 | return number_format(tep_round($number * $currency_value, $currencies->currencies[$currency_code]['decimal_places']), $currencies->currencies[$currency_code]['decimal_places'], '.', ''); |
| 666 | 669 | } |
| 667 | 670 | |
| 671 | + /** |
|
| 672 | + * @return string |
|
| 673 | + */ |
|
| 668 | 674 | function getTransactionCurrency() { |
| 669 | 675 | return $this->isValidCurrency($_SESSION['currency']) ? $_SESSION['currency'] : DEFAULT_CURRENCY; |
| 670 | 676 | } |
@@ -99,7 +99,7 @@ discard block |
||
| 99 | 99 | * @access public |
| 100 | 100 | * @param mixed $customerOrId |
| 101 | 101 | * @param string $addressId |
| 102 | - * @return object Braintree_Address |
|
| 102 | + * @return Braintree_Address Braintree_Address |
|
| 103 | 103 | * @throws Braintree_Exception_NotFound |
| 104 | 104 | */ |
| 105 | 105 | public static function find($customerOrId, $addressId) |
@@ -173,8 +173,7 @@ discard block |
||
| 173 | 173 | * customerOrId & addressId are not sent in object context. |
| 174 | 174 | * |
| 175 | 175 | * @access public |
| 176 | - * @param array $transactionAttribs |
|
| 177 | - * @param string $customerId |
|
| 176 | + * @param string $customerOrId |
|
| 178 | 177 | * @return object Braintree_Transaction |
| 179 | 178 | * @throws Braintree_Exception_ValidationsFailed |
| 180 | 179 | * @see Braintree_Address::update() |
@@ -187,7 +186,7 @@ discard block |
||
| 187 | 186 | |
| 188 | 187 | /** |
| 189 | 188 | * creates a full array signature of a valid create request |
| 190 | - * @return array gateway create request format |
|
| 189 | + * @return string[] gateway create request format |
|
| 191 | 190 | */ |
| 192 | 191 | public static function createSignature() |
| 193 | 192 | { |
@@ -200,7 +199,7 @@ discard block |
||
| 200 | 199 | |
| 201 | 200 | /** |
| 202 | 201 | * creates a full array signature of a valid update request |
| 203 | - * @return array gateway update request format |
|
| 202 | + * @return string[] gateway update request format |
|
| 204 | 203 | */ |
| 205 | 204 | public static function updateSignature() |
| 206 | 205 | { |
@@ -213,7 +212,7 @@ discard block |
||
| 213 | 212 | * create a printable representation of the object as: |
| 214 | 213 | * ClassName[property=value, property=value] |
| 215 | 214 | * @ignore |
| 216 | - * @return var |
|
| 215 | + * @return string |
|
| 217 | 216 | */ |
| 218 | 217 | public function __toString() |
| 219 | 218 | { |
@@ -340,7 +339,7 @@ discard block |
||
| 340 | 339 | * factory method: returns an instance of Braintree_Address |
| 341 | 340 | * to the requesting method, with populated properties |
| 342 | 341 | * @ignore |
| 343 | - * @return object instance of Braintree_Address |
|
| 342 | + * @return Braintree_Address instance of Braintree_Address |
|
| 344 | 343 | */ |
| 345 | 344 | public static function factory($attributes) |
| 346 | 345 | { |
@@ -17,9 +17,9 @@ |
||
| 17 | 17 | * sends the generate request to the gateway |
| 18 | 18 | * |
| 19 | 19 | * @ignore |
| 20 | - * @param var $url |
|
| 20 | + * @param string $url |
|
| 21 | 21 | * @param array $params |
| 22 | - * @return mixed |
|
| 22 | + * @return string |
|
| 23 | 23 | */ |
| 24 | 24 | public static function _doGenerate($url, $params) |
| 25 | 25 | { |
@@ -106,7 +106,6 @@ discard block |
||
| 106 | 106 | * create a customer from a TransparentRedirect operation |
| 107 | 107 | * |
| 108 | 108 | * @access public |
| 109 | - * @param array $attribs |
|
| 110 | 109 | * @return object |
| 111 | 110 | */ |
| 112 | 111 | public static function createFromTransparentRedirect($queryString) |
@@ -136,7 +135,7 @@ discard block |
||
| 136 | 135 | |
| 137 | 136 | /** |
| 138 | 137 | * returns a ResourceCollection of expired credit cards |
| 139 | - * @return object ResourceCollection |
|
| 138 | + * @return Braintree_ResourceCollection ResourceCollection |
|
| 140 | 139 | */ |
| 141 | 140 | public static function expired() |
| 142 | 141 | { |
@@ -162,7 +161,7 @@ discard block |
||
| 162 | 161 | /** |
| 163 | 162 | * returns a ResourceCollection of credit cards expiring between start/end |
| 164 | 163 | * |
| 165 | - * @return object ResourceCollection |
|
| 164 | + * @return Braintree_ResourceCollection ResourceCollection |
|
| 166 | 165 | */ |
| 167 | 166 | public static function expiringBetween($startDate, $endDate) |
| 168 | 167 | { |
@@ -193,7 +192,7 @@ discard block |
||
| 193 | 192 | * |
| 194 | 193 | * @access public |
| 195 | 194 | * @param string $token credit card unique id |
| 196 | - * @return object Braintree_CreditCard |
|
| 195 | + * @return Braintree_CreditCard Braintree_CreditCard |
|
| 197 | 196 | * @throws Braintree_Exception_NotFound |
| 198 | 197 | */ |
| 199 | 198 | public static function find($token) |
@@ -215,7 +214,7 @@ discard block |
||
| 215 | 214 | * |
| 216 | 215 | * @access public |
| 217 | 216 | * @param string $nonce payment method nonce |
| 218 | - * @return object Braintree_CreditCard |
|
| 217 | + * @return Braintree_CreditCard Braintree_CreditCard |
|
| 219 | 218 | * @throws Braintree_Exception_NotFound |
| 220 | 219 | */ |
| 221 | 220 | public static function fromNonce($nonce) |
@@ -236,7 +235,6 @@ discard block |
||
| 236 | 235 | * create a credit on the card for the passed transaction |
| 237 | 236 | * |
| 238 | 237 | * @access public |
| 239 | - * @param array $attribs |
|
| 240 | 238 | * @return object Braintree_Result_Successful or Braintree_Result_Error |
| 241 | 239 | */ |
| 242 | 240 | public static function credit($token, $transactionAttribs) |
@@ -256,7 +254,6 @@ discard block |
||
| 256 | 254 | * returns a Braintree_Transaction object on success |
| 257 | 255 | * |
| 258 | 256 | * @access public |
| 259 | - * @param array $attribs |
|
| 260 | 257 | * @return object Braintree_Transaction |
| 261 | 258 | * @throws Braintree_Exception_ValidationError |
| 262 | 259 | */ |
@@ -356,7 +353,6 @@ discard block |
||
| 356 | 353 | * update a customer from a TransparentRedirect operation |
| 357 | 354 | * |
| 358 | 355 | * @access public |
| 359 | - * @param array $attribs |
|
| 360 | 356 | * @return object |
| 361 | 357 | */ |
| 362 | 358 | public static function updateFromTransparentRedirect($queryString) |
@@ -457,6 +453,9 @@ discard block |
||
| 457 | 453 | return array('makeDefault', 'verificationMerchantAccountId', 'verifyCard', 'venmoSdkSession'); |
| 458 | 454 | } |
| 459 | 455 | |
| 456 | + /** |
|
| 457 | + * @param string[] $options |
|
| 458 | + */ |
|
| 460 | 459 | private static function baseSignature($options) |
| 461 | 460 | { |
| 462 | 461 | return array( |
@@ -543,7 +542,6 @@ discard block |
||
| 543 | 542 | * verifies that a valid credit card identifier is being used |
| 544 | 543 | * @ignore |
| 545 | 544 | * @param string $identifier |
| 546 | - * @param Optional $string $identifierType type of identifier supplied, default "token" |
|
| 547 | 545 | * @throws InvalidArgumentException |
| 548 | 546 | */ |
| 549 | 547 | private static function _validateId($identifier = null, $identifierType = "token") |
@@ -566,6 +564,7 @@ discard block |
||
| 566 | 564 | * @ignore |
| 567 | 565 | * @param string $url |
| 568 | 566 | * @param array $params |
| 567 | + * @param string $httpVerb |
|
| 569 | 568 | * @return mixed |
| 570 | 569 | */ |
| 571 | 570 | private static function _doUpdate($httpVerb, $url, $params) |
@@ -608,7 +607,7 @@ discard block |
||
| 608 | 607 | * to the requesting method, with populated properties |
| 609 | 608 | * |
| 610 | 609 | * @ignore |
| 611 | - * @return object instance of Braintree_CreditCard |
|
| 610 | + * @return Braintree_CreditCard instance of Braintree_CreditCard |
|
| 612 | 611 | */ |
| 613 | 612 | public static function factory($attributes) |
| 614 | 613 | { |
@@ -110,7 +110,6 @@ discard block |
||
| 110 | 110 | * create a customer from a TransparentRedirect operation |
| 111 | 111 | * |
| 112 | 112 | * @access public |
| 113 | - * @param array $attribs |
|
| 114 | 113 | * @return object |
| 115 | 114 | */ |
| 116 | 115 | public static function createFromTransparentRedirect($queryString) |
@@ -188,7 +187,7 @@ discard block |
||
| 188 | 187 | * |
| 189 | 188 | * @access public |
| 190 | 189 | * @param string id customer Id |
| 191 | - * @return object Braintree_Customer |
|
| 190 | + * @return Braintree_Customer Braintree_Customer |
|
| 192 | 191 | * @throws Braintree_Exception_NotFound |
| 193 | 192 | */ |
| 194 | 193 | public static function find($id) |
@@ -209,7 +208,6 @@ discard block |
||
| 209 | 208 | * credit a customer for the passed transaction |
| 210 | 209 | * |
| 211 | 210 | * @access public |
| 212 | - * @param array $attribs |
|
| 213 | 211 | * @return object Braintree_Result_Successful or Braintree_Result_Error |
| 214 | 212 | */ |
| 215 | 213 | public static function credit($customerId, $transactionAttribs) |
@@ -228,7 +226,6 @@ discard block |
||
| 228 | 226 | * returns a Braintree_Transaction object on success |
| 229 | 227 | * |
| 230 | 228 | * @access public |
| 231 | - * @param array $attribs |
|
| 232 | 229 | * @return object Braintree_Transaction |
| 233 | 230 | * @throws Braintree_Exception_ValidationError |
| 234 | 231 | */ |
@@ -293,8 +290,7 @@ discard block |
||
| 293 | 290 | * For more detailed information and examples, see {@link http://www.braintreepayments.com/gateway/customer-api#searching http://www.braintreepaymentsolutions.com/gateway/customer-api} |
| 294 | 291 | * |
| 295 | 292 | * @param mixed $query search query |
| 296 | - * @param array $options options such as page number |
|
| 297 | - * @return object Braintree_ResourceCollection |
|
| 293 | + * @return Braintree_ResourceCollection Braintree_ResourceCollection |
|
| 298 | 294 | * @throws InvalidArgumentException |
| 299 | 295 | */ |
| 300 | 296 | public static function search($query) |
@@ -371,7 +367,6 @@ discard block |
||
| 371 | 367 | * update a customer from a TransparentRedirect operation |
| 372 | 368 | * |
| 373 | 369 | * @access public |
| 374 | - * @param array $attribs |
|
| 375 | 370 | * @return object |
| 376 | 371 | */ |
| 377 | 372 | public static function updateFromTransparentRedirect($queryString) |
@@ -509,6 +504,7 @@ discard block |
||
| 509 | 504 | * @ignore |
| 510 | 505 | * @param string $url |
| 511 | 506 | * @param array $params |
| 507 | + * @param string $httpVerb |
|
| 512 | 508 | * @return mixed |
| 513 | 509 | */ |
| 514 | 510 | private static function _doUpdate($httpVerb, $url, $params) |
@@ -552,7 +548,7 @@ discard block |
||
| 552 | 548 | * to the requesting method, with populated properties |
| 553 | 549 | * |
| 554 | 550 | * @ignore |
| 555 | - * @return object instance of Braintree_Customer |
|
| 551 | + * @return Braintree_Customer instance of Braintree_Customer |
|
| 556 | 552 | */ |
| 557 | 553 | public static function factory($attributes) |
| 558 | 554 | { |
@@ -26,6 +26,9 @@ |
||
| 26 | 26 | return hash_hmac('sha256', $string, hash('sha256', $key, true)); |
| 27 | 27 | } |
| 28 | 28 | |
| 29 | + /** |
|
| 30 | + * @param string $right |
|
| 31 | + */ |
|
| 29 | 32 | public static function secureCompare($left, $right) |
| 30 | 33 | { |
| 31 | 34 | if (strlen($left) != strlen($right)) { |
@@ -68,6 +68,9 @@ |
||
| 68 | 68 | return $this->forKey("index" . $index); |
| 69 | 69 | } |
| 70 | 70 | |
| 71 | + /** |
|
| 72 | + * @param string $key |
|
| 73 | + */ |
|
| 71 | 74 | public function forKey($key) |
| 72 | 75 | { |
| 73 | 76 | return isset($this->_nested[$key]) ? $this->_nested[$key] : null; |
@@ -19,7 +19,7 @@ discard block |
||
| 19 | 19 | { |
| 20 | 20 | /** |
| 21 | 21 | * |
| 22 | - * @param array $aAttribs |
|
| 22 | + * @param array $attributes |
|
| 23 | 23 | */ |
| 24 | 24 | public function __construct($attributes) |
| 25 | 25 | { |
@@ -59,7 +59,7 @@ discard block |
||
| 59 | 59 | /** |
| 60 | 60 | * create a printable representation of the object as: |
| 61 | 61 | * ClassName[property=value, property=value] |
| 62 | - * @return var |
|
| 62 | + * @return string |
|
| 63 | 63 | */ |
| 64 | 64 | public function __toString() |
| 65 | 65 | { |
@@ -70,7 +70,7 @@ discard block |
||
| 70 | 70 | * initializes instance properties from the keys/values of an array |
| 71 | 71 | * @ignore |
| 72 | 72 | * @access protected |
| 73 | - * @param <type> $aAttribs array of properties to set - single level |
|
| 73 | + * @param <type> $attributes array of properties to set - single level |
|
| 74 | 74 | * @return none |
| 75 | 75 | */ |
| 76 | 76 | private function _initializeFromArray($attributes) |