Feature/plugins doc #76
Conversation
| [$contentLengthPlugin] | ||
| ); | ||
|
|
||
| One of the main advantage of using this plugin, is when you want to transfer information from an existing stream |
There was a problem hiding this comment.
This plugin is useful when you want....
|
👍 I would recommend waiting for some input from @dbu as well, he usually has good points about docs (as well 😛 ) |
| @@ -1,4 +1,38 @@ | |||
| Content-Length Plugin | |||
| ===================== | |||
|
|
|||
| TODO | |||
| The Content-Length Plugin allows you to make your HTTP Request compliant with most of the servers. | |||
| It's main purpose is to set the correct `Content-Length` Header value based on your stream size. | |||
There was a problem hiding this comment.
The ContentLenghtPlugin sets the correct Content-Length header value based on the size of the body stream of the request. This helps HTTP servers to handle the request.
|
thanks a lot for the work, joel! i added some feedback. update as much as you feel like, then lets merge. i can also do a follow up PR with further tweaks if you don't want to adress all of it, better have some documentation than none at all. |
|
Will try to implement all remarks by the end of the week. Wanted to add the other plugins also, but will do that in another PR |
| @@ -1,4 +1,35 @@ | |||
| Content-Length Plugin | |||
| ===================== | |||
|
|
|||
| TODO | |||
| The `ContentLengthPlugin` sets the correct `Content-Length` header value based on the size of the body stream of the | |||
There was a problem hiding this comment.
in .rst, you need double backticks for code, single backticks won't work. (needs to be fixed in all places, won't repeat it everywhere ,-) )
| ); | ||
|
|
||
|
|
||
| This plugin only collect data after resolution, for logging purpose it's best to use the `LoggerPlugin` which logs |
There was a problem hiding this comment.
This plugin collects data only after the request resolution. For logging purposes, ...
| You can also use the decoder plugin to decode only the `Transfer-Encoding` header and not the `Content-Encoding` one | ||
| by setting the first parameter of the constructor to false:: | ||
|
|
||
| $decoderPlugin = new DecoderPlugin(false); |
There was a problem hiding this comment.
with php-http/plugins#45 this is now ['use_content_encoding' => false]
|
Some last review ? |
| @@ -1,4 +1,17 @@ | |||
| Cookie Plugin | |||
| ============= | |||
|
|
|||
| TODO: explain the cookie plugin | |||
| The ``CookiePlugin`` allow you to store cookies information in a ``CookieJar`` and reuse them on consequent requests according | |||
There was a problem hiding this comment.
‘store cookies’ (no ‘information’)
|
@joelwurtz Good job! Can you please wrap at 80 chars? That’s what we’re doing elsewhere in the docs as well (and is according to PHP coding standards, so easy to remember). |
|
Should be ready to merge |
|
Please squash. 😉 |
joelwurtz
force-pushed
the
feature/plugins-doc
branch
from
66a937c
to
c5b2795
Compare
|
I squash with one commit per documentation file |
|
Thanks, Joel! 😄 |
|
Build seems to have failed on readthedocs any idea ? |
|
Restarted the build, it was an API error |
Feature/plugins doc
No description provided.