Util.php
16.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
<?php
namespace Braintree;
use DateTime;
use InvalidArgumentException;
/**
* Braintree Utility methods
* PHP version 5
*/
class Util
{
/**
* extracts an attribute and returns an array of objects
*
* extracts the requested element from an array, and converts the contents
* of its child arrays to objects of type $attributeName, or returns
* an array with a single element containing the value of that array element
*
* @param array $attribArray attributes from a search response
* @param string $attributeName indicates which element of the passed array to extract
* @return array array of $attributeName objects, or a single element array
*/
public static function extractAttributeAsArray(&$attribArray, $attributeName)
{
if(!isset($attribArray[$attributeName])):
return [];
endif;
// get what should be an array from the passed array
$data = $attribArray[$attributeName];
// set up the class that will be used to convert each array element
$classFactory = self::buildClassName($attributeName) . '::factory';
if(is_array($data)):
// create an object from the data in each element
$objectArray = array_map($classFactory, $data);
else:
return [$data];
endif;
unset($attribArray[$attributeName]);
return $objectArray;
}
/**
* throws an exception based on the type of error
* @param string $statusCode HTTP status code to throw exception from
* @param null|string $message
* @throws Exception multiple types depending on the error
* @return void
*/
public static function throwStatusCodeException($statusCode, $message=null)
{
switch($statusCode) {
case 401:
throw new Exception\Authentication();
break;
case 403:
throw new Exception\Authorization($message);
break;
case 404:
throw new Exception\NotFound();
break;
case 426:
throw new Exception\UpgradeRequired();
break;
case 429:
throw new Exception\TooManyRequests();
break;
case 500:
throw new Exception\ServerError();
break;
case 503:
throw new Exception\DownForMaintenance();
break;
default:
throw new Exception\Unexpected('Unexpected HTTP_RESPONSE #' . $statusCode);
break;
}
}
/**
* throws an exception based on the type of error returned from graphql
* @param array $response complete graphql response
* @throws Exception multiple types depending on the error
* @return void
*/
public static function throwGraphQLResponseException($response)
{
if(!array_key_exists("errors", $response) || !($errors = $response["errors"])) {
return;
}
foreach ($errors as $error) {
$message = $error["message"];
if ($error["extensions"] == null) {
throw new Exception\Unexpected("Unexpected exception:" . $message);
}
$errorClass = $error["extensions"]["errorClass"];
if ($errorClass == "VALIDATION") {
continue;
} else if ($errorClass == "AUTHENTICATION") {
throw new Exception\Authentication();
} else if ($errorClass == "AUTHORIZATION") {
throw new Exception\Authorization($message);
} else if ($errorClass == "NOT_FOUND") {
throw new Exception\NotFound();
} else if ($errorClass == "UNSUPPORTED_CLIENT") {
throw new Exception\UpgradeRequired();
} else if ($errorClass == "RESOURCE_LIMIT") {
throw new Exception\TooManyRequests();
} else if ($errorClass == "INTERNAL") {
throw new Exception\ServerError();
} else if ($errorClass == "SERVICE_AVAILABILITY") {
throw new Exception\DownForMaintenance();
} else {
throw new Exception\Unexpected('Unexpected exception ' . $message);
}
}
}
/**
*
* @param string $className
* @param object $resultObj
* @return object returns the passed object if successful
* @throws Exception\ValidationsFailed
*/
public static function returnObjectOrThrowException($className, $resultObj)
{
$resultObjName = self::cleanClassName($className);
if ($resultObj->success) {
return $resultObj->$resultObjName;
} else {
throw new Exception\ValidationsFailed();
}
}
/**
* removes the header from a classname
*
* @param string $name ClassName
* @return camelCased classname minus header
*/
public static function cleanClassName($name)
{
$classNamesToResponseKeys = [
'Braintree\CreditCard' => 'creditCard',
'Braintree_CreditCard' => 'creditCard',
'Braintree\CreditCardGateway' => 'creditCard',
'Braintree_CreditCardGateway' => 'creditCard',
'Braintree\Customer' => 'customer',
'Braintree_Customer' => 'customer',
'Braintree\CustomerGateway' => 'customer',
'Braintree_CustomerGateway' => 'customer',
'Braintree\Subscription' => 'subscription',
'Braintree_Subscription' => 'subscription',
'Braintree\SubscriptionGateway' => 'subscription',
'Braintree_SubscriptionGateway' => 'subscription',
'Braintree\Transaction' => 'transaction',
'Braintree_Transaction' => 'transaction',
'Braintree\TransactionGateway' => 'transaction',
'Braintree_TransactionGateway' => 'transaction',
'Braintree\CreditCardVerification' => 'verification',
'Braintree_CreditCardVerification' => 'verification',
'Braintree\CreditCardVerificationGateway' => 'verification',
'Braintree_CreditCardVerificationGateway' => 'verification',
'Braintree\AddOn' => 'addOn',
'Braintree_AddOn' => 'addOn',
'Braintree\AddOnGateway' => 'addOn',
'Braintree_AddOnGateway' => 'addOn',
'Braintree\Discount' => 'discount',
'Braintree_Discount' => 'discount',
'Braintree\DiscountGateway' => 'discount',
'Braintree_DiscountGateway' => 'discount',
'Braintree\Dispute' => 'dispute',
'Braintree_Dispute' => 'dispute',
'Braintree\Dispute\EvidenceDetails' => 'evidence',
'Braintree_Dispute_EvidenceDetails' => 'evidence',
'Braintree\DocumentUpload' => 'documentUpload',
'Braintree_DocumentUpload' => 'doumentUpload',
'Braintree\Plan' => 'plan',
'Braintree_Plan' => 'plan',
'Braintree\PlanGateway' => 'plan',
'Braintree_PlanGateway' => 'plan',
'Braintree\Address' => 'address',
'Braintree_Address' => 'address',
'Braintree\AddressGateway' => 'address',
'Braintree_AddressGateway' => 'address',
'Braintree\SettlementBatchSummary' => 'settlementBatchSummary',
'Braintree_SettlementBatchSummary' => 'settlementBatchSummary',
'Braintree\SettlementBatchSummaryGateway' => 'settlementBatchSummary',
'Braintree_SettlementBatchSummaryGateway' => 'settlementBatchSummary',
'Braintree\Merchant' => 'merchant',
'Braintree_Merchant' => 'merchant',
'Braintree\MerchantGateway' => 'merchant',
'Braintree_MerchantGateway' => 'merchant',
'Braintree\MerchantAccount' => 'merchantAccount',
'Braintree_MerchantAccount' => 'merchantAccount',
'Braintree\MerchantAccountGateway' => 'merchantAccount',
'Braintree_MerchantAccountGateway' => 'merchantAccount',
'Braintree\OAuthCredentials' => 'credentials',
'Braintree_OAuthCredentials' => 'credentials',
'Braintree\OAuthResult' => 'result',
'Braintree_OAuthResult' => 'result',
'Braintree\PayPalAccount' => 'paypalAccount',
'Braintree_PayPalAccount' => 'paypalAccount',
'Braintree\PayPalAccountGateway' => 'paypalAccount',
'Braintree_PayPalAccountGateway' => 'paypalAccount',
'Braintree\UsBankAccountVerification' => 'usBankAccountVerification',
'Braintree_UsBankAccountVerification' => 'usBankAccountVerification',
];
return $classNamesToResponseKeys[$name];
}
/**
*
* @param string $name className
* @return string ClassName
*/
public static function buildClassName($name)
{
$responseKeysToClassNames = [
'creditCard' => 'Braintree\CreditCard',
'customer' => 'Braintree\Customer',
'dispute' => 'Braintree\Dispute',
'documentUpload' => 'Braintree\DocumentUpload',
'subscription' => 'Braintree\Subscription',
'transaction' => 'Braintree\Transaction',
'verification' => 'Braintree\CreditCardVerification',
'addOn' => 'Braintree\AddOn',
'discount' => 'Braintree\Discount',
'plan' => 'Braintree\Plan',
'address' => 'Braintree\Address',
'settlementBatchSummary' => 'Braintree\SettlementBatchSummary',
'merchantAccount' => 'Braintree\MerchantAccount',
];
return (string) $responseKeysToClassNames[$name];
}
/**
* convert alpha-beta-gamma to alphaBetaGamma
*
* @access public
* @param string $string
* @param null|string $delimiter
* @return string modified string
*/
public static function delimiterToCamelCase($string, $delimiter = '[\-\_]')
{
static $callback = null;
if ($callback === null) {
$callback = function ($matches) {
return strtoupper($matches[1]);
};
}
return preg_replace_callback('/' . $delimiter . '(\w)/', $callback, $string);
}
/**
* convert alpha-beta-gamma to alpha_beta_gamma
*
* @access public
* @param string $string
* @return string modified string
*/
public static function delimiterToUnderscore($string)
{
return preg_replace('/-/', '_', $string);
}
/**
* find capitals and convert to delimiter + lowercase
*
* @access public
* @param string $string
* @param null|string $delimiter
* @return string modified string
*/
public static function camelCaseToDelimiter($string, $delimiter = '-')
{
return strtolower(preg_replace('/([A-Z])/', "$delimiter\\1", $string));
}
public static function delimiterToCamelCaseArray($array, $delimiter = '[\-\_]')
{
$converted = [];
foreach ($array as $key => $value) {
if (is_string($key)) {
$key = self::delimiterToCamelCase($key, $delimiter);
}
if (is_array($value)) {
// Make an exception for custom fields, which must be underscore (can't be
// camelCase).
if ($key === 'customFields') {
$value = self::delimiterToUnderscoreArray($value);
} else {
$value = self::delimiterToCamelCaseArray($value, $delimiter);
}
}
$converted[$key] = $value;
}
return $converted;
}
public static function camelCaseToDelimiterArray($array, $delimiter = '-')
{
$converted = [];
foreach ($array as $key => $value) {
if (is_string($key)) {
$key = self::camelCaseToDelimiter($key, $delimiter);
}
if (is_array($value)) {
$value = self::camelCaseToDelimiterArray($value, $delimiter);
}
$converted[$key] = $value;
}
return $converted;
}
public static function delimiterToUnderscoreArray($array)
{
$converted = [];
foreach ($array as $key => $value) {
$key = self::delimiterToUnderscore($key);
$converted[$key] = $value;
}
return $converted;
}
/**
*
* @param array $array associative array to implode
* @param string $separator (optional, defaults to =)
* @param string $glue (optional, defaults to ', ')
* @return bool
*/
public static function implodeAssociativeArray($array, $separator = '=', $glue = ', ')
{
// build a new array with joined keys and values
$tmpArray = null;
foreach ($array AS $key => $value) {
if ($value instanceof DateTime) {
$value = $value->format('r');
}
$tmpArray[] = $key . $separator . $value;
}
// implode and return the new array
return (is_array($tmpArray)) ? implode($glue, $tmpArray) : false;
}
public static function attributesToString($attributes) {
$printableAttribs = [];
foreach ($attributes AS $key => $value) {
if (is_array($value)) {
$pAttrib = self::attributesToString($value);
} else if ($value instanceof DateTime) {
$pAttrib = $value->format(DateTime::RFC850);
} else {
$pAttrib = $value;
}
$printableAttribs[$key] = sprintf('%s', $pAttrib);
}
return self::implodeAssociativeArray($printableAttribs);
}
/**
* verify user request structure
*
* compares the expected signature of a gateway request
* against the actual structure sent by the user
*
* @param array $signature
* @param array $attributes
*/
public static function verifyKeys($signature, $attributes)
{
$validKeys = self::_flattenArray($signature);
$userKeys = self::_flattenUserKeys($attributes);
$invalidKeys = array_diff($userKeys, $validKeys);
$invalidKeys = self::_removeWildcardKeys($validKeys, $invalidKeys);
if(!empty($invalidKeys)) {
asort($invalidKeys);
$sortedList = join(', ', $invalidKeys);
throw new InvalidArgumentException('invalid keys: ' . $sortedList);
}
}
/**
* flattens a numerically indexed nested array to a single level
* @param array $keys
* @param string $namespace
* @return array
*/
private static function _flattenArray($keys, $namespace = null)
{
$flattenedArray = [];
foreach($keys AS $key) {
if(is_array($key)) {
$theKeys = array_keys($key);
$theValues = array_values($key);
$scope = $theKeys[0];
$fullKey = empty($namespace) ? $scope : $namespace . '[' . $scope . ']';
$flattenedArray = array_merge($flattenedArray, self::_flattenArray($theValues[0], $fullKey));
} else {
$fullKey = empty($namespace) ? $key : $namespace . '[' . $key . ']';
$flattenedArray[] = $fullKey;
}
}
sort($flattenedArray);
return $flattenedArray;
}
private static function _flattenUserKeys($keys, $namespace = null)
{
$flattenedArray = [];
foreach($keys AS $key => $value) {
$fullKey = empty($namespace) ? $key : $namespace;
if (!is_numeric($key) && $namespace != null) {
$fullKey .= '[' . $key . ']';
}
if (is_numeric($key) && is_string($value)) {
$fullKey .= '[' . $value . ']';
}
if(is_array($value)) {
$more = self::_flattenUserKeys($value, $fullKey);
$flattenedArray = array_merge($flattenedArray, $more);
} else {
$flattenedArray[] = $fullKey;
}
}
sort($flattenedArray);
return $flattenedArray;
}
/**
* removes wildcard entries from the invalid keys array
* @param array $validKeys
* @param <array $invalidKeys
* @return array
*/
private static function _removeWildcardKeys($validKeys, $invalidKeys)
{
foreach($validKeys AS $key) {
if (stristr($key, '[_anyKey_]')) {
$wildcardKey = str_replace('[_anyKey_]', '', $key);
foreach ($invalidKeys AS $index => $invalidKey) {
if (stristr($invalidKey, $wildcardKey)) {
unset($invalidKeys[$index]);
}
}
}
}
return $invalidKeys;
}
}
class_alias('Braintree\Util', 'Braintree_Util');