...

...

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

1

1

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

2

2

<!-- $Revision$ -->

3

-

4

3

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

5

4

<refnamediv>

6

5

<refname>SessionHandler::gc</refname>

...

...

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

9

8

10

9

<refsect1 role="description">

11

10

&reftitle.description;

12

-

<methodsynopsis>

13

-

<modifier>public</modifier> <type>bool</type><methodname>SessionHandler::gc</methodname>

14

-

<methodparam><type>int</type><parameter>maxlifetime</parameter></methodparam>

11

+

<methodsynopsis role="SessionHandler">

12

+

<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>SessionHandler::gc</methodname>

13

+

<methodparam><type>int</type><parameter>max_lifetime</parameter></methodparam>

15

14

</methodsynopsis>

16

15

<para>

17

16

Cleans up expired sessions. Called randomly by PHP internally when a session starts or when

...

...

@@ -26,9 +25,9 @@

26

25

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

27

26

</para>

28

27

<para>

29

-

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

28

+

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

30

29

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

31

-

overidden and or intercepted and filtered.

30

+

overridden and or intercepted and filtered.

32

31

</para>

33

32

<para>

34

33

For more information on what this method is expected to do, please refer to the documentation at

...

...

@@ -40,10 +39,10 @@

40

39

&reftitle.parameters;

41

40

<variablelist>

42

41

<varlistentry>

43

-

<term><parameter>maxlifetime</parameter></term>

42

+

<term><parameter>max_lifetime</parameter></term>

44

43

<listitem>

45

44

<para>

46

-

Sessions that have not updated for the last <parameter>maxlifetime</parameter> seconds will be removed.

45

+

Sessions that have not updated for the last <parameter>max_lifetime</parameter> seconds will be removed.

47

46

</para>

48

47

</listitem>

49

48

</varlistentry>

...

...

@@ -53,13 +52,34 @@

53

52

<refsect1 role="returnvalues">

54

53

&reftitle.returnvalues;

55

54

<para>

56

-

&returns.session.storage.retval;

55

+

Returns the number of deleted sessions on success, &return.falseforfailure;.

56

+

Note this value is returned internally to PHP for processing.

57

57

</para>

58

58

</refsect1>

59

59

60

+

<refsect1 role="changelog">

61

+

&reftitle.changelog;

62

+

<informaltable>

63

+

<tgroup cols="2">

64

+

<thead>

65

+

<row>

66

+

<entry>&Version;</entry>

67

+

<entry>&Description;</entry>

68

+

</row>

69

+

</thead>

70

+

<tbody>

71

+

<row>

72

+

<entry>7.1.0</entry>

73

+

<entry>

74

+

Prior to this version, the function returned &true; on success.

75

+

</entry>

76

+

</row>

77

+

</tbody>

78

+

</tgroup>

79

+

</informaltable>

80

+

</refsect1>

60

81

61

82

</refentry>

62

-

63

83

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

64

84

Local variables:

65

85

mode: sgml

66

86