Added final getHash method in SQLFilter to avoid caching the filtered…

… queries. Issue: doctrine#3955
bagrinsergiu · Nov 27, 2020 · 398ea44 · 398ea44
1 parent e8c4d7b
commit 398ea44
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 3 deletions.
diff --git a/lib/Doctrine/ORM/Query/Filter/SQLFilter.php b/lib/Doctrine/ORM/Query/Filter/SQLFilter.php
@@ -102,6 +102,27 @@ final public function hasParameter($name)
  return isset($this->parameters[$name]);
  }
 
+ /**
+ * Return a unique hash base on filter class and his parametters
+ *
+ * @return string
+ */
+ final public function getHash()
+ {
+ $parameterCount = count($this->parameters);
+ $hash = get_class($this).$parameterCount;
+ foreach ($this->parameters as $name => $param) {
+ if (is_object($param['value'])) {
+ $valueHash = spl_object_hash($param['value']);
+ } else {
+ $valueHash = $param['value'];
+ }
+ $hash .= $name.$param['type'].$valueHash;
+ }
+
+ return $hash;
+ }
+
  /**
  * Returns as string representation of the SQLFilter parameters (the state).
  *

diff --git a/lib/Doctrine/ORM/Query/FilterCollection.php b/lib/Doctrine/ORM/Query/FilterCollection.php
@@ -187,7 +187,7 @@ public function getHash()
  $filterHash = '';
 
  foreach ($this->enabledFilters as $name => $filter) {
- $filterHash .= $name . $filter;
+ $filterHash .= $name . $filter->getHash();
  }
 
  return $filterHash;

diff --git a/tests/Doctrine/Tests/ORM/Functional/SQLFilterTest.php b/tests/Doctrine/Tests/ORM/Functional/SQLFilterTest.php
@@ -191,6 +191,32 @@ public function testEntityManagerIsFilterEnabled() : void
  self::assertFalse($em->getFilters()->isEnabled('foo_filter'));
  }
 
+ public function testGetHash() : void
+ {
+ $em = $this->getEntityManager();
+ $this->configureFilters($em);
+
+ // Check the filter hash without parameters
+ $em->getFilters()->enable("locale");
+ $filter = $em->getFilters()->getFilter("locale");
+ self::assertEquals('Doctrine\Tests\ORM\Functional\MyLocaleFilter0',$filter->getHash());
+
+ // Check the filter hash with one parameters
+ $filter->setParameter('test','string');
+ self::assertEquals('Doctrine\Tests\ORM\Functional\MyLocaleFilter1test2string',$filter->getHash());
+
+ // Check the filter hash with two parameters
+ $filter->setParameter('test2','string2');
+ self::assertEquals('Doctrine\Tests\ORM\Functional\MyLocaleFilter2test2stringtest22string2',$filter->getHash());
+
+ // Check the filter hash with three parameters one being an object
+ $stdClass = new \stdClass();
+ $splHash = spl_object_hash($stdClass);
+ $filter->setParameter('test3', $stdClass);
+ self::assertEquals('Doctrine\Tests\ORM\Functional\MyLocaleFilter3test2stringtest22string2test32'.$splHash,$filter->getHash());
+ }
+
+
  protected function configureFilters($em)
  {
  // Add filters to the configuration of the EM
@@ -248,9 +274,7 @@ public function testSQLFilterGetSetParameter() : void
  ->method('setFiltersStateDirty');
 
  $filter = new MyLocaleFilter($em);
-
  $filter->setParameter('locale', 'en', DBALType::STRING);
-
  self::assertEquals("'en'", $filter->getParameter('locale'));
  }
 

diff --git a/tests/Doctrine/Tests/ORM/Query/FilterCollectionTest.php b/tests/Doctrine/Tests/ORM/Query/FilterCollectionTest.php
@@ -95,6 +95,17 @@ public function testGetFilter() : void
 
  self::assertInstanceOf(MyFilter::class, $filterCollection->getFilter(self::TEST_FILTER));
  }
+
+ public function testGetHash()
+ {
+ $filterCollection = $this->em->getFilters();
+ $filterCollection->enable('testFilter');
+ $filterCollection->getFilter('testFilter');
+ $filterCollection->setParameter('test','string');
+ $hash = $filterCollection->getHash();
+
+ $this->assertEquals("testFilterDoctrine\Tests\ORM\Query\MyFilter1test2string",$hash);
+ }
 }
 
 class MyFilter extends SQLFilter