git.m6w6.name Git - mdref/mdref-http/blob - 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_ESCAPED
  20   Parse backslash escaped (quoted) strings.
  21 * PARSE_URLENCODED
  22   Urldecode single units of parameters, arguments and values.
  23 * PARSE_DIMENSION
  24   Parse sub dimensions indicated by square brackets.
  25 * PARSE_QUERY
  26   Parse URL querystring (same as http\Params::PARSE_URLENCODED|http\Params::PARSE_DIMENSION).
  27 * PARSE_RFC5987
  28   Parse [RFC5987](http://tools.ietf.org/html/rfc5987) style encoded character set and language information embedded in HTTP header params.
  29 * PARSE_RFC5988
  30   Parse [RFC5988](http://tools.ietf.org/html/rfc5988) (Web Linking) tags of Link headers.
  31
  32 ## Properties:
  33
  34 * public array $params = NULL
  35   The (parsed) parameters.
  36 * public array $param_sep = http\Params::DEF_PARAM_SEP
  37   The parameter separator(s).
  38 * public array $arg_sep = http\Params::DEF_ARG_SEP
  39   The argument separator(s).
  40 * public array $val_sep = http\Params::DEF_VAL_SEP
  41   The value separator(s).
  42 * public int $flags = http\Params::PARSE_DEFAULT
  43   The modus operandi of the parser. See http\Params::PARSE_* constants.