Session/SaveHandler/DbTable.php

Show:

inherited

Classes
- \Zend_Session_SaveHandler_DbTable

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Session
Version: $Id: DbTable.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Session_SaveHandler_DbTable
jump to top

Package: Zend\Session\SaveHandler

Zend_Session_SaveHandler_DbTable

Implements: \Zend_Session_SaveHandler_Interface
Parent(s): \Zend_Db_Table_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                PRIMARY_ASSIGNMENT
                = 'primaryAssignment'

 
                PRIMARY_ASSIGNMENT_SESSION_SAVE_PATH
                = 'sessionSavePath'

 
                PRIMARY_ASSIGNMENT_SESSION_NAME
                = 'sessionName'

 
                PRIMARY_ASSIGNMENT_SESSION_ID
                = 'sessionId'

 
                MODIFIED_COLUMN
                = 'modifiedColumn'

 
                LIFETIME_COLUMN
                = 'lifetimeColumn'

 
                DATA_COLUMN
                = 'dataColumn'

 
                LIFETIME
                = 'lifetime'

 
                OVERRIDE_LIFETIME
                = 'overrideLifetime'

 
                PRIMARY_TYPE_NUM
                = 'PRIMARY_TYPE_NUM'

 
                PRIMARY_TYPE_PRIMARYNUM
                = 'PRIMARY_TYPE_PRIMARYNUM'

 
                PRIMARY_TYPE_ASSOC
                = 'PRIMARY_TYPE_ASSOC'

 
                PRIMARY_TYPE_WHERECLAUSE
                = 'PRIMARY_TYPE_WHERECLAUSE'

 
                ADAPTER
                = 'db'

inheritedInherited from: \Zend_Db_Table_Abstract::ADAPTER

Inherited_from: \Zend_Db_Table_Abstract::ADAPTER

 
                DEFINITION
                = 'definition'

inheritedInherited from: \Zend_Db_Table_Abstract::DEFINITION

Inherited_from: \Zend_Db_Table_Abstract::DEFINITION

 
                DEFINITION_CONFIG_NAME
                = 'definitionConfigName'

inheritedInherited from: \Zend_Db_Table_Abstract::DEFINITION_CONFIG_NAME

Inherited_from: \Zend_Db_Table_Abstract::DEFINITION_CONFIG_NAME

 
                SCHEMA
                = 'schema'

inheritedInherited from: \Zend_Db_Table_Abstract::SCHEMA

Inherited_from: \Zend_Db_Table_Abstract::SCHEMA

 
                NAME
                = 'name'

inheritedInherited from: \Zend_Db_Table_Abstract::NAME

Inherited_from: \Zend_Db_Table_Abstract::NAME

 
                PRIMARY
                = 'primary'

inheritedInherited from: \Zend_Db_Table_Abstract::PRIMARY

Inherited_from: \Zend_Db_Table_Abstract::PRIMARY

 
                COLS
                = 'cols'

inheritedInherited from: \Zend_Db_Table_Abstract::COLS

Inherited_from: \Zend_Db_Table_Abstract::COLS

 
                METADATA
                = 'metadata'

inheritedInherited from: \Zend_Db_Table_Abstract::METADATA

Inherited_from: \Zend_Db_Table_Abstract::METADATA

 
                METADATA_CACHE
                = 'metadataCache'

inheritedInherited from: \Zend_Db_Table_Abstract::METADATA_CACHE

Inherited_from: \Zend_Db_Table_Abstract::METADATA_CACHE

 
                METADATA_CACHE_IN_CLASS
                = 'metadataCacheInClass'

inheritedInherited from: \Zend_Db_Table_Abstract::METADATA_CACHE_IN_CLASS

Inherited_from: \Zend_Db_Table_Abstract::METADATA_CACHE_IN_CLASS

 
                ROW_CLASS
                = 'rowClass'

inheritedInherited from: \Zend_Db_Table_Abstract::ROW_CLASS

Inherited_from: \Zend_Db_Table_Abstract::ROW_CLASS

 
                ROWSET_CLASS
                = 'rowsetClass'

inheritedInherited from: \Zend_Db_Table_Abstract::ROWSET_CLASS

