Fix doc bug #52916 (Reference to old RFC version) by removing the references to

the Netscape cookie spec in the parameters section and adding a little more
detail to the domain parameter description on how that parameter should be
structured and is matched.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@303739 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Adam Harvey 2010-09-24 04:06:05 +00:00
parent ffbac896ce
commit 0616d35712

View file

@ -48,8 +48,9 @@
instead.
</para>
<para>
See <link xlink:href="&spec.cookies;"><literal>Netscape cookie specification</literal></link> for
specifics on how each <function>setcookie</function> parameter works
<link xlink:href="&url.rfc;2109">RFC 2109</link> provides the normative
reference on how each <function>setcookie</function> parameter is
interpreted.
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
@ -63,9 +64,9 @@
<term><parameter>value</parameter></term>
<listitem>
<para>
The value of the cookie. This value is stored on the clients
computer; do not store sensitive information.
Assuming the <parameter>name</parameter> is 'cookiename', this
The value of the cookie. This value is stored on the clients computer;
do not store sensitive information. Assuming the
<parameter>name</parameter> is <literal>'cookiename'</literal>, this
value is retrieved through <varname>$_COOKIE['cookiename']</varname>
</para>
</listitem>
@ -118,14 +119,15 @@
<term><parameter>domain</parameter></term>
<listitem>
<para>
The domain that the cookie is available.
To make the cookie available on all subdomains of example.com
then you'd set it to <literal>'.example.com'</literal>. The
<literal>.</literal> is not required but makes it compatible
with more browsers. Setting it to <literal>www.example.com</literal>
will make the cookie only available in the <literal>www</literal>
subdomain. Refer to tail matching in the
<link xlink:href="&spec.cookies;">spec</link> for details.
The domain that the cookie is available to. To make the cookie
available on all subdomains of example.com (including example.com
itself) then you'd set it to <literal>'.example.com'</literal>.
Although some browsers will accept cookies without the initial
<literal>.</literal>, <link xlink:href="&url.rfc;2109">RFC 2109</link>
requires it to be included. Setting the domain to
<literal>'www.example.com'</literal> or
<literal>'.www.example.com'</literal> will make the cookie only
available in the <literal>www</literal> subdomain.
</para>
</listitem>
</varlistentry>
@ -370,6 +372,7 @@ one : cookieone
<member><function>header</function></member>
<member><function>setrawcookie</function></member>
<member><link linkend="features.cookies">cookies section</link></member>
<member><link xlink:href="&spec.cookies;">Original Netscape cookie specification</link></member>
<member><link xlink:href="&url.rfc;2109">RFC 2109</link></member>
<member><link xlink:href="&url.rfc;2965">RFC 2965</link></member>
</simplelist>