vendor/stripe/stripe-php/lib/ApiOperations/Request.php line 106

Open in your IDE?
  1. <?php
  3. namespace Stripe\ApiOperations;
  5. /**
  6.  * Trait for resources that need to make API requests.
  7.  *
  8.  * This trait should only be applied to classes that derive from StripeObject.
  9.  */
  10. trait Request
  11. {
  12.     /**
  13.      * @param null|array|mixed $params The list of parameters to validate
  14.      *
  15.      * @throws \Stripe\Exception\InvalidArgumentException if $params exists and is not an array
  16.      */
  17.     protected static function _validateParams($params = null)
  18.     {
  19.         if ($params && !\is_array($params)) {
  20.             $message = 'You must pass an array as the first argument to Stripe API '
  21.                 . 'method calls.  (HINT: an example call to create a charge '
  22.                 . "would be: \"Stripe\\Charge::create(['amount' => 100, "
  23.                 . "'currency' => 'usd', 'source' => 'tok_1234'])\")";
  25.             throw new \Stripe\Exception\InvalidArgumentException($message);
  26.         }
  27.     }
  29.     /**
  30.      * @param 'delete'|'get'|'post' $method HTTP method ('get', 'post', etc.)
  31.      * @param string $url URL for the request
  32.      * @param array $params list of parameters for the request
  33.      * @param null|array|string $options
  34.      * @param string[] $usage names of tracked behaviors associated with this request
  35.      * @param 'v1'|'v2' $apiMode
  36.      *
  37.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  38.      *
  39.      * @return array tuple containing (the JSON response, $options)
  40.      */
  41.     protected function _request($method, $url, $params = [], $options = null, $usage = [], $apiMode = 'v1')
  42.     {
  43.         $opts = $this->_opts->merge($options);
  44.         list($resp, $options) = static::_staticRequest($method, $url, $params, $opts, $usage, $apiMode);
  45.         $this->setLastResponse($resp);
  47.         return [$resp->json, $options];
  48.     }
  50.     /**
  51.      * @param string $url URL for the request
  52.      * @param class-string< \Stripe\SearchResult|\Stripe\Collection > $resultClass indicating what type of paginated result is returned
  53.      * @param null|array $params list of parameters for the request
  54.      * @param null|array|string $options
  55.      * @param string[] $usage names of tracked behaviors associated with this request
  56.      *
  57.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  58.      *
  59.      * @return \Stripe\Collection|\Stripe\SearchResult
  60.      */
  61.     protected static function _requestPage($url, $resultClass, $params = null, $options = null, $usage = [])
  62.     {
  63.         self::_validateParams($params);
  65.         list($response, $opts) = static::_staticRequest('get', $url, $params, $options, $usage);
  66.         $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
  67.         if (!($obj instanceof $resultClass)) {
  68.             throw new \Stripe\Exception\UnexpectedValueException(
  69.                 'Expected type ' . $resultClass . ', got "' . \get_class($obj) . '" instead.'
  70.             );
  71.         }
  72.         $obj->setLastResponse($response);
  73.         $obj->setFilters($params);
  75.         return $obj;
  76.     }
  78.     /**
  79.      * @param 'delete'|'get'|'post' $method HTTP method ('get', 'post', etc.)
  80.      * @param string $url URL for the request
  81.      * @param callable $readBodyChunk function that will receive chunks of data from a successful request body
  82.      * @param array $params list of parameters for the request
  83.      * @param null|array|string $options
  84.      * @param string[] $usage names of tracked behaviors associated with this request
  85.      *
  86.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  87.      */
  88.     protected function _requestStream($method, $url, $readBodyChunk, $params = [], $options = null, $usage = [])
  89.     {
  90.         $opts = $this->_opts->merge($options);
  91.         static::_staticStreamingRequest($method, $url, $readBodyChunk, $params, $opts, $usage);
  92.     }
  94.     /**
  95.      * @param 'delete'|'get'|'post' $method HTTP method ('get', 'post', etc.)
  96.      * @param string $url URL for the request
  97.      * @param array $params list of parameters for the request
  98.      * @param null|array|string $options
  99.      * @param string[] $usage names of tracked behaviors associated with this request
  100.      * @param 'v1'|'v2' $apiMode
  101.      *
  102.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  103.      *
  104.      * @return array tuple containing (the JSON response, $options)
  105.      */
  106.     protected static function _staticRequest($method, $url, $params, $options, $usage = [], $apiMode = 'v1')
  107.     {
  108.         $opts = \Stripe\Util\RequestOptions::parse($options);
  109.         $baseUrl = isset($opts->apiBase) ? $opts->apiBase : static::baseUrl();
  110.         $requestor = new \Stripe\ApiRequestor($opts->apiKey, $baseUrl);
  111.         list($response, $opts->apiKey) = $requestor->request($method, $url, $params, $opts->headers, $apiMode, $usage);
  112.         $opts->discardNonPersistentHeaders();
  114.         return [$response, $opts];
  115.     }
  117.     /**
  118.      * @param 'delete'|'get'|'post' $method HTTP method ('get', 'post', etc.)
  119.      * @param string $url URL for the request
  120.      * @param callable $readBodyChunk function that will receive chunks of data from a successful request body
  121.      * @param array $params list of parameters for the request
  122.      * @param null|array|string $options
  123.      * @param string[] $usage names of tracked behaviors associated with this request
  124.      *
  125.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  126.      */
  127.     protected static function _staticStreamingRequest($method, $url, $readBodyChunk, $params, $options, $usage = [])
  128.     {
  129.         $opts = \Stripe\Util\RequestOptions::parse($options);
  130.         $baseUrl = isset($opts->apiBase) ? $opts->apiBase : static::baseUrl();
  131.         $requestor = new \Stripe\ApiRequestor($opts->apiKey, $baseUrl);
  132.         $requestor->requestStream($method, $url, $readBodyChunk, $params, $opts->headers);
  133.     }
  134. }