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 |

_cascadeDelete(
string $parentTableClassname, array $primaryKey
)
:
int
Called by parent table's class during delete() method.
Inherited from: \Zend_Db_Table_Abstract::_cascadeDelete()Name | Type | Description |
---|---|---|
$parentTableClassname | string | |
$primaryKey | array |
Type | Description |
---|---|
int | Number of affected rows |

_cascadeUpdate(
string $parentTableClassname, array $oldPrimaryKey, array $newPrimaryKey
)
:
int
Called by a row object for the parent table's class during save() method.
Inherited from: \Zend_Db_Table_Abstract::_cascadeUpdate()Name | Type | Description |
---|---|---|
$parentTableClassname | string | |
$oldPrimaryKey | array | |
$newPrimaryKey | array |
Type | Description |
---|---|
int |

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

_fetch(
\Zend_Db_Table_Select $select
)
:
array
Support method for fetching rows.
Inherited from: \Zend_Db_Table_Abstract::_fetch()Name | Type | Description |
---|---|---|
$select | \Zend_Db_Table_Select | query options. |
Type | Description |
---|---|
array | An array containing the row results in FETCH_ASSOC mode. |

_getCols(
)
:
array
Retrieve table columns
Inherited from: \Zend_Db_Table_Abstract::_getCols()Type | Description |
---|---|
array |

_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 |

_getReferenceMapNormalized(
)
:
array
Returns a normalized version of the reference map
Inherited from: \Zend_Db_Table_Abstract::_getReferenceMapNormalized()Type | Description |
---|---|
array |

_order(
$select, string|array $order
)
:
\Zend_Db_Table_Select
Generate ORDER clause from user-supplied string or array
Inherited from: \Zend_Db_Table_Abstract::_order()Name | Type | Description |
---|---|---|
$select | ||
$order | string|array | OPTIONAL An SQL ORDER clause. |
Type | Description |
---|---|
\Zend_Db_Table_Select |

_setAdapter(
mixed $db
)
:
\Zend_Db_Table_Abstract
Name | Type | Description |
---|---|---|
$db | mixed | Either an Adapter object, or a string naming a Registry key |
Type | Description |
---|---|
\Zend_Db_Table_Abstract | Provides a fluent interface |

_setMetadataCache(
mixed $metadataCache
)
:
\Zend_Db_Table_Abstract
Sets the metadata cache for information returned by Zend_Db_Adapter_Abstract::describeTable().
Inherited from: \Zend_Db_Table_Abstract::_setMetadataCache()If $metadataCache is null, then no metadata cache is used. Since there is no opportunity to reload metadata after instantiation, this method need not be public, particularly because that it would have no effect results in unnecessary API complexity. To configure the metadata cache, use the metadataCache configuration option for the class constructor upon instantiation.
Name | Type | Description |
---|---|---|
$metadataCache | mixed | Either a Cache object, or a string naming a Registry key |
Type | Description |
---|---|
\Zend_Db_Table_Abstract | Provides a fluent interface |

_setSequence(
mixed $sequence
)
:
\Zend_Db_Table_Adapter_Abstract
Sets the sequence member, which defines the behavior for generating primary key values in new rows.
Inherited from: \Zend_Db_Table_Abstract::_setSequence()Name | Type | Description |
---|---|---|
$sequence | mixed |
Type | Description |
---|---|
\Zend_Db_Table_Adapter_Abstract | Provides a fluent interface |

_setup(
)
:
void
Calls other protected methods for individual setup tasks and requirement checks
Calls other protected methods for individual tasks, to make it easier for a subclass to override part of the setup logic.

_setupAdapter(
mixed $db
)
:
\Zend_Db_Adapter_Abstract
Name | Type | Description |
---|---|---|
$db | mixed | Either an Adapter object, or a string naming a Registry key |
Type | Description |
---|---|
\Zend_Db_Adapter_Abstract |
Exception | Description |
---|---|
\Zend_Db_Table_Exception |

_setupDatabaseAdapter(
)
:
void
Initialize database adapter.
Inherited from: \Zend_Db_Table_Abstract::_setupDatabaseAdapter()Exception | Description |
---|---|
\Zend_Db_Table_Exception |

_setupMetadata(
)
:
boolean
Initializes metadata.
Inherited from: \Zend_Db_Table_Abstract::_setupMetadata()If metadata cannot be loaded from cache, adapter's describeTable() method is called to discover metadata information. Returns true if and only if the metadata are loaded from cache.
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Db_Table_Exception |

