File: SessionHandlerInterface.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (46 lines) | stat: -rw-r--r-- 2,522 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8" ?>
<interface xmlns="http://xml.phpdox.net/src" full="SessionHandlerInterface" namespace="" name="SessionHandlerInterface">
  <method name="close" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Close the session"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="destroy" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Destroy a session"/>
      <return type="bool"/>
    </docblock>
    <parameter name="session_id" optional="false" byreference="false" type="string"/>
  </method>
  <method name="gc" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Cleanup old sessions"/>
      <return type="int"/>
    </docblock>
    <parameter name="maxlifetime" optional="false" byreference="false" type="int"/>
  </method>
  <method name="open" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Initialize session"/>
      <return type="bool"/>
    </docblock>
    <parameter name="save_path" optional="false" byreference="false" type="string"/>
    <parameter name="session_name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="read" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Read session data">Reads the session data from the session storage, and returns the results. Called right after the session starts or when session_start is called. Please note that before this method is called SessionHandlerInterface::open is invoked.</description>
      <return type="string"/>
    </docblock>
    <parameter name="session_id" optional="false" byreference="false" type="string"/>
  </method>
  <method name="write" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Write session data">Writes the session data to the session storage. Called by session_write_close, when session_register_shutdown fails, or during a normal shutdown. Note: SessionHandlerInterface::close is called immediately after this function.</description>
      <return type="bool"/>
    </docblock>
    <parameter name="session_id" optional="false" byreference="false" type="string"/>
    <parameter name="session_data" optional="false" byreference="false" type="string"/>
  </method>
</interface>