Skip to content

Remove support for partial DocumentManager::clear() #2889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 3.0.x
Choose a base branch
from
Open

Remove support for partial DocumentManager::clear() #2889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions docs/en/reference/events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -616,14 +616,9 @@ Define the ``EventTest`` class with a ``onClear()`` method:
{
public function onClear(\Doctrine\ODM\MongoDB\Event\OnClearEventArgs $eventArgs): void
{
$class = $eventArgs->getDocumentClass();
$dm = $eventArgs->getDocumentManager();
$uow = $dm->getUnitOfWork();

// Check if event clears all documents.
if ($eventArgs->clearsAllDocuments()) {
// do something
}
// do something
}
}
Expand Down
16 changes: 2 additions & 14 deletions src/DocumentManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@
use function is_object;
use function ltrim;
use function sprintf;
use function trigger_deprecation;

/**
* The DocumentManager class is the central access point for managing the
Expand Down Expand Up @@ -696,21 +695,10 @@ public function find($className, $id, $lockMode = LockMode::NONE, $lockVersion =
*
* All documents that are currently managed by this DocumentManager become
* detached.
*
* @param string|null $objectName if given, only documents of this type will get detached
*/
public function clear($objectName = null): void
public function clear(): void
{
if ($objectName !== null) {
trigger_deprecation(
'doctrine/mongodb-odm',
'2.4',
'Calling %s() with any arguments to clear specific documents is deprecated and will not be supported in Doctrine ODM 3.0.',
__METHOD__,
);
}

$this->unitOfWork->clear($objectName);
$this->unitOfWork->clear();
}

/**
Expand Down
105 changes: 0 additions & 105 deletions src/Event/OnClearEventArgs.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,120 +7,15 @@
use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\Persistence\Event\OnClearEventArgs as BaseOnClearEventArgs;

use function func_num_args;
use function method_exists;
use function trigger_deprecation;

/**
* Provides event arguments for the onClear event.
*
* @template-extends BaseOnClearEventArgs<DocumentManager>
*/
final class OnClearEventArgs extends BaseOnClearEventArgs
{
/**
* @deprecated
*
* @var class-string|null
*/
private ?string $entityClass;

/** @param class-string|null $entityClass */
public function __construct($objectManager, $entityClass = null)
{
if (method_exists(parent::class, 'getEntityClass') && $entityClass !== null) {
parent::__construct($objectManager, $entityClass);
} else {
if (func_num_args() > 1) {
trigger_deprecation(
'doctrine/mongodb-odm',
'2.4',
'Passing $entityClass argument to %s::%s() is deprecated and will not be supported in Doctrine ODM 3.0.',
self::class,
__METHOD__,
);
}

parent::__construct($objectManager);
}

$this->entityClass = $entityClass;
}

public function getDocumentManager(): DocumentManager
{
return $this->getObjectManager();
}

/**
* @deprecated no replacement planned
*
* @return class-string|null
*/
public function getDocumentClass(): ?string
{
trigger_deprecation(
'doctrine/mongodb-odm',
'2.4',
'Calling %s() is deprecated and will not be supported in Doctrine ODM 3.0.',
__METHOD__,
);

return $this->entityClass;
}

/**
* Returns whether this event clears all documents.
*
* @deprecated no replacement planned
*/
public function clearsAllDocuments(): bool
{
trigger_deprecation(
'doctrine/mongodb-odm',
'2.4',
'Calling %s() is deprecated and will not be supported in Doctrine ODM 3.0.',
__METHOD__,
);

return $this->entityClass !== null;
}

/** @deprecated no replacement planned */
public function clearsAllEntities(): bool
{
if (method_exists(parent::class, 'clearsAllEntities')) {
return parent::clearsAllEntities();
}

trigger_deprecation(
'doctrine/mongodb-odm',
'2.4',
'Calling %s() is deprecated and will not be supported in Doctrine ODM 3.0.',
__METHOD__,
);

return $this->entityClass !== null;
}

/**
* @deprecated no replacement planned
*
* @return class-string|null
*/
public function getEntityClass(): ?string
{
if (method_exists(parent::class, 'getEntityClass')) {
return parent::getEntityClass();
}

trigger_deprecation(
'doctrine/mongodb-odm',
'2.4',
'Calling %s() is deprecated and will not be supported in Doctrine ODM 3.0.',
__METHOD__,
);

return $this->entityClass;
}
}
18 changes: 0 additions & 18 deletions src/Repository/DocumentRepository.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
use function assert;
use function count;
use function is_array;
use function trigger_deprecation;