_setupMetadataCache(
mixed $metadataCache
)
:
\Zend_Cache_Core
Name | Type | Description |
---|---|---|
$metadataCache | mixed | Either a Cache object, or a string naming a Registry key |
Type | Description |
---|---|
\Zend_Cache_Core |
Exception | Description |
---|---|
\Zend_Db_Table_Exception |

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

_setupPrimaryKey(
)
:
void
Initialize primary key from metadata.
Inherited from: \Zend_Db_Table_Abstract::_setupPrimaryKey()If $_primary is not defined, discover primary keys from the information returned by describeTable().
Exception | Description |
---|---|
\Zend_Db_Table_Exception |

_setupTableName(
)
:
void
Initialize table and schema names
If the table name is not set in the class definition, use the class name itself as the table name.
A schema name provided with the table name (e.g., "schema.table") overrides any existing value for $this->_schema.
Exception | Description |
---|---|
\Zend_Session_SaveHandler_Exception |

_where(
$select, string|array $where
)
:
\Zend_Db_Table_Select
Generate WHERE clause from user-supplied string or array
Inherited from: \Zend_Db_Table_Abstract::_where()Name | Type | Description |
---|---|---|
$select | ||
$where | string|array | OPTIONAL An SQL WHERE clause. |
Type | Description |
---|---|
\Zend_Db_Table_Select |

addReference(
string $ruleKey, string|array $columns, string $refTableClass, string|array $refColumns, string $onDelete
=
null, string $onUpdate
=
null
)
:
\Zend_Db_Table_Abstract
Add a reference to the reference map
Inherited from: \Zend_Db_Table_Abstract::addReference()Name | Type | Description |
---|---|---|
$ruleKey | string | |
$columns | string|array | |
$refTableClass | string | |
$refColumns | string|array | |
$onDelete | string | |
$onUpdate | string |
Type | Description |
---|---|
\Zend_Db_Table_Abstract |

createRow(
array $data
=
array, string $defaultSource
=
null
)
:
\Zend_Db_Table_Row_Abstract
Fetches a new blank row (not from the database).
Inherited from: \Zend_Db_Table_Abstract::createRow()Name | Type | Description |
---|---|---|
$data | array | OPTIONAL data to populate in the new row. |
$defaultSource | string | OPTIONAL flag to force default values into new row |
Type | Description |
---|---|
\Zend_Db_Table_Row_Abstract |

delete(
array|string $where
)
:
int
Deletes existing rows.
Inherited from: \Zend_Db_Table_Abstract::delete()Name | Type | Description |
---|---|---|
$where | array|string | SQL WHERE clause(s). |
Type | Description |
---|---|
int | The number of rows deleted. |

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

fetchAll(
string|array|\Zend_Db_Table_Select $where
=
null, string|array $order
=
null, int $count
=
null, int $offset
=
null
)
:
\Zend_Db_Table_Rowset_Abstract
Fetches all rows.
Inherited from: \Zend_Db_Table_Abstract::fetchAll()Honors the Zend_Db_Adapter fetch mode.
Name | Type | Description |
---|---|---|
$where | string|array|\Zend_Db_Table_Select | OPTIONAL An SQL WHERE clause or Zend_Db_Table_Select object. |
$order | string|array | OPTIONAL An SQL ORDER clause. |
$count | int | OPTIONAL An SQL LIMIT count. |
$offset | int | OPTIONAL An SQL LIMIT offset. |
Type | Description |
---|---|
\Zend_Db_Table_Rowset_Abstract | The row results per the Zend_Db_Adapter fetch mode. |

fetchNew(
)
:
\Zend_Db_Table_Row_Abstract
Fetches a new blank row (not from the database).
Inherited from: \Zend_Db_Table_Abstract::fetchNew()Type | Description |
---|---|
\Zend_Db_Table_Row_Abstract |

fetchRow(
string|array|\Zend_Db_Table_Select $where
=
null, string|array $order
=
null, int $offset
=
null
)
:
\Zend_Db_Table_Row_Abstract|null
Fetches one row in an object of type Zend_Db_Table_Row_Abstract, or returns null if no row matches the specified criteria.
Inherited from: \Zend_Db_Table_Abstract::fetchRow()Name | Type | Description |
---|---|---|
$where | string|array|\Zend_Db_Table_Select | OPTIONAL An SQL WHERE clause or Zend_Db_Table_Select object. |
$order | string|array | OPTIONAL An SQL ORDER clause. |
$offset | int | OPTIONAL An SQL OFFSET value. |
Type | Description |
---|---|
\Zend_Db_Table_Row_Abstractnull | The row results per the Zend_Db_Adapter fetch mode, or null if no row found. |