Inherited_from: \Zend_Db_Table_Abstract::ROWSET_CLASS

 
                REFERENCE_MAP
                = 'referenceMap'

inheritedInherited from: \Zend_Db_Table_Abstract::REFERENCE_MAP

Inherited_from: \Zend_Db_Table_Abstract::REFERENCE_MAP

 
                DEPENDENT_TABLES
                = 'dependentTables'

inheritedInherited from: \Zend_Db_Table_Abstract::DEPENDENT_TABLES

Inherited_from: \Zend_Db_Table_Abstract::DEPENDENT_TABLES

 
                SEQUENCE
                = 'sequence'

inheritedInherited from: \Zend_Db_Table_Abstract::SEQUENCE

Inherited_from: \Zend_Db_Table_Abstract::SEQUENCE

 
                COLUMNS
                = 'columns'

inheritedInherited from: \Zend_Db_Table_Abstract::COLUMNS

Inherited_from: \Zend_Db_Table_Abstract::COLUMNS

 
                REF_TABLE_CLASS
                = 'refTableClass'

inheritedInherited from: \Zend_Db_Table_Abstract::REF_TABLE_CLASS

Inherited_from: \Zend_Db_Table_Abstract::REF_TABLE_CLASS

 
                REF_COLUMNS
                = 'refColumns'

inheritedInherited from: \Zend_Db_Table_Abstract::REF_COLUMNS

Inherited_from: \Zend_Db_Table_Abstract::REF_COLUMNS

 
                ON_DELETE
                = 'onDelete'

inheritedInherited from: \Zend_Db_Table_Abstract::ON_DELETE

Inherited_from: \Zend_Db_Table_Abstract::ON_DELETE

 
                ON_UPDATE
                = 'onUpdate'

inheritedInherited from: \Zend_Db_Table_Abstract::ON_UPDATE

Inherited_from: \Zend_Db_Table_Abstract::ON_UPDATE

 
                CASCADE
                = 'cascade'

inheritedInherited from: \Zend_Db_Table_Abstract::CASCADE

Inherited_from: \Zend_Db_Table_Abstract::CASCADE

 
                CASCADE_RECURSE
                = 'cascadeRecurse'

inheritedInherited from: \Zend_Db_Table_Abstract::CASCADE_RECURSE

Inherited_from: \Zend_Db_Table_Abstract::CASCADE_RECURSE

 
                RESTRICT
                = 'restrict'

inheritedInherited from: \Zend_Db_Table_Abstract::RESTRICT

Inherited_from: \Zend_Db_Table_Abstract::RESTRICT

 
                SET_NULL
                = 'setNull'

inheritedInherited from: \Zend_Db_Table_Abstract::SET_NULL

Inherited_from: \Zend_Db_Table_Abstract::SET_NULL

 
                DEFAULT_NONE
                = 'defaultNone'

inheritedInherited from: \Zend_Db_Table_Abstract::DEFAULT_NONE

Inherited_from: \Zend_Db_Table_Abstract::DEFAULT_NONE

 
                DEFAULT_CLASS
                = 'defaultClass'

inheritedInherited from: \Zend_Db_Table_Abstract::DEFAULT_CLASS

Inherited_from: \Zend_Db_Table_Abstract::DEFAULT_CLASS

 
                DEFAULT_DB
                = 'defaultDb'

inheritedInherited from: \Zend_Db_Table_Abstract::DEFAULT_DB

Inherited_from: \Zend_Db_Table_Abstract::DEFAULT_DB

 
                SELECT_WITH_FROM_PART
                = true

inheritedInherited from: \Zend_Db_Table_Abstract::SELECT_WITH_FROM_PART

Inherited_from: \Zend_Db_Table_Abstract::SELECT_WITH_FROM_PART

 
                SELECT_WITHOUT_FROM_PART
                = false

inheritedInherited from: \Zend_Db_Table_Abstract::SELECT_WITHOUT_FROM_PART

Inherited_from: \Zend_Db_Table_Abstract::SELECT_WITHOUT_FROM_PART

Properties

array $_cols =

inherited

The table column names derived from Zend_Db_Adapter_Abstract::describeTable().

