Session/SaveHandler/DbTable.php

Show: PublicProtectedPrivateinherited
Table of Contents
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.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Session  
Version
$Id$  

\Zend_Session_SaveHandler_DbTable

Package: Zend_Session\SaveHandler
Zend_Session_SaveHandler_DbTable
Implements
Parent(s)
\Zend_Db_Table_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  PRIMARY_ASSIGNMENT = 'primaryAssignment'
>VConstant  PRIMARY_ASSIGNMENT_SESSION_SAVE_PATH = 'sessionSavePath'
>VConstant  PRIMARY_ASSIGNMENT_SESSION_NAME = 'sessionName'
>VConstant  PRIMARY_ASSIGNMENT_SESSION_ID = 'sessionId'
>VConstant  MODIFIED_COLUMN = 'modifiedColumn'
>VConstant  LIFETIME_COLUMN = 'lifetimeColumn'
>VConstant  DATA_COLUMN = 'dataColumn'
>VConstant  LIFETIME = 'lifetime'
>VConstant  OVERRIDE_LIFETIME = 'overrideLifetime'
>VConstant  PRIMARY_TYPE_NUM = 'PRIMARY_TYPE_NUM'
>VConstant  PRIMARY_TYPE_PRIMARYNUM = 'PRIMARY_TYPE_PRIMARYNUM'
>VConstant  PRIMARY_TYPE_ASSOC = 'PRIMARY_TYPE_ASSOC'
>VConstant  PRIMARY_TYPE_WHERECLAUSE = 'PRIMARY_TYPE_WHERECLAUSE'

Properties

>VPropertyprotectedstring $_dataColumn = null
Session table data column
Default valuenullDetails
Type
string
>VPropertyprotectedint $_lifetime = false
Session lifetime
Default valuefalseDetails
Type
int
>VPropertyprotectedstring $_lifetimeColumn = null
Session table lifetime column
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_modifiedColumn = null
Session table last modification time column
Default valuenullDetails
Type
string
>VPropertyprotectedboolean $_overrideLifetime = false
Whether or not the lifetime of an existing session should be overridden
Default valuefalseDetails
Type
boolean
>VPropertyprotectedarray $_primaryAssignment = null
Session table primary key value assignment
Default valuenullDetails
Type
array
>VPropertyprotectedstring $_sessionName
Session name
Details
Type
string
>VPropertyprotectedstring $_sessionSavePath
Session save path
Details
Type
string

Methods

methodpublic__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)
Parameters
NameTypeDescription
$config\Zend_Config | array

User-provided configuration

Throws
ExceptionDescription
\Zend_Session_SaveHandler_Exception
methodpublic__destruct() : void

Destructor

methodprotected_checkRequiredColumns() : void

Check for required session table columns

Throws
ExceptionDescription
\Zend_Session_SaveHandler_Exception
methodprotected_getExpirationTime(\Zend_Db_Table_Row_Abstract $row) : int

Retrieve session expiration time

Parameters
NameTypeDescription
$row\Zend_Db_Table_Row_Abstract
Returns
TypeDescription
int
methodprotected_getLifetime(\Zend_Db_Table_Row_Abstract $row) : int

Retrieve session lifetime considering Zend_Session_SaveHandler_DbTable::OVERRIDE_LIFETIME

Parameters
NameTypeDescription
$row\Zend_Db_Table_Row_Abstract
Returns
TypeDescription
int
methodprotected_getPrimary(string $id, string $type = null) : array

Retrieve session table primary key values

Parameters
NameTypeDescription
$idstring
$typestring

(optional; default: self::PRIMARY_TYPE_NUM)

Returns
TypeDescription
array
methodprotected_setup() : void

Calls other protected methods for individual setup tasks and requirement checks

methodprotected_setupPrimaryAssignment() : void

Initialize session table primary key value assignment

Throws
ExceptionDescription
\Zend_Session_SaveHandler_Exception
methodprotected_setupTableName() : void

Initialize table and schema names

Throws
ExceptionDescription
\Zend_Session_SaveHandler_Exception
methodpublicclose() : boolean

Close session

Returns
TypeDescription
boolean
methodpublicdestroy(string $id) : boolean

Destroy session

Parameters
NameTypeDescription
$idstring
Returns
TypeDescription
boolean
methodpublicgc(int $maxlifetime) : true

Garbage Collection

Parameters
NameTypeDescription
$maxlifetimeint
Returns
TypeDescription
true
methodpublicgetLifetime() : int

Retrieve session lifetime

Returns
TypeDescription
int
methodpublicgetOverrideLifetime() : boolean

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

Returns
TypeDescription
boolean
methodpublicopen(string $save_path, string $name) : boolean

Open Session

Parameters
NameTypeDescription
$save_pathstring
$namestring
Returns
TypeDescription
boolean
methodpublicread(string $id) : string

Read session data

Parameters
NameTypeDescription
$idstring
Returns
TypeDescription
string
methodpublicsetLifetime(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
Parameters
NameTypeDescription
$lifetimeint
$overrideLifetimeboolean

(optional)

Returns
TypeDescription
\Zend_Session_SaveHandler_DbTable
methodpublicsetOverrideLifetime(boolean $overrideLifetime) : \Zend_Session_SaveHandler_DbTable

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

Parameters
NameTypeDescription
$overrideLifetimeboolean
Returns
TypeDescription
\Zend_Session_SaveHandler_DbTable
methodpublicwrite(string $id, string $data) : boolean

Write session data

Parameters
NameTypeDescription
$idstring
$datastring
Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.2.0 .