Abstract class Doctrine_Connection

Doctrine_Locator_Injectable

Doctrine_Configurable

Doctrine_Connection

Doctrine

Doctrine_Connection

abstract class Doctrine_Connection extends Doctrine_Configurable implements Countable, IteratorAggregate, Serializable

Defined in line 56 of file lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php.

Subclasses : Doctrine_Connection_Common Doctrine_Connection_Db2 Doctrine_Connection_Firebird Doctrine_Connection_Informix Doctrine_Connection_Mssql Doctrine_Connection_Oracle

Doctrine_Connection

A wrapper layer on top of PDO / Doctrine_Adapter

Doctrine_Connection is the heart of any Doctrine based application.

1. Event listeners
An easy to use, pluggable eventlistener architecture. Aspects such as
logging, query profiling and caching can be easily implemented through
the use of these listeners

2. Lazy-connecting
Creating an instance of Doctrine_Connection does not connect
to database. Connecting to database is only invoked when actually needed
(for example when query() is being called)

3. Convenience methods
Doctrine_Connection provides many convenience methods such as fetchAll(), fetchOne() etc.

4. Modular structure
Higher level functionality such as schema importing, exporting, sequence handling etc.
is divided into modules. For a full list of connection modules see
Doctrine_Connection::$_modules

Package	Doctrine
Subpackage	Connection
License	http://www.opensource.org/licenses/lgpl-license.php LGPL
Link	www.phpdoctrine.org
Since	1.0
Version	$Revision: 5801 $
Author	Konsta Vesterinen
Author	Lukas Smith (MDB2 library)

Overview

Static fields$supportedDrivers

Inherited from Doctrine_Locator_Injectable : $_null

Instance fields$_count $_name $dbh $driverName $isConnected $modules $options $pendingAttributes $properties $serverInfo $supported $tables

Inherited from Doctrine_Configurable : $_impl $_params $attributes $parent

Inherited from Doctrine_Locator_Injectable : $_locator $_resources

Static methodsgetAvailableDrivers() getSupportedDrivers()

Inherited from Doctrine_Locator_Injectable : getNullObject() initNullObject()

Instance methods__construct() __get() __toString() addTable() beginInternalTransaction() beginTransaction() clear() close() commit() connect() convertBooleans() count() create() createDatabase() createQuery() delete() driverName() dropDatabase() errorCode() errorInfo() evictTables() exec() execute() fetchAll() fetchArray() fetchAssoc() fetchBoth() fetchColumn() fetchOne() fetchRow() flush() getAttribute() getCacheDriver() getDbh() getDriverName() getIterator() getManager() getName() getOption() getOptions() getQueryCacheDriver() getResultCacheDriver() getTable() getTables() getTmpConnection() getTransactionLevel() hasTable() incrementQueryCount() insert() lastInsertId() modifyLimitQuery() modifyLimitSubquery() prepare() query() queryOne() quote() quoteIdentifier() quoteMultipleIdentifier() replace() rethrowException() rollback() select() serialize() setAttribute() setCharset() setDateFormat() setName() setOption() standaloneQuery() supports() unserialize() update()

Inherited from Doctrine_Locator_Injectable : bind() getLocator() locate() setLocator()

Summary

Static fields

- $supportedDrivers

Instance fields

# $_count
# $_name	$_name
# $dbh
# $driverName	The name of this connection driver
# $isConnected
- $modules
# $options
# $pendingAttributes
# $properties
# $serverInfo
# $supported
# $tables

Static methods

+ getAvailableDrivers()	returns an array of available PDO drivers
+ getSupportedDrivers()	Returns an array of supported drivers by `Doctrine`

Instance methods

