File: book.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (109 lines) | stat: -rw-r--r-- 3,789 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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<!-- Purpose: basic.session -->
<!-- Membership: core -->

<book xml:id="book.session" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <title>Session Handling</title>
 <titleabbrev>Sessions</titleabbrev>

 <!-- {{{ preface -->
 <preface xml:id="intro.session">
  &reftitle.intro;
  <para>
   Session support in PHP consists of a way to preserve certain data
   across subsequent accesses. This enables you to build more
   customized applications and increase the appeal of your web site.
  </para>
  <para>
   A visitor accessing your web site is assigned a unique id, the
   so-called session id. This is either stored in a cookie on the
   user side or is propagated in the URL.
  </para>
  <para>
   The session support allows you to register arbitrary numbers of
   variables to be preserved across requests. When a visitor accesses
   your site, PHP will check automatically (if <link 
   linkend="ini.session.auto-start">session.auto_start</link>
   is set to 1) or on your request (explicitly through
   <function>session_start</function> or implicitly through
   <function>session_register</function>) whether a specific session
   id has been sent with the request. If this is the case, the prior
   saved environment is recreated.
  </para>
  <caution>
   <para>
    If you turn on <link linkend="ini.session.auto-start">
    session.auto_start</link> then the only way to put objects 
    into your sessions is to load its class definition using 
    <link linkend="ini.auto-prepend-file">auto_prepend_file</link> 
    in which you load the class definition else you will have to 
    <function>serialize</function> your object 
    and <function>unserialize</function> it  
    afterwards.
   </para>
  </caution>
  <para>
   All registered variables are serialized after the request
   finishes.  Registered variables which are undefined are marked as
   being not defined.  On subsequent accesses, these are not defined
   by the session module unless the user defines them later.
  </para>
  <warning>
   <para>
    Some types of data can not be serialized thus stored in sessions. It
    includes <type>resource</type> variables or objects with circular
    references (i.e. objects which passes a reference to itself to another
    object).
   </para>
  </warning>
  <note>
   <para>
    Please note when working with sessions that a record of a session
    is not created until a variable has been registered using the
    <function>session_register</function> function or by adding a new 
    key to the <varname>$_SESSION</varname> superglobal array. This 
    holds true regardless of if a session has been started using the 
    <function>session_start</function> function. 
   </para>
  </note>
  <note>
   <para>
    PHP 5.2.2 introduced an undocumented feature to store session files 
    in "/tmp" even if <link linkend="ini.open-basedir">open_basedir</link> 
    was enabled and "/tmp" is not explicitly added to the allowed paths 
    list. This feature has been removed from PHP as of PHP 5.3.0.
   </para>
  </note>
 </preface>
 <!-- }}} -->

 &reference.session.setup;
 &reference.session.constants;
 &reference.session.examples;
 &reference.session.security;
 &reference.session.reference;

</book>

<!-- 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:"~/.phpdoc/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
-->