File: session-set-cookie-params.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (65 lines) | stat: -rw-r--r-- 2,495 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/session.xml, last change in rev 1.2 -->
  <refentry id="function.session-set-cookie-params">
   <refnamediv>
    <refname>session_set_cookie_params</refname>
    <refpurpose>
     Set the session cookie parameters
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>session_set_cookie_params</methodname>
      <methodparam><type>int</type><parameter>lifetime</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>path</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>domain</parameter></methodparam>
      <methodparam choice="opt"><type>bool</type><parameter>secure</parameter></methodparam>
      <methodparam choice="opt"><type>bool</type><parameter>httponly</parameter></methodparam>
     </methodsynopsis>
    <para>
     Set cookie parameters defined in the &php.ini; file. The effect of this
     function only lasts for the duration of the script. Thus, you need to
     call <function>session_set_cookie_params</function> for every request and
     before <function>session_start</function> is called.
    </para>
    <note>
     <para>
       The <parameter>secure</parameter> parameter was added in PHP
       4.0.4, while the <parameter>httponly</parameter> parameter was added in
       PHP 5.2.0.
     </para>
    </note>
    <para>
     See also the configuration directives
     <link linkend="ini.session.cookie-lifetime">session.cookie_lifetime</link>,
     <link linkend="ini.session.cookie-path">session.cookie_path</link>,
     <link linkend="ini.session.cookie-domain">session.cookie_domain</link>,
     <link linkend="ini.session.cookie-secure">session.cookie_secure</link>,
     <link linkend="ini.session.cookie-httponly">session.cookie_httponly</link>, and
     <function>session_get_cookie_params</function>.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->