You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

92 lines
2.3 KiB

13 years ago
<?php
/**
13 years ago
* Transaction class file.
13 years ago
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.yiiframework.com/
13 years ago
* @copyright Copyright &copy; 2008-2012 Yii Software LLC
13 years ago
* @license http://www.yiiframework.com/license/
*/
13 years ago
namespace yii\db\dao;
13 years ago
use yii\db\Exception;
13 years ago
/**
13 years ago
* Transaction represents a DB transaction.
*
* It is usually created by calling [[Connection::beginTransaction]].
13 years ago
*
13 years ago
* The following code is a typical example of using transactions (note that some
* DBMS may not support transactions):
13 years ago
*
13 years ago
* ~~~
* $transaction = $connection->beginTransaction();
* try {
* $connection->createCommand($sql1)->execute();
* $connection->createCommand($sql2)->execute();
* //.... other SQL executions
* $transaction->commit();
13 years ago
* }
13 years ago
* catch(Exception $e) {
* $transaction->rollBack();
13 years ago
* }
13 years ago
* ~~~
13 years ago
*
* @author Qiang Xue <qiang.xue@gmail.com>
13 years ago
* @since 2.0
13 years ago
*/
13 years ago
class Transaction extends \yii\base\Object
13 years ago
{
13 years ago
/**
* @var boolean whether this transaction is active. Only an active transaction
* can [[commit]] or [[rollBack]]. This property is set true when the transaction is started.
*/
public $active;
/**
* @var Connection the database connection that this transaction is associated with.
*/
public $connection;
13 years ago
/**
* Constructor.
13 years ago
* @param Connection $connection the connection associated with this transaction
* @see Connection::beginTransaction
13 years ago
*/
13 years ago
public function __construct($connection)
13 years ago
{
13 years ago
$this->active = true;
$this->connection = $connection;
13 years ago
}
/**
* Commits a transaction.
13 years ago
* @throws Exception if the transaction or the DB connection is not active.
13 years ago
*/
public function commit()
{
13 years ago
if ($this->active && $this->connection->getActive()) {
13 years ago
\Yii::trace('Committing transaction', __CLASS__);
13 years ago
$this->connection->pdo->commit();
$this->active = false;
13 years ago
} else {
throw new Exception('Failed to commit transaction: transaction was inactive.');
13 years ago
}
}
/**
* Rolls back a transaction.
13 years ago
* @throws Exception if the transaction or the DB connection is not active.
13 years ago
*/
public function rollback()
{
13 years ago
if ($this->active && $this->connection->getActive()) {
13 years ago
\Yii::trace('Rolling back transaction', __CLASS__);
13 years ago
$this->connection->pdo->rollBack();
$this->active = false;
13 years ago
} else {
throw new Exception('Failed to roll back transaction: transaction was inactive.');
13 years ago
}
}
}