Skip to content

Updated doc block to be coherent with the suggested PSR #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 28, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/CachePlugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ class CachePlugin implements Plugin
private $config;

/**
* Available options for $config are
* - respect_cache_headers: Whether to look at the cache directives or ignore them.
* - default_ttl: If we do not respect cache headers or can't calculate a good ttl, use this value.
*
* @param CacheItemPoolInterface $pool
* @param StreamFactory $streamFactory
* @param array $config
* @param array $config {
*
* @var bool $respect_cache_headers Whether to look at the cache directives or ignore them.
* @var int $default_ttl If we do not respect cache headers or can't calculate a good ttl, use this value.
* }
*/
public function __construct(CacheItemPoolInterface $pool, StreamFactory $streamFactory, array $config = [])
{
Expand Down
6 changes: 3 additions & 3 deletions src/DecoderPlugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ class DecoderPlugin implements Plugin
private $useContentEncoding;

/**
* Available options for $config are:
* - use_content_encoding: Whether this plugin should look at the Content-Encoding header first or only at the Transfer-Encoding (defaults to true).
* @param array $config {
*
* @param array $config
* @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).
* }
*/
public function __construct(array $config = [])
{
Expand Down
5 changes: 4 additions & 1 deletion src/PluginClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,10 @@ final class PluginClient implements HttpClient, HttpAsyncClient
/**
* @param HttpClient|HttpAsyncClient $client
* @param Plugin[] $plugins
* @param array $options
* @param array $options {
*
* @var int $max_restarts
* }
*
* @throws \RuntimeException if client is not an instance of HttpClient or HttpAsyncClient
*/
Expand Down
8 changes: 4 additions & 4 deletions src/RedirectPlugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,11 @@ class RedirectPlugin implements Plugin
protected $circularDetection = [];

/**
* Available options for $config are:
* - 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.
* - use_default_for_multiple: Whether the location header must be directly used for a multiple redirection status code (300).
* @param array $config {
*
* @param array $config
* @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.
* @var bool $use_default_for_multiple Whether the location header must be directly used for a multiple redirection status code (300).
* }
*/
public function __construct(array $config = [])
{
Expand Down
6 changes: 3 additions & 3 deletions src/RetryPlugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ class RetryPlugin implements Plugin
private $retryStorage = [];

/**
* Available options for $config are:
* - retries: Number of retries to attempt if an exception occurs before letting the exception bubble up.
* @param array $config {
*
* @param array $config
* @var int $retries Number of retries to attempt if an exception occurs before letting the exception bubble up.
* }
*/
public function __construct(array $config = [])
{
Expand Down