Inherited from: \Zend_Db_Table_Abstract::$$_cols

Details

Type: array
Inherited_from: \Zend_Db_Table_Abstract::$$_cols

string $_dataColumn = null

Session table data column

Default valuenullDetails

Type: string

\Zend_Db_Adapter_Abstract $_db =

inherited

Zend_Db_Adapter_Abstract object.

Inherited from: \Zend_Db_Table_Abstract::$$_db

Details

Type: \Zend_Db_Adapter_Abstract
Inherited_from: \Zend_Db_Table_Abstract::$$_db

\Zend_Db_Adapter_Abstract $_defaultDb =

staticinherited

Default Zend_Db_Adapter_Abstract object.

Inherited from: \Zend_Db_Table_Abstract::$$_defaultDb

Details

Type: \Zend_Db_Adapter_Abstract
Inherited_from: \Zend_Db_Table_Abstract::$$_defaultDb

\Zend_Cache_Core $_defaultMetadataCache = null

staticinherited

Default cache for information provided by the adapter's describeTable() method.

Inherited from: \Zend_Db_Table_Abstract::$$_defaultMetadataCache

Default valuenullDetails

Type: \Zend_Cache_Core
Inherited_from: \Zend_Db_Table_Abstract::$$_defaultMetadataCache

$_defaultSource = self::DEFAULT_NONE

inheritedInherited from: \Zend_Db_Table_Abstract::$$_defaultSource

Default valueself::DEFAULT_NONEDetails

Type: n/a
Inherited_from: \Zend_Db_Table_Abstract::$$_defaultSource

$_defaultValues = array()

inheritedInherited from: \Zend_Db_Table_Abstract::$$_defaultValues

Default valuearray()Details

Type: n/a
Inherited_from: \Zend_Db_Table_Abstract::$$_defaultValues

\unknown_type $_definition = null

inherited

Optional Zend_Db_Table_Definition object

Inherited from: \Zend_Db_Table_Abstract::$$_definition

Default valuenullDetails

Type: \unknown_type
Inherited_from: \Zend_Db_Table_Abstract::$$_definition

string $_definitionConfigName = null

inherited

Optional definition config name used in concrete implementation

Inherited from: \Zend_Db_Table_Abstract::$$_definitionConfigName

Default valuenullDetails

Type: string
Inherited_from: \Zend_Db_Table_Abstract::$$_definitionConfigName

array $_dependentTables = array()

inherited

Simple array of class names of tables that are "children" of the current table, in other words tables that contain a foreign key to this one.

Inherited from: \Zend_Db_Table_Abstract::$$_dependentTables

Array elements are not table names; they are class names of classes that extend Zend_Db_Table_Abstract.

Default valuearray()Details

Type: array
Inherited_from: \Zend_Db_Table_Abstract::$$_dependentTables

integer $_identity = 1

inherited

If your primary key is a compound key, and one of the columns uses an auto-increment or sequence-generated value, set _identity to the ordinal index in the $_primary array for that column.

Inherited from: \Zend_Db_Table_Abstract::$$_identity

Note this index is the position of the column in the primary key, not the position of the column in the table. The primary key array is 1-based.

Default value1Details

Type: integer
Inherited_from: \Zend_Db_Table_Abstract::$$_identity

int $_lifetime = false

Session lifetime

Default valuefalseDetails

Type: int

string $_lifetimeColumn = null

Session table lifetime column

Default valuenullDetails

Type: string

array $_metadata = array()

inherited

Information provided by the adapter's describeTable() method.

Inherited from: \Zend_Db_Table_Abstract::$$_metadata

Default valuearray()Details

Type: array
Inherited_from: \Zend_Db_Table_Abstract::$$_metadata

\Zend_Cache_Core $_metadataCache = null

inherited

Cache for information provided by the adapter's describeTable() method.

Inherited from: \Zend_Db_Table_Abstract::$$_metadataCache

Default valuenullDetails

Type: \Zend_Cache_Core
Inherited_from: \Zend_Db_Table_Abstract::$$_metadataCache

bool $_metadataCacheInClass = true

inherited

Flag: whether or not to cache metadata in the class

Inherited from: \Zend_Db_Table_Abstract::$$_metadataCacheInClass

