...

...

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

1

1

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

2

2

<!-- $Revision$ -->

3

-

4

3

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

5

4

<refnamediv>

6

5

<refname>SessionHandlerInterface::read</refname>

...

...

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

9

8

10

9

<refsect1 role="description">

11

10

&reftitle.description;

12

-

<methodsynopsis>

13

-

<modifier>abstract</modifier> <modifier>public</modifier> <type>string</type><methodname>SessionHandlerInterface::read</methodname>

14

-

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

11

+

<methodsynopsis role="SessionHandlerInterface">

12

+

<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>SessionHandlerInterface::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 results.

...

...

@@ -23,7 +22,7 @@

23

22

This method should retrieve the session data from storage by the

24

23

session ID provided. The string returned by this method must be in the same

25

24

serialized format as when originally passed to the <function>SessionHandlerInterface::write</function>

26

-

If the record was not found, return an empty string.

25

+

If the record was not found, return &false;.

27

26

</para>

28

27

<para>

29

28

The data returned by this method will be decoded internally by PHP using the

...

...

@@ -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.

...

...

@@ -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

...

...

@@ -70,7 +69,6 @@

70

69

</refsect1>

71

70

72

71

</refentry>

73

-

74

72

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

75

73

Local variables:

76

74

mode: sgml

77

75