Class Horde_Token_file

Description

Token tracking implementation for local files.

Optional parameters:

   'token_dir'  The directory where to keep token files.
   'timeout'    The period (in seconds) after which an id is purged.
                Defaults to 86400 (i.e. 24 hours).

$Horde: framework/Token/Token/file.php,v 1.19.6.11 2009/01/06 15:23:44 jan Exp $

Copyright 1999-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Token/Token/file.php (line 21)

Horde_Token
   |
   --Horde_Token_file
Variable Summary
 boolean $_connected
 resource $_fd
Method Summary
 Horde_Token_file Horde_Token_file ([array $params = array()])
 void add ( $tokenID)
 void exists ( $tokenID)
 boolean purge ()
 boolean _connect ( $tokenID)
 boolean _disconnect ()
Variables
boolean $_connected = false (line 35)

Boolean indicating whether or not we have an open file descriptor.

resource $_fd = false (line 28)

Handle for the open file descriptor.

Inherited Variables

Inherited from Horde_Token

Horde_Token::$_params
Methods
Constructor Horde_Token_file (line 42)

Create a new file based token-tracking container.

Horde_Token_file Horde_Token_file ([array $params = array()])
  • array $params: A hash containing storage parameters.
add (line 108)
void add ( $tokenID)
  • $tokenID

Redefinition of:
Horde_Token::add()
This is an abstract method that should be overridden by a subclass implementation. The base implementation allows all token values.
exists (line 88)
void exists ( $tokenID)
  • $tokenID

Redefinition of:
Horde_Token::exists()
This is an abstract method that should be overridden by a subclass implementation. The base implementation allows all token values.
purge (line 62)

Deletes all expired connection id's from the SQL server.

  • return: True on success, a PEAR_Error object on failure.
boolean purge ()

Redefinition of:
Horde_Token::purge()
This is an abstract method that should be overridden by a subclass implementation. The base implementation allows all token values.
_connect (line 130)

Opens a file descriptor to a new or existing file.

  • return: True on success, a PEAR_Error object on failure.
boolean _connect ( $tokenID)
  • $tokenID
_disconnect (line 151)

Closes the file descriptor.

  • return: True on success, false on failure.
boolean _disconnect ()

Inherited Methods

Inherited From Horde_Token

 Horde_Token::Horde_Token()
 Horde_Token::add()
 Horde_Token::encodeRemoteAddress()
 Horde_Token::exists()
 Horde_Token::factory()
 Horde_Token::generateId()
 Horde_Token::purge()
 Horde_Token::singleton()
 Horde_Token::verify()

Documentation generated on Sun, 30 Jan 2011 05:17:15 +0000 by phpDocumentor 1.4.3