sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Moved and greatly expanded parameter information into a table. And mention

Browse source 
register_globals and $_REQUEST as well as print_r($_COOKIE) for debugging.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@112981 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2003-01-21 21:26:43 +00:00
parent c3ba56c890
commit 2d657e3136
1 changed files with 113 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

126
reference/http/functions/setcookie.xml
View file

@ -1,5 +1,6 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- $Revision: 1.15 $ -->
<!-- splitted from ./en/functions/http.xml, last change in rev 1.2 -->
<refentry id="function.setcookie">
<refnamediv>
@ -33,17 +34,105 @@
All the arguments except the <parameter>name</parameter> argument
are optional. If only the name argument is present, the cookie
by that name will be deleted from the remote client. You may
also replace any argument with an empty string
also replace an argument with an empty string
(<emphasis>&quot;&quot;</emphasis>) in order to skip that
argument. The <parameter>expire</parameter> and
<parameter>secure</parameter> arguments are integers and cannot
be skipped with an empty string. Use a zero
(<emphasis>0</emphasis>) instead. The
<parameter>expire</parameter> argument is a regular Unix time
integer as returned by the <function>time</function> or
<function>mktime</function> functions. The
<parameter>secure</parameter> indicates that the cookie should
only be transmitted over a secure HTTPS connection.
argument. Because the <parameter>expire</parameter> and
<parameter>secure</parameter> arguments are integers, they cannot
be skipped with an empty string, use a zero (<emphasis>0</emphasis>)
instead. The following table explains each parameter of
<function>setcookie</function>:
</para>
<para>
<table>
<title><function>setcookie</function> parameters explained</title>
<tgroup cols="3">
<thead>
<row>
<entry>Parameter</entry>
<entry>Description</entry>
<entry>Examples</entry>
</row>
</thead>
<tbody>
<row>
<entry><parameter>name</parameter></entry>
<entry>
The name of the cookie.
</entry>
<entry>
'cookiename' is called as <varname>$_COOKIE['cookiename']</varname>
</entry>
</row>
<row>
<entry><parameter>value</parameter></entry>
<entry>
The value of the cookie. This value is stored on the clients
computer; do not store sensitive information.
</entry>
<entry>
Assuming the <parameter>name</parameter> is 'cookiename', this
value is retrieved through <varname>$_COOKIE['cookiename']</varname>
</entry>
</row>
<row>
<entry><parameter>expire</parameter></entry>
<entry>
The time the cookie expires. This is a unix timestamp so is
in number of seconds since the epoch. In otherwords, you'll
most likely set this with the <function>time</function> function
plus the number of seconds before you want it to expire. Or
you might use <function>mktime</function>.
</entry>
<entry>
<literal>time()+60*60*24*30</literal> will set the cookie to
expire in 30 days. If not set, the cookie will expire at
the end of the session (when the browser closes).
</entry>
</row>
<row>
<entry><parameter>path</parameter></entry>
<entry>
The path on the server in which the cookie will be available on.
</entry>
<entry>
If set to <literal>'/'</literal>, the cookie will be available
within the entire <parameter>domain</parameter>. If set to
<literal>'/foo/'</literal>, the cookie will only be available
within the <literal>/foo/</literal> directory and all
sub-directories such as <literal>/foo/bar/</literal> of
<parameter>domain</parameter>. The default value is the
current directory that the cookie is being set in.
</entry>
</row>
<row>
<entry><parameter>domain</parameter></entry>
<entry>
The domain that the cookie is available.
</entry>
<entry>
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 compatable
with more browsers. Setting it to <literal>www.example.com</literal>
will make the cookie only available in the <literal>www</literal>
subdomain.
</entry>
</row>
<row>
<entry><parameter>secure</parameter></entry>
<entry>
Indicates that the cookie should only be transmitted over a
secure HTTPS connection. When set to <literal>1</literal>, the
cookie will only be set if a secure connection exists. The default
is <literal>0</literal>.
</entry>
<entry>
<literal>0</literal> or <literal>1</literal>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
Once the cookies have been set, they can be accessed on the next page load
@ -52,8 +141,18 @@
<link linkend="language.variables.superglobals">autoglobals</link>
such as <varname>$_COOKIE</varname> became available in PHP
<ulink url="&url.php.release4.1.0;">4.1.0</ulink>.
<varname>$HTTP_COOKIE_VARS</varname> has existed since PHP 3.
<varname>$HTTP_COOKIE_VARS</varname> has existed since PHP 3. Cookie
values also exist in <link linkend="reserved.variables.request">
$_REQUEST</link>.
</para>
<note>
<para>
If the PHP directive <link linkend="ini.register-globals">register_globals</link>
is set to <literal>on</literal> then cookie values will also be made into
variables. In our examples below, <varname>$TextCookie</varname> will
exist. It's recommended to use <varname>$_COOKIE</varname>.
</para>
</note>
<para>
Common Pitfalls:
<itemizedlist>
@ -63,7 +162,8 @@
the cookie should be visible for. To test if a cookie was successfully
set, check for the cookie on a next loading page before the cookie
expires. Expire time is set via the <parameter>expire</parameter>
parameter.
parameter. A nice way to debug the existence of cookies is by
simply calling <literal>print_r($_COOKIE);</literal>.
</simpara>
</listitem>
<listitem>