0 follower

CDbTransaction

Package system.db
Inheritance class CDbTransaction » CComponent
Since 1.0
Version $Id$
Source Code framework/db/CDbTransaction.php
CDbTransaction represents a DB transaction.

It is usually created by calling CDbConnection::beginTransaction.

The following code is a common scenario of using transactions: 
$transaction=$connection->beginTransaction();
try
{
   $connection->createCommand($sql1)->execute();
   $connection->createCommand($sql2)->execute();
   //.... other SQL executions
   $transaction->commit();
}
catch(Exception $e)
{
   $transaction->rollBack();
}

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
active boolean whether this transaction is active CDbTransaction
connection CDbConnection the DB connection for this transaction CDbTransaction

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__construct() Constructor. CDbTransaction
__get() Returns a property value, an event handler list or a behavior based on its name. CComponent
__isset() Checks if a property value is null. CComponent
__set() Sets value of a component property. CComponent
__unset() Sets a component property to be null. CComponent
asa() Returns the named behavior object. CComponent
attachBehavior() Attaches a behavior to this component. CComponent
attachBehaviors() Attaches a list of behaviors to the component. CComponent
attachEventHandler() Attaches an event handler to an event. CComponent
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
commit() Commits a transaction. CDbTransaction
detachBehavior() Detaches a behavior from the component. CComponent
detachBehaviors() Detaches all behaviors from the component. CComponent
detachEventHandler() Detaches an existing event handler. CComponent
disableBehavior() Disables an attached behavior. CComponent
disableBehaviors() Disables all behaviors attached to this component. CComponent
enableBehavior() Enables an attached behavior. CComponent
enableBehaviors() Enables all behaviors attached to this component. CComponent
getActive() Returns whether this transaction is active CDbTransaction
getConnection() Returns the DB connection for this transaction CDbTransaction
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
hasEvent() Determines whether an event is defined. CComponent
hasEventHandler() Checks whether the named event has attached handlers. CComponent
hasProperty() Determines whether a property is defined. CComponent
raiseEvent() Raises an event. CComponent
rollback() Rolls back a transaction. CDbTransaction

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
setActive() Sets whether this transaction is active CDbTransaction

Property Details

active property
public boolean getActive()
protected void setActive(boolean $value)

whether this transaction is active

connection property read-only
public CDbConnection getConnection()

the DB connection for this transaction

Method Details

__construct() method
public void __construct(CDbConnection $connection)
$connection CDbConnection the connection associated with this transaction
Source Code: framework/db/CDbTransaction.php#47 (show)
public function __construct(CDbConnection $connection)
{
    $this->_connection=$connection;
    $this->setActive(true);
}

Constructor.

See Also

commit() method
public void commit()
Source Code: framework/db/CDbTransaction.php#57 (show)
public function commit()
{
    if($this->_active && $this->_connection->getActive())
    {
        Yii::trace('Committing transaction','system.db.CDbTransaction');
        $this->_connection->getPdoInstance()->commit();
        $this->_active=false;
    }
    else
        throw new CDbException(Yii::t('yii','CDbTransaction is inactive and cannot perform commit or roll back operations.'));
}

Commits a transaction.

getActive() method
public boolean getActive()
{return} boolean whether this transaction is active
Source Code: framework/db/CDbTransaction.php#96 (show)
public function getActive()
{
    return $this->_active;
}

getConnection() method
public CDbConnection getConnection()
{return} CDbConnection the DB connection for this transaction
Source Code: framework/db/CDbTransaction.php#88 (show)
public function getConnection()
{
    return $this->_connection;
}

rollback() method
public void rollback()
Source Code: framework/db/CDbTransaction.php#73 (show)
public function rollback()
{
    if($this->_active && $this->_connection->getActive())
    {
        Yii::trace('Rolling back transaction','system.db.CDbTransaction');
        $this->_connection->getPdoInstance()->rollBack();
        $this->_active=false;
    }
    else
        throw new CDbException(Yii::t('yii','CDbTransaction is inactive and cannot perform commit or roll back operations.'));
}

Rolls back a transaction.

setActive() method
protected void setActive(boolean $value)
$value boolean whether this transaction is active
Source Code: framework/db/CDbTransaction.php#104 (show)
protected function setActive($value)
{
    $this->_active=$value;
}