Class: DBMySQL

Source Location: /adapter/DBMySQL.php

Class Overview

DBAdapter
   |
   --DBMySQL

This is used in order to connect to a MySQL database.

Author(s):

Hans Lellelid <hans@xmpl.org> (Propel)
Daniel Rall <dlr@finemaltcoding.com> (Torque)
Jon S. Stevens <jon@clearink.com> (Torque)
Brett McLaughlin <bmclaugh@algx.net> (Torque)

Version:

$Revision: 784 $

Methods

Inherited Constants

Class: DBAdapter

DBAdapter::ID_METHOD_AUTOINCREMENT
DBAdapter::ID_METHOD_NONE
DBAdapter::ID_METHOD_SEQUENCE

Inherited Methods

Class: DBAdapter

DBAdapter::applyLimit(): Modifies the passed-in SQL to add LIMIT and/or OFFSET.
DBAdapter::concatString(): Returns SQL which concatenates the second string to the first.
DBAdapter::factory(): Creates a new instance of the database adapter associated with the specified Creole driver.
DBAdapter::getDateFormatter(): Returns date formatter string for use in date() function.
DBAdapter::getId(): Gets the generated ID (either last ID for autoincrement or next sequence ID).
DBAdapter::getIdMethod(): Returns the native ID method for this RDBMS.
DBAdapter::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).
DBAdapter::getTimeFormatter(): Returns time formatter string for use in date() function.
DBAdapter::getTimestampFormatter(): Returns timestamp formatter string for use in date() function.
DBAdapter::ignoreCase(): This method is used to ignore case.
DBAdapter::ignoreCaseInOrderBy(): This method is used to ignore case in an ORDER BY clause.
DBAdapter::initConnection(): This method is called after a connection was created to run necessary post-initialization queries or code.
DBAdapter::isGetIdAfterInsert(): Whether this adapter uses an ID generation system that requires getting ID _before_ performing INSERT.
DBAdapter::isGetIdBeforeInsert(): Whether this adapter uses an ID generation system that requires getting ID _before_ performing INSERT.
DBAdapter::quoteIdentifier(): Quotes database objec identifiers (table names, col names, sequences, etc.).
DBAdapter::random()
DBAdapter::strLength(): Returns SQL which calculates the length (in chars) of a string.
DBAdapter::subString(): Returns SQL which extracts a substring.
DBAdapter::toUpperCase(): This method is used to ignore case.
DBAdapter::useQuoteIdentifier(): Should Column-Names get identifiers for inserts or updates.

Class Details

[line 33]
This is used in order to connect to a MySQL database.

Tags:

author:	Hans Lellelid <hans@xmpl.org> (Propel)
author:	Daniel Rall <dlr@finemaltcoding.com> (Torque)
author:	Jon S. Stevens <jon@clearink.com> (Torque)
author:	Brett McLaughlin <bmclaugh@algx.net> (Torque)
version:	$Revision: 784 $

[ Top ]

Class Methods

method applyLimit [line 154]

void applyLimit(

&$sql, 
$offset, 
$limit)

Tags:

see:	DBAdapter::applyLimit()
access:	public

Overrides DBAdapter::applyLimit() (Modifies the passed-in SQL to add LIMIT and/or OFFSET.)

Parameters:

	&$sql
	$offset
	$limit

[ Top ]

method concatString [line 79]

string concatString(
string
$s1, string
$s2)

Returns SQL which concatenates the second string to the first.

Tags:

access:

public

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

Parameters:

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

[ Top ]

method ignoreCase [line 67]

The ignoreCase(
in
$in)

This method is used to ignore case.

Tags:

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

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

Parameters:

$in

The string whose case to ignore.

[ Top ]

method initConnection [line 42]

void initConnection(

$con, 
$settings)

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

Tags:

access:

public

Overrides DBAdapter::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 ]

method lockTable [line 117]

void lockTable(

$con, string
$table)

Locks the specified table.

Tags:

throws:	PDOException No Statement could be created or executed.
access:	public

Parameters:

Connection	$con	The Creole connection to use.
string	$table	The name of the table to lock.

[ Top ]

method quoteIdentifier [line 138]

void quoteIdentifier(

$text)

Tags:

see:	DBAdapter::quoteIdentifier()
access:	public

Overrides DBAdapter::quoteIdentifier() (Quotes database objec identifiers (table names, col names, sequences, etc.).)

Parameters:

$text

[ Top ]

method random [line 166]

void random(
[
$seed = null])

Tags:

see:	DBAdapter::random()
access:	public

Overrides DBAdapter::random() (parent method not documented)

Parameters:

$seed

[ Top ]

method strLength [line 103]

string strLength(
string
$s)

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

Tags:

access:

public

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

Parameters:

string

String to calculate length of.

[ Top ]

method subString [line 92]

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

Returns SQL which extracts a substring.

Tags:

access:

public

Overrides DBAdapter::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 ]

method toUpperCase [line 56]

The toUpperCase(
in
$in)

This method is used to ignore case.

Tags:

return:	upper case string.
access:	public

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

Parameters:

$in

The string to transform to upper case.

[ Top ]

method unlockTable [line 130]

void unlockTable(

$con, string
$table)

Unlocks the specified table.

Tags:

throws:	PDOException No Statement could be created or executed.
access:	public

Parameters:

PDO	$con	The PDO connection to use.
string	$table	The name of the table to unlock.

[ Top ]

method useQuoteIdentifier [line 146]

void useQuoteIdentifier(
)

Tags:

see:	DBAdapter::useQuoteIdentifier()
access:	public

Overrides DBAdapter::useQuoteIdentifier() (Should Column-Names get identifiers for inserts or updates.)

[ Top ]

Documentation generated on Thu, 22 Nov 2007 03:33:41 +0000 by phpDocumentor 1.4.0