diff --git a/UPGRADE.md b/UPGRADE.md index e1611c2c..e16ded6e 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -6,6 +6,10 @@ awareness about deprecated code. - Use of our low-overhead runtime deprecation API, details: https://github.com/doctrine/deprecations/ +# Upgrade to 1.8 + +Executor and Purger classes are now final. You should not extend them. + # Upgrade to 1.6 ## BC BREAK: `CircularReferenceException` no longer extends `Doctrine\Common\CommonException` diff --git a/docs/en/explanation/transactions-and-purging.rst b/docs/en/explanation/transactions-and-purging.rst index 8ccb6fab..d0f04ad4 100644 --- a/docs/en/explanation/transactions-and-purging.rst +++ b/docs/en/explanation/transactions-and-purging.rst @@ -1,9 +1,8 @@ Transactions and purging ======================== -This package exposes an ``AbstractExecutor`` class and 3 concrete -implementations for ``doctrine/orm``, ``doctrine/mongodb-odm`` and -``doctrine/phpcr-odm``. +This package provides executors for ``doctrine/orm``, ``doctrine/mongodb-odm`` +and ``doctrine/phpcr-odm``. The executors purge the database, then load the fixtures. The ORM implementation wraps these two steps in a database transaction, which diff --git a/src/Executor/AbstractExecutor.php b/src/Executor/AbstractExecutor.php index d0c31b3b..f1bcdd82 100644 --- a/src/Executor/AbstractExecutor.php +++ b/src/Executor/AbstractExecutor.php @@ -17,6 +17,8 @@ /** * Abstract fixture executor. + * + * @internal since 1.8.0 */ abstract class AbstractExecutor { diff --git a/src/Executor/MongoDBExecutor.php b/src/Executor/MongoDBExecutor.php index ff2a72d1..c3d91424 100644 --- a/src/Executor/MongoDBExecutor.php +++ b/src/Executor/MongoDBExecutor.php @@ -11,6 +11,8 @@ /** * Class responsible for executing data fixtures. + * + * @final since 1.8.0 */ class MongoDBExecutor extends AbstractExecutor { diff --git a/src/Executor/ORMExecutor.php b/src/Executor/ORMExecutor.php index a82a0a2a..1ce9014a 100644 --- a/src/Executor/ORMExecutor.php +++ b/src/Executor/ORMExecutor.php @@ -8,6 +8,8 @@ /** * Class responsible for executing data fixtures. + * + * @final since 1.8.0 */ class ORMExecutor extends AbstractExecutor { diff --git a/src/Executor/PHPCRExecutor.php b/src/Executor/PHPCRExecutor.php index bd1fca70..dc62a35c 100644 --- a/src/Executor/PHPCRExecutor.php +++ b/src/Executor/PHPCRExecutor.php @@ -11,6 +11,8 @@ /** * Class responsible for executing data fixtures. + * + * @final since 1.8.0 */ class PHPCRExecutor extends AbstractExecutor { diff --git a/src/Purger/MongoDBPurger.php b/src/Purger/MongoDBPurger.php index 3ac7c6f7..dfbc3767 100644 --- a/src/Purger/MongoDBPurger.php +++ b/src/Purger/MongoDBPurger.php @@ -8,6 +8,8 @@ /** * Class responsible for purging databases of data before reloading data fixtures. + * + * @final since 1.8.0 */ class MongoDBPurger implements PurgerInterface { diff --git a/src/Purger/ORMPurger.php b/src/Purger/ORMPurger.php index 2fbf4095..ba820377 100644 --- a/src/Purger/ORMPurger.php +++ b/src/Purger/ORMPurger.php @@ -19,6 +19,8 @@ /** * Class responsible for purging databases of data before reloading data fixtures. + * + * @final since 1.8.0 */ class ORMPurger implements PurgerInterface, ORMPurgerInterface { diff --git a/src/Purger/PHPCRPurger.php b/src/Purger/PHPCRPurger.php index eba6c317..01da74ef 100644 --- a/src/Purger/PHPCRPurger.php +++ b/src/Purger/PHPCRPurger.php @@ -10,6 +10,8 @@ /** * Class responsible for purging databases of data before reloading data fixtures. + * + * @final since 1.8.0 */ class PHPCRPurger implements PurgerInterface {