Default valuetrueDetails

Type: bool
Inherited_from: \Zend_Db_Table_Abstract::$$_metadataCacheInClass

string $_modifiedColumn = null

Session table last modification time column

Default valuenullDetails

Type: string

string $_name = null

inherited

The table name.

Inherited from: \Zend_Db_Table_Abstract::$$_name

Default valuenullDetails

Type: string
Inherited_from: \Zend_Db_Table_Abstract::$$_name

boolean $_overrideLifetime = false

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

Default valuefalseDetails

Type: boolean

mixed $_primary = null

inherited

The primary key column or columns.

Inherited from: \Zend_Db_Table_Abstract::$$_primary

A compound key should be declared as an array. You may declare a single-column primary key as a string.

Default valuenullDetails

Type: mixed
Inherited_from: \Zend_Db_Table_Abstract::$$_primary

array $_primaryAssignment = null

Session table primary key value assignment

Default valuenullDetails

Type: array

array $_referenceMap = array()

inherited

Associative array map of declarative referential integrity rules.

Inherited from: \Zend_Db_Table_Abstract::$$_referenceMap

This array has one entry per foreign key in the current table. Each key is a mnemonic name for one reference rule.

Each value is also an associative array, with the following keys: - columns = array of names of column(s) in the child table. - refTableClass = class name of the parent table. - refColumns = array of names of column(s) in the parent table, in the same order as those in the 'columns' entry. - onDelete = "cascade" means that a delete in the parent table also causes a delete of referencing rows in the child table. - onUpdate = "cascade" means that an update of primary key values in the parent table also causes an update of referencing rows in the child table.

Default valuearray()Details

Type: array
Inherited_from: \Zend_Db_Table_Abstract::$$_referenceMap

string $_rowClass = 'Zend_Db_Table_Row'

inherited

Classname for row

Inherited from: \Zend_Db_Table_Abstract::$$_rowClass

Default value'Zend_Db_Table_Row'Details

Type: string
Inherited_from: \Zend_Db_Table_Abstract::$$_rowClass

string $_rowsetClass = 'Zend_Db_Table_Rowset'

inherited

Classname for rowset

Inherited from: \Zend_Db_Table_Abstract::$$_rowsetClass

Default value'Zend_Db_Table_Rowset'Details

Type: string
Inherited_from: \Zend_Db_Table_Abstract::$$_rowsetClass

array $_schema = null

inherited

The schema name (default null means current schema)

Inherited from: \Zend_Db_Table_Abstract::$$_schema

Default valuenullDetails

Type: array
Inherited_from: \Zend_Db_Table_Abstract::$$_schema

mixed $_sequence = true

inherited

Define the logic for new values in the primary key.

Inherited from: \Zend_Db_Table_Abstract::$$_sequence

May be a string, boolean true, or boolean false.

Default valuetrueDetails

Type: mixed
Inherited_from: \Zend_Db_Table_Abstract::$$_sequence

string $_sessionName =

Session name

Details

Type: string

string $_sessionSavePath =

Session save path

Details

Type: string

Methods

__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

Name	Type	Description
$config	\Zend_Config \| array	User-provided configuration

Throws

Exception	Description
\Zend_Session_SaveHandler_Exception

__destruct() : void

Destructor

_cascadeDelete(string $parentTableClassname, array $primaryKey) : int

inherited

Called by parent table's class during delete() method.

Inherited from: \Zend_Db_Table_Abstract::_cascadeDelete()

Parameters

Name	Type	Description
$parentTableClassname	string
$primaryKey	array

Returns

Type	Description
int	Number of affected rows

_cascadeUpdate(string $parentTableClassname, array $oldPrimaryKey, array $newPrimaryKey) : int

inherited

Called by a row object for the parent table's class during save() method.

Inherited from: \Zend_Db_Table_Abstract::_cascadeUpdate()

Parameters

Name	Type	Description
$parentTableClassname	string
$oldPrimaryKey	array
$newPrimaryKey	array

Returns

Type	Description
int

_checkRequiredColumns() : void

Check for required session table columns

Throws

Exception	Description
\Zend_Session_SaveHandler_Exception

