Class Overview

Doctrine_Sequence The base class for sequence handling drivers.

Located in /Doctrine/Sequence.php [line 34]

Doctrine_Connection_Module
   |
   --Doctrine_Sequence

Author(s):

Konsta Vesterinen <kvesteri@cc.hut.fi>

Information Tags:

Version:	$Revision: 1080 $
Link:	www.phpdoctrine.com
Since:	1.0
License:	LGPL

Methods

[ Top ]

Direct descendents

Child Class	Description
Doctrine_Sequence_Db2	Doctrine_Sequence_Db2
Doctrine_Sequence_Firebird	Doctrine_Sequence_Firebird
Doctrine_Sequence_Informix	Doctrine_Sequence_Informix
Doctrine_Sequence_Mssql	Doctrine_Sequence_Mssql
Doctrine_Sequence_Mysql	Doctrine_Sequence_Mysql
Doctrine_Sequence_Oracle	Doctrine_Sequence_Oracle
Doctrine_Sequence_Pgsql	Doctrine_Sequence_Pgsql
Doctrine_Sequence_Sqlite	Doctrine_Sequence_Sqlite

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From Doctrine_Connection_Module Doctrine_Connection_Module::$conn Doctrine_Connection_Module::$moduleName	Inherited From Doctrine_Connection_Module Doctrine_Connection_Module::__construct() Doctrine_Connection_Module::getConnection() getConnection returns the connection object this module uses Doctrine_Connection_Module::getModuleName() getModuleName returns the name of this module

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Doctrine_Connection_Module

Doctrine_Connection_Module::$conn

Doctrine_Connection_Module::$moduleName

Inherited From Doctrine_Connection_Module

Doctrine_Connection_Module::__construct()

Doctrine_Connection_Module::getConnection()

getConnection returns the connection object this module uses

Doctrine_Connection_Module::getModuleName()

getModuleName returns the name of this module

[ Top ]

Method Summary

integer	currId()	Returns the current id of a sequence
void	lastInsertId()	Returns the autoincrement ID if supported or $id or fetches the current ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)
integer	nextId()	Returns the next free id of a sequence

[ Top ]

Properties

Methods

currId [line 66]

integer currId(
string
$seqName 
)

Returns the current id of a sequence

Parameters:

string

$seqName:

name of the sequence

API Tags:

Return:	current id in the given sequence
Access:	public

Redefined in descendants as:

Doctrine_Sequence_Firebird::currId() : Returns the current id of a sequence
Doctrine_Sequence_Mssql::currId() : Returns the current id of a sequence
Doctrine_Sequence_Mysql::currId() : Returns the current id of a sequence
Doctrine_Sequence_Pgsql::currId() : Returns the current id of a sequence
Doctrine_Sequence_Sqlite::currId() : Returns the current id of a sequence

[ Top ]

lastInsertId [line 55]

void lastInsertId(
[string
$table = null], [string
$field = null] 
)

Returns the autoincrement ID if supported or $id or fetches the current ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)

Parameters:

string	$table:	name of the table into which a new row was inserted
string	$field:	name of the field into which a new row was inserted

API Tags:

Access:

public

Redefined in descendants as:

Doctrine_Sequence_Db2::lastInsertId() : Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.
Doctrine_Sequence_Firebird::lastInsertId() : Returns the autoincrement ID if supported or $id or fetches the current ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)
Doctrine_Sequence_Mssql::lastInsertId() : Returns the autoincrement ID if supported or $id or fetches the current ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)
Doctrine_Sequence_Mysql::lastInsertId() : Returns the autoincrement ID if supported or $id or fetches the current ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)
Doctrine_Sequence_Pgsql::lastInsertId() : lastInsertId
Doctrine_Sequence_Sqlite::lastInsertId() : Returns the autoincrement ID if supported or $id or fetches the current ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)

[ Top ]

nextId [line 44]

integer nextId(
string
$seqName, [bool
$ondemand = true] 
)

Returns the next free id of a sequence

Parameters:

string	$seqName:	name of the sequence
bool	$ondemand:	when true missing sequences are automatic created

API Tags:

Return:	next id in the given sequence
Access:	public

Redefined in descendants as:

Doctrine_Sequence_Mssql::nextId() : Returns the next free id of a sequence
Doctrine_Sequence_Mysql::nextId() : Returns the next free id of a sequence
Doctrine_Sequence_Pgsql::nextId() : Returns the next free id of a sequence
Doctrine_Sequence_Sqlite::nextId() : Returns the next free id of a sequence

[ Top ]

Class: Doctrine_Sequence

Class Doctrine_Sequence