+ __construct()	the constructor
+ __get()	__get
+ __toString()	returns a string representation of this object
+ addTable()	addTable
+ beginInternalTransaction()
+ beginTransaction()	beginTransaction
+ clear()	clear
+ close()	close
+ commit()	commit
+ connect()	connect
+ convertBooleans()	convertBooleans
+ count()	returns the count of initialized table objects
+ create()	create
+ createDatabase()	createDatabase
+ createQuery()	Creates a new `Doctrine_Query` object that operates on this connection
+ delete()	deletes table row(s) matching the specified identifier
+ driverName()	converts given driver name
+ dropDatabase()	dropDatabase
+ errorCode()	errorCode
+ errorInfo()	errorInfo
+ evictTables()	evictTables
+ exec()	exec
+ execute()	execute
+ fetchAll()	fetchAll
+ fetchArray()	fetchArray
+ fetchAssoc()	fetchAssoc
+ fetchBoth()	fetchBoth
+ fetchColumn()	fetchColumn
+ fetchOne()	fetchOne
+ fetchRow()	fetchRow
+ flush()	flush
+ getAttribute()	getAttribute
+ getCacheDriver()	getCacheDriver
+ getDbh()	returns the database handler of which this connection uses
+ getDriverName()	getDriverName
+ getIterator()	returns an iterator that iterators through all
+ getManager()	returns the manager that created this connection
+ getName()	getName
+ getOption()	getOption
+ getOptions()	getOptions
+ getQueryCacheDriver()	getQueryCacheDriver
+ getResultCacheDriver()	getResultCacheDriver
+ getTable()	returns a table object for given component name
+ getTables()	returns an array of all initialized tables
+ getTmpConnection()	getTmpConnection
+ getTransactionLevel()	get the current transaction nesting level
+ hasTable()	hasTable
+ incrementQueryCount()
+ insert()	Inserts a table row with specified data
+ lastInsertId()	lastInsertId
+ modifyLimitQuery()	modifyLimitQuery
+ modifyLimitSubquery()	Creates dbms specific LIMIT/OFFSET SQL for the subqueries that are used in the
+ prepare()	prepare
+ query()	query
+ queryOne()	query
+ quote()	quote
+ quoteIdentifier()	Quote a string so it can be safely used as a table or column name
+ quoteMultipleIdentifier()	quoteMultipleIdentifier
+ replace()	Execute a SQL REPLACE query
+ rethrowException()	rethrowException
+ rollback()	rollback
+ select()	queries the database with limit and offset
+ serialize()	Serialize
+ setAttribute()	setAttribute
+ setCharset()	Set the charset on the current connection
+ setDateFormat()	Set the date/time format for the current connection
+ setName()	setName
+ setOption()	setOption
+ standaloneQuery()	standaloneQuery
+ supports()	supports
+ unserialize()	Unserialize
+ update()	Updates table row(s) with specified data

Details

Static fields

$supportedDrivers

private static $supportedDrivers    = array(
                                        'Mysql',
                                        'Pgsql',
                                        'Oracle',
                                        'Informix',
                                        'Mssql',
                                        'Sqlite',
                                        'Firebird'
                                        )

Var array $supportedDrivers an array containing all supported drivers

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 168

Instance fields

$_count

protected $_count = 0

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 177

$_name

protected $_name

$_name

Name of the connection

Var string $_name

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 76

$dbh

protected $dbh

Var $dbh the database handler

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 61

$driverName

protected $driverName

The name of this connection driver.

Var string $driverName

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 83

$isConnected

protected $isConnected = false

Var boolean $isConnected whether or not a connection has been established

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 88

$modules

private $modules = array('transaction' => false,
                             'expression'  => false,
                             'dataDict'    => false,
                             'export'      => false,
                             'import'      => false,
                             'sequence'    => false,
                             'unitOfWork'  => false,
                             'formatter'   => false,
                             'util'        => false,
                             )

Static methods

getAvailableDrivers()

public static function getAvailableDrivers( )

returns an array of available PDO drivers

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 297

getSupportedDrivers()

public static function getSupportedDrivers( )

Returns an array of supported drivers by Doctrine

Returns array $supportedDrivers

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 307

Instance methods

__construct()

public function __construct( Doctrine_Manager $manager $adapter $user = null $pass = null)

the constructor

Parameters

`Doctrine_Manager $manager`
`PDO\|Doctrine_Adapter_Interface $adapter`	database driver
`$user`
`$pass`

Overriden by __construct() in classes : Doctrine_Connection_Mock, Doctrine_Connection_Firebird, Doctrine_Connection_Informix, Doctrine_Connection_Mssql, Doctrine_Connection_Pgsql, Doctrine_Connection_Mysql, Doctrine_Connection_Oracle, Doctrine_Connection_Sqlite

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 185

__get()

public function __get( $name)

__get
lazy loads given module and returns it

Parameters

string $name the name of the module to get

Returns Doctrine_Connection_Module connection module

Throws Doctrine_Connection_Exception if trying to get an unknown module

See also Doctrine_Transaction

See also Doctrine_Connection::$modules all availible modules

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 396

__toString()

public function __toString( )

returns a string representation of this object

Returns string

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1564

addTable()

public function addTable( Doctrine_Table $table)

addTable
adds a Doctrine_Table object into connection registry

Parameters

Doctrine_Table $table

Returns boolean

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1180

beginInternalTransaction()

public function beginInternalTransaction( $savepoint = null)

Parameters

$savepoint

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1390

beginTransaction()

public function beginTransaction( $savepoint = null)

beginTransaction
Start a transaction or set a savepoint.

if trying to set a savepoint and there is no active transaction
a new transaction is being started

Listeners: onPreTransactionBegin, onTransactionBegin

Parameters

string $savepoint name of a savepoint to set

Returns integer current transaction nesting level

Throws Doctrine_Transaction_Exception if the transaction fails at database level

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1385

clear()

public function clear( )

clear
clears all repositories

Returns void

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1240

close()

public function close( )

close
closes the connection

Returns void

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1266

commit()

public function commit( $savepoint = null)

commit
Commit the database changes done during a transaction that is in
progress or release a savepoint. This function may only be called when
auto-committing is disabled, otherwise it will fail.

Listeners: onPreTransactionCommit, onTransactionCommit

Parameters

string $savepoint name of a savepoint to release

Returns boolean false if commit couldn't be performed, true otherwise

Throws Doctrine_Transaction_Exception if the transaction fails at PDO level

Throws Doctrine_Validator_Exception if the transaction fails due to record validations

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1408

connect()

public function connect( )

connect
connects into database

Returns boolean

Overriden by connect() in classes : Doctrine_Connection_Mysql, Doctrine_Connection_Sqlite

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 450

convertBooleans()

public function convertBooleans( $item)

convertBooleans
some drivers need the boolean values to be converted into integers
when using DQL API

This method takes care of that conversion

Parameters

array $item

Returns void

Overriden by convertBooleans() in class : Doctrine_Connection_Pgsql

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 770

count()

public function count( )

returns the count of initialized table objects

Returns integer

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1168

create()

public function create( $name)

create
creates a record

create creates a record

Parameters

string $name component name

Returns Doctrine_Record Doctrine_Record object

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1199

createDatabase()

public function createDatabase( )

createDatabase

Issue create database command for this instance of Doctrine_Connection

Returns mixed Returns Doctrine_Exception or success string

Overriden by createDatabase() in class : Doctrine_Connection_Sqlite

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1439

createQuery()

public function createQuery( )

Creates a new Doctrine_Query object that operates on this connection.

Returns Doctrine_Query

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1209

delete()

public function delete( Doctrine_Table $table array $identifier)

deletes table row(s) matching the specified identifier

Parameters

`Doctrine_Table $table`
`array $identifier`

Returns integer The number of affected rows

Throws Doctrine_Connection_Exception if something went wrong at the database level

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 603

driverName()

public function driverName( $name)

converts given driver name

Parameters

$name

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 512

dropDatabase()

public function dropDatabase( )

dropDatabase

Issue drop database command for this instance of Doctrine_Connection

Returns mixed Returns Doctrine_Exception or success string

Overriden by dropDatabase() in class : Doctrine_Connection_Sqlite

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1473

errorCode()

public function errorCode( )

errorCode
Fetch the SQLSTATE associated with the last operation on the database handle

Returns integer

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1296

errorInfo()

public function errorInfo( )

errorInfo
Fetch extended error information associated with the last operation on the database handle