_fetch(\Zend_Db_Table_Select $select) : array

inherited

Support method for fetching rows.

Inherited from: \Zend_Db_Table_Abstract::_fetch()

Parameters

Name	Type	Description
$select	\Zend_Db_Table_Select	query options.

Returns

Type	Description
array	An array containing the row results in FETCH_ASSOC mode.

_getCols() : array

inherited

Retrieve table columns

Inherited from: \Zend_Db_Table_Abstract::_getCols()

Returns

Type	Description
array

_getExpirationTime(\Zend_Db_Table_Row_Abstract $row) : int

Retrieve session expiration time

Parameters

Name	Type	Description
$row	\Zend_Db_Table_Row_Abstract

Returns

Type	Description
int

_getLifetime(\Zend_Db_Table_Row_Abstract $row) : int

Retrieve session lifetime considering Zend_Session_SaveHandler_DbTable::OVERRIDE_LIFETIME

Parameters

Name	Type	Description
$row	\Zend_Db_Table_Row_Abstract

Returns

Type	Description
int

_getPrimary(string $id, string $type = null) : array

Retrieve session table primary key values

Parameters

Name	Type	Description
$id	string
$type	string	(optional; default: self::PRIMARY_TYPE_NUM)

Returns

Type	Description
array

_getReferenceMapNormalized() : array

inherited

Returns a normalized version of the reference map

Inherited from: \Zend_Db_Table_Abstract::_getReferenceMapNormalized()

Returns

Type	Description
array

_order( $select, string | array $order) : \Zend_Db_Table_Select

inherited

Generate ORDER clause from user-supplied string or array

Inherited from: \Zend_Db_Table_Abstract::_order()

Parameters

Name	Type	Description
$select
$order	string \| array	OPTIONAL An SQL ORDER clause.

Returns

Type	Description
\Zend_Db_Table_Select

_setAdapter(mixed $db) : \Zend_Db_Table_Abstract

inherited

Inherited from: \Zend_Db_Table_Abstract::_setAdapter()

Parameters

Name	Type	Description
$db	mixed	Either an Adapter object, or a string naming a Registry key

Returns

Type	Description
\Zend_Db_Table_Abstract	Provides a fluent interface

_setMetadataCache(mixed $metadataCache) : \Zend_Db_Table_Abstract

inherited

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.

Parameters

Name	Type	Description
$metadataCache	mixed	Either a Cache object, or a string naming a Registry key

Returns

Type	Description
\Zend_Db_Table_Abstract	Provides a fluent interface

_setSequence(mixed $sequence) : \Zend_Db_Table_Adapter_Abstract

inherited

Sets the sequence member, which defines the behavior for generating primary key values in new rows.

Inherited from: \Zend_Db_Table_Abstract::_setSequence()

If this is a string, then the string names the sequence object.
If this is boolean true, then the key uses an auto-incrementing or identity mechanism.
If this is boolean false, then the key is user-defined. Use this for natural keys, for example.

Parameters

Name	Type	Description
$sequence	mixed

Returns

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

staticinherited

Inherited from: \Zend_Db_Table_Abstract::_setupAdapter()

Parameters

Name	Type	Description
$db	mixed	Either an Adapter object, or a string naming a Registry key

Returns

Type	Description
\Zend_Db_Adapter_Abstract

Throws

Exception	Description
\Zend_Db_Table_Exception

_setupDatabaseAdapter() : void

inherited

Initialize database adapter.

Inherited from: \Zend_Db_Table_Abstract::_setupDatabaseAdapter()

Throws

Exception	Description
\Zend_Db_Table_Exception

_setupMetadata() : boolean

inherited

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.

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Db_Table_Exception

_setupMetadataCache(mixed $metadataCache) : \Zend_Cache_Core

staticinherited

Inherited from: \Zend_Db_Table_Abstract::_setupMetadataCache()

Parameters

Name	Type	Description
$metadataCache	mixed	Either a Cache object, or a string naming a Registry key

Returns

Type	Description
\Zend_Cache_Core

Throws

Exception	Description
\Zend_Db_Table_Exception

_setupPrimaryAssignment() : void

Initialize session table primary key value assignment