/**
* A DocumentRepository serves as a repository for documents with generic as well as
Expand Down Expand Up @@ -82,23 +81,6 @@ public function createAggregationBuilder(): AggregationBuilder
return $this->dm->createAggregationBuilder($this->documentName);
}

/**
* Clears the repository, causing all managed documents to become detached.
*
* @deprecated Deprecated in 2.6, will be removed in 3.0
*/
public function clear(): void
{
trigger_deprecation(
'doctrine/mongodb-odm',
'2.6',
'The %s() method is deprecated and will be removed in Doctrine ODM 3.0.',
__METHOD__,
);

$this->dm->clear($this->class->rootDocumentName);
}

/**
* Finds a document matching the specified identifier. Optionally a lock mode and
* expected version may be specified.
Expand Down
55 changes: 20 additions & 35 deletions src/UnitOfWork.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2399,41 +2399,26 @@ public function unlock(object $document): void
*
* @internal
*/
public function clear(?string $documentName = null): void
{
if ($documentName === null) {
$this->identityMap =
$this->documentIdentifiers =
$this->originalDocumentData =
$this->documentChangeSets =
$this->documentStates =
$this->scheduledForSynchronization =
$this->scheduledDocumentInsertions =
$this->scheduledDocumentUpserts =
$this->scheduledDocumentUpdates =
$this->scheduledDocumentDeletions =
$this->scheduledCollectionUpdates =
$this->scheduledCollectionDeletions =
$this->parentAssociations =
$this->embeddedDocumentsRegistry =
$this->orphanRemovals =
$this->hasScheduledCollections = [];

$event = new Event\OnClearEventArgs($this->dm);
} else {
$visited = [];
foreach ($this->identityMap as $className => $documents) {
if ($className !== $documentName) {
continue;
}

foreach ($documents as $document) {
$this->doDetach($document, $visited);
}
}

$event = new Event\OnClearEventArgs($this->dm, $documentName);
}
public function clear(): void
{
$this->identityMap =
$this->documentIdentifiers =
$this->originalDocumentData =
$this->documentChangeSets =
$this->documentStates =
$this->scheduledForSynchronization =
$this->scheduledDocumentInsertions =
$this->scheduledDocumentUpserts =
$this->scheduledDocumentUpdates =
$this->scheduledDocumentDeletions =
$this->scheduledCollectionUpdates =
$this->scheduledCollectionDeletions =
$this->parentAssociations =
$this->embeddedDocumentsRegistry =
$this->orphanRemovals =
$this->hasScheduledCollections = [];

$event = new Event\OnClearEventArgs($this->dm);

$this->evm->dispatchEvent(Events::onClear, $event);
}
Expand Down
12 changes: 0 additions & 12 deletions tests/Tests/Functional/SplObjectHashCollisionsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
use Doctrine\ODM\MongoDB\Tests\BaseTestCase;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\IgnoreDeprecations;
use ReflectionObject;

class SplObjectHashCollisionsTest extends BaseTestCase
Expand Down Expand Up @@ -68,17 +67,6 @@ static function (DocumentManager $dm, $doc): void {
];
}

#[IgnoreDeprecations]
public function testParentAssociationsLeftoverPartialClear(): void
{
$this->testParentAssociationsLeftover(
static function (DocumentManager $dm): void {
$dm->clear(SplColDoc::class);
},
1,
);
}

private function expectCount(string $prop, int $expected): void
{
$ro = new ReflectionObject($this->uow);
Expand Down
15 changes: 0 additions & 15 deletions tests/Tests/UnitOfWorkTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
use MongoDB\Driver\WriteConcern;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
use PHPUnit\Framework\Attributes\IgnoreDeprecations;
use ReflectionProperty;
use Throwable;

Expand All @@ -39,20 +38,6 @@

class UnitOfWorkTest extends BaseTestCase
{
/** Clear by class name is deprecated */
#[IgnoreDeprecations]
public function testPartialClear(): void
{
$user = new ForumUser();
$avatar = new ForumAvatar();
$this->uow->persist($avatar);
$this->uow->persist($user);

$this->uow->clear(ForumUser::class);
self::assertFalse($this->uow->isScheduledForInsert($user));
self::assertTrue($this->uow->isScheduledForInsert($avatar));
}

public function testIsDocumentScheduled(): void
{
$class = $this->dm->getClassMetadata(ForumUser::class);
Expand Down