Code cleanup (#1854)

* Code cleanup for parameter usage, class properties, typehints, etc. * Formatting tweak
aws · Jul 29, 2019 · 941de21 · 941de21
1 parent df65815
commit 941de21
Show file tree

Hide file tree

Showing 18 changed files with 38 additions and 18 deletions.
diff --git a/src/Api/DocModel.php b/src/Api/DocModel.php
@@ -109,7 +109,7 @@ private function clean($content)
             return '';
         }
 
-        $tidy = new \Tidy();
+        $tidy = new \tidy();
         $tidy->parseString($content, [
             'indent' => true,
             'doctype' => 'omit',

diff --git a/src/Api/ErrorParser/AbstractErrorParser.php b/src/Api/ErrorParser/AbstractErrorParser.php
@@ -1,11 +1,9 @@
 <?php
 namespace Aws\Api\ErrorParser;
 
-use Aws\Api\DateTimeResult;
 use Aws\Api\Parser\MetadataParserTrait;
 use Aws\Api\Parser\PayloadParserTrait;
 use Aws\Api\Service;
-use Aws\Api\Shape;
 use Aws\Api\StructureShape;
 use Aws\CommandInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -28,6 +26,11 @@ public function __construct(Service $api = null)
         $this->api = $api;
     }
 
+    abstract protected function payload(
+        ResponseInterface $response,
+        StructureShape $member
+    );
+
     protected function extractPayload(
         StructureShape $member,
         ResponseInterface $response

diff --git a/src/Api/ErrorParser/JsonRpcErrorParser.php b/src/Api/ErrorParser/JsonRpcErrorParser.php
@@ -13,6 +13,8 @@ class JsonRpcErrorParser extends AbstractErrorParser
 {
     use JsonParserTrait;
 
+    private $parser;
+
     public function __construct(Service $api = null, JsonParser $parser = null)
     {
         parent::__construct($api);

diff --git a/src/Api/Parser/DecodingEventStreamIterator.php b/src/Api/Parser/DecodingEventStreamIterator.php
@@ -60,7 +60,7 @@ class DecodingEventStreamIterator implements Iterator
     /** @var int Current in-order event key. */
     private $key;
 
-    /** @var resource|HashContext CRC32 hash context for event validation */
+    /** @var resource|\HashContext CRC32 hash context for event validation */
     private $hashContext;
 
     /** @var int $currentPosition */

diff --git a/src/Api/Parser/Exception/ParserException.php b/src/Api/Parser/Exception/ParserException.php
@@ -4,6 +4,7 @@
 use Aws\HasMonitoringEventsTrait;
 use Aws\MonitoringEventsInterface;
 use Aws\ResponseContainerInterface;
+use Psr\Http\Message\ResponseInterface;
 
 class ParserException extends \RuntimeException implements
     MonitoringEventsInterface,

diff --git a/src/Credentials/AssumeRoleWithWebIdentityCredentialProvider.php b/src/Credentials/AssumeRoleWithWebIdentityCredentialProvider.php
@@ -71,7 +71,7 @@ public function __construct(array $config = [])
     /**
      * Loads assume role with web identity credentials.
      *
-     * @return PromiseInterface
+     * @return Promise\PromiseInterface
      */
     public function __invoke()
     {

diff --git a/src/Credentials/EcsCredentialProvider.php b/src/Credentials/EcsCredentialProvider.php
@@ -18,6 +18,9 @@ class EcsCredentialProvider
     /** @var callable */
     private $client;
 
+    /** @var float|mixed */
+    private $timeout;
+
     /**
      *  The constructor accepts following options:
      *  - timeout: (optional) Connection timeout, in seconds, default 1.0

diff --git a/src/Credentials/InstanceProfileProvider.php b/src/Credentials/InstanceProfileProvider.php
@@ -32,6 +32,9 @@ class InstanceProfileProvider
     /** @var int */
     private $attempts;
 
+    /** @var float|mixed */
+    private $timeout;
+
     /**
      * The constructor accepts the following options:
      *

diff --git a/src/DynamoDb/DynamoDbClient.php b/src/DynamoDb/DynamoDbClient.php
@@ -142,7 +142,7 @@ function ($retries) {
     /** @internal */
     public static function _applyApiProvider($value, array &$args, HandlerList $list)
     {
-        ClientResolver::_apply_api_provider($value, $args, $list);
+        ClientResolver::_apply_api_provider($value, $args);
         $args['parser'] = new Crc32ValidatingParser($args['parser']);
     }
 }
diff --git a/src/DynamoDb/SessionConnectionConfigTrait.php b/src/DynamoDb/SessionConnectionConfigTrait.php
@@ -182,15 +182,15 @@ public function setConsistentRead($consistentRead)
     }
 
     /**
-     * @return multitype:
+     * @return mixed
      */
     public function getBatchConfig()
     {
         return $this->batchConfig;
     }
 
     /**
-     * @param multitype: $batchConfig
+     * @param mixed $batchConfig
      */
     public function setBatchConfig($batchConfig)
     {

diff --git a/src/EndpointDiscovery/EndpointDiscoveryMiddleware.php b/src/EndpointDiscovery/EndpointDiscoveryMiddleware.php
@@ -130,7 +130,6 @@ public function __invoke(CommandInterface $cmd, RequestInterface $request)
                     $cmd,
                     $identifiers,
                     $isRequired,
-                    $nextHandler,
                     $originalUri,
                     $request,
                     &$endpoint,

diff --git a/src/EndpointParameterMiddleware.php b/src/EndpointParameterMiddleware.php
@@ -14,6 +14,11 @@
  */
 class EndpointParameterMiddleware
 {
+    /** @var callable */
+    private $nextHandler;
+
+    /** @var Service */
+    private $service;
 
     /**
      * Create a middleware wrapper function

diff --git a/src/Glacier/GlacierClient.php b/src/Glacier/GlacierClient.php
@@ -146,7 +146,7 @@ private function getChecksumsMiddleware()
                     if (!$command['checksum']) {
                         $body = new HashingStream(
                             $body, new TreeHash(),
-                            function ($result) use ($command, &$request) {
+                            function ($result) use (&$request) {
                                 $request = $request->withHeader(
                                     'x-amz-sha256-tree-hash',
                                     bin2hex($result)

diff --git a/src/Handler/GuzzleV5/GuzzleHandler.php b/src/Handler/GuzzleV5/GuzzleHandler.php
@@ -51,9 +51,9 @@ public function __construct(ClientInterface $client = null)
 
     /**
      * @param Psr7Request $request
-     * @param array       $options
-     *
-     * @return Promise\Promise
+     * @param array $options
+     * @return Promise\Promise|Promise\PromiseInterface
+     * @throws \GuzzleHttp\Exception\GuzzleException
      */
     public function __invoke(Psr7Request $request, array $options = [])
     {

diff --git a/src/MultiRegionClient.php b/src/MultiRegionClient.php
@@ -20,6 +20,8 @@ class MultiRegionClient implements AwsClientInterface
     private $config;
     /** @var HandlerList */
     private $handlerList;
+    /** @var array */
+    private $aliases;
 
     public static function getArguments()
     {

diff --git a/src/ResponseContainerInterface.php b/src/ResponseContainerInterface.php
@@ -2,6 +2,8 @@
 
 namespace Aws;
 
+use Psr\Http\Message\ResponseInterface;
+
 interface ResponseContainerInterface
 {
     /**

diff --git a/src/S3/S3Client.php b/src/S3/S3Client.php
@@ -566,7 +566,7 @@ public static function _applyRetryConfig($value, $_, HandlerList $list)
     /** @internal */
     public static function _applyApiProvider($value, array &$args, HandlerList $list)
     {
-        ClientResolver::_apply_api_provider($value, $args, $list);
+        ClientResolver::_apply_api_provider($value, $args);
         $args['parser'] = new GetBucketLocationParser(
             new AmbiguousSuccessParser(
                 new RetryableMalformedResponseParser(

diff --git a/src/S3/StreamWrapper.php b/src/S3/StreamWrapper.php
@@ -147,11 +147,11 @@ public function stream_open($path, $mode, $options, &$opened_path)
             return $this->triggerError($errors);
         }
 
-        return $this->boolCall(function() use ($path) {
+        return $this->boolCall(function() {
             switch ($this->mode) {
-                case 'r': return $this->openReadStream($path);
-                case 'a': return $this->openAppendStream($path);
-                default: return $this->openWriteStream($path);
+                case 'r': return $this->openReadStream();
+                case 'a': return $this->openAppendStream();
+                default: return $this->openWriteStream();
             }
         });
     }