Nkey\Caribu\Orm\OrmTransaction

Complexity

Total Complexity

10

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

80.77%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	startTX()	0	12	2
A	commitTX()	0	14	3
B	rollBackTX()	0	24	5

<?php
namespace Nkey\Caribu\Orm;

use PDOException;

/**
 * Transaction related functionality
 *
 * This class is part of Caribu package
 *
 * @author Maik Greubel <greubel@nkey.de>
 */
trait OrmTransaction
{
    /**
     * Include the connection related functionality
     */
    use OrmConnection;

    /**
     * The stack of open transactions
     *
     * @var int
     */
    private $transactionStack = 0;

    /**
     * Begin a new transaction
     *
     * @return \PDO
     */
    public function startTX()
    {
        $connection = $this->getConnection();

        if (!$connection->inTransaction()) {
            $connection->beginTransaction();
        }

        $this->transactionStack++;

        return $connection;
    }

    /**
     * Try to commit the complete transaction stack
     *
     * @throws OrmException
     * @throws PDOException
     */
    public function commitTX()
    {
        $connection = $this->getConnection();

        if (!$connection->inTransaction()) {
            throw new OrmException("Transaction is not open");
        }

        $this->transactionStack--;

        if ($this->transactionStack === 0) {
            $connection->commit();
        }
    }

    /**
     * Rollback the complete stack
     *
     * @return OrmException either previous exception or new occured during rollback containing previous
     */
    public function rollBackTX(\Exception $previousException = null)
    {
        $connection = $this->getConnection();

        $this->transactionStack = 0; // Yes, we just ignore any error and reset the transaction stack here

        if (!$connection) {
            $previousException = new OrmException("Connection not open", array(), 101, $previousException);
        }

        if (!$connection->inTransaction()) {
            $previousException = new OrmException("Transaction not open", array(), 102, $previousException);
        }

        try {
            if (!$connection->rollBack()) {
                $previousException = new OrmException("Could not rollback!", array(), 103, $previousException);
            }
        } catch (\PDOException $exception) {
            $previousException = OrmException::fromPrevious($exception);
        }

        return $previousException;
    }
}