Skip to content

Commit

Permalink
Revert "Introduce FilterCollection#restore method (#10537)"
Browse files Browse the repository at this point in the history 
This reverts commit 8e20e15.
  • Loading branch information
@derrabus
derrabus committed Jul 28, 2023
1 parent 8e20e15 commit d2de4ec
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 206 deletions.
31 changes: 0 additions & 31 deletions docs/en/reference/filters.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,34 +93,3 @@ object.
want to refresh or reload an object after having modified a filter or the
FilterCollection, then you should clear the EntityManager and re-fetch your
entities, having the new rules for filtering applied.


Suspending/Restoring Filters
----------------------------
When a filter is disabled, the instance is fully deleted and all the filter
parameters previously set are lost. Then, if you enable it again, a new filter
is created without the previous filter parameters. If you want to keep a filter
(in order to use it later) but temporary disable it, you'll need to use the
``FilterCollection#suspend($name)`` and ``FilterCollection#restore($name)``
methods instead.

.. code-block:: php
<?php
$filter = $em->getFilters()->enable("locale");
$filter->setParameter('locale', 'en');
// Temporary suspend the filter
$filter = $em->getFilters()->suspend("locale");
// Do things
// Then restore it, the locale parameter will still be set
$filter = $em->getFilters()->restore("locale");
.. warning::
If you enable a previously disabled filter, doctrine will create a new
one without keeping any of the previously parameter set with
``SQLFilter#setParameter()`` or ``SQLFilter#getParameterList()``. If you
want to restore the previously disabled filter instead, you must use the
``FilterCollection#restore($name)`` method.
82 changes: 0 additions & 82 deletions lib/Doctrine/ORM/Query/FilterCollection.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,6 @@ class FilterCollection
*/
private $enabledFilters = [];

/**
* Instances of suspended filters.
*
* @var SQLFilter[]
* @psalm-var array<string, SQLFilter>
*/
private $suspendedFilters = [];

/**
* The filter hash from the last time the query was parsed.
*
Expand Down Expand Up @@ -91,17 +83,6 @@ public function getEnabledFilters()
return $this->enabledFilters;
}

/**
* Gets all the suspended filters.
*
* @return SQLFilter[] The suspended filters.
* @psalm-return array<string, SQLFilter>
*/
public function getSuspendedFilters(): array
{
return $this->suspendedFilters;
}

/**
* Enables a filter from the collection.
*
Expand All @@ -124,9 +105,6 @@ public function enable($name)

$this->enabledFilters[$name] = new $filterClass($this->em);

// In case a suspended filter with the same name was forgotten
unset($this->suspendedFilters[$name]);

// Keep the enabled filters sorted for the hash
ksort($this->enabledFilters);

Expand Down Expand Up @@ -157,54 +135,6 @@ public function disable($name)
return $filter;
}

/**
* Suspend a filter.
*
* @param string $name Name of the filter.
*
* @return SQLFilter The suspended filter.
*
* @throws InvalidArgumentException If the filter does not exist.
*/
public function suspend(string $name): SQLFilter
{
// Get the filter to return it
$filter = $this->getFilter($name);

$this->suspendedFilters[$name] = $filter;
unset($this->enabledFilters[$name]);

$this->setFiltersStateDirty();

return $filter;
}

/**
* Restore a disabled filter from the collection.
*
* @param string $name Name of the filter.
*
* @return SQLFilter The restored filter.
*
* @throws InvalidArgumentException If the filter does not exist.
*/
public function restore(string $name): SQLFilter
{
if (! $this->isSuspended($name)) {
throw new InvalidArgumentException("Filter '" . $name . "' is not suspended.");
}

$this->enabledFilters[$name] = $this->suspendedFilters[$name];
unset($this->suspendedFilters[$name]);

// Keep the enabled filters sorted for the hash
ksort($this->enabledFilters);

$this->setFiltersStateDirty();

return $this->enabledFilters[$name];
}

/**
* Gets an enabled filter from the collection.
*
Expand Down Expand Up @@ -247,18 +177,6 @@ public function isEnabled($name)
return isset($this->enabledFilters[$name]);
}

/**
* Checks if a filter is suspended.
*
* @param string $name Name of the filter.
*
* @return bool True if the filter is suspended, false otherwise.
*/
public function isSuspended(string $name): bool
{
return isset($this->suspendedFilters[$name]);
}

/**
* Checks if the filter collection is clean.
*
Expand Down
96 changes: 3 additions & 93 deletions tests/Doctrine/Tests/ORM/Query/FilterCollectionTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,54 +30,15 @@ public function testEnable(): void

self::assertCount(0, $filterCollection->getEnabledFilters());

$filter1 = $filterCollection->enable('testFilter');
$filterCollection->enable('testFilter');

$enabledFilters = $filterCollection->getEnabledFilters();

self::assertCount(1, $enabledFilters);
self::assertContainsOnly(MyFilter::class, $enabledFilters);

$filter2 = $filterCollection->disable('testFilter');
self::assertCount(0, $filterCollection->getEnabledFilters());
self::assertSame($filter1, $filter2);

$filter3 = $filterCollection->enable('testFilter');
self::assertNotSame($filter1, $filter3);

$filter4 = $filterCollection->suspend('testFilter');
self::assertSame($filter3, $filter4);

$filter5 = $filterCollection->enable('testFilter');
self::assertNotSame($filter4, $filter5);

self::assertCount(1, $enabledFilters);
self::assertContainsOnly(MyFilter::class, $enabledFilters);
}

public function testSuspend(): void
{
$filterCollection = $this->em->getFilters();

self::assertCount(0, $filterCollection->getEnabledFilters());

$filter1 = $filterCollection->enable('testFilter');
self::assertCount(1, $filterCollection->getEnabledFilters());

$filter2 = $filterCollection->suspend('testFilter');
self::assertSame($filter1, $filter2);
$filterCollection->disable('testFilter');
self::assertCount(0, $filterCollection->getEnabledFilters());

$filter3 = $filterCollection->restore('testFilter');
self::assertSame($filter1, $filter3);
self::assertCount(1, $filterCollection->getEnabledFilters());
}

public function testRestoreFailure(): void
{
$filterCollection = $this->em->getFilters();

$this->expectException(InvalidArgumentException::class);
$filterCollection->suspend('testFilter');
}

public function testHasFilter(): void
Expand All @@ -88,6 +49,7 @@ public function testHasFilter(): void
self::assertFalse($filterCollection->has('fakeFilter'));
}

/** @depends testEnable */
public function testIsEnabled(): void
{
$filterCollection = $this->em->getFilters();
Expand All @@ -97,41 +59,6 @@ public function testIsEnabled(): void
$filterCollection->enable('testFilter');

self::assertTrue($filterCollection->isEnabled('testFilter'));

$filterCollection->suspend('testFilter');

self::assertFalse($filterCollection->isEnabled('testFilter'));

$filterCollection->restore('testFilter');

self::assertTrue($filterCollection->isEnabled('testFilter'));

self::assertFalse($filterCollection->isEnabled('wrongFilter'));
}

public function testIsSuspended(): void
{
$filterCollection = $this->em->getFilters();

self::assertFalse($filterCollection->isSuspended('testFilter'));

$filterCollection->enable('testFilter');

self::assertFalse($filterCollection->isSuspended('testFilter'));

$filterCollection->suspend('testFilter');

self::assertTrue($filterCollection->isSuspended('testFilter'));

$filterCollection->restore('testFilter');

self::assertFalse($filterCollection->isSuspended('testFilter'));

$filterCollection->disable('testFilter');

self::assertFalse($filterCollection->isSuspended('testFilter'));

self::assertFalse($filterCollection->isSuspended('wrongFilter'));
}

public function testGetFilterInvalidArgument(): void
Expand All @@ -147,11 +74,6 @@ public function testGetFilter(): void
$filterCollection->enable('testFilter');

self::assertInstanceOf(MyFilter::class, $filterCollection->getFilter('testFilter'));

$filterCollection->suspend('testFilter');

$this->expectException(InvalidArgumentException::class);
$filterCollection->getFilter('testFilter');
}

public function testHashing(): void
Expand All @@ -177,18 +99,6 @@ public function testHashing(): void
self::assertTrue($filterCollection->isClean());
self::assertSame($hash, $filterCollection->getHash());

$filterCollection->suspend('testFilter');

self::assertFalse($filterCollection->isClean());
self::assertSame($oldHash, $filterCollection->getHash());
self::assertTrue($filterCollection->isClean());

$filterCollection->restore('testFilter');

self::assertFalse($filterCollection->isClean());
self::assertSame($hash, $filterCollection->getHash());
self::assertTrue($filterCollection->isClean());

$filterCollection->disable('testFilter');

self::assertFalse($filterCollection->isClean());
Expand Down

0 comments on commit d2de4ec

Please sign in to comment.