projects
/
mdref
/
mdref
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
github edit link
[mdref/mdref]
/
http
/
Env
/
negotiate.md
diff --git
a/http/Env/negotiate.md
b/http/Env/negotiate.md
index 0230bc684e3f9acbf2a227da677897fabdf9fb91..86786bbde95abd6e8679fa61bdd3b2a4b0b3885e 100644
(file)
--- a/
http/Env/negotiate.md
+++ b/
http/Env/negotiate.md
@@
-2,20
+2,20
@@
Generic negotiator. For specific client negotiation see http\Env::negotiateContentType() and related methods.
Generic negotiator. For specific client negotiation see http\Env::negotiateContentType() and related methods.
-> **
*NOTE:*
** The first elemement of $supported serves as a default if no operand matches.
+> **
Note:
** The first elemement of $supported serves as a default if no operand matches.
## Params:
## Params:
-*
```string $params```
+*
string $params
HTTP header parameter's value to negotiate.
HTTP header parameter's value to negotiate.
-*
```array $supported```
+*
array $supported
List of supported negotiation operands.
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.).
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:
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).