Skip to content

Commit 1c84052

Browse files
committed
phpdoc for the new method
1 parent 1ca05db commit 1c84052

File tree

4 files changed

+12
-3
lines changed

4 files changed

+12
-3
lines changed

Diff for: src/Formatter.php

+3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
*
1111
* @author Márk Sági-Kazár <[email protected]>
1212
*
13+
* The formatResponseForRequest method will be added to this interface in the next major version, replacing the formatRequest method.
14+
* Meanwhile, callers SHOULD check the formatter for the existence of formatResponseForRequest and call that if available.
15+
*
1316
* @method string formatResponseForRequest(ResponseInterface $response, RequestInterface $request) Formats a response in context of its request.
1417
*/
1518
interface Formatter

Diff for: src/Formatter/CurlCommandFormatter.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,9 @@ public function formatResponse(ResponseInterface $response)
6969
}
7070

7171
/**
72-
* {@inheritdoc}
72+
* Formats a response in context of its request.
73+
*
74+
* @return string
7375
*/
7476
public function formatResponseForRequest(ResponseInterface $response, RequestInterface $request)
7577
{

Diff for: src/Formatter/FullHttpMessageFormatter.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,9 @@ public function formatResponse(ResponseInterface $response)
7575
}
7676

7777
/**
78-
* {@inheritdoc}
78+
* Formats a response in context of its request.
79+
*
80+
* @return string
7981
*/
8082
public function formatResponseForRequest(ResponseInterface $response, RequestInterface $request)
8183
{

Diff for: src/Formatter/SimpleFormatter.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@ public function formatResponse(ResponseInterface $response)
4141
}
4242

4343
/**
44-
* {@inheritdoc}
44+
* Formats a response in context of its request.
45+
*
46+
* @return string
4547
*/
4648
public function formatResponseForRequest(ResponseInterface $response, RequestInterface $request)
4749
{

0 commit comments

Comments
 (0)