find(
)
:
\Zend_Db_Table_Rowset_Abstract
Fetches rows by primary key. The argument specifies one or more primary key value(s). To find multiple rows by primary key, the argument must be an array.
Inherited from: \Zend_Db_Table_Abstract::find()This method accepts a variable number of arguments. If the table has a multi-column primary key, the number of arguments must be the same as the number of columns in the primary key. To find multiple rows in a table with a multi-column primary key, each argument must be an array with the same number of elements.
The find() method always returns a Rowset object, even if only one row was found.
Type | Description |
---|---|
\Zend_Db_Table_Rowset_Abstract | Row(s) matching the criteria. |
Exception | Description |
---|---|
\Zend_Db_Table_Exception |

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

getAdapter(
)
:
\Zend_Db_Adapter_Abstract
Gets the Zend_Db_Adapter_Abstract for this particular Zend_Db_Table object.
Inherited from: \Zend_Db_Table_Abstract::getAdapter()Type | Description |
---|---|
\Zend_Db_Adapter_Abstract |

getDefaultAdapter(
)
:
\Zend_Db_Adapter_Abstract
Gets the default Zend_Db_Adapter_Abstract for all Zend_Db_Table objects.
Inherited from: \Zend_Db_Table_Abstract::getDefaultAdapter()Type | Description |
---|---|
\Zend_Db_Adapter_Abstract | or null |

getDefaultMetadataCache(
)
:
\Zend_Cache_Core
Gets the default metadata cache for information returned by Zend_Db_Adapter_Abstract::describeTable().
Inherited from: \Zend_Db_Table_Abstract::getDefaultMetadataCache()Type | Description |
---|---|
\Zend_Cache_Core | or null |

getDefaultSource(
)
:
\unknown
returns the default source flag that determines where defaultSources come from
Inherited from: \Zend_Db_Table_Abstract::getDefaultSource()Type | Description |
---|---|
\unknown |

getDefinition(
)
:
\Zend_Db_Table_Definition|null
getDefinition()
Inherited from: \Zend_Db_Table_Abstract::getDefinition()Type | Description |
---|---|
\Zend_Db_Table_Definitionnull |

getDefinitionConfigName(
)
:
string
getDefinitionConfigName()
Inherited from: \Zend_Db_Table_Abstract::getDefinitionConfigName()Type | Description |
---|---|
string |

getDependentTables(
)
:
array
Type | Description |
---|---|
array |

getMetadataCache(
)
:
\Zend_Cache_Core
Gets the metadata cache for information returned by Zend_Db_Adapter_Abstract::describeTable().
Inherited from: \Zend_Db_Table_Abstract::getMetadataCache()Type | Description |
---|---|
\Zend_Cache_Core | or null |

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

getReference(
string $tableClassname, string $ruleKey
=
null
)
:
array
Name | Type | Description |
---|---|---|
$tableClassname | string | |
$ruleKey | string | OPTIONAL |
Type | Description |
---|---|
array |
Exception | Description |
---|---|
\Zend_Db_Table_Exception |

getRowClass(
)
:
string
Type | Description |
---|---|
string |

getRowsetClass(
)
:
string
Type | Description |
---|---|
string |

info(
string $key
=
null
)
:
mixed
Returns table information.
Inherited from: \Zend_Db_Table_Abstract::info()You can elect to return only a part of this information by supplying its key name, otherwise all information is returned as an array.
Name | Type | Description |
---|---|---|
$key | string | The specific info part to return OPTIONAL |
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\Zend_Db_Table_Exception |

init(
)
:
void
Initialize object
Inherited from: \Zend_Db_Table_Abstract::init()Called from {@link __construct()} as final step of object instantiation.

insert(
array $data
)
:
mixed
Inserts a new row.
Inherited from: \Zend_Db_Table_Abstract::insert()Name | Type | Description |
---|---|---|
$data | array | Column-value pairs. |
Type | Description |
---|---|
mixed | The primary key of the row inserted. |

isIdentity(
string $column
)
:
boolean
Check if the provided column is an identity of the table
Inherited from: \Zend_Db_Table_Abstract::isIdentity()Name | Type | Description |
---|---|---|
$column | string |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Db_Table_Exception |

metadataCacheInClass(
)
:
bool
Retrieve flag indicating if metadata should be cached for duration of instance
Inherited from: \Zend_Db_Table_Abstract::metadataCacheInClass()Type | Description |
---|---|
bool |

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 |

