Skip to content

Commit

Permalink
Merge pull request #457 from GromNaN/final
Browse files Browse the repository at this point in the history
Make Executor and Purger classes final
  • Loading branch information
greg0ire authored Dec 15, 2023
2 parents dee43b2 + 71ba52a commit a77f4d3
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 3 deletions.
5 changes: 5 additions & 0 deletions UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ 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 final, they cannot be extended.
`AbstractExecutor` is internal. It cannot be extended or used as typehint.

# Upgrade to 1.6

## BC BREAK: `CircularReferenceException` no longer extends `Doctrine\Common\CommonException`
Expand Down
5 changes: 2 additions & 3 deletions docs/en/explanation/transactions-and-purging.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions src/Executor/AbstractExecutor.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@

/**
* Abstract fixture executor.
*
* @internal since 1.8.0
*/
abstract class AbstractExecutor
{
Expand Down
2 changes: 2 additions & 0 deletions src/Executor/MongoDBExecutor.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

/**
* Class responsible for executing data fixtures.
*
* @final since 1.8.0
*/
class MongoDBExecutor extends AbstractExecutor
{
Expand Down
2 changes: 2 additions & 0 deletions src/Executor/ORMExecutor.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

/**
* Class responsible for executing data fixtures.
*
* @final since 1.8.0
*/
class ORMExecutor extends AbstractExecutor
{
Expand Down
2 changes: 2 additions & 0 deletions src/Executor/PHPCRExecutor.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

/**
* Class responsible for executing data fixtures.
*
* @final since 1.8.0
*/
class PHPCRExecutor extends AbstractExecutor
{
Expand Down
2 changes: 2 additions & 0 deletions src/Purger/MongoDBPurger.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

/**
* Class responsible for purging databases of data before reloading data fixtures.
*
* @final since 1.8.0
*/
class MongoDBPurger implements PurgerInterface
{
Expand Down
2 changes: 2 additions & 0 deletions src/Purger/ORMPurger.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 2 additions & 0 deletions src/Purger/PHPCRPurger.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

/**
* Class responsible for purging databases of data before reloading data fixtures.
*
* @final since 1.8.0
*/
class PHPCRPurger implements PurgerInterface
{
Expand Down

0 comments on commit a77f4d3

Please sign in to comment.