Your IP : 216.73.216.95
<?php
/**
* Braintree Utility methods
* PHP version 5
*
* @copyright 2014 Braintree, a division of PayPal, Inc.
*/
class Braintree_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 Braintree_$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 Braintree_$attributeName objects, or a single element array
*/
public static function extractAttributeAsArray(& $attribArray, $attributeName)
{
if(!isset($attribArray[$attributeName])):
return array();
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 array($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
* @throws Braintree_Exception multiple types depending on the error
*
*/
public static function throwStatusCodeException($statusCode, $message=null)
{
switch($statusCode) {
case 401:
throw new Braintree_Exception_Authentication();
break;
case 403:
throw new Braintree_Exception_Authorization($message);
break;
case 404:
throw new Braintree_Exception_NotFound();
break;
case 426:
throw new Braintree_Exception_UpgradeRequired();
break;
case 500:
throw new Braintree_Exception_ServerError();
break;
case 503:
throw new Braintree_Exception_DownForMaintenance();
break;
default:
throw new Braintree_Exception_Unexpected('Unexpected HTTP_RESPONSE #'.$statusCode);
break;
}
}
/**
*
* @param string $className
* @param object $resultObj
* @return object returns the passed object if successful
* @throws Braintree_Exception_ValidationsFailed
*/
public static function returnObjectOrThrowException($className, $resultObj)
{
$resultObjName = Braintree_Util::cleanClassName($className);
if ($resultObj->success) {
return $resultObj->$resultObjName;
} else {
throw new Braintree_Exception_ValidationsFailed();
}
}
/**
* removes the Braintree_ header from a classname
*
* @param string $name Braintree_ClassName
* @return camelCased classname minus Braintree_ header
*/
public static function cleanClassName($name)
{
$classNamesToResponseKeys = array(
'CreditCard' => 'creditCard',
'CreditCardGateway' => 'creditCard',
'Customer' => 'customer',
'CustomerGateway' => 'customer',
'Subscription' => 'subscription',
'SubscriptionGateway' => 'subscription',
'Transaction' => 'transaction',
'TransactionGateway' => 'transaction',
'CreditCardVerification' => 'verification',
'CreditCardVerificationGateway' => 'verification',
'AddOn' => 'addOn',
'AddOnGateway' => 'addOn',
'Discount' => 'discount',
'DiscountGateway' => 'discount',
'Plan' => 'plan',
'PlanGateway' => 'plan',
'Address' => 'address',
'AddressGateway' => 'address',
'SettlementBatchSummary' => 'settlementBatchSummary',
'SettlementBatchSummaryGateway' => 'settlementBatchSummary',
'Merchant' => 'merchant',
'MerchantGateway' => 'merchant',
'MerchantAccount' => 'merchantAccount',
'MerchantAccountGateway' => 'merchantAccount',
'OAuthCredentials' => 'credentials',
'PayPalAccount' => 'paypalAccount',
'PayPalAccountGateway' => 'paypalAccount'
);
$name = str_replace('Braintree_', '', $name);
return $classNamesToResponseKeys[$name];
}
/**
*
* @param string $name className
* @return string Braintree_ClassName
*/
public static function buildClassName($name)
{
$responseKeysToClassNames = array(
'creditCard' => 'CreditCard',
'customer' => 'Customer',
'subscription' => 'Subscription',
'transaction' => 'Transaction',
'verification' => 'CreditCardVerification',
'addOn' => 'AddOn',
'discount' => 'Discount',
'plan' => 'Plan',
'address' => 'Address',
'settlementBatchSummary' => 'SettlementBatchSummary',
'merchantAccount' => 'MerchantAccount'
);
return 'Braintree_' . $responseKeysToClassNames[$name];
}
/**
* convert alpha-beta-gamma to alphaBetaGamma
*
* @access public
* @param string $string
* @return string modified string
*/
public static function delimiterToCamelCase($string, $delimiter = '[\-\_]')
{
// php doesn't garbage collect functions created by create_function()
// so use a static variable to avoid adding a new function to memory
// every time this function is called.
static $callback = null;
if ($callback === null) {
$callback = create_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 var $string
* @return var modified string
*/
public static function camelCaseToDelimiter($string, $delimiter = '-')
{
// php doesn't garbage collect functions created by create_function()
// so use a static variable to avoid adding a new function to memory
// every time this function is called.
static $callbacks = array();
if (!isset($callbacks[$delimiter])) {
$callbacks[$delimiter] = create_function('$matches', "return '$delimiter' . strtolower(\$matches[1]);");
}
return preg_replace_callback('/([A-Z])/', $callbacks[$delimiter], $string);
}
public static function delimiterToCamelCaseArray($array, $delimiter = '[\-\_]')
{
$converted = array();
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 = array();
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 = array();
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 ', ')
*/
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 = array();
foreach ($attributes AS $key => $value) {
if (is_array($value)) {
$pAttrib = Braintree_Util::attributesToString($value);
} else if ($value instanceof DateTime) {
$pAttrib = $value->format(DateTime::RFC850);
} else {
$pAttrib = $value;
}
$printableAttribs[$key] = sprintf('%s', $pAttrib);
}
return Braintree_Util::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 = array();
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 = array();
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;
}
}