Skip to content

clarify header plugin phpdoc #39

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.

Sign up for GitHub

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
Aug 12, 2016
Merged

clarify header plugin phpdoc #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions src/Plugin/HeaderAppendPlugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
use Psr\Http\Message\RequestInterface;

/**
* Adds headers to the request.
* Append headers to the request.
*
* If the header already exists the value will be appended to the current value.
*
* This only makes sense for headers that can have multiple values like 'Forwarded'
Expand All @@ -23,7 +24,7 @@ final class HeaderAppendPlugin implements Plugin
private $headers = [];

/**
* @param array $headers headers to add to the request
* @param array $headers Hashmap of header name to header value
*/
public function __construct(array $headers)
{
Expand Down
5 changes: 3 additions & 2 deletions src/Plugin/HeaderDefaultsPlugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
use Psr\Http\Message\RequestInterface;

/**
* Set default values for the request headers.
* Set header to default value if it does not exist.
*
* If a given header already exists the value wont be replaced and the request wont be changed.
*
* @author Soufiane Ghzal <[email protected]>
Expand All @@ -19,7 +20,7 @@ final class HeaderDefaultsPlugin implements Plugin
private $headers = [];

/**
* @param array $headers headers to set to the request
* @param array $headers Hashmap of header name to header value
*/
public function __construct(array $headers)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Plugin/HeaderRemovePlugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ final class HeaderRemovePlugin implements Plugin
private $headers = [];

/**
* @param array $headers headers to remove from the request
* @param array $headers List of header names to remove from the request
*/
public function __construct(array $headers)
{
Expand Down
5 changes: 3 additions & 2 deletions src/Plugin/HeaderSetPlugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
use Psr\Http\Message\RequestInterface;

/**
* Set headers to the request.
* Set headers on the request.
*
* If the header does not exist it wil be set, if the header already exists it will be replaced.
*
* @author Soufiane Ghzal <[email protected]>
Expand All @@ -19,7 +20,7 @@ final class HeaderSetPlugin implements Plugin
private $headers = [];

/**
* @param array $headers headers to set to the request
* @param array $headers Hashmap of header name to header value
*/
public function __construct(array $headers)
{
Expand Down