minor tweaks
[mdref/mdref-http] / http / Params.md
1 # class http\Params implements ArrayAccess
2
3 Parse, interpret and compose HTTP (header) parameters.
4
5 ## Constants:
6
7 * DEF_PARAM_SEP
8 The default parameter separator (",").
9 * DEF_ARG_SEP
10 The default argument separator (";").
11 * DEF_VAL_SEP
12 The default value separator ("=").
13 * COOKIE_PARAM_SEP
14 Empty param separator to parse cookies.
15 * PARSE_RAW
16 Do not interpret the parsed parameters.
17 * PARSE_DEFAULT
18 Interpret input as default formatted parameters.
19 * PARSE_URLENCODED
20 Urldecode single units of parameters, arguments and values.
21 * PARSE_DIMENSION
22 Parse sub dimensions indicated by square brackets.
23 * PARSE_QUERY
24 Parse URL querystring (same as http\Params::PARSE_URLENCODED|http\Params::PARSE_DIMENSION).
25
26 ## Properties:
27
28 * public $params = NULL
29 The (parsed) parameters.
30 * public $param_sep = http\Params::DEF_PARAM_SEP
31 The parameter separator(s).
32 * public $arg_sep = http\Params::DEF_ARG_SEP
33 The argument separator(s).
34 * public $val_sep = http\Params::DEF_VAL_SEP
35 The value separator(s).
36 * public $flags = http\Params::PARSE_DEFAULT
37 The modus operandi of the parser. See http\Params::PARSE_* constants.