From fb2ab0c8596f274acb2a3aea76f97c895ee2af34 Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Wed, 30 Oct 2013 18:47:50 +0100 Subject: [PATCH] flush --- http.md | 5 +++++ http/Env.md | 2 +- http/Env/Request.md | 8 +++---- http/Env/Request/__construct.md | 7 ++++++ http/Env/getRequestBody.md | 4 ++-- http/Env/getRequestHeader.md | 8 +++---- http/Env/getResponseCode.md | 4 ++-- http/Env/getResponseHeader.md | 8 +++---- http/Env/getResponseStatusForAllCodes.md | 6 ++--- http/Env/getResponseStatusForCode.md | 6 ++--- http/Env/negotiate.md | 12 +++++----- http/Env/negotiateCharset.md | 8 +++---- http/Env/negotiateContentType.md | 12 +++++----- http/Env/negotiateEncoding.md | 8 +++---- http/Env/negotiateLanguage.md | 8 +++---- http/Env/setResoponseCode.md | 4 ++-- http/Env/setResponseHeader.md | 14 ++++++------ http/Header.md | 16 +++++++------- http/Header/__construct.md | 4 ++-- http/Header/__toString.md | 4 ++-- http/Header/getParams.md | 10 ++++----- http/Header/match.md | 6 ++--- http/Header/negotiate.md | 12 +++++----- http/Header/parse.md | 6 ++--- http/Header/serialize.md | 4 ++-- http/Header/toString.md | 4 ++-- http/Header/unserialize.md | 2 +- http/Params.md | 28 ++++++++++++------------ http/Params/__construct.md | 10 ++++----- http/Params/__toString.md | 4 ++-- http/Params/offsetExists.md | 4 ++-- http/Params/offsetGet.md | 4 ++-- http/Params/offsetSet.md | 4 ++-- http/Params/offsetUnset.md | 2 +- http/Params/toArray.md | 4 ++-- http/Params/toString.md | 4 ++-- 36 files changed, 134 insertions(+), 122 deletions(-) create mode 100644 http.md diff --git a/http.md b/http.md new file mode 100644 index 0000000..6175e26 --- /dev/null +++ b/http.md @@ -0,0 +1,5 @@ +# namespace http + +This is pecl_http-v2. + +This documentation is work-in-progress. diff --git a/http/Env.md b/http/Env.md index d75dbf2..d4245bb 100644 --- a/http/Env.md +++ b/http/Env.md @@ -6,6 +6,6 @@ The http\Env class provides static methods to manipulate and inspect the server' The http\Env module overrides PHP's builtin POST data parser to be run also if the request method is not POST. Additionally it will handle -```application/json``` payloads if ```ext/json``` is available. Successfully +application/json payloads if ext/json is available. Successfully parsed JSON will be put right into the $_POST array. diff --git a/http/Env/Request.md b/http/Env/Request.md index 5c4b32f..63de534 100644 --- a/http/Env/Request.md +++ b/http/Env/Request.md @@ -2,13 +2,13 @@ ## Constants: -> None. +None. ## Properties: -* ```protected $query = NULL``` +* protected $query = NULL The request's query parameters. ($_GET) -* ```protected $form = NULL``` +* protected $form = NULL The request's form parameters. ($_POST) -* ```protected $files = NULL``` +* protected $files = NULL The request's form uploads. ($_FILES) diff --git a/http/Env/Request/__construct.md b/http/Env/Request/__construct.md index e69de29..307d73a 100644 --- a/http/Env/Request/__construct.md +++ b/http/Env/Request/__construct.md @@ -0,0 +1,7 @@ +# void http\Env\Request::__construct(void) + +Instantiate the server's current HTTP request. + +## Params: + +None. diff --git a/http/Env/getRequestBody.md b/http/Env/getRequestBody.md index 512128d..eaadc0d 100644 --- a/http/Env/getRequestBody.md +++ b/http/Env/getRequestBody.md @@ -4,12 +4,12 @@ Retreive the current HTTP request's body. ## Parameters: -* Optional ```string $body_class_name``` +* Optional string $body_class_name A user class extending http\Body. ## Returns: -* ```http\Message\Body``` instance representing the request body +* http\Message\Body instance representing the request body ## Throws: diff --git a/http/Env/getRequestHeader.md b/http/Env/getRequestHeader.md index b33718b..17e87b7 100644 --- a/http/Env/getRequestHeader.md +++ b/http/Env/getRequestHeader.md @@ -4,11 +4,11 @@ Retrieve one or all headers of the current HTTP request. ## Parameters: -* Optional ```string $header_name``` +* Optional string $header_name The key of a header to retrieve. ## Returns: -* ```NULL```, if $header_name was not found -* ```string```, the compound header when $header_name was found -* ```array``` of all headers if $header_name was not specified +* NULL, if $header_name was not found +* string, the compound header when $header_name was found +* array of all headers if $header_name was not specified diff --git a/http/Env/getResponseCode.md b/http/Env/getResponseCode.md index 11feca8..bb5dba0 100644 --- a/http/Env/getResponseCode.md +++ b/http/Env/getResponseCode.md @@ -4,9 +4,9 @@ Get the HTTP response code to send. ## Parameters: -> None. +None. ## Returns: -* ```int```, the HTTP response code. +* int, the HTTP response code. diff --git a/http/Env/getResponseHeader.md b/http/Env/getResponseHeader.md index c30a4d7..7bdd37a 100644 --- a/http/Env/getResponseHeader.md +++ b/http/Env/getResponseHeader.md @@ -4,11 +4,11 @@ Get one or all HTTP response headers to be sent. ## Parameters: -* Optional ```string $header_name``` +* Optional string $header_name The name of the response header to retrieve. ## Returns: -* ```string```, the compound value of the response header to send -* ```NULL```, if the header was not found -* ```array```, of all response headers, if $header_name was not specified +* string, the compound value of the response header to send +* NULL, if the header was not found +* array, of all response headers, if $header_name was not specified diff --git a/http/Env/getResponseStatusForAllCodes.md b/http/Env/getResponseStatusForAllCodes.md index 2e37783..f31941f 100644 --- a/http/Env/getResponseStatusForAllCodes.md +++ b/http/Env/getResponseStatusForAllCodes.md @@ -4,12 +4,12 @@ Retrieve a list of all known HTTP response status. ## Parameters: -> None. +None. ## Returns: -* ```array``` mapping of the form \[ +* array mapping of the form \[ ... - ```int $code``` => ```string $status``` + int $code => string $status ... \] diff --git a/http/Env/getResponseStatusForCode.md b/http/Env/getResponseStatusForCode.md index d2bfa85..e97b60f 100644 --- a/http/Env/getResponseStatusForCode.md +++ b/http/Env/getResponseStatusForCode.md @@ -4,11 +4,11 @@ Retrieve the string representation of specified HTTP response code. ## Parameters: -* ```int $code``` +* int $code The HTTP response code to get the string representation for. ## Returns: -* ```string```, the HTTP response status message -* empty ```string```, if no message for this code was found +* string, the HTTP response status message +* empty string, if no message for this code was found diff --git a/http/Env/negotiate.md b/http/Env/negotiate.md index 0230bc6..f7b53d2 100644 --- a/http/Env/negotiate.md +++ b/http/Env/negotiate.md @@ -6,16 +6,16 @@ Generic negotiator. For specific client negotiation see http\Env::negotiateConte ## Params: -* ```string $params``` +* string $params HTTP header parameter's value to negotiate. -* ```array $supported``` +* array $supported List of supported negotiation operands. -* Optional ```string $prim_typ_sep``` +* Optional string $prim_typ_sep A "primary type separator", i.e. that would be a hyphen for content language negotiation (en-US, de-DE, etc.). -* Optional reference ```array &$result``` +* Optional reference array &$result Out parameter recording negotiation results. ## Returns: -* ```NULL```, if negotiation fails. -* ```string```, the closest match negotiated, or the default (first entry of $supported). +* NULL, if negotiation fails. +* string, the closest match negotiated, or the default (first entry of $supported). diff --git a/http/Env/negotiateCharset.md b/http/Env/negotiateCharset.md index 20cc01b..c13020b 100644 --- a/http/Env/negotiateCharset.md +++ b/http/Env/negotiateCharset.md @@ -6,12 +6,12 @@ Negotiate the client's preferred character set. ## Params: -* ```array $supported``` +* array $supported List of supported content character sets. -* Optional reference ```array &$result``` +* Optional reference array &$result Out parameter recording negotiation results. ## Returns: -* ```NULL```, if negotiation fails. -* ```string```, the negotiated character set. +* NULL, if negotiation fails. +* string, the negotiated character set. diff --git a/http/Env/negotiateContentType.md b/http/Env/negotiateContentType.md index 510e33f..7b2ea31 100644 --- a/http/Env/negotiateContentType.md +++ b/http/Env/negotiateContentType.md @@ -6,20 +6,20 @@ Negotiate the client's preferred MIME content type. ## Params: -* ```array $supported``` +* array $supported List of supported MIME content types. -* Optional reference ```array &$result``` +* Optional reference array &$result Out parameter recording negotiation results. ## Returns: -* ```NULL```, if negotiation fails. -* ```string```, the negotiated content type. +* NULL, if negotiation fails. +* string, the negotiated content type. ## Example: -A client indicates his accepted MIME content types by sending an ```Accept``` -header. The static ```http\Env``` class provides a facility to negotiate the +A client indicates his accepted MIME content types by sending an Accept +header. The static http\Env class provides a facility to negotiate the client's preferred content type: None. +None. ## Returns: -* ```string```, the serialized form of the HTTP header (i.e. "Name: value"). +* string, the serialized form of the HTTP header (i.e. "Name: value"). diff --git a/http/Header/getParams.md b/http/Header/getParams.md index d3645c2..98fd885 100644 --- a/http/Header/getParams.md +++ b/http/Header/getParams.md @@ -4,15 +4,15 @@ Create a parameter list out of the HTTP header value. ## Params: -* Optional ```mixed $ps``` +* Optional mixed $ps The parameter separator(s). -* Optional ```mixed $as``` +* Optional mixed $as The argument separator(s). -* Optional ```mixed``` +* Optional mixed The value separator(s). -* Optional ```int $flags``` +* Optional int $flags The modus operandi. See http\Params constants. ## Returns: -* ```http\Params``` instance +* http\Params instance diff --git a/http/Header/match.md b/http/Header/match.md index 7635cd2..7fd74bf 100644 --- a/http/Header/match.md +++ b/http/Header/match.md @@ -4,11 +4,11 @@ Match the HTTP header's value against provided $value according to $flags. ## Params: -* ```string $value``` +* string $value The comparison value. -* Optional ```int $flags``` +* Optional int $flags The modus operandi. See http\Header constants. ## Returns: -* ```bool```, whether $value matches the header value according to $flags. +* bool, whether $value matches the header value according to $flags. diff --git a/http/Header/negotiate.md b/http/Header/negotiate.md index af0547f..32daaa0 100644 --- a/http/Header/negotiate.md +++ b/http/Header/negotiate.md @@ -2,20 +2,20 @@ Negotiate the header's value against a list of supported values in $supported. Negotiation operation is adopted according to the header name, i.e. if the -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 +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. ## Params: -* ```array $supported``` +* array $supported The list of supported values to negotiate. -* Optional reference ```array &$result``` +* Optional reference array &$result Out parameter recording the negotiation results. ## Returns: -* ```NULL```, if negotiation fails. -* ```string```, the closest match negotiated, or the default (first entry of $supported). +* NULL, if negotiation fails. +* string, the closest match negotiated, or the default (first entry of $supported). diff --git a/http/Header/parse.md b/http/Header/parse.md index c1965c1..0db884c 100644 --- a/http/Header/parse.md +++ b/http/Header/parse.md @@ -4,11 +4,11 @@ Parse HTTP headers. ## Params: -* ```string $header``` +* string $header The complete string of headers. -* Optional ```string $header_class``` +* Optional string $header_class A class extending http\Header. ## Returns: -* ```array``` of parsed headers, where the elements are instances of $header_class if specified. +* array of parsed headers, where the elements are instances of $header_class if specified. diff --git a/http/Header/serialize.md b/http/Header/serialize.md index 2afe46e..9a73a5b 100644 --- a/http/Header/serialize.md +++ b/http/Header/serialize.md @@ -4,8 +4,8 @@ Implements Serializable. ## Params: -> None. +None. ## Returns: -* ```string```, serialized representation of HTTP header (i.e. "Name: value") +* string, serialized representation of HTTP header (i.e. "Name: value") diff --git a/http/Header/toString.md b/http/Header/toString.md index 2eec780..6197fa7 100644 --- a/http/Header/toString.md +++ b/http/Header/toString.md @@ -4,8 +4,8 @@ Convenience method. Alias of http\Header::serialize(). ## Params: -> None. +None. ## Returns: -* ```string```, the serialized form of the HTTP header (i.e. "Name: value"). +* string, the serialized form of the HTTP header (i.e. "Name: value"). diff --git a/http/Header/unserialize.md b/http/Header/unserialize.md index 2ccd6c4..3a40de6 100644 --- a/http/Header/unserialize.md +++ b/http/Header/unserialize.md @@ -4,6 +4,6 @@ Implements Serializable. ## Params: -* ```string $serialized``` +* string $serialized The serialized HTTP header (i.e. "Name: value") diff --git a/http/Params.md b/http/Params.md index f479223..3d80b88 100644 --- a/http/Params.md +++ b/http/Params.md @@ -4,34 +4,34 @@ Parse, interpret and compose HTTP (header) parameters. ## Constants: -* ```DEF_PARAM_SEP``` +* DEF_PARAM_SEP The default parameter separator (","). -* ```DEF_ARG_SEP``` +* DEF_ARG_SEP The default argument separator (";"). -* ```DEF_VAL_SEP``` +* DEF_VAL_SEP The default value separator ("="). -* ```COOKIE_PARAM_SEP``` +* COOKIE_PARAM_SEP TBD -* ```PARSE_RAW``` +* PARSE_RAW Do not interpret the parsed parameters. -* ```PARSE_DEFAULT``` +* PARSE_DEFAULT Interpret input as default formatted parameters. -* ```PARSE_URLENCODED``` +* PARSE_URLENCODED Urldecode single units of parameters, arguments and values. -* ```PARSE_DIMENSION``` +* PARSE_DIMENSION Parse sub dimensions indicated by square brackets. -* ```PARSE_QUERY``` +* PARSE_QUERY Parse URL query string (same as http\Params::PARSE_URLENCODED|http\Params::PARSE_DIMENSION). ## Properties: -* ```public $params = NULL``` +* public $params = NULL The (parsed) parameters. -* ```public $param_sep = http\Header::DEF_PARAM_SEP``` +* public $param_sep = http\Params::DEF_PARAM_SEP The parameter separator(s). -* ```public $arg_sep = http\Header::DEF_ARG_SEP``` +* public $arg_sep = http\Params::DEF_ARG_SEP The argument separator(s). -* ```public $val_sep = http\Header::DEF_VAL_SEP``` +* public $val_sep = http\Params::DEF_VAL_SEP The value separator(s). -* ```public $flags = http\Params::PARSE_DEFAULT``` +* public $flags = http\Params::PARSE_DEFAULT The modus operandi of the parser. See http\Params::PARSE_* constants. diff --git a/http/Params/__construct.md b/http/Params/__construct.md index 76034a9..ff2a296 100644 --- a/http/Params/__construct.md +++ b/http/Params/__construct.md @@ -4,15 +4,15 @@ Instantiate a new HTTP (header) parameter set. ## Params: -* Optional ```mixed $params``` +* Optional mixed $params Pre-parsed parameters or a string to be parsed. -* Optional ```mixed $ps``` +* Optional mixed $ps The parameter separator(s). -* Optional ```mixed $as``` +* Optional mixed $as The argument separator(s). -* Optional ```mixed $vs``` +* Optional mixed $vs The value separator(s). -* Optional ```int $flags``` +* Optional int $flags The modus operandi. See http\Params::PARSE_* constants. ## Throws: diff --git a/http/Params/__toString.md b/http/Params/__toString.md index c1bd91c..050445a 100644 --- a/http/Params/__toString.md +++ b/http/Params/__toString.md @@ -5,8 +5,8 @@ Returns a stringified version of the parameters. ## Params: -> None. +None. ## Returns: -* ```string``` version of the parameters. +* string version of the parameters. diff --git a/http/Params/offsetExists.md b/http/Params/offsetExists.md index b3d7b29..0e46228 100644 --- a/http/Params/offsetExists.md +++ b/http/Params/offsetExists.md @@ -4,9 +4,9 @@ Implements ArrayAccess. ## Params: -* ```string $name``` +* string $name The offset to look after. ## Returns: -* ```bool``` Existence. +* bool Existence. diff --git a/http/Params/offsetGet.md b/http/Params/offsetGet.md index cc96a9a..4c68c8b 100644 --- a/http/Params/offsetGet.md +++ b/http/Params/offsetGet.md @@ -4,9 +4,9 @@ Implements ArrayAccess. ## Params: -* ```string $name``` +* string $name The offset to retrieve. ## Returns: -* ```mixed```, contents at offset. +* mixed, contents at offset. diff --git a/http/Params/offsetSet.md b/http/Params/offsetSet.md index 4a24d41..55932af 100644 --- a/http/Params/offsetSet.md +++ b/http/Params/offsetSet.md @@ -4,8 +4,8 @@ Implements ArrayAccess. ## Params: -* ```string $name``` +* string $name The offset to modify. -* ```mixed $value``` +* mixed $value The value to set. diff --git a/http/Params/offsetUnset.md b/http/Params/offsetUnset.md index 4c5af78..0593022 100644 --- a/http/Params/offsetUnset.md +++ b/http/Params/offsetUnset.md @@ -4,6 +4,6 @@ Implements ArrayAccess. ## Params: -* ```string $name``` +* string $name The offset to delete. diff --git a/http/Params/toArray.md b/http/Params/toArray.md index e7ca841..4686bf1 100644 --- a/http/Params/toArray.md +++ b/http/Params/toArray.md @@ -4,8 +4,8 @@ Convenience method that simply returns http\Params::$params. ## Params: -> None. +None. ## Returns: -* ```array``` of paramters. +* array of paramters. diff --git a/http/Params/toString.md b/http/Params/toString.md index 34400be..7776ece 100644 --- a/http/Params/toString.md +++ b/http/Params/toString.md @@ -4,8 +4,8 @@ Returns a stringified version of the parameters. ## Params: -> None. +None. ## Returns: -* ```string``` version of the parameters. +* string version of the parameters. -- 2.30.2