Returns array

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1309

evictTables()

public function evictTables( )

evictTables
evicts all tables

Returns void

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1254

exec()

public function exec( $query array $params = array())

exec

Parameters

`string $query`	sql query
`array $params`

Returns PDOStatement|Doctrine_Adapter_Statement

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1044

execute()

public function execute( $query array $params = array())

execute

Parameters

`string $query`	sql query
`array $params`

Returns PDOStatement|Doctrine_Adapter_Statement

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1007

fetchAll()

public function fetchAll( $statement array $params = array())

fetchAll

Parameters

`string $statement`	sql query to be executed
`array $params`

Returns array

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 806

fetchArray()

public function fetchArray( $statement array $params = array())

fetchArray

Parameters

`string $statement`	sql query to be executed
`array $params`

Returns array

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 843

fetchAssoc()

public function fetchAssoc( $statement array $params = array())

fetchAssoc

Parameters

`string $statement`	sql query to be executed
`array $params`

Returns array

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 868

fetchBoth()

public function fetchBoth( $statement array $params = array())

fetchBoth

Parameters

`string $statement`	sql query to be executed
`array $params`

Returns array

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 880

fetchColumn()

public function fetchColumn( $statement array $params = array() $colnum)

fetchColumn

Parameters

`string $statement`	sql query to be executed
`array $params`
`int $colnum`	0-indexed column number to retrieve

Returns array

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 856

fetchOne()

public function fetchOne( $statement array $params = array() $colnum)

fetchOne

Parameters

`string $statement`	sql query to be executed
`array $params`
`int $colnum`	0-indexed column number to retrieve

Returns mixed

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 819

fetchRow()

public function fetchRow( $statement array $params = array())

fetchRow

Parameters

`string $statement`	sql query to be executed
`array $params`

Returns array

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 831

flush()

public function flush( )

flush
saves all the records from all tables
this operation is isolated using a transaction

Returns void

Throws PDOException if something went wrong at database level

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1222

getAttribute()

public function getAttribute( $attribute)

getAttribute
retrieves a database connection attribute

Parameters

integer $attribute

Returns mixed

Overrides Doctrine_Configurable->getAttribute()

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 264

getCacheDriver() Deprecated

public function getCacheDriver( )

getCacheDriver

Returns Doctrine_Cache_Interface

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1322

getDbh()

public function getDbh( )

returns the database handler of which this connection uses

Returns PDO the database handler

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 437

getDriverName()

public function getDriverName( )

getDriverName

Gets the name of the instance driver

Returns void

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 378

getIterator()

public function getIterator( )

returns an iterator that iterators through all
initialized table objects



foreach ($conn as $index => $table) {

     print $table;  // get a string representation of each table object

}

Returns ArrayIterator SPL ArrayIterator object

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1158

getManager()

public function getManager( )

returns the manager that created this connection

Returns Doctrine_Manager

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 427

getName()

public function getName( )

getName
returns the name of this driver

Returns string the name of this driver

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 353

getOption()

public function getOption( $option)

getOption

Retrieves option

Parameters

string $option

Returns void

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 237

getOptions()

public function getOptions( )

getOptions

Get array of all options

Returns void

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 224

getQueryCacheDriver()

public function getQueryCacheDriver( )

getQueryCacheDriver

Returns Doctrine_Cache_Interface

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1346

getResultCacheDriver()

public function getResultCacheDriver( )

getResultCacheDriver

Returns Doctrine_Cache_Interface

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1332

getTable()

public function getTable( $name)

returns a table object for given component name

Parameters

string $name component name

Returns object Doctrine_Table

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1117

getTables()

public function getTables( )

returns an array of all initialized tables

Returns array

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1141

getTmpConnection()

public function getTmpConnection( $info)

getTmpConnection

Create a temporary connection to the database with the user credentials.
This is so the user can make a connection to a db server. Some dbms allow
connections with no database, but some do not. In that case we have a table
which is always guaranteed to exist. Mysql: 'mysql', PostgreSQL: 'postgres', etc.
This value is set in the Doctrine_Export_{DRIVER} classes if required

Parameters

string $info

Returns void

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1512

getTransactionLevel()

public function getTransactionLevel( )

get the current transaction nesting level

Returns integer

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1285

hasTable()

public function hasTable( $name)

hasTable
whether or not this connection has table $name initialized

Parameters

mixed $name

Returns boolean

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1106

incrementQueryCount()

public function incrementQueryCount( )

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 502

insert()

public function insert( Doctrine_Table $table array $fields)

Inserts a table row with specified data.

Parameters

`Doctrine_Table $table`
`array $fields`

Returns mixed boolean false if empty value array was given,
otherwise returns the number of affected rows

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 661

lastInsertId()

public function lastInsertId( $table = null $field = null)

lastInsertId

Returns the ID of the last inserted row, or the last value from a sequence object,
depending on the underlying driver.

Note: This method may not return a meaningful or consistent result across different drivers,
because the underlying database may not even support the notion of auto-increment fields or sequences.

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

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1367

modifyLimitQuery()

public function modifyLimitQuery( $query $limit = false $offset = false $isManip = false)

modifyLimitQuery

Some dbms require specific functionality for this. Check the other connection adapters for examples

Parameters

`$query`
`$limit`
`$offset`
`$isManip`

Returns string

Overriden by modifyLimitQuery() in classes : Doctrine_Connection_Firebird, Doctrine_Connection_Mssql, Doctrine_Connection_Oracle, Doctrine_Connection_Common, Doctrine_Connection_Db2

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1543

modifyLimitSubquery()

public function modifyLimitSubquery( Doctrine_Table $rootTable $query $limit = false $offset = false $isManip = false)

Creates dbms specific LIMIT/OFFSET SQL for the subqueries that are used in the
context of the limit-subquery algorithm.

Parameters

`Doctrine_Table $rootTable`
`$query`
`$limit`
`$offset`
`$isManip`

Returns string

Overriden by modifyLimitSubquery() in class : Doctrine_Connection_Oracle

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1554

prepare()

public function prepare( $statement)

prepare

Parameters

string $statement

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 916

query()

public function query( $query array $params = array() $hydrationMode = null)

query
queries the database using Doctrine Query Language
returns a collection of Doctrine_Record objects



$users = $conn->query('SELECT u.* FROM User u');



$users = $conn->query('SELECT u.* FROM User u WHERE u.name LIKE ?', array('someone'));

Parameters

`string $query`	DQL query
`array $params`
`int $hydrationMode`	`Doctrine`::HYDRATE_ARRAY or `Doctrine`::HYDRATE_RECORD

Returns Doctrine_Collection Collection of Doctrine_Record objects

See also Doctrine_Query

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 959

quote()

public function quote( $input $type = null)

quote
quotes given input parameter

Parameters

`mixed $input`	parameter to be quoted
`string $type`

Returns mixed

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 783

quoteIdentifier()

public function quoteIdentifier( $str $checkOption = true)

Quote a string so it can be safely used as a table or column name

Delimiting style depends on which database driver is being used.

NOTE: just because you CAN use delimited identifiers doesn't mean
you SHOULD use them. In general, they end up causing way more
problems than they solve.

Portability is broken by using the following characters inside
delimited identifiers:
+ backtick (`) -- due to MySQL
+ double quote (") -- due to Oracle
+ brackets ([ or ]) -- due to Access

Delimited identifiers are known to generally work correctly under
the following drivers:
+ mssql
+ mysql
+ mysqli
+ oci8
+ pgsql
+ sqlite

InterBase doesn't seem to be able to use delimited identifiers
via PHP 4. They work fine under PHP 5.

Parameters

`string $str`	identifier name to be quoted
`bool $checkOption`	check the 'quote_identifier' option

Returns string quoted identifier string

Overriden by quoteIdentifier() in classes : Doctrine_Connection_Informix, Doctrine_Connection_Mssql

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 729

quoteMultipleIdentifier()

public function quoteMultipleIdentifier( $arr $checkOption = true)

quoteMultipleIdentifier
Quotes multiple identifier strings

Parameters

`array $arr`	identifiers array to be quoted
`bool $checkOption`	check the 'quote_identifier' option

Returns string quoted identifier string

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 750

replace()

public function replace( Doctrine_Table $table array $fields array $keys)

Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT
query, except that if there is already a row in the table with the same
key field values, the REPLACE query just updates its values instead of
inserting a new row.

The REPLACE type of query does not make part of the SQL standards. Since
practically only MySQL and SQLIte implement it natively, this type of
query isemulated through this method for other DBMS using standard types
of queries inside a transaction to assure the atomicity of the operation.

Parameters

`Doctrine_Table $table`
`array $fields`
`array $keys`

Returns integer number of rows affected

Throws Doctrine_Connection_Exception if this driver doesn't support replace

Throws Doctrine_Connection_Exception if some of the key values was null

Throws Doctrine_Connection_Exception if there were no key fields

Throws PDOException if something fails at PDO level

Overriden by replace() in class : Doctrine_Connection_Mysql

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 563

rethrowException()

public function rethrowException( Exception $e $invoker)

rethrowException

Parameters

`Exception $e`
`$invoker`

Throws Doctrine_Connection_Exception

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1078

rollback()

public function rollback( $savepoint = null)

rollback
Cancel any database changes done during a transaction or since a specific
savepoint that is in progress. This function may only be called when
auto-committing is disabled, otherwise it will fail. Therefore, a new
transaction is implicitly started after canceling the pending changes.

this method can be listened with onPreTransactionRollback and onTransactionRollback
eventlistener methods

Parameters

string $savepoint name of a savepoint to rollback to

Returns boolean false if rollback couldn't be performed, true otherwise

Throws Doctrine_Transaction_Exception if the rollback operation fails at database level

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1427

select()

public function select( $query $limit $offset)

queries the database with limit and offset
added to the query and returns a Doctrine_Connection_Statement object

Parameters

`string $query`
`integer $limit`
`integer $offset`

Returns Doctrine_Connection_Statement

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 979

serialize()

public function serialize( )

Serialize. Remove database connection(pdo) since it cannot be serialized

Returns string $serialized

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1574

setAttribute()

public function setAttribute( $attribute $value)

setAttribute
sets an attribute

Parameters

`integer $attribute`
`mixed $value`

Returns boolean

To do why check for >= 100? has this any special meaning when creating
attributes?

Overrides Doctrine_Configurable->setAttribute()

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 323

setCharset()

public function setCharset( $charset)

Set the charset on the current connection

Parameters

$charset

Overriden by setCharset() in classes : Doctrine_Connection_Firebird, Doctrine_Connection_Pgsql, Doctrine_Connection_Mysql

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 692

setDateFormat()

public function setDateFormat( $format = null)

Set the date/time format for the current connection

Parameters

$format

Returns void

Overriden by setDateFormat() in class : Doctrine_Connection_Oracle

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 795

setName()

public function setName( $name)

setName

Sets the name of the connection

Parameters

string $name

Returns void

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 366

setOption()

public function setOption( $option $value)

setOption

Set option value

Parameters

`string $option`
`$value`

Returns void

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 252

standaloneQuery()

public function standaloneQuery( $query $params = array())

standaloneQuery

Parameters

`string $query`	sql query
`array $params`	query parameters

Returns PDOStatement|Doctrine_Adapter_Statement

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 995

supports()

public function supports( $feature)

supports

Parameters

string $feature the name of the feature

Returns boolean whether or not this drivers supports given feature

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 522

unserialize()

public function unserialize( $serialized)

Unserialize. Recreate connection from serialized content

Parameters

string $serialized

Returns void

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 1588

update()

public function update( Doctrine_Table $table array $fields array $identifier)

Updates table row(s) with specified data

Parameters

`Doctrine_Table $table`
`array $fields`
`array $identifier`

Returns mixed boolean false if empty value array was given,
otherwise returns the number of affected rows

Throws Doctrine_Connection_Exception if something went wrong at the database level

Defined in lib/plugins/sfDoctrinePlugin/lib/vendor/doctrine/Doctrine/Connection.php, line 627