Class: TimeOut

Source Location: /class_timeout.php

Class Overview [line 14]

GlobalConfig
   |
   --TimeOut

Class for session time out routines Extends the class "GlobalConfig".

Author(s):

  • Elpidio Latorilla

Version:

  • beta 1.0.08

Copyright:

  • 2002,2003 Elpidio Latorilla

Variables

Methods


Inherited Methods

Class: GlobalConfig

GlobalConfig::GlobalConfig()
Constructor
GlobalConfig::getConfig()
Gets (a) global configuration value(s) of (a) configuration item(s).
GlobalConfig::getConfigValue()
Gets a global config value of a config item supplied as parameter.
GlobalConfig::saveConfigArray()
Saves configuration values stored in an associative array.
GlobalConfig::saveConfigItem()
Saves a global configuration value to its configuration item.


Class Details

Class for session time out routines Extends the class "GlobalConfig".

Note this class should be instantiated only after a "$db" adodb connector object has been established by an adodb instance

Tags:

[ Top ]


Class Variables

$tcheck =

[line 24]

Status if timeout is to be checked or not.

Type: int

Overrides:

[ Top ]

$tostart =

[line 19]

Time-out start count variable. This is a reference to the session variable.

Type: int

Overrides:

[ Top ]

$totime =

[line 29]

Elapsed time of inactivity in MinutesSeconds format e.g. 530 = 5 minutes, 20 seconds or e.g. 2000 = 20 minutes, 00 seconds.

Type: int

Overrides:

[ Top ]


Class Methods

TimeOut

TimeOut TimeOut( $tostart &$tostart, [$tcheck $tcheck = TRUE], [$totime $totime = 10])

[line 40]

Constructor.

The session variable which stores the time out count start value should be passed by reference.

Parameters:

  • $tostart &$tostart - (var) reference passed variable
  • $tcheck $tcheck - (bool) if time out is to be checked or not
  • $totime $totime - (int) time out length of time in MinutesSeconds format e.g. 530 = 5 minutes, 20 seconds or e.g. 2000 = 20 minutes, 00 seconds

[ Top ]

isTimedOut

void isTimedOut( [$tnow $tnow = 0])

[line 61]

Checks if the session has timed out

Parameters:

  • $tnow $tnow - (int) the current time return TRUE if timed out, FALSE if not

[ Top ]

Reset

void Reset( [$ts $ts = 0])

[line 51]

Resets the time out count start time

Parameters:

  • $ts $ts - (int) optionally a time value can be passed as the count start return resetted start value

[ Top ]


Documentation generated on Sun, 16 Nov 2003 01:03:00 +0100 by phpDocumentor 1.2.3