consolidate notes
authorMichael Wallner <mike@php.net>
Thu, 18 Aug 2016 20:58:35 +0000 (22:58 +0200)
committerMichael Wallner <mike@php.net>
Thu, 18 Aug 2016 20:58:35 +0000 (22:58 +0200)
26 files changed:
http/Client/Request/setOptions.md
http/Client/count.md
http/Client/getHistory.md
http/Client/getResponse.md
http/Client/setOptions.md
http/Cookie/getExpires.md
http/Cookie/getMaxAge.md
http/Cookie/setCookie.md
http/Cookie/setExtra.md
http/Env/Response/setEtag.md
http/Env/Response/setLastModified.md
http/Env/Response/setThrottleRate.md
http/Env/negotiate.md
http/Env/negotiateCharset.md
http/Env/negotiateContentType.md
http/Env/negotiateEncoding.md
http/Env/negotiateLanguage.md
http/Header/negotiate.md
http/Message/Body.md
http/Message/Body/addForm.md
http/Message/prepend.md
http/Message/reverse.md
http/Message/setRequestUrl.md
http/Message/setResponseCode.md
http/QueryString/mod.md
http/QueryString/xlate.md

index cbd3b9fd33eaa4b23664cac227622fb755ed3084..5ff03337e86c5be2acb839eb04a2a04d7c80d9f4 100644 (file)
@@ -5,7 +5,8 @@ See http\Client::setOptions() and http\Client\Curl.
 
 Request specific options override general options which were set in the client.
 
-> **Note:** Only options specified prior enqueueing a request are applied to the request.
+> ***NOTE:***  
+> Only options specified prior enqueueing a request are applied to the request.
 
 ## Params:
 
index 851ae1fdc2dd65dcd6229d64252969a28f62b59a..67718e65dc3d6dbcdb76b6df6cda56edbbf7cbc5 100644 (file)
@@ -2,7 +2,8 @@
 
 Implements Countable. Retrieve the number of enqueued requests.
 
-> **Note:** The enqueued requests are counted without regard whether they are finished or not.
+> ***NOTE:***  
+> The enqueued requests are counted without regard whether they are finished or not.
 
 ## Params:
 
index 60d3ecff62d15b37a9ff120e55fc43ebe01c74b5..5cfeca7f6ef671efade2d28e49c7b535daac87ce 100644 (file)
@@ -2,7 +2,8 @@
 
 Simply returns the http\Message chain representing the request/response history.
 
-> **Note:** The history is only recorded while http\Client::$recordHistory is true.
+> ***NOTE:***  
+> The history is only recorded while http\Client::$recordHistory is true.
 
 ## Params:
 
index 00d3d95e5b2d06d23056887aec88915b02d530b1..f006b3d3dbd115c56de58aa26032e17df598abc7 100644 (file)
@@ -2,7 +2,8 @@
 
 Retrieve the corresponding reponse of an already finished request, or the last received response if $request is not set.
 
-> **Note:** If $request is NULL, then the response is removed from the internal storage (stack-like operation).
+> ***NOTE:***  
+> If $request is NULL, then the response is removed from the internal storage (stack-like operation).
 
 ## Params:
 
index 50136fb05bdb5cf7994c7e1695383480b75c2139..9a6233fdf2dfc7886dd06059c67f710e5f7041ab 100644 (file)
@@ -3,7 +3,8 @@
 Set client options.
 See http\Client\Curl.
 
-> **Note:** Only options specified prior enqueueing a request are applied to the request.
+> ***NOTE:***  
+> Only options specified prior enqueueing a request are applied to the request.
 
 ## Params:
 
index 46300a5c03d8d0a34b870348d0ef9a8dce079528..853cde7b13e1f49789af344f78ef13d623cba6f2 100644 (file)
@@ -3,7 +3,8 @@
 Get the currently set expires attribute.
 See http\Cookie::setExpires().
 
-> **Note:** A return value of -1 means that the attribute is not set.
+> ***NOTE:***  
+> A return value of -1 means that the attribute is not set.
 
 ## Params:
 
index 88c476f24ae964d7de4b17379cce220fad6f07dd..44b61c5b59528901d29faa2a3d696144df9b1039 100644 (file)
@@ -3,7 +3,8 @@
 Get the currently set max-age attribute of the cookie list.
 See http\Cookie::setMaxAge().
 
-> **Note:** A return value of -1 means that the attribute is not set.
+> ***NOTE:***  
+> A return value of -1 means that the attribute is not set.
 
 ## Params:
 
index 15b88d09cf5fb0908a61bfb50bbca850952bde73..88adba4ca815f769a401502bab23b3c6892bf5d3 100644 (file)
@@ -3,7 +3,8 @@
 (Re)set a cookie.
 See http\Cookie::addCookie() and http\Cookie::setCookies().
 
-> **Note:** The cookie will be deleted from the list if $cookie_value is NULL.
+> ***NOTE:***  
+> The cookie will be deleted from the list if $cookie_value is NULL.
 
 ## Params:
 
index ff40921cb65eb766979f039f9d3a4cdb97e3ff7c..72312d3346416b424f299241babeecf1cdce7a07 100644 (file)
@@ -3,7 +3,8 @@
 (Re)set an extra attribute.
 See http\Cookie::addExtra().
 
-> **Note:** The attribute will be removed from the extras list if $extra_value is NULL.
+> ***NOTE:***  
+> The attribute will be removed from the extras list if $extra_value is NULL.
 
 ## Params:
 
index f71c80bdcd17b6a322a6d7b7746543122eec5f84..4321ceb86174f45c53ef46e646e7831f27226f7f 100644 (file)
@@ -2,7 +2,8 @@
 
 Set a custom ETag.
 
-> **Note:** This will be used for caching and pre-condition checks.
+> ***NOTE:***  
+> This will be used for caching and pre-condition checks.
 
 ## Params:
 
index a057605d6bc20cfee9d964ffa982fa1b416ed39d..046f0305fe800c70a302c7c33e093f3a10bcde92 100644 (file)
@@ -2,7 +2,8 @@
 
 Set a custom last modified time stamp.
 
-> **Note:** This will be used for caching and pre-condition checks.
+> ***NOTE:***  
+> This will be used for caching and pre-condition checks.
 
 ## Params:
 
index 03b7047baddfd99ce4d5b8ea5762ee5769c9682f..686d5e9905ffd11a30da4e4cbbbc0dcf5a93c397 100644 (file)
@@ -3,7 +3,8 @@
 Enable throttling.
 Send $chunk_size bytes every $delay seconds.
 
-> **Note:** If you need throttling by regular means, check for other options in your stack, because this method blocks the executing process/thread until the response has completely been sent.
+> ***NOTE:***  
+> If you need throttling by regular means, check for other options in your stack, because this method blocks the executing process/thread until the response has completely been sent.
 
 ## Params:
 
index 86786bbde95abd6e8679fa61bdd3b2a4b0b3885e..6463bef0908799d0eefafaddf967711692e8456b 100644 (file)
@@ -2,7 +2,8 @@
 
 Generic negotiator. For specific client negotiation see http\Env::negotiateContentType() and related methods.
 
-> **Note:** The first elemement of $supported serves as a default if no operand matches.
+> ***NOTE:***  
+> The first elemement of $supported serves as a default if no operand matches.
 
 ## Params:
 
index 9db7a79d8adb01c2c5d833b36a1657bc92bf43eb..084c62218d21ff5d7ea430100cec737dffa87b90 100644 (file)
@@ -2,7 +2,8 @@
 
 Negotiate the client's preferred character set.
 
-> **Note:** The first elemement of $supported character sets serves as a default if no character set matches.
+> ***NOTE:***  
+> The first elemement of $supported character sets serves as a default if no character set matches.
 
 ## Params:
 
index d5ee50094e8010b73bf39ae0d7cb4dca2176534d..ccdac8119c89c1c55e4252d45268d5e0b25d2fad 100644 (file)
@@ -2,7 +2,8 @@
 
 Negotiate the client's preferred MIME content type.
 
-> **Note:** The first elemement of $supported content types serves as a default if no content-type matches.
+> ***NOTE:***  
+> The first elemement of $supported content types serves as a default if no content-type matches.
 
 ## Params:
 
index 7053373f2005c1d2b88927ce15a2eb3e0cd6d063..60e90d2657b4fc7c12cca364e063c707d412c41b 100644 (file)
@@ -2,7 +2,8 @@
 
 Negotiate the client's preferred encoding.
 
-> **Note:** The first elemement of $supported encodings serves as a default if no encoding matches.
+> ***NOTE:***  
+> The first elemement of $supported encodings serves as a default if no encoding matches.
 
 ## Params:
 
index 4c91b931e605fcdd7e5585fa322d3413b919718f..a50561c80c71954ef50c81885ac1ce8553150d33 100644 (file)
@@ -2,7 +2,8 @@
 
 Negotiate the client's preferred language.
 
-> **Note:** The first elemement of $supported languages serves as a default if no language matches.
+> ***NOTE:***  
+> The first elemement of $supported languages serves as a default if no language matches.
 
 ## Params:
 
