thanks git
authorMichael Wallner <mike@php.net>
Thu, 18 Aug 2016 20:37:02 +0000 (22:37 +0200)
committerMichael Wallner <mike@php.net>
Thu, 18 Aug 2016 20:46:46 +0000 (22:46 +0200)
14 files changed:
http/Client.md
http/Client/Curl.md
http/Client/Curl/Features.md
http/Client/Curl/User.md
http/Client/Curl/User/init.md
http/Client/Curl/User/once.md
http/Client/Curl/User/send.md
http/Client/Curl/User/socket.md
http/Client/Curl/User/timer.md
http/Client/Curl/User/wait.md
http/Client/Curl/Versions.md
http/Client/setDebug.md
http/Params.md
http/Url/__construct.md

index ba66dc05d50964f93bec01b91fde4f5360462da5..639af26b7bd65fc7a6f8c9d7fe1b2bfd9753b157 100644 (file)
@@ -4,17 +4,17 @@ The HTTP client. See http\Client\Curl's [options](http/Client/Curl#Options:) whi
 
 ## Constants:
 
-* DEBUG_INFO
+* DEBUG_INFO  
   Debug callback's $data contains human readable text.
-* DEBUG_IN
+* DEBUG_IN  
   Debug callback's $data contains data received.
-* DEBUG_OUT
+* DEBUG_OUT  
   Debug callback's $data contains data sent.
-* DEBUG_HEADER
+* DEBUG_HEADER  
   Debug callback's $data contains headers.
-* DEBUG_BODY
+* DEBUG_BODY  
   Debug callback's $data contains a body part.
-* DEBUG_SSL
+* DEBUG_SSL  
   Debug callback's $data contains SSL data.
 
 ## Properties:
index 12fc7f9ae51aa0f25e3159d90afbd254ad7513a9..eefb02dfabc6d7f9d4aaea8aff98ddec2c948225 100644 (file)
@@ -6,12 +6,12 @@ The http\Client\Curl namespace holds option value constants specific to the curl
 
 ### Features and Versions:
 
-* FEATURES
-  Bitmask of available libcurl features.
+* FEATURES  
+  Bitmask of available libcurl features.  
   See http\Client\Curl\Features namespace.
-* VERSIONS
-  List of library versions of or linked into libcurl,
-  e.g. "libcurl/7.50.0 OpenSSL/1.0.2h zlib/1.2.8 libidn/1.32 nghttp2/1.12.0".
+* VERSIONS  
+  List of library versions of or linked into libcurl,  
+  e.g. "libcurl/7.50.0 OpenSSL/1.0.2h zlib/1.2.8 libidn/1.32 nghttp2/1.12.0".  
   See http\Client\Curl\Versions namespace.
 
 ### HTTP Protocol Version
@@ -126,7 +126,7 @@ The option names used here are more or less derived from the corresponding CURLO
   Comma separated list of hosts where no proxy should be used. Available if libcurl is v7.19.4 or more recent.
 * array $proxyheader  
   List of key/value pairs of headers which should only be sent to a proxy. Available if libcurl is v7.37.0 or more recent.
-* string $proxy_service_name
+* string $proxy_service_name  
   Proxy service name. The default service name is "HTTP" for HTTP based proxies and "rcmd" for SOCKS5. Available if libcurl is v7.43.0 or more recent and has built-in GSSAPI support.
 
 ### DNS
@@ -182,7 +182,7 @@ The option names used here are more or less derived from the corresponding CURLO
   Disable [Nagle's algotrithm](http://tools.ietf.org/html/rfc896).
 * string $unix_socket_path  
   Connect to the webserver listening at $unix_socket_path instead of opening a TCP connection to it. Available if libcurl is v7.40.0 or more recent.
-* bool $path_as_is
+* bool $path_as_is  
   Do *not* squash sequences of "/../" or "/./" that may exist in the URL's path.
 
 ### Authentication
@@ -191,7 +191,7 @@ The option names used here are more or less derived from the corresponding CURLO
   user:password
 * int $httpauthtype  
   See http\Client\Curl\AUTH_* constants.
-* string $service_name
+* string $service_name  
   The name of the service for DIGEST-MD5, SPNEGO and KERBEROS5 authentication mechanisms. The default service name is "HTTP". Available if libcurl is v7.43.0 or more recent.
 
 ### Redirection
@@ -300,7 +300,7 @@ The option names used here are more or less derived from the corresponding CURLO
     TLS-SRP password. Available if libcurl is v7.21.4 or more recent.
   * bool $verifystatus  
     Enable OCSP. Available if libcurl is v7.41.0 or more recent and was built with OpenSSL, GnuTLS or NSS support.
-  * bool $falsestart
+  * bool $falsestart  
     Whether false start should be used during the TLS handshake. Available if libcurl is v7.42.0 or more recent and was built with NSS or SecureTransport support.
 
 ## Configuration:
@@ -323,11 +323,11 @@ The option names used here are more or less derived from the corresponding CURLO
   Simple list of server software names to blacklist for pipelining. Available if libcurl is v7.30.0 or more recent.
 * array $pipelining_site_bl  
   Simple list of server host names to blacklist for pipelining. Available if libcurl is v7.30.0 or more recent.
-* mixed $use_eventloop
+* mixed $use_eventloop  
   Whether to use an event loop. This option accepts either bool, whether to use
   the internal event loop, or an instance of an http\Client\Curl\User implementation.
   The internal event loop is only available if pecl/http was built with libevent support.
-* bool $share_cookies
+* bool $share_cookies  
   Whether to let the client share cookies between requests.
-* bool $share_ssl
+* bool $share_ssl  
   Whether to let the client share SSL/TLS sessions between requests. Available if libcurl is v7.23.0 or more recent.
index 06fbd85ab0204b05134ee21d1d9b448a0ffddca8..d8c497b95899bb635578ef175dcc353f56f224f2 100644 (file)
@@ -7,39 +7,39 @@ CURL feature constants.
 
 ## Constants:
 
-* ASYNCHDNS
+* ASYNCHDNS  
   Whether libcurl supports asynchronous domain name resolution.
-* GSSAPI
+* GSSAPI  
   Whether libcurl supports the Generic Security Services Application Program Interface. Available if libcurl is v7.38.0 or more recent.
-* GSSNEGOTIATE
+* GSSNEGOTIATE  
   Whether libcurl supports HTTP Generic Security Services negotiation.
-* HTTP2
+* HTTP2  
   Whether libcurl supports the HTTP/2 protocol. Available if libcurl is v7.33.0 or more recent.
-* IDN
+* IDN  
   Whether libcurl supports international domain names.
-* IPV6
+* IPV6  
   Whether libcurl supports IPv6.
-* KERBEROS4
+* KERBEROS4  
   Whether libcurl supports the old Kerberos protocol.
-* KERBEROS5
+* KERBEROS5  
   Whether libcurl supports the more recent Kerberos v5 protocol. Available if libcurl is v7.40.0 or more recent.
-* LARGEFILE
+* LARGEFILE  
   Whether libcurl supports large files.
-* LIBZ
+* LIBZ  
   Whether libcurl supports gzip/deflate compression.
-* NTLM
+* NTLM  
   Whether libcurl supports the NT Lan Manager authentication.
-* NTLM_WB
+* NTLM_WB  
   Whether libcurl supports NTLM delegation to a winbind helper. Available if libcurl is v7.22.0 or more recent.
-* PSL
+* PSL  
   Whether libcurl supports the Public Suffix List for cookie host handling. Available if libcurl is v7.47.0 or more recent.
-* SPNEGO
+* SPNEGO  
   Whether libcurl supports the Simple and Protected GSSAPI Negotiation Mechanism.
-* SSL
+* SSL  
   Whether libcurl supports SSL/TLS protocols.
-* SSPI
+* SSPI  
   Whether libcurl supports the Security Support Provider Interface.
-* TLSAUTH_SRP
+* TLSAUTH_SRP  
   Whether libcurl supports TLS Secure Remote Password authentication. Available if libcurl is v7.21.4 or more recent.
-* UNIX_SOCKETS
+* UNIX_SOCKETS  
   Whether libcurl supports connections to unix sockets. Available if libcurl is v7.40.0 or more recent.
index 7eb455b863c6c2a87fd613c69b48995b18f83b1d..19249a7ab62fb0b8448d5d7a7a6a40e2dfd67530 100644 (file)
@@ -2,18 +2,18 @@
 
 Interface to an user event loop implementation for http\Client::configure()'s $use_eventloop option.
 
-> ***NOTE:***
+> ***NOTE:***  
 > This interface was added in v2.6.0, resp. v3.1.0.
 
 ## Constants:
 
-* POLL_NONE
+* POLL_NONE  
   No action.
-* POLL_IN
+* POLL_IN  
   Poll for read readiness.
-* POLL_OUT
+* POLL_OUT  
   Poll for write readiness.
-* POLL_INOUT
+* POLL_INOUT  
   Poll for read/write readiness.
-* POLL_REMOVE
+* POLL_REMOVE  
   Stop polling for activity on this descriptor.
index 45afb55291f93ba641f912434b3b69e4e5d73acc..ba98e9729e307af1d21a82ecafb294fdc9345e00 100644 (file)
@@ -5,9 +5,9 @@ Initialize the event loop.
 
 ## Params:
 
-* callable $run as function(http\Client $c, resource $s = null, int $action = http\Client\Curl\User::POLL_NONE) : int
+* callable $run as function(http\Client $c, resource $s = null, int $action = http\Client\Curl\User::POLL_NONE) : int  
   Internal callback returning the number of unfinished requests pending.
 
 
-> ***NOTE***:
+> ***NOTE***:  
 > The callback should be run when a timeout occurs or a watched socket needs action.
index 0c3aa581c6cb9fd1807aadec8d1628be233167ac..4b620bbc12feca9cf4c4cc6d7dceee07f23621ab 100644 (file)
@@ -2,7 +2,7 @@
 
 Run the loop as long as it does not block.
 
-> ***NOTE:***
+> ***NOTE:***  
 > This method is called by http\Client::once(), so it does not need to have an actual implementation if http\Client::once() is never called.
 
 
index 9bd3c3557b1b960d8c181d75de51bc52729af095..dc07de9fb6cbb54123a1d1101bcf57e621ba3f53 100644 (file)
@@ -2,7 +2,7 @@
 
 Run the loop.
 
-> ***NOTE:***
+> ***NOTE:***  
 > This method is called by http\Client::send(), so it does not need to have an actual implementation if http\Client::send() is never called.
 
 ## Params:
index 4ef660d7cb100ac1b3c0f504b797618717f2c6bd..e5b34984cd2dbe4ecd34e62b93e6cbaaab177a52 100644 (file)
@@ -4,7 +4,7 @@ Register (or deregister) a socket watcher.
 
 ## Params:
 
-* resource $socket
+* resource $socket  
   The socket descriptor to watch.
-* int $poll
+* int $poll  
   http\Client\Curl\User::POLL_* constant.
index 22057996dfd3a4e2de10de22715d2fff775f309c..34984d8d19b326e450da6cf9153660bf253d2277 100644 (file)
@@ -4,5 +4,5 @@ Register a timeout watcher.
 
 ## Params:
 
-* int $timeout_ms
+* int $timeout_ms  
   Desired maximum timeout in milliseconds.
index 06ee274c9113de21439dbea6f661afbbcf423904..6a5fabfa7ec01ebd12694aa8230897ac98bd6a56 100644 (file)
@@ -2,10 +2,10 @@
 
 Wait/poll/select (block the loop) until events fire.
 
-> ***NOTE:***
+> ***NOTE:***  
 > This method is called by http\Client::wait(), so it does not need to have an actual implementation if http\Client::wait() is never called.
 
 ## Params:
 
-* Optional int $timeout_ms = null
+* Optional int $timeout_ms = null  
   Block for at most this milliseconds.
index 794fe2e91036d41c914b338ce6f9a7fe8fe6757f..0ddbd2e6cefdf5d9eac78476888575428cc0f09a 100644 (file)
@@ -7,13 +7,13 @@ CURL version constants.
 
 ## Constants:
 
-* CURL
+* CURL  
   Version string of libcurl, e.g. "7.50.0".
-* SSL
+* SSL  
   Version string of the SSL/TLS library, e.g. "OpenSSL/1.0.2h".
-* LIBZ
+* LIBZ  
   Version string of the zlib compression library, e.g. "1.2.8".
-* ARES
+* ARES  
   Version string of the c-ares library, e.g. "1.11.0".
-* IDN
+* IDN  
   Version string of the IDN library, e.g. "1.32".
index 9ca4ba8fc1de025c8b54427c84e7fc49c5498eed..16d5cf1b08c591255ed34433604e3190b3cac0fb 100644 (file)
@@ -7,7 +7,7 @@ Set client debugging callback.
 
 ## Params:
 
-* callable $callback as function(http\Client $c, http\Client\Request $r, int $type, string $data)
+* callable $callback as function(http\Client $c, http\Client\Request $r, int $type, string $data)  
   The debug callback. For $type see http\Client::DEBUG_* constants.
 
 ## Returns:
index e1679b5ea020cf5c62396570fbbdcc5c8474d2da..4349769938a6aafcdb802d1865e267d3491eeb02 100644 (file)
@@ -22,9 +22,9 @@ Parse, interpret and compose HTTP (header) parameters.
   Parse sub dimensions indicated by square brackets.
 * PARSE_QUERY  
   Parse URL querystring (same as http\Params::PARSE_URLENCODED|http\Params::PARSE_DIMENSION).
-* PARSE_RFC5987
+* PARSE_RFC5987  
   Parse [RFC5987](http://tools.ietf.org/html/rfc5987) style encoded character set and language information embedded in HTTP header params.
-* PARSE_RFC5988
+* PARSE_RFC5988  
   Parse [RFC5988](http://tools.ietf.org/html/rfc5988) (Web Linking) tags of Link headers.
 
 ## Properties:
index cb1f7710bfd5c5f9e3d8e64e3035a850701e313f..ee3ec33b70b7e8068075c5e28362862d5150b549 100644 (file)
@@ -13,7 +13,7 @@ See also http\Env\Url.
   Initial URL parts. Either an array, object, http\Url instance or string to parse.
 * Optional mixed $new_url = NULL  
   Overriding URL parts. Either an array, object, http\Url instance or string to parse.
-* Optional int $flags = 0
+* Optional int $flags = 0  
   The modus operandi of constructing the url. See http\Url constants.
 
 ## Throws: