Docs For Class DBAdapter

static DBAdapter factory(
string
$driver)

Creates a new instance of the database adapter associated with the specified Creole driver.

Tags:

return:	An instance of a Propel database adapter.
throws:	PropelException if the adapter could not be instantiated.
access:	public

Parameters:

string

$driver

The name of the Propel/Creole driver to create a new adapter instance for or a shorter form adapter key.

[ Top ]

void applyLimit(

&$sql, 
$offset, 
$limit)

Modifies the passed-in SQL to add LIMIT and/or OFFSET.

Tags:

abstract:
access:	public

Overridden in child classes as:

DBOracle::applyLimit()

DBMySQL::applyLimit()

DBMSSQL::applyLimit(): Simulated Limit/Offset This rewrites the $sql query to apply the offset and limit.

DBSQLite::applyLimit()

DBPostgres::applyLimit()

Parameters:

	&$sql
	$offset
	$limit

[ Top ]

string concatString(
string
$s1, string
$s2)

Returns SQL which concatenates the second string to the first.

Tags:

abstract:
access:	public

Overridden in child classes as:

DBOracle::concatString(): Returns SQL which concatenates the second string to the first.

DBMySQL::concatString(): Returns SQL which concatenates the second string to the first.

DBSybase::concatString(): Returns SQL which concatenates the second string to the first.

DBSQLite::concatString(): Returns SQL which concatenates the second string to the first.

DBNone::concatString(): Returns SQL which concatenates the second string to the first.

DBPostgres::concatString(): Returns SQL which concatenates the second string to the first.

Parameters:

string	$s1	String to concatenate.
string	$s2	String to append.

[ Top ]

string getDateFormatter(
)

Returns date formatter string for use in date() function.

Tags:

access:

public

[ Top ]

mixed getId(

$con, [
$name = null])

Gets the generated ID (either last ID for autoincrement or next sequence ID).

Tags:

access:

public

Overridden in child classes as:

DBOracle::getId()

DBPostgres::getId(): Gets ID for specified sequence name.

Parameters:

PDO	$con
	$name

[ Top ]

int getIdMethod(
)

Returns the native ID method for this RDBMS.

Tags:

return:	one of DBAdapter:ID_METHOD_SEQUENCE, DBAdapter::ID_METHOD_AUTOINCREMENT.
access:	protected

Overridden in child classes as:

DBOracle::getIdMethod()

DBPostgres::getIdMethod()

[ Top ]

string getStringDelimiter(
)

Returns the character used to indicate the beginning and end of a piece of text used in a SQL statement (generally a single quote).

Tags:

return:	The text delimeter.
access:	public

[ Top ]

string getTimeFormatter(
)

Returns time formatter string for use in date() function.

Tags:

access:

public

Overridden in child classes as:

DBPostgres::getTimeFormatter(): Returns timestamp formatter string for use in date() function.

[ Top ]

string getTimestampFormatter(
)

Returns timestamp formatter string for use in date() function.

Tags:

access:

public

Overridden in child classes as:

DBPostgres::getTimestampFormatter(): Returns timestamp formatter string for use in date() function.

[ Top ]

string ignoreCase(
string
$in)

This method is used to ignore case.

Tags:

return:	The string in a case that can be ignored.
abstract:
access:	public

Overridden in child classes as:

DBOracle::ignoreCase(): This method is used to ignore case.

DBMySQL::ignoreCase(): This method is used to ignore case.

DBSybase::ignoreCase(): This method is used to ignore case.

DBSQLite::ignoreCase(): This method is used to ignore case.

DBNone::ignoreCase(): This method is used to ignore case.

DBPostgres::ignoreCase(): This method is used to ignore case.

Parameters:

string

$in

The string whose case to ignore.

[ Top ]

string ignoreCaseInOrderBy(
string
$in)

This method is used to ignore case in an ORDER BY clause.

Usually it is the same as ignoreCase, but some databases (Interbase for example) does not use the same SQL in ORDER BY and other clauses.

Tags:

return:	The string in a case that can be ignored.
access:	public

Parameters:

string

$in

The string whose case to ignore.

[ Top ]

void initConnection(

$con, 
$settings)

This method is called after a connection was created to run necessary post-initialization queries or code.

This base method runs queries specified using the "query" setting.

Tags:

access:

public

Overridden in child classes as:

DBMySQL::initConnection(): This method is called after a connection was created to run necessary post-initialization queries or code.

Parameters:

PDO	$con	A PDO connection instance.
array	$settings	An array of settings.

[ Top ]

boolean isGetIdAfterInsert(
)

Whether this adapter uses an ID generation system that requires getting ID _before_ performing INSERT.

