X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=http%2FParams.md;h=fb28bb1759489bccca43255bbe2280e21e80fce4;hb=HEAD;hp=f47922392476cff8f46fe9a8d28edf29aaa3dacb;hpb=7823a35136269030a351b68b8ae8ee5026696aea;p=mdref%2Fmdref-http diff --git a/http/Params.md b/http/Params.md index f479223..fb28bb1 100644 --- a/http/Params.md +++ b/http/Params.md @@ -1,37 +1,43 @@ -# class http\Params extends http\Object implements ArrayAccess +# class http\Params implements ArrayAccess 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``` - TBD -* ```PARSE_RAW``` +* COOKIE_PARAM_SEP + Empty param separator to parse cookies. +* PARSE_RAW Do not interpret the parsed parameters. -* ```PARSE_DEFAULT``` +* PARSE_DEFAULT Interpret input as default formatted parameters. -* ```PARSE_URLENCODED``` +* PARSE_ESCAPED + Parse backslash escaped (quoted) strings. +* PARSE_URLENCODED Urldecode single units of parameters, arguments and values. -* ```PARSE_DIMENSION``` +* PARSE_DIMENSION Parse sub dimensions indicated by square brackets. -* ```PARSE_QUERY``` - Parse URL query string (same as http\Params::PARSE_URLENCODED|http\Params::PARSE_DIMENSION). +* PARSE_QUERY + Parse URL querystring (same as http\Params::PARSE_URLENCODED|http\Params::PARSE_DIMENSION). +* 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](http://tools.ietf.org/html/rfc5988) (Web Linking) tags of Link headers. ## Properties: -* ```public $params = NULL``` +* public array $params = NULL The (parsed) parameters. -* ```public $param_sep = http\Header::DEF_PARAM_SEP``` +* public array $param_sep = http\Params::DEF_PARAM_SEP The parameter separator(s). -* ```public $arg_sep = http\Header::DEF_ARG_SEP``` +* public array $arg_sep = http\Params::DEF_ARG_SEP The argument separator(s). -* ```public $val_sep = http\Header::DEF_VAL_SEP``` +* public array $val_sep = http\Params::DEF_VAL_SEP The value separator(s). -* ```public $flags = http\Params::PARSE_DEFAULT``` +* public int $flags = http\Params::PARSE_DEFAULT The modus operandi of the parser. See http\Params::PARSE_* constants.