Skip to content

Commit 2c541cf

Browse files
committed
Updated doc block to be coherent with the suggested PSR
1 parent 3d77e7d commit 2c541cf

File tree

5 files changed

+17
-19
lines changed

5 files changed

+17
-19
lines changed

src/CachePlugin.php

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,12 @@ class CachePlugin implements Plugin
3232
private $config;
3333

3434
/**
35-
* Available options for $config are
36-
* - respect_cache_headers: Whether to look at the cache directives or ignore them.
37-
* - default_ttl: If we do not respect cache headers or can't calculate a good ttl, use this value.
38-
*
3935
* @param CacheItemPoolInterface $pool
4036
* @param StreamFactory $streamFactory
41-
* @param array $config
37+
* @param array $config {
38+
* @var bool $respect_cache_headers Whether to look at the cache directives or ignore them.
39+
* @var int $default_ttl If we do not respect cache headers or can't calculate a good ttl, use this value.
40+
* }
4241
*/
4342
public function __construct(CacheItemPoolInterface $pool, StreamFactory $streamFactory, array $config = [])
4443
{

src/DecoderPlugin.php

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,9 @@ class DecoderPlugin implements Plugin
3030
private $useContentEncoding;
3131

3232
/**
33-
* Available options for $config are:
34-
* - use_content_encoding: Whether this plugin should look at the Content-Encoding header first or only at the Transfer-Encoding (defaults to true).
35-
*
36-
* @param array $config
33+
* @param array $config {
34+
* @var bool $use_content_encoding Whether this plugin should look at the Content-Encoding header first or only at the Transfer-Encoding (defaults to true).
35+
* }
3736
*/
3837
public function __construct(array $config = [])
3938
{

src/PluginClient.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@ final class PluginClient implements HttpClient, HttpAsyncClient
4343
/**
4444
* @param HttpClient|HttpAsyncClient $client
4545
* @param Plugin[] $plugins
46-
* @param array $options
46+
* @param array $options {
47+
* @var int $max_restarts
48+
* }
4749
*
4850
* @throws \RuntimeException if client is not an instance of HttpClient or HttpAsyncClient
4951
*/

src/RedirectPlugin.php

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,10 @@ class RedirectPlugin implements Plugin
9999
protected $circularDetection = [];
100100

101101
/**
102-
* Available options for $config are:
103-
* - preserve_header: bool|string[] True keeps all headers, false remove all of them, an array is interpreted as a list of header names to keep.
104-
* - use_default_for_multiple: Whether the location header must be directly used for a multiple redirection status code (300).
105-
*
106-
* @param array $config
102+
* @param array $config {
103+
* @var bool|string[] $preserve_header True keeps all headers, false remove all of them, an array is interpreted as a list of header names to keep.
104+
* @var bool $use_default_for_multiple Whether the location header must be directly used for a multiple redirection status code (300).
105+
* }
107106
*/
108107
public function __construct(array $config = [])
109108
{

src/RetryPlugin.php

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,9 @@ class RetryPlugin implements Plugin
3131
private $retryStorage = [];
3232

3333
/**
34-
* Available options for $config are:
35-
* - retries: Number of retries to attempt if an exception occurs before letting the exception bubble up.
36-
*
37-
* @param array $config
34+
* @param array $config {
35+
* @var int $retries Number of retries to attempt if an exception occurs before letting the exception bubble up.
36+
* }
3837
*/
3938
public function __construct(array $config = [])
4039
{

0 commit comments

Comments
 (0)