Throws

Exception	Description
\Zend_Session_SaveHandler_Exception

_setupPrimaryKey() : void

inherited

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().

Throws

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.

Throws

Exception	Description
\Zend_Session_SaveHandler_Exception

_where( $select, string | array $where) : \Zend_Db_Table_Select

inherited

Generate WHERE clause from user-supplied string or array

Inherited from: \Zend_Db_Table_Abstract::_where()

Parameters

Name	Type	Description
$select
$where	string \| array	OPTIONAL An SQL WHERE clause.

Returns

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

inherited

Add a reference to the reference map

Inherited from: \Zend_Db_Table_Abstract::addReference()

Parameters

Name	Type	Description
$ruleKey	string
$columns	string \| array
$refTableClass	string
$refColumns	string \| array
$onDelete	string
$onUpdate	string

Returns

Type	Description
\Zend_Db_Table_Abstract

close() : boolean

Close session

Returns

Type	Description
boolean

createRow(array $data = array(), string $defaultSource = null) : \Zend_Db_Table_Row_Abstract

inherited

Fetches a new blank row (not from the database).

Inherited from: \Zend_Db_Table_Abstract::createRow()

Parameters

Name	Type	Description
$data	array	OPTIONAL data to populate in the new row.
$defaultSource	string	OPTIONAL flag to force default values into new row

Returns

Type	Description
\Zend_Db_Table_Row_Abstract

delete(array | string $where) : int

inherited

Deletes existing rows.

Inherited from: \Zend_Db_Table_Abstract::delete()

Parameters

Name	Type	Description
$where	array \| string	SQL WHERE clause(s).

Returns

Type	Description
int	The number of rows deleted.

destroy(string $id) : boolean

Destroy session

Parameters

Name	Type	Description
$id	string

Returns

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

inherited

Fetches all rows.

Inherited from: \Zend_Db_Table_Abstract::fetchAll()

Honors the Zend_Db_Adapter fetch mode.

Parameters

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.

Returns

Type	Description
\Zend_Db_Table_Rowset_Abstract	The row results per the Zend_Db_Adapter fetch mode.

fetchNew() : \Zend_Db_Table_Row_Abstract

inherited

Fetches a new blank row (not from the database).

Inherited from: \Zend_Db_Table_Abstract::fetchNew()

Returns

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

inherited

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()

Parameters

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.

Returns

Type	Description
\Zend_Db_Table_Row_Abstract \| null	The row results per the Zend_Db_Adapter fetch mode, or null if no row found.

find() : \Zend_Db_Table_Rowset_Abstract

inherited

Fetches rows by primary key.

Inherited from: \Zend_Db_Table_Abstract::find()

The argument specifies one or more primary key value(s). To find multiple rows by primary key, the argument must be an array.

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.

Returns

Type	Description
\Zend_Db_Table_Rowset_Abstract	Row(s) matching the criteria.

Throws

Exception	Description
\Zend_Db_Table_Exception

gc(int $maxlifetime) : true

Garbage Collection

Parameters

Name	Type	Description
$maxlifetime	int

Returns

Type	Description
true

getAdapter() : \Zend_Db_Adapter_Abstract

inherited

Gets the Zend_Db_Adapter_Abstract for this particular Zend_Db_Table object.

Inherited from: \Zend_Db_Table_Abstract::getAdapter()

Returns

Type	Description
\Zend_Db_Adapter_Abstract

getDefaultAdapter() : \Zend_Db_Adapter_Abstract

staticinherited

Gets the default Zend_Db_Adapter_Abstract for all Zend_Db_Table objects.

Inherited from: \Zend_Db_Table_Abstract::getDefaultAdapter()

Returns

Type	Description
\Zend_Db_Adapter_Abstract	or null

getDefaultMetadataCache() : \Zend_Cache_Core

staticinherited

Gets the default metadata cache for information returned by Zend_Db_Adapter_Abstract::describeTable().

Inherited from: \Zend_Db_Table_Abstract::getDefaultMetadataCache()

Returns

Type	Description
\Zend_Cache_Core	or null

getDefaultSource() : \unknown

inherited

returns the default source flag that determines where defaultSources come from

