Better document the S3-specific parsers

Thinkscape · Sep 10, 2015 · 4c68fa4 · 4c68fa4
1 parent 0494e06
commit 4c68fa4
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/src/S3/AmbiguousSuccessParser.php b/src/S3/AmbiguousSuccessParser.php
@@ -6,6 +6,11 @@
 use Aws\Exception\AwsException;
 use Psr\Http\Message\ResponseInterface;
 
+/**
+ * Converts errors returned with a status code of 200 to a retryable error type.
+ *
+ * @internal
+ */
 class AmbiguousSuccessParser extends AbstractParser
 {
     private static $ambiguousSuccesses = [

diff --git a/src/S3/MalformedResponseParser.php → src/S3/RetryableMalformedResponseParser.php b/src/S3/MalformedResponseParser.php → src/S3/RetryableMalformedResponseParser.php
@@ -7,7 +7,12 @@
 use Aws\Exception\AwsException;
 use Psr\Http\Message\ResponseInterface;
 
-class MalformedResponseParser extends AbstractParser
+/**
+ * Converts malformed responses to a retryable error type.
+ *
+ * @internal
+ */
+class RetryableMalformedResponseParser extends AbstractParser
 {
     /** @var callable */
     private $parser;

diff --git a/src/S3/S3Client.php b/src/S3/S3Client.php
@@ -496,7 +496,10 @@ public static function _applyApiProvider($value, array &$args, HandlerList $list
         ClientResolver::_apply_api_provider($value, $args, $list);
         $args['parser'] = new GetBucketLocationParser(
             new AmbiguousSuccessParser(
-                new MalformedResponseParser($args['parser'], $args['exception_class']),
+                new RetryableMalformedResponseParser(
+                    $args['parser'],
+                    $args['exception_class']
+                ),
                 $args['error_parser'],
                 $args['exception_class']
             )