index dd2d1c884e4c9db75d05159fb1022416bc197020..b9aaff920a6089e123053091ca512740048a5a3e 100644 (file)
@@ -6,7 +6,8 @@ header being negotiated is Accept, then a slash is used as primary type
 separator, and if the header is Accept-Language respectively, a hyphen is 
 used instead.
 
-> **Note:** The first elemement of $supported serves as a default if no operand matches.
+> ***NOTE:***  
+> The first elemement of $supported serves as a default if no operand matches.
 
 ## Params:
 
index ef684ad3f8fc87145efc740d04145d36218ab815..89dd07a7a46dd663716d8d8c51bba0f41c8fb360 100644 (file)
@@ -2,7 +2,8 @@
 
 The message body, represented as a PHP (temporary) stream.
 
-> **Note:** Currently, http\Message\Body::addForm() creates multipart/form-data bodies.
+> ***NOTE:***  
+> Currently, http\Message\Body::addForm() creates multipart/form-data bodies.
 
 ## Constants:
 
index 19e3b6cda2d739943b905fe953c1dffc6402088a..5b59fc0cb58bdb036b0ec704d35db4278edceeb9 100644 (file)
@@ -2,7 +2,8 @@
 
 Add form fields and files to the message body.
 
-> **Note:** Currently, http\Message\Body::addForm() creates "multipart/form-data" bodies.
+> ***NOTE:***  
+> Currently, http\Message\Body::addForm() creates "multipart/form-data" bodies.
 
 ## Params:
 
index 7bc88df959f3833e90a1ef18fd1eb45136133884..308475d35e1f4d7d6aa7b7f51d8e1bfd79f50c0b 100644 (file)
@@ -2,7 +2,8 @@
 
 Prepend message(s) $message to this message, or the top most message of this message chain.
 
-> **Note:** The message chains must not overlap.
+> ***NOTE:***  
+> The message chains must not overlap.
 
 ## Params:
 
index 9189589b4ca2fcda68fe6301b07a290fb9105722..00d8c15ddee06ee12c5838a8c8cea2d533aec5ab 100644 (file)
@@ -2,7 +2,8 @@
 
 Reverse the message chain and return the former top-most message.
 
-> **Note:** Message chains are ordered in reverse-parsed order by default, i.e. the last parsed message is the message you'll receive from any call parsing HTTP messages.
+> ***NOTE:***  
+> Message chains are ordered in reverse-parsed order by default, i.e. the last parsed message is the message you'll receive from any call parsing HTTP messages.
 >
 > This call re-orders the messages of the chain and returns the message that was parsed first with any later parsed messages re-parentized.
 
index 30e4a7dccd097dc53d74bda8806f218a5465025d..766b3d1c9ca0b394fb28511780048e2ff5408bc1 100644 (file)
@@ -19,7 +19,8 @@ See http\Message::getRequestUrl() and http\Message::setRequestMethod().
 
 ## Example:
 
-> **Note:** The request URL in a request message usually only consists of the path and the querystring.
+> ***NOTE:***  
+> The request URL in a request message usually only consists of the path and the querystring.
 
     <?php
     $m = new http\Message;
index 71ff8f05f1faa2148480eb8c7af26686088f4a90..63cd1d14e5db7055a1af3439b8ca77ce882a2880 100644 (file)
@@ -3,7 +3,8 @@
 Set the response status code.
 See http\Message::getResponseCode() and http\Message::setResponseStatus().
 
-> **Note:** This method also resets the response status phrase to the default for that code.
+> ***NOTE:***  
+> This method also resets the response status phrase to the default for that code.
 
 ## Params:
 
index 83068e94109446e71193d13415e11ae5644306fb..aaff3d5155f6b30174594c30cb3d2900b012db85 100644 (file)
@@ -3,7 +3,8 @@
 Set additional $params to a clone of this instance. 
 See http\QueryString::set().
 
-> **Note:** This method returns a clone (copy) of this instance.
+> ***NOTE:***  
+> This method returns a clone (copy) of this instance.
 
 ## Params:
 
index 4087b40dc92e31632907818aa3ab84cb3ee8b12a..06ceb01b0dea3a960cb39915757b2fcd1e5318d3 100644 (file)
@@ -2,7 +2,8 @@
 
 Translate character encodings of the querystring with ext/iconv.
 
-> **Note:** This method is only available when ext/iconv support was enabled at build time.
+> ***NOTE:***  
+> This method is only available when ext/iconv support was enabled at build time.
 
 ## Params: