Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-webat this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Zend_Session_SaveHandler_DbTable

string
$_modifiedColumn= 'null'
Session table last modification time column
null
Details
boolean
$_overrideLifetime= 'false'
Whether or not the lifetime of an existing session should be overridden
false
Details
array
$_primaryAssignment= 'null'
Session table primary key value assignment
null
Details
__construct(
\Zend_Config|array $config
)
:
void
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)
Name | Type | Description |
---|---|---|
$config | \Zend_Config|array | User-provided configuration |
Exception | Description |
---|---|
\Zend_Session_SaveHandler_Exception |

_checkRequiredColumns(
)
:
void
Check for required session table columns
Exception | Description |
---|---|
\Zend_Session_SaveHandler_Exception |

_getLifetime(
\Zend_Db_Table_Row_Abstract $row
)
:
int
Retrieve session lifetime considering Zend_Session_SaveHandler_DbTable::OVERRIDE_LIFETIME

_getPrimary(
string $id, string $type
=
null
)
:
array
Retrieve session table primary key values
Name | Type | Description |
---|---|---|
$id | string | |
$type | string | (optional; default: self::PRIMARY_TYPE_NUM) |
Type | Description |
---|---|
array |

_setupPrimaryAssignment(
)
:
void
Initialize session table primary key value assignment
Exception | Description |
---|---|
\Zend_Session_SaveHandler_Exception |

_setupTableName(
)
:
void
Initialize table and schema names
Exception | Description |
---|---|
\Zend_Session_SaveHandler_Exception |

destroy(
string $id
)
:
boolean
Destroy session
Name | Type | Description |
---|---|---|
$id | string |
Type | Description |
---|---|
boolean |

gc(
int $maxlifetime
)
:
true
Garbage Collection
Name | Type | Description |
---|---|---|
$maxlifetime | int |
Type | Description |
---|---|
true |

getOverrideLifetime(
)
:
boolean
Retrieve whether or not the lifetime of an existing session should be overridden
Type | Description |
---|---|
boolean |

open(
string $save_path, string $name
)
:
boolean
Open Session
Name | Type | Description |
---|---|---|
$save_path | string | |
$name | string |
Type | Description |
---|---|
boolean |

read(
string $id
)
:
string
Read session data
Name | Type | Description |
---|---|---|
$id | string |
Type | Description |
---|---|
string |

setLifetime(
int $lifetime, boolean $overrideLifetime
=
null
)
:
\Zend_Session_SaveHandler_DbTable
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
Name | Type | Description |
---|---|---|
$lifetime | int | |
$overrideLifetime | boolean | (optional) |
Type | Description |
---|---|
\Zend_Session_SaveHandler_DbTable |

setOverrideLifetime(
boolean $overrideLifetime
)
:
\Zend_Session_SaveHandler_DbTable
Set whether or not the lifetime of an existing session should be overridden
Name | Type | Description |
---|---|---|
$overrideLifetime | boolean |
Type | Description |
---|---|
\Zend_Session_SaveHandler_DbTable |