...

...

@@ -1,6 +1,5 @@

1

1

<?xml version="1.0" encoding="utf-8"?>

2

2

<!-- $Revision$ -->

3

-

4

3

<refentry xml:id="sessionhandler.read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

5

4

<refnamediv>

6

5

<refname>SessionHandler::read</refname>

...

...

@@ -9,14 +8,14 @@

9

8

10

9

<refsect1 role="description">

11

10

&reftitle.description;

12

-

<methodsynopsis>

13

-

<modifier>public</modifier> <type>string</type><methodname>SessionHandler::read</methodname>

14

-

<methodparam><type>string</type><parameter>session_id</parameter></methodparam>

11

+

<methodsynopsis role="SessionHandler">

12

+

<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>SessionHandler::read</methodname>

13

+

<methodparam><type>string</type><parameter>id</parameter></methodparam>

15

14

</methodsynopsis>

16

15

<para>

17

16

Reads the session data from the session storage, and returns the result back to PHP for internal processing.

18

-

This method is called automatically by PHP when a session is started (either automatically or explicity

19

-

with <function>session_start</function> and is preceeded by an internal call to the

17

+

This method is called automatically by PHP when a session is started (either automatically or explicitly

18

+

with <function>session_start</function> and is preceded by an internal call to the

20

19

<function>SessionHandler::open</function>.

21

20

</para>

22

21

<para>

...

...

@@ -25,9 +24,9 @@

25

24

before this handler was set by <function>session_set_save_handler</function>.

26

25

</para>

27

26

<para>

28

-

If this class is extended by inheritiance, calling the parent <parameter>read</parameter> method will invoke the

29

-

wrapper for this method and therefor invoke the associated internal callback. This allows the method to be

30

-

overidden and or intercepted and filtered (for example, decrypting <parameter>$data</parameter> value

27

+

If this class is extended by inheritance, calling the parent <parameter>read</parameter> method will invoke the

28

+

wrapper for this method and therefore invoke the associated internal callback. This allows the method to be

29

+

overridden and or intercepted and filtered (for example, decrypting the <parameter>$data</parameter> value

31

30

returned by the parent <parameter>read</parameter> method).

32

31

</para>

33

32

<para>

...

...

@@ -40,7 +39,7 @@

40

39

&reftitle.parameters;

41

40

<variablelist>

42

41

<varlistentry>

43

-

<term><parameter>session_id</parameter></term>

42

+

<term><parameter>id</parameter></term>

44

43

<listitem>

45

44

<para>

46

45

The session id to read data for.

...

...

@@ -53,7 +52,7 @@

53

52

<refsect1 role="returnvalues">

54

53

&reftitle.returnvalues;

55

54

<para>

56

-

Returns an encoded string of the read data. If nothing was read, it must return an empty string. Note this value is returned internally to PHP for processing.

55

+

Returns an encoded string of the read data. If nothing was read, it must return &false;. Note this value is returned internally to PHP for processing.

57

56

</para>

58

57

</refsect1>

59

58

...

...

@@ -71,7 +70,6 @@

71

70

72

71

73

72

</refentry>

74

-

75

73

<!-- Keep this comment at the end of the file

76

74

Local variables:

77

75

mode: sgml

78

76