Inherited from: \Zend_Db_Table_Abstract::getDefaultSource()

Returns

Type	Description
\unknown

getDefaultValues() : void

inherited

Inherited from: \Zend_Db_Table_Abstract::getDefaultValues()

getDefinition() : \Zend_Db_Table_Definition | null

inherited

getDefinition()

Inherited from: \Zend_Db_Table_Abstract::getDefinition()

Returns

Type	Description
\Zend_Db_Table_Definition \| null

getDefinitionConfigName() : string

inherited

getDefinitionConfigName()

Inherited from: \Zend_Db_Table_Abstract::getDefinitionConfigName()

Returns

Type	Description
string

getDependentTables() : array

inherited

Inherited from: \Zend_Db_Table_Abstract::getDependentTables()

Returns

Type	Description
array

getLifetime() : int

Retrieve session lifetime

Returns

Type	Description
int

getMetadataCache() : \Zend_Cache_Core

inherited

Gets the metadata cache for information returned by Zend_Db_Adapter_Abstract::describeTable().

Inherited from: \Zend_Db_Table_Abstract::getMetadataCache()

Returns

Type	Description
\Zend_Cache_Core	or null

getOverrideLifetime() : boolean

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

Returns

Type	Description
boolean

getReference(string $tableClassname, string $ruleKey = null) : array

inherited

Inherited from: \Zend_Db_Table_Abstract::getReference()

Parameters

Name	Type	Description
$tableClassname	string
$ruleKey	string	OPTIONAL

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Db_Table_Exception

getRowClass() : string

inherited

Inherited from: \Zend_Db_Table_Abstract::getRowClass()

Returns

Type	Description
string

getRowsetClass() : string

inherited

Inherited from: \Zend_Db_Table_Abstract::getRowsetClass()

Returns

Type	Description
string

getTableFromString( $tableName, $referenceTable = null) : void

staticinherited

Inherited from: \Zend_Db_Table_Abstract::getTableFromString()

Parameters

Name	Type	Description
$tableName
$referenceTable

info(string $key = null) : mixed

inherited

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.

Parameters

Name	Type	Description
$key	string	The specific info part to return OPTIONAL

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Db_Table_Exception

init() : void

inherited

Initialize object

Inherited from: \Zend_Db_Table_Abstract::init()

Called from __construct() as final step of object instantiation.

insert(array $data) : mixed

inherited

Inserts a new row.

Inherited from: \Zend_Db_Table_Abstract::insert()

Parameters

Name	Type	Description
$data	array	Column-value pairs.

Returns

Type	Description
mixed	The primary key of the row inserted.

isIdentity(string $column) : boolean

inherited

Check if the provided column is an identity of the table

Inherited from: \Zend_Db_Table_Abstract::isIdentity()

Parameters

Name	Type	Description
$column	string

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Db_Table_Exception

metadataCacheInClass() : bool

inherited

Retrieve flag indicating if metadata should be cached for duration of instance

Inherited from: \Zend_Db_Table_Abstract::metadataCacheInClass()

Returns

Type	Description
bool

open(string $save_path, string $name) : boolean

Open Session

Parameters

Name	Type	Description
$save_path	string
$name	string

Returns

Type	Description
boolean

read(string $id) : string

Read session data

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
string

select(bool $withFromPart = self::SELECT_WITHOUT_FROM_PART) : \Zend_Db_Table_Select

inherited

Returns an instance of a Zend_Db_Table_Select object.

Inherited from: \Zend_Db_Table_Abstract::select()

Parameters

Name	Type	Description
$withFromPart	bool	Whether or not to include the from part of the select based on the table

Returns

Type	Description
\Zend_Db_Table_Select

setDefaultAdapter(mixed $db = null) : void

staticinherited

Sets the default Zend_Db_Adapter_Abstract for all Zend_Db_Table objects.

Inherited from: \Zend_Db_Table_Abstract::setDefaultAdapter()

Parameters

Name	Type	Description
$db	mixed	Either an Adapter object, or a string naming a Registry key

setDefaultMetadataCache(mixed $metadataCache = null) : void

staticinherited

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.

Parameters

