Merge pull request #1487 from stripe/richardm-better-method-types

PHPDoc: use union of literals for $method parameter throughout

lib/ApiOperations/NestedResource.php

@@ -10,7 +10,7 @@
 trait NestedResource
 {
     /**
-     * @param string $method
+     * @param 'delete'|'get'|'post' $method
      * @param string $url
      * @param null|array $params
      * @param null|array|string $options

lib/ApiOperations/Request.php

@@ -27,7 +27,7 @@ protected static function _validateParams($params = null)
     }
 
     /**
-     * @param string $method HTTP method ('get', 'post', etc.)
+     * @param 'delete'|'get'|'post' $method HTTP method ('get', 'post', etc.)
      * @param string $url URL for the request
      * @param array $params list of parameters for the request
      * @param null|array|string $options
@@ -46,7 +46,7 @@ protected function _request($method, $url, $params = [], $options = null)
     }
 
     /**
-     * @param string $method HTTP method ('get', 'post', etc.)
+     * @param 'delete'|'get'|'post' $method HTTP method ('get', 'post', etc.)
      * @param string $url URL for the request
      * @param callable $readBodyChunk function that will receive chunks of data from a successful request body
      * @param array $params list of parameters for the request
@@ -61,7 +61,7 @@ protected function _requestStream($method, $url, $readBodyChunk, $params = [], $
     }
 
     /**
-     * @param string $method HTTP method ('get', 'post', etc.)
+     * @param 'delete'|'get'|'post' $method HTTP method ('get', 'post', etc.)
      * @param string $url URL for the request
      * @param array $params list of parameters for the request
      * @param null|array|string $options
@@ -82,7 +82,7 @@ protected static function _staticRequest($method, $url, $params, $options)
     }
 
     /**
-     * @param string $method HTTP method ('get', 'post', etc.)
+     * @param 'delete'|'get'|'post' $method HTTP method ('get', 'post', etc.)
      * @param string $url URL for the request
      * @param callable $readBodyChunk function that will receive chunks of data from a successful request body
      * @param array $params list of parameters for the request

lib/ApiRequestor.php

@@ -106,7 +106,7 @@ private static function _encodeObjects($d)
     }
 
     /**
-     * @param string     $method
+     * @param 'delete'|'get'|'post' $method
      * @param string     $url
      * @param null|array $params
      * @param null|array $headers
@@ -128,7 +128,7 @@ public function request($method, $url, $params = null, $headers = null)
     }
 
     /**
-     * @param string     $method
+     * @param 'delete'|'get'|'post' $method
      * @param string     $url
      * @param callable $readBodyChunkCallable
      * @param null|array $params
@@ -432,7 +432,7 @@ function ($key) use ($params) {
     }
 
     /**
-     * @param string $method
+     * @param 'delete'|'get'|'post' $method
      * @param string $url
      * @param array $params
      * @param array $headers
@@ -469,7 +469,7 @@ private function _requestRaw($method, $url, $params, $headers)
     }
 
     /**
-     * @param string $method
+     * @param 'delete'|'get'|'post' $method
      * @param string $url
      * @param array $params
      * @param array $headers

lib/BaseStripeClient.php

@@ -119,7 +119,7 @@ public function getFilesBase()
     /**
      * Sends a request to Stripe's API.
      *
-     * @param string $method the HTTP method
+     * @param 'delete'|'get'|'post' $method the HTTP method
      * @param string $path the path of the request
      * @param array $params the parameters of the request
      * @param array|\Stripe\Util\RequestOptions $opts the special modifiers of the request
@@ -143,7 +143,7 @@ public function request($method, $path, $params, $opts)
      * Sends a request to Stripe's API, passing chunks of the streamed response
      * into a user-provided $readBodyChunkCallable callback.
      *
-     * @param string $method the HTTP method
+     * @param 'delete'|'get'|'post' $method the HTTP method
      * @param string $path the path of the request
      * @param callable $readBodyChunkCallable a function that will be called
      * @param array $params the parameters of the request
@@ -161,7 +161,7 @@ public function requestStream($method, $path, $readBodyChunkCallable, $params, $
     /**
      * Sends a request to Stripe's API.
      *
-     * @param string $method the HTTP method
+     * @param 'delete'|'get'|'post' $method the HTTP method
      * @param string $path the path of the request
      * @param array $params the parameters of the request
      * @param array|\Stripe\Util\RequestOptions $opts the special modifiers of the request
@@ -185,7 +185,7 @@ public function requestCollection($method, $path, $params, $opts)
     /**
      * Sends a request to Stripe's API.
      *
-     * @param string $method the HTTP method
+     * @param 'delete'|'get'|'post' $method the HTTP method
      * @param string $path the path of the request
      * @param array $params the parameters of the request
      * @param array|\Stripe\Util\RequestOptions $opts the special modifiers of the request

lib/HttpClient/ClientInterface.php

@@ -5,7 +5,7 @@
 interface ClientInterface
 {
     /**
-     * @param string $method The HTTP method being used
+     * @param 'delete'|'get'|'post' $method The HTTP method being used
      * @param string $absUrl The URL being requested, including domain and protocol
      * @param array $headers Headers to be used in the request (full strings, not KV pairs)
      * @param array $params KV pairs for parameters. Can be nested for arrays and hashes

lib/HttpClient/StreamingClientInterface.php

@@ -5,7 +5,7 @@
 interface StreamingClientInterface
 {
     /**
-     * @param string $method The HTTP method being used
+     * @param 'delete'|'get'|'post' $method The HTTP method being used
      * @param string $absUrl The URL being requested, including domain and protocol
      * @param array $headers Headers to be used in the request (full strings, not KV pairs)
      * @param array $params KV pairs for parameters. Can be nested for arrays and hashes

lib/Service/OAuthService.php

@@ -7,7 +7,7 @@ class OAuthService extends \Stripe\Service\AbstractService
     /**
      * Sends a request to Stripe's Connect API.
      *
-     * @param string $method the HTTP method
+     * @param 'delete'|'get'|'post' $method the HTTP method
      * @param string $path the path of the request
      * @param array $params the parameters of the request
      * @param array|\Stripe\Util\RequestOptions $opts the special modifiers of the request

lib/StripeClientInterface.php

@@ -10,7 +10,7 @@ interface StripeClientInterface extends BaseStripeClientInterface
     /**
      * Sends a request to Stripe's API.
      *
-     * @param string $method the HTTP method
+     * @param 'delete'|'get'|'post' $method the HTTP method
      * @param string $path the path of the request
      * @param array $params the parameters of the request
      * @param array|\Stripe\Util\RequestOptions $opts the special modifiers of the request

tests/TestHelper.php

@@ -71,7 +71,7 @@ protected function tearDownConfig()
      * Sets up a request expectation with the provided parameters. The request
      * will actually go through and be emitted.
      *
-     * @param string $method HTTP method (e.g. 'post', 'get', etc.)
+     * @param 'delete'|'get'|'post' $method HTTP method (e.g. 'post', 'get', etc.)
      * @param string $path relative path (e.g. '/v1/charges')
      * @param null|array $params array of parameters. If null, parameters will
      *   not be checked.
@@ -106,7 +106,7 @@ function ($method, $absUrl, $headers, $params, $hasFile) {
      * Sets up a request expectation with the provided parameters. The request
      * will actually go through and be emitted.
      *
-     * @param string $method HTTP method (e.g. 'post', 'get', etc.)
+     * @param 'delete'|'get'|'post' $method HTTP method (e.g. 'post', 'get', etc.)
      * @param string $path relative path (e.g. '/v1/charges')
      * @param null|array $params array of parameters. If null, parameters will
      *   not be checked.
@@ -142,7 +142,7 @@ function ($method, $absUrl, $readBodyChunkCallable, $headers, $params, $hasFile)
      * will not actually be emitted, instead the provided response parameters
      * will be returned.
      *
-     * @param string $method HTTP method (e.g. 'post', 'get', etc.)
+     * @param 'delete'|'get'|'post' $method HTTP method (e.g. 'post', 'get', etc.)
      * @param string $path relative path (e.g. '/v1/charges')
      * @param null|array $params array of parameters. If null, parameters will
      *   not be checked.
@@ -175,7 +175,7 @@ protected function stubRequest(
      * prepare the client mocker to expect an invocation of the `request` method
      * with the provided arguments.
      *
-     * @param string $method HTTP method (e.g. 'post', 'get', etc.)
+     * @param 'delete'|'get'|'post' $method HTTP method (e.g. 'post', 'get', etc.)
      * @param string $path relative path (e.g. '/v1/charges')
      * @param null|array $params array of parameters. If null, parameters will
      *   not be checked.
@@ -231,7 +231,7 @@ private function prepareRequestMock(
      * prepare the client mocker to expect an invocation of the `request` method
      * with the provided arguments.
      *
-     * @param string $method HTTP method (e.g. 'post', 'get', etc.)
+     * @param 'delete'|'get'|'post' $method HTTP method (e.g. 'post', 'get', etc.)
      * @param string $path relative path (e.g. '/v1/charges')
      * @param null|array $params array of parameters. If null, parameters will
      *   not be checked.