X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=http%2FEnv%2Fnegotiate.md;h=86786bbde95abd6e8679fa61bdd3b2a4b0b3885e;hb=d2a94d6c3e639b670960f300f0bc16889ff93cd8;hp=0230bc684e3f9acbf2a227da677897fabdf9fb91;hpb=13943464c255c79c2038c4c63ad5af34331af088;p=mdref%2Fmdref diff --git a/http/Env/negotiate.md b/http/Env/negotiate.md index 0230bc6..86786bb 100644 --- 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. -> ***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: -* ```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).