| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265 |
- <?php
- namespace Stripe\Util;
- use Stripe\StripeObject;
- abstract class Util
- {
- private static $isMbstringAvailable = null;
- private static $isHashEqualsAvailable = null;
- /**
- * Whether the provided array (or other) is a list rather than a dictionary.
- * A list is defined as an array for which all the keys are consecutive
- * integers starting at 0. Empty arrays are considered to be lists.
- *
- * @param array|mixed $array
- *
- * @return bool true if the given object is a list
- */
- public static function isList($array)
- {
- if (!\is_array($array)) {
- return false;
- }
- if ([] === $array) {
- return true;
- }
- if (\array_keys($array) !== \range(0, \count($array) - 1)) {
- return false;
- }
- return true;
- }
- /**
- * Converts a response from the Stripe API to the corresponding PHP object.
- *
- * @param array $resp the response from the Stripe API
- * @param array $opts
- *
- * @return array|StripeObject
- */
- public static function convertToStripeObject($resp, $opts)
- {
- $types = \Stripe\Util\ObjectTypes::mapping;
- if (self::isList($resp)) {
- $mapped = [];
- foreach ($resp as $i) {
- $mapped[] = self::convertToStripeObject($i, $opts);
- }
- return $mapped;
- }
- if (\is_array($resp)) {
- if (isset($resp['object']) && \is_string($resp['object']) && isset($types[$resp['object']])) {
- $class = $types[$resp['object']];
- } else {
- $class = \Stripe\StripeObject::class;
- }
- return $class::constructFrom($resp, $opts);
- }
- return $resp;
- }
- /**
- * @param mixed|string $value a string to UTF8-encode
- *
- * @return mixed|string the UTF8-encoded string, or the object passed in if
- * it wasn't a string
- */
- public static function utf8($value)
- {
- if (null === self::$isMbstringAvailable) {
- self::$isMbstringAvailable = \function_exists('mb_detect_encoding');
- if (!self::$isMbstringAvailable) {
- \trigger_error('It looks like the mbstring extension is not enabled. ' .
- 'UTF-8 strings will not properly be encoded. Ask your system ' .
- 'administrator to enable the mbstring extension, or write to ' .
- 'support@stripe.com if you have any questions.', \E_USER_WARNING);
- }
- }
- if (\is_string($value) && self::$isMbstringAvailable && 'UTF-8' !== \mb_detect_encoding($value, 'UTF-8', true)) {
- return \utf8_encode($value);
- }
- return $value;
- }
- /**
- * Compares two strings for equality. The time taken is independent of the
- * number of characters that match.
- *
- * @param string $a one of the strings to compare
- * @param string $b the other string to compare
- *
- * @return bool true if the strings are equal, false otherwise
- */
- public static function secureCompare($a, $b)
- {
- if (null === self::$isHashEqualsAvailable) {
- self::$isHashEqualsAvailable = \function_exists('hash_equals');
- }
- if (self::$isHashEqualsAvailable) {
- return \hash_equals($a, $b);
- }
- if (\strlen($a) !== \strlen($b)) {
- return false;
- }
- $result = 0;
- for ($i = 0; $i < \strlen($a); ++$i) {
- $result |= \ord($a[$i]) ^ \ord($b[$i]);
- }
- return 0 === $result;
- }
- /**
- * Recursively goes through an array of parameters. If a parameter is an instance of
- * ApiResource, then it is replaced by the resource's ID.
- * Also clears out null values.
- *
- * @param mixed $h
- *
- * @return mixed
- */
- public static function objectsToIds($h)
- {
- if ($h instanceof \Stripe\ApiResource) {
- return $h->id;
- }
- if (static::isList($h)) {
- $results = [];
- foreach ($h as $v) {
- $results[] = static::objectsToIds($v);
- }
- return $results;
- }
- if (\is_array($h)) {
- $results = [];
- foreach ($h as $k => $v) {
- if (null === $v) {
- continue;
- }
- $results[$k] = static::objectsToIds($v);
- }
- return $results;
- }
- return $h;
- }
- /**
- * @param array $params
- *
- * @return string
- */
- public static function encodeParameters($params)
- {
- $flattenedParams = self::flattenParams($params);
- $pieces = [];
- foreach ($flattenedParams as $param) {
- list($k, $v) = $param;
- $pieces[] = self::urlEncode($k) . '=' . self::urlEncode($v);
- }
- return \implode('&', $pieces);
- }
- /**
- * @param array $params
- * @param null|string $parentKey
- *
- * @return array
- */
- public static function flattenParams($params, $parentKey = null)
- {
- $result = [];
- foreach ($params as $key => $value) {
- $calculatedKey = $parentKey ? "{$parentKey}[{$key}]" : $key;
- if (self::isList($value)) {
- $result = \array_merge($result, self::flattenParamsList($value, $calculatedKey));
- } elseif (\is_array($value)) {
- $result = \array_merge($result, self::flattenParams($value, $calculatedKey));
- } else {
- \array_push($result, [$calculatedKey, $value]);
- }
- }
- return $result;
- }
- /**
- * @param array $value
- * @param string $calculatedKey
- *
- * @return array
- */
- public static function flattenParamsList($value, $calculatedKey)
- {
- $result = [];
- foreach ($value as $i => $elem) {
- if (self::isList($elem)) {
- $result = \array_merge($result, self::flattenParamsList($elem, $calculatedKey));
- } elseif (\is_array($elem)) {
- $result = \array_merge($result, self::flattenParams($elem, "{$calculatedKey}[{$i}]"));
- } else {
- \array_push($result, ["{$calculatedKey}[{$i}]", $elem]);
- }
- }
- return $result;
- }
- /**
- * @param string $key a string to URL-encode
- *
- * @return string the URL-encoded string
- */
- public static function urlEncode($key)
- {
- $s = \urlencode((string) $key);
- // Don't use strict form encoding by changing the square bracket control
- // characters back to their literals. This is fine by the server, and
- // makes these parameter strings easier to read.
- $s = \str_replace('%5B', '[', $s);
- return \str_replace('%5D', ']', $s);
- }
- public static function normalizeId($id)
- {
- if (\is_array($id)) {
- $params = $id;
- $id = $params['id'];
- unset($params['id']);
- } else {
- $params = [];
- }
- return [$id, $params];
- }
- /**
- * Returns UNIX timestamp in milliseconds.
- *
- * @return int current time in millis
- */
- public static function currentTimeMillis()
- {
- return (int) \round(\microtime(true) * 1000);
- }
- }
|