Tutorial - Database Transaction Handling

Edit on GitHub

To reduce boilerplate code and properly handle database transactions you can use Spryker\Zed\Kernel\Persistence\EntityManager\TransactionTrait.

Usage

To use database transactions in the DatabaseTransactionHandlingExample class:

Code sample:

<?php

use Spryker\Zed\Kernel\Persistence\EntityManager\TransactionTrait;

class DatabaseTransactionHandlingExample
{

    use TransactionTrait;

    /**
     * @param string $fooName
     * @param \Bar[] $barCollection
     *
     * @return \Foo
     */
    public function createFoo($fooName, array $barCollection)
    {
        return $this->getTransactionHandler()->handleTransaction(function () use ($fooName, $barCollection) {
            return $this->executeCreateFooTransaction($fooName, $barCollection);
        });
    }

    /**
     * @param string $fooName
     * @param \Bar[] $barCollection
     *
     * @return \Foo
     */
    protected function executeCreateFooTransaction($fooName, array $barCollection)
    {
        $fooEntity = new Foo();
        $fooEntity->setFooName($fooName);
        $fooEntity->save();

        foreach ($barCollection as $bar) {
            $bar->setFkFoo($fooEntity->getIdFoo());
            $bar->save();
        }

        return $fooEntity;
    }

}

Under the Hood

In case of any error, the transaction will be rolled back and an exception will be re-thrown. The code only has one method. The $connection parameter is optional and if not specified Propel::getConnection() will be used.

Code sample:

<?php

    /**
     * @param \Closure $callback
     *
     * @throws \Exception
     * @throws \Throwable
     *
     * @return mixed
     */
    public function handleTransaction(Closure $callback)
    {
        if (!$this->connection) {
            $this->connection = Propel::getConnection();
        }

        $this->connection->beginTransaction();

        try {
            $result = $callback();

            $this->connection->commit();

            return $result;
        } catch (Exception $exception) {
            $this->connection->rollBack();
            throw $exception;
        } catch (Throwable $exception) {
            $this->connection->rollBack();
            throw $exception;
        }
    }