Tags:

access:

public

[ Top ]

boolean isGetIdBeforeInsert(
)

Whether this adapter uses an ID generation system that requires getting ID _before_ performing INSERT.

Tags:

access:

public

[ Top ]

string quoteIdentifier(
string
$text)

Quotes database objec identifiers (table names, col names, sequences, etc.).

Tags:

return:	The quoted identifier.
access:	public

Overridden in child classes as:

DBMySQL::quoteIdentifier()

DBSybase::quoteIdentifier()

DBSQLite::quoteIdentifier()

Parameters:

string

$text

The identifier to quote.

[ Top ]

void random(
[
$seed = NULL])

Tags:

abstract:
access:	public

Overridden in child classes as:

DBOracle::random()

DBMySQL::random()

DBSybase::random()

DBMSSQL::random()

DBSQLite::random()

DBPostgres::random()

Parameters:

$seed

[ Top ]

string strLength(
string
$s)

Returns SQL which calculates the length (in chars) of a string.

Tags:

abstract:
access:	public

Overridden in child classes as:

DBOracle::strLength(): Returns SQL which calculates the length (in chars) of a string.

DBMySQL::strLength(): Returns SQL which calculates the length (in chars) of a string.

DBSybase::strLength(): Returns SQL which calculates the length (in chars) of a string.

DBSQLite::strLength(): Returns SQL which calculates the length (in chars) of a string.

DBNone::strLength(): Returns SQL which calculates the length (in chars) of a string.

DBPostgres::strLength(): Returns SQL which calculates the length (in chars) of a string.

Parameters:

string

$s

String to calculate length of.

[ Top ]

string subString(
string
$s, int
$pos, int
$len)

Returns SQL which extracts a substring.

Tags:

abstract:
access:	public

Overridden in child classes as:

DBOracle::subString(): Returns SQL which extracts a substring.

DBMySQL::subString(): Returns SQL which extracts a substring.

DBSybase::subString(): Returns SQL which extracts a substring.

DBSQLite::subString(): Returns SQL which extracts a substring.

DBNone::subString(): Returns SQL which extracts a substring.

DBPostgres::subString(): Returns SQL which extracts a substring.

Parameters:

string	$s	String to extract from.
int	$pos	Offset to start from.
int	$len	Number of characters to extract.

[ Top ]

string toUpperCase(
string
$in)

This method is used to ignore case.

Tags:

return:	The upper case string.
abstract:
access:	public

Overridden in child classes as:

DBOracle::toUpperCase(): This method is used to ignore case.

DBMySQL::toUpperCase(): This method is used to ignore case.

DBSybase::toUpperCase(): This method is used to ignore case.

DBSQLite::toUpperCase(): This method is used to ignore case.

DBNone::toUpperCase(): This method is used to ignore case.

DBPostgres::toUpperCase(): This method is used to ignore case.

Parameters:

string

$in

The string to transform to upper case.

[ Top ]

boolean useQuoteIdentifier(
)

Should Column-Names get identifiers for inserts or updates.

By default false is returned -> backwards compability.

it`s a workaround...!!!

Tags:

deprecated:
todo:	should be abstract
access:	public

Overridden in child classes as:

DBMySQL::useQuoteIdentifier()

[ Top ]

Class: DBAdapter

Class Overview

Author(s):

Version:

Constants

Methods

Child classes:

Class Details

Tags:

Class Methods

static method factory [line 74]

Tags:

Parameters:

method applyLimit [line 264]

Tags:

Parameters:

method concatString [line 153]

Tags:

Parameters:

method getDateFormatter [line 233]

Tags:

method getId [line 215]

Tags:

Parameters:

method getIdMethod [line 188]

Tags:

method getStringDelimiter [line 119]

Tags:

method getTimeFormatter [line 242]

Tags:

method getTimestampFormatter [line 224]

Tags:

method ignoreCase [line 130]

Tags:

Parameters:

method ignoreCaseInOrderBy [line 141]

Tags:

Parameters:

method initConnection [line 93]

Tags:

Parameters:

method isGetIdAfterInsert [line 206]

Tags:

method isGetIdBeforeInsert [line 197]

Tags:

method quoteIdentifier [line 179]

Tags:

Parameters:

method random [line 266]

Tags:

Parameters:

method strLength [line 171]

Tags:

Parameters:

method subString [line 163]

Tags:

Parameters:

method toUpperCase [line 110]

Tags:

Parameters:

method useQuoteIdentifier [line 257]

Tags:

Class Constants

ID_METHOD_AUTOINCREMENT = 1

ID_METHOD_NONE = 0

ID_METHOD_SEQUENCE = 2