Name	Type	Description
$metadataCache	mixed	Either a Cache object, or a string naming a Registry key

setDefaultSource(string $defaultSource = self::DEFAULT_NONE) : \Zend_Db_Table_Abstract

inherited

set the defaultSource property - this tells the table class where to find default values

Inherited from: \Zend_Db_Table_Abstract::setDefaultSource()

Parameters

Name	Type	Description
$defaultSource	string

Returns

Type	Description
\Zend_Db_Table_Abstract

setDefaultValues(array $defaultValues) : \Zend_Db_Table_Abstract

inherited

set the default values for the table class

Inherited from: \Zend_Db_Table_Abstract::setDefaultValues()

Parameters

Name	Type	Description
$defaultValues	array

Returns

Type	Description
\Zend_Db_Table_Abstract

setDefinition(\Zend_Db_Table_Definition $definition) : \Zend_Db_Table_Abstract

inherited

setDefinition()

Inherited from: \Zend_Db_Table_Abstract::setDefinition()

Parameters

Name	Type	Description
$definition	\Zend_Db_Table_Definition

Returns

Type	Description
\Zend_Db_Table_Abstract

setDefinitionConfigName( $definitionConfigName) : \Zend_Db_Table_Abstract

inherited

setDefinitionConfigName()

Inherited from: \Zend_Db_Table_Abstract::setDefinitionConfigName()

Parameters

Name	Type	Description
$definitionConfigName

Returns

Type	Description
\Zend_Db_Table_Abstract

setDependentTables(array $dependentTables) : \Zend_Db_Table_Abstract

inherited

Inherited from: \Zend_Db_Table_Abstract::setDependentTables()

Parameters

Name	Type	Description
$dependentTables	array

Returns

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

Parameters

Name	Type	Description
$lifetime	int
$overrideLifetime	boolean	(optional)

Returns

Type	Description
\Zend_Session_SaveHandler_DbTable

setMetadataCacheInClass(bool $flag) : \Zend_Db_Table_Abstract

inherited

Indicate whether metadata should be cached in the class for the duration of the instance

Inherited from: \Zend_Db_Table_Abstract::setMetadataCacheInClass()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Db_Table_Abstract

setOptions(array $options) : \Zend_Db_Table_Abstract

inherited

setOptions()

Inherited from: \Zend_Db_Table_Abstract::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Db_Table_Abstract

setOverrideLifetime(boolean $overrideLifetime) : \Zend_Session_SaveHandler_DbTable

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

Parameters

Name	Type	Description
$overrideLifetime	boolean

Returns

Type	Description
\Zend_Session_SaveHandler_DbTable

setReferences(array $referenceMap) : \Zend_Db_Table_Abstract

inherited

Inherited from: \Zend_Db_Table_Abstract::setReferences()

Parameters

Name	Type	Description
$referenceMap	array

Returns

Type	Description
\Zend_Db_Table_Abstract	Provides a fluent interface

setRowClass(string $classname) : \Zend_Db_Table_Abstract

inherited

Inherited from: \Zend_Db_Table_Abstract::setRowClass()

Parameters

Name	Type	Description
$classname	string

Returns

Type	Description
\Zend_Db_Table_Abstract	Provides a fluent interface

setRowsetClass(string $classname) : \Zend_Db_Table_Abstract

inherited

Inherited from: \Zend_Db_Table_Abstract::setRowsetClass()

Parameters

Name	Type	Description
$classname	string

Returns

Type	Description
\Zend_Db_Table_Abstract	Provides a fluent interface

update(array $data, array | string $where) : int

inherited

Updates existing rows.

Inherited from: \Zend_Db_Table_Abstract::update()

Parameters

Name	Type	Description
$data	array	Column-value pairs.
$where	array \| string	An SQL WHERE clause, or an array of SQL WHERE clauses.

Returns

Type	Description
int	The number of rows updated.

write(string $id, string $data) : boolean

Write session data

Parameters

Name	Type	Description
$id	string
$data	string

Returns

Type	Description
boolean

Session/SaveHandler/DbTable.php

\Zend_Session_SaveHandler_DbTablejump to top

Constants

Properties

Methods

\Zend_Session_SaveHandler_DbTable
jump to top