Class Zend_Session_SaveHandler_DbTable

Description

Implements interfaces:

Zend_Session_SaveHandler_DbTable

  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Session/SaveHandler/DbTable.php (line 52)

Zend_Db_Table_Abstract
   |
   --Zend_Session_SaveHandler_DbTable
Class Constant Summary
 DATA_COLUMN = 'dataColumn'
 LIFETIME = 'lifetime'
 LIFETIME_COLUMN = 'lifetimeColumn'
 MODIFIED_COLUMN = 'modifiedColumn'
 OVERRIDE_LIFETIME = 'overrideLifetime'
 PRIMARY_ASSIGNMENT = 'primaryAssignment'
 PRIMARY_TYPE_ASSOC = 'PRIMARY_TYPE_ASSOC'
 PRIMARY_TYPE_NUM = 'PRIMARY_TYPE_NUM'
 PRIMARY_TYPE_PRIMARYNUM = 'PRIMARY_TYPE_PRIMARYNUM'
 PRIMARY_TYPE_WHERECLAUSE = 'PRIMARY_TYPE_WHERECLAUSE'
Variable Summary
Method Summary
 void __construct (Zend_Config|array $config)
 void __destruct ()
 boolean close ()
 boolean destroy (string $id)
 true gc (int $maxlifetime)
 int getLifetime ()
 boolean getOverrideLifetime ()
 boolean open (string $save_path, string $name)
 string read (string $id)
 Zend_Session_SaveHandler_DbTable setLifetime (int $lifetime, [boolean $overrideLifetime = null])
 boolean write (string $id, string $data)
 int _getExpirationTime ( $row)
 int _getLifetime ( $row)
 array _getPrimary (string $id, [string $type = null])
 void _setup ()
 void _setupTableName ()
Variables
string $_dataColumn = null (line 99)

Session table data column

  • access: protected
int $_lifetime = false (line 106)

Session lifetime

  • access: protected
string $_lifetimeColumn = null (line 92)

Session table lifetime column

  • access: protected
string $_modifiedColumn = null (line 85)

Session table last modification time column

  • access: protected
boolean $_overrideLifetime = false (line 113)

Whether or not the lifetime of an existing session should be overridden

  • access: protected
array $_primaryAssignment = null (line 78)

Session table primary key value assignment

  • access: protected
string $_sessionName (line 127)

Session name

  • access: protected
string $_sessionSavePath (line 120)

Session save path

  • access: protected

Inherited Variables

Inherited from Zend_Db_Table_Abstract

Zend_Db_Table_Abstract::$_cols
Zend_Db_Table_Abstract::$_db
Zend_Db_Table_Abstract::$_defaultDb
Zend_Db_Table_Abstract::$_defaultMetadataCache
Zend_Db_Table_Abstract::$_defaultSource
Zend_Db_Table_Abstract::$_defaultValues
Zend_Db_Table_Abstract::$_definition
Zend_Db_Table_Abstract::$_definitionConfigName
Zend_Db_Table_Abstract::$_dependentTables
Zend_Db_Table_Abstract::$_identity
Zend_Db_Table_Abstract::$_metadata
Zend_Db_Table_Abstract::$_metadataCache
Zend_Db_Table_Abstract::$_metadataCacheInClass
Zend_Db_Table_Abstract::$_name
Zend_Db_Table_Abstract::$_primary
Zend_Db_Table_Abstract::$_referenceMap
Zend_Db_Table_Abstract::$_rowClass
Zend_Db_Table_Abstract::$_rowsetClass
Zend_Db_Table_Abstract::$_schema
Zend_Db_Table_Abstract::$_sequence
Methods
Constructor __construct (line 163)

Constructor

$config is an instance of Zend_Config or an array of key/value pairs containing configuration options for Zend_Session_SaveHandler_DbTable and Zend_Db_Table_Abstract. These are the configuration options for Zend_Session_SaveHandler_DbTable:

primaryAssignment => (string|array) Session table primary key value assignment (optional; default: 1 => sessionId) You have to assign a value to each primary key of your session table. The value of this configuration option is either a string if you have only one primary key or an array if you have multiple primary keys. The array consists of numeric keys starting at 1 and string values. There are some values which will be replaced by session information:

sessionId => The id of the current session sessionName => The name of the current session sessionSavePath => The save path of the current session

NOTE: One of your assignments MUST contain 'sessionId' as value!

modifiedColumn => (string) Session table last modification time column

lifetimeColumn => (string) Session table lifetime column

dataColumn => (string) Session table data column

lifetime => (integer) Session lifetime (optional; default: ini_get('session.gc_maxlifetime'))

overrideLifetime => (boolean) Whether or not the lifetime of an existing session should be overridden (optional; default: false)

  • throws: Zend_Session_SaveHandler_Exception
  • access: public
void __construct (Zend_Config|array $config)
  • Zend_Config|array $config: User-provided configuration

Redefinition of:
Zend_Db_Table_Abstract::__construct()
Constructor.
Destructor __destruct (line 215)

Destructor

  • access: public
void __destruct ()
close (line 303)

Close session

  • access: public
boolean close ()

Implementation of:
Zend_Session_SaveHandler_Interface::close()
Close Session - free resources
destroy (line 370)

Destroy session

  • access: public
boolean destroy (string $id)
  • string $id

Implementation of:
Zend_Session_SaveHandler_Interface::destroy()
Destroy Session - remove data from resource for given session id
gc (line 387)

Garbage Collection

  • access: public
true gc (int $maxlifetime)
  • int $maxlifetime

Implementation of:
Zend_Session_SaveHandler_Interface::gc()
Garbage Collection - remove old session data older than $maxlifetime (in seconds)
getLifetime (line 255)

Retrieve session lifetime

  • access: public
int getLifetime ()
getOverrideLifetime (line 278)

Retrieve whether or not the lifetime of an existing session should be overridden

  • access: public
boolean getOverrideLifetime ()
open (line 290)

Open Session

  • access: public
boolean open (string $save_path, string $name)
  • string $save_path
  • string $name

Implementation of:
Zend_Session_SaveHandler_Interface::open()
Open Session - retrieve resources
read (line 314)

Read session data

  • access: public
string read (string $id)
  • string $id

Implementation of:
Zend_Session_SaveHandler_Interface::read()
Read session data
setLifetime (line 229)

Set session lifetime and optional whether or not the lifetime of an existing session should be overridden

$lifetime === false resets lifetime to session.gc_maxlifetime

  • access: public
Zend_Session_SaveHandler_DbTable setLifetime (int $lifetime, [boolean $overrideLifetime = null])
  • int $lifetime
  • boolean $overrideLifetime: (optional)
setOverrideLifetime (line 266)

Set whether or not the lifetime of an existing session should be overridden

  • access: public
Zend_Session_SaveHandler_DbTable setOverrideLifetime (boolean $overrideLifetime)
  • boolean $overrideLifetime
write (line 338)

Write session data

  • access: public
boolean write (string $id, string $data)
  • string $id
  • string $data

Implementation of:
Zend_Session_SaveHandler_Interface::write()
Write Session - commit data to resource
_checkRequiredColumns (line 478)

Check for required session table columns

  • throws: Zend_Session_SaveHandler_Exception
  • access: protected
void _checkRequiredColumns ()
_getExpirationTime (line 587)

Retrieve session expiration time

  • access: protected
int _getExpirationTime ( $row)
_getLifetime (line 570)

Retrieve session lifetime considering Zend_Session_SaveHandler_DbTable::OVERRIDE_LIFETIME

  • access: protected
int _getLifetime ( $row)
_getPrimary (line 517)

Retrieve session table primary key values

  • access: protected
array _getPrimary (string $id, [string $type = null])
  • string $id
  • string $type: (optional; default: self::PRIMARY_TYPE_NUM)
_setup (line 401)

Calls other protected methods for individual setup tasks and requirement checks

  • access: protected
void _setup ()

Redefinition of:
Zend_Db_Table_Abstract::_setup()
Turnkey for initialization of a table object.
_setupPrimaryAssignment (line 439)

Initialize session table primary key value assignment

  • throws: Zend_Session_SaveHandler_Exception
  • access: protected
void _setupPrimaryAssignment ()
_setupTableName (line 417)

Initialize table and schema names

  • throws: Zend_Session_SaveHandler_Exception
  • access: protected
void _setupTableName ()

Redefinition of:
Zend_Db_Table_Abstract::_setupTableName()
Initialize table and schema names.

Inherited Methods

Inherited From Zend_Db_Table_Abstract

 Zend_Db_Table_Abstract::__construct()
 Zend_Db_Table_Abstract::addReference()
 Zend_Db_Table_Abstract::createRow()
 Zend_Db_Table_Abstract::delete()
 Zend_Db_Table_Abstract::fetchAll()
 Zend_Db_Table_Abstract::fetchNew()
 Zend_Db_Table_Abstract::fetchRow()
 Zend_Db_Table_Abstract::find()
 Zend_Db_Table_Abstract::getAdapter()
 Zend_Db_Table_Abstract::getDefaultAdapter()
 Zend_Db_Table_Abstract::getDefaultMetadataCache()
 Zend_Db_Table_Abstract::getDefaultSource()
 Zend_Db_Table_Abstract::getDefaultValues()
 Zend_Db_Table_Abstract::getDefinition()
 Zend_Db_Table_Abstract::getDefinitionConfigName()
 Zend_Db_Table_Abstract::getDependentTables()
 Zend_Db_Table_Abstract::getMetadataCache()
 Zend_Db_Table_Abstract::getReference()
 Zend_Db_Table_Abstract::getRowClass()
 Zend_Db_Table_Abstract::getRowsetClass()
 Zend_Db_Table_Abstract::info()
 Zend_Db_Table_Abstract::init()
 Zend_Db_Table_Abstract::insert()
 Zend_Db_Table_Abstract::isIdentity()
 Zend_Db_Table_Abstract::metadataCacheInClass()
 Zend_Db_Table_Abstract::select()
 Zend_Db_Table_Abstract::setDefaultAdapter()
 Zend_Db_Table_Abstract::setDefaultMetadataCache()
 Zend_Db_Table_Abstract::setDefaultSource()
 Zend_Db_Table_Abstract::setDefaultValues()
 Zend_Db_Table_Abstract::setDefinition()
 Zend_Db_Table_Abstract::setDefinitionConfigName()
 Zend_Db_Table_Abstract::setDependentTables()
 Zend_Db_Table_Abstract::setMetadataCacheInClass()
 Zend_Db_Table_Abstract::setOptions()
 Zend_Db_Table_Abstract::setReferences()
 Zend_Db_Table_Abstract::setRowClass()
 Zend_Db_Table_Abstract::setRowsetClass()
 Zend_Db_Table_Abstract::update()
 Zend_Db_Table_Abstract::_cascadeDelete()
 Zend_Db_Table_Abstract::_cascadeUpdate()
 Zend_Db_Table_Abstract::_fetch()
 Zend_Db_Table_Abstract::_getCols()
 Zend_Db_Table_Abstract::_getReferenceMapNormalized()
 Zend_Db_Table_Abstract::_order()
 Zend_Db_Table_Abstract::_setAdapter()
 Zend_Db_Table_Abstract::_setMetadataCache()
 Zend_Db_Table_Abstract::_setSequence()
 Zend_Db_Table_Abstract::_setup()
 Zend_Db_Table_Abstract::_setupAdapter()
 Zend_Db_Table_Abstract::_setupDatabaseAdapter()
 Zend_Db_Table_Abstract::_setupMetadata()
 Zend_Db_Table_Abstract::_setupMetadataCache()
 Zend_Db_Table_Abstract::_setupPrimaryKey()
 Zend_Db_Table_Abstract::_setupTableName()
 Zend_Db_Table_Abstract::_where()
Class Constants
DATA_COLUMN = 'dataColumn' (line 63)
LIFETIME = 'lifetime' (line 65)
LIFETIME_COLUMN = 'lifetimeColumn' (line 62)
MODIFIED_COLUMN = 'modifiedColumn' (line 61)
OVERRIDE_LIFETIME = 'overrideLifetime' (line 66)
PRIMARY_ASSIGNMENT = 'primaryAssignment' (line 56)
PRIMARY_ASSIGNMENT_SESSION_ID = 'sessionId' (line 59)
PRIMARY_ASSIGNMENT_SESSION_NAME = 'sessionName' (line 58)
PRIMARY_ASSIGNMENT_SESSION_SAVE_PATH = 'sessionSavePath' (line 57)
PRIMARY_TYPE_ASSOC = 'PRIMARY_TYPE_ASSOC' (line 70)
PRIMARY_TYPE_NUM = 'PRIMARY_TYPE_NUM' (line 68)
PRIMARY_TYPE_PRIMARYNUM = 'PRIMARY_TYPE_PRIMARYNUM' (line 69)
PRIMARY_TYPE_WHERECLAUSE = 'PRIMARY_TYPE_WHERECLAUSE' (line 71)

Inherited Constants

Inherited from Zend_Db_Table_Abstract

Zend_Db_Table_Abstract::ADAPTER
Zend_Db_Table_Abstract::CASCADE
Zend_Db_Table_Abstract::COLS
Zend_Db_Table_Abstract::COLUMNS
Zend_Db_Table_Abstract::DEFAULT_CLASS
Zend_Db_Table_Abstract::DEFAULT_DB
Zend_Db_Table_Abstract::DEFAULT_NONE
Zend_Db_Table_Abstract::DEFINITION
Zend_Db_Table_Abstract::DEFINITION_CONFIG_NAME
Zend_Db_Table_Abstract::DEPENDENT_TABLES
Zend_Db_Table_Abstract::METADATA
Zend_Db_Table_Abstract::METADATA_CACHE
Zend_Db_Table_Abstract::METADATA_CACHE_IN_CLASS
Zend_Db_Table_Abstract::NAME
Zend_Db_Table_Abstract::ON_DELETE
Zend_Db_Table_Abstract::ON_UPDATE
Zend_Db_Table_Abstract::PRIMARY
Zend_Db_Table_Abstract::REFERENCE_MAP
Zend_Db_Table_Abstract::REF_COLUMNS
Zend_Db_Table_Abstract::REF_TABLE_CLASS
Zend_Db_Table_Abstract::RESTRICT
Zend_Db_Table_Abstract::ROWSET_CLASS
Zend_Db_Table_Abstract::ROW_CLASS
Zend_Db_Table_Abstract::SCHEMA
Zend_Db_Table_Abstract::SELECT_WITHOUT_FROM_PART
Zend_Db_Table_Abstract::SELECT_WITH_FROM_PART
Zend_Db_Table_Abstract::SEQUENCE
Zend_Db_Table_Abstract::SET_NULL

Documentation generated on Mon, 21 Jun 2010 15:16:14 -0400 by phpDocumentor 1.4.3