select(
bool $withFromPart
=
self
)
:
\Zend_Db_Table_Select
Returns an instance of a Zend_Db_Table_Select object.
Inherited from: \Zend_Db_Table_Abstract::select()Name | Type | Description |
---|---|---|
$withFromPart | bool | Whether or not to include the from part of the select based on the table |
Type | Description |
---|---|
\Zend_Db_Table_Select |

setDefaultAdapter(
mixed $db
=
null
)
:
void
Sets the default Zend_Db_Adapter_Abstract for all Zend_Db_Table objects.
Inherited from: \Zend_Db_Table_Abstract::setDefaultAdapter()Name | Type | Description |
---|---|---|
$db | mixed | Either an Adapter object, or a string naming a Registry key |

setDefaultMetadataCache(
mixed $metadataCache
=
null
)
:
void
Sets the default metadata cache for information returned by Zend_Db_Adapter_Abstract::describeTable().
Inherited from: \Zend_Db_Table_Abstract::setDefaultMetadataCache()If $defaultMetadataCache is null, then no metadata cache is used by default.
Name | Type | Description |
---|---|---|
$metadataCache | mixed | Either a Cache object, or a string naming a Registry key |

setDefaultSource(
string $defaultSource
=
self
)
:
\Zend_Db_Table_Abstract
set the defaultSource property - this tells the table class where to find default values
Inherited from: \Zend_Db_Table_Abstract::setDefaultSource()Name | Type | Description |
---|---|---|
$defaultSource | string |
Type | Description |
---|---|
\Zend_Db_Table_Abstract |

setDefaultValues(
array $defaultValues
)
:
\Zend_Db_Table_Abstract
set the default values for the table class
Inherited from: \Zend_Db_Table_Abstract::setDefaultValues()Name | Type | Description |
---|---|---|
$defaultValues | array |
Type | Description |
---|---|
\Zend_Db_Table_Abstract |

setDefinition(
\Zend_Db_Table_Definition $definition
)
:
\Zend_Db_Table_Abstract
setDefinition()
Inherited from: \Zend_Db_Table_Abstract::setDefinition()Name | Type | Description |
---|---|---|
$definition | \Zend_Db_Table_Definition |
Type | Description |
---|---|
\Zend_Db_Table_Abstract |

setDefinitionConfigName(
$definitionConfigName
)
:
\Zend_Db_Table_Abstract
setDefinitionConfigName()
Inherited from: \Zend_Db_Table_Abstract::setDefinitionConfigName()Name | Type | Description |
---|---|---|
$definitionConfigName |
Type | Description |
---|---|
\Zend_Db_Table_Abstract |

setDependentTables(
array $dependentTables
)
:
\Zend_Db_Table_Abstract
Name | Type | Description |
---|---|---|
$dependentTables | array |
Type | Description |
---|---|
\Zend_Db_Table_Abstract | Provides a fluent interface |

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 |

setMetadataCacheInClass(
bool $flag
)
:
\Zend_Db_Table_Abstract
Indicate whether metadata should be cached in the class for the duration of the instance
Inherited from: \Zend_Db_Table_Abstract::setMetadataCacheInClass()
setOptions(
array $options
)
:
\Zend_Db_Table_Abstract
setOptions()
Inherited from: \Zend_Db_Table_Abstract::setOptions()
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 |

setReferences(
array $referenceMap
)
:
\Zend_Db_Table_Abstract
Name | Type | Description |
---|---|---|
$referenceMap | array |
Type | Description |
---|---|
\Zend_Db_Table_Abstract | Provides a fluent interface |

setRowClass(
string $classname
)
:
\Zend_Db_Table_Abstract
Name | Type | Description |
---|---|---|
$classname | string |
Type | Description |
---|---|
\Zend_Db_Table_Abstract | Provides a fluent interface |

setRowsetClass(
string $classname
)
:
\Zend_Db_Table_Abstract
Name | Type | Description |
---|---|---|
$classname | string |
Type | Description |
---|---|
\Zend_Db_Table_Abstract | Provides a fluent interface |

update(
array $data, array|string $where
)
:
int
Updates existing rows.
Inherited from: \Zend_Db_Table_Abstract::update()Name | Type | Description |
---|---|---|
$data | array | Column-value pairs. |
$where | array|string | An SQL WHERE clause, or an array of SQL WHERE clauses. |
Type | Description |
---|---|
int | The number of rows updated. |