Adding TransactionalManagerInterface

src/Entity/BaseEntityManager.php

@@ -15,15 +15,17 @@
 
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\EntityRepository;
+use Sonata\Doctrine\Exception\TransactionException;
 use Sonata\Doctrine\Model\BaseManager;
+use Sonata\Doctrine\Model\TransactionalManagerInterface;
 
 /**
  * @author Sylvain Deloux <[email protected]>
  *
  * @phpstan-template T of object
  * @phpstan-extends BaseManager<T>
  */
-abstract class BaseEntityManager extends BaseManager
+abstract class BaseEntityManager extends BaseManager implements TransactionalManagerInterface
 {
     /**
      * Make sure the code is compatible with legacy code.
@@ -78,6 +80,25 @@ public function getEntityManager()
         return $objectManager;
     }
 
+    public function beginTransaction(): void
+    {
+        $this->getEntityManager()->beginTransaction();
+    }
+
+    public function commit(): void
+    {
+        try {
+            $this->getEntityManager()->commit();
+        } catch (\Throwable $exception) {
+            throw new TransactionException($exception->getMessage(), (int) $exception->getCode(), $exception);
+        }
+    }
+
+    public function rollBack(): void
+    {
+        $this->getEntityManager()->rollback();
+    }
+
     /**
      * @phpstan-return EntityRepository<T>
      */

src/Exception/TransactionException.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\Doctrine\Exception;
+
+/**
+ * @author Erison Silva <[email protected]>
+ */
+final class TransactionException extends \RuntimeException
+{
+}

src/Model/TransactionalManagerInterface.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\Doctrine\Model;
+
+use Sonata\Doctrine\Exception\TransactionException;
+
+/**
+ * @author Erison Silva <[email protected]>
+ */
+interface TransactionalManagerInterface
+{
+    public function beginTransaction(): void;
+
+    /**
+     * @throws TransactionException
+     */
+    public function commit(): void;
+
+    public function rollBack(): void;
+}

tests/Entity/BaseEntityManagerTest.php

@@ -20,6 +20,8 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Sonata\Doctrine\Entity\BaseEntityManager;
+use Sonata\Doctrine\Exception\TransactionException;
+use Sonata\Doctrine\Model\TransactionalManagerInterface;
 
 final class BaseEntityManagerTest extends TestCase
 {
@@ -99,4 +101,57 @@ public function testGetRepository(): void
 
         static::assertInstanceOf(EntityRepository::class, $m->invoke($this->manager));
     }
+
+    public function testTransactionsFields(): void
+    {
+        // Mocks
+        $entityManagerMock = $this->createMock(EntityManagerInterface::class);
+        $entityManagerMock
+            ->expects(static::once())
+            ->method('beginTransaction');
+
+        $entityManagerMock
+            ->expects(static::once())
+            ->method('commit');
+
+        $entityManagerMock
+            ->expects(static::once())
+            ->method('rollback');
+
+        $baseEntityManagerMock = $this->createPartialMock(BaseEntityManager::class, ['getEntityManager']);
+        $baseEntityManagerMock
+            ->method('getEntityManager')
+            ->willReturn($entityManagerMock);
+
+        // Run code
+        $baseEntityManagerMock->beginTransaction();
+        $baseEntityManagerMock->commit();
+        $baseEntityManagerMock->rollBack();
+
+        // Asserts
+        static::assertInstanceOf(TransactionalManagerInterface::class, $baseEntityManagerMock);
+    }
+
+    public function testTransactionException(): void
+    {
+        // Asserts exception
+        static::expectException(TransactionException::class);
+        static::expectExceptionMessage('Foo message');
+        static::expectExceptionCode(123);
+
+        // Mocks
+        $entityManagerMock = $this->createMock(EntityManagerInterface::class);
+        $entityManagerMock
+            ->expects(static::once())
+            ->method('commit')
+            ->willThrowException(new TransactionException('Foo message', 123, new \Exception()));
+
+        $baseEntityManagerMock = $this->createPartialMock(BaseEntityManager::class, ['getEntityManager']);
+        $baseEntityManagerMock
+            ->method('getEntityManager')
+            ->willReturn($entityManagerMock);
+
+        // Run code
+        $baseEntityManagerMock->commit();
+    }
 }