[PropertyInfo] Cache support

dunglas · dunglas · commit 677b45d58450 · 2015-12-09T08:23:40.000+01:00
diff --git a/src/Symfony/Component/PropertyInfo/PropertyInfoExtractor.php b/src/Symfony/Component/PropertyInfo/PropertyInfoExtractor.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\PropertyInfo;
 
+use Doctrine\Common\Cache\Cache;
+
 /**
  * Default {@see PropertyInfoExtractorInterface} implementation.
  *
@@ -38,18 +40,30 @@ class PropertyInfoExtractor implements PropertyInfoExtractorInterface
      */
     private $accessExtractors;
 
+    /**
+     * @var Cache
+     */
+    private $cache;
+
+    /**
+     * @var array
+     */
+    private $arrayCache = array();
+
     /**
      * @param PropertyListExtractorInterface[]        $listExtractors
      * @param PropertyTypeExtractorInterface[]        $typeExtractors
      * @param PropertyDescriptionExtractorInterface[] $descriptionExtractors
      * @param PropertyAccessExtractorInterface[]      $accessExtractors
+     * @param Cache|null                              $cache
      */
-    public function __construct(array $listExtractors = array(), array $typeExtractors = array(),  array $descriptionExtractors = array(), array $accessExtractors = array())
+    public function __construct(array $listExtractors = array(), array $typeExtractors = array(),  array $descriptionExtractors = array(), array $accessExtractors = array(), Cache $cache = null)
     {
         $this->listExtractors = $listExtractors;
         $this->typeExtractors = $typeExtractors;
         $this->descriptionExtractors = $descriptionExtractors;
         $this->accessExtractors = $accessExtractors;
+        $this->cache = $cache;
     }
 
     /**
@@ -111,11 +125,27 @@ public function isWritable($class, $property, array $context = array())
      */
     private function extract(array $extractors, $method, array $arguments)
     {
+        $key = $method.serialize($arguments);
+
+        if (isset($this->arrayCache[$key])) {
+            return $this->arrayCache[$key];
+        }
+
+        if ($this->cache && $value = $this->cache->fetch($key)) {
+            return $this->arrayCache[$key] = $value;
+        }
+
         foreach ($extractors as $extractor) {
             $value = call_user_func_array(array($extractor, $method), $arguments);
             if (null !== $value) {
-                return $value;
+                break;
             }
         }
+
+        if ($this->cache) {
+            $this->cache->save($key, $value);
+        }
+
+        return $this->arrayCache[$key] = $value;
     }
 }
diff --git a/src/Symfony/Component/PropertyInfo/Tests/PropertyInfoExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/PropertyInfoExtractorTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\PropertyInfo\PropertyInfo\Tests;
 
+use Doctrine\Common\Cache\ArrayCache;
 use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\DummyExtractor;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\NullExtractor;
@@ -69,4 +70,13 @@ public function testGetProperties()
     {
         $this->assertEquals(array('a', 'b'), $this->propertyInfo->getProperties('Foo'));
     }
+
+    public function testCache()
+    {
+        $extractors = array(new NullExtractor(), new DummyExtractor());
+        $this->propertyInfo = new PropertyInfoExtractor($extractors, $extractors, $extractors, $extractors, new ArrayCache());
+
+        $this->assertSame('short', $this->propertyInfo->getShortDescription('Foo', 'bar', array()));
+        $this->assertSame('short', $this->propertyInfo->getShortDescription('Foo', 'bar', array()));
+    }
 }
diff --git a/src/Symfony/Component/PropertyInfo/composer.json b/src/Symfony/Component/PropertyInfo/composer.json
@@ -28,12 +28,14 @@
     "require-dev": {
         "symfony/serializer": "~2.8|~3.0",
         "phpdocumentor/reflection": "^1.0.7",
-        "doctrine/annotations": "~1.0"
+        "doctrine/annotations": "~1.0",
+        "doctrine/cache": "~1.0"
     },
     "conflict": {
         "phpdocumentor/reflection": "<1.0.7"
     },
     "suggest": {
+        "doctrine/cache": "To cache results",
         "symfony/doctrine-bridge": "To use Doctrine metadata",
         "phpdocumentor/reflection": "To use the PHPDoc",
         "symfony/serializer": "To use Serializer metadata"

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\PropertyInfo\PropertyInfo\Tests;`
`13`	`13`
	`14`	`+use Doctrine\Common\Cache\ArrayCache;`
`14`	`15`	`use Symfony\Component\PropertyInfo\PropertyInfoExtractor;`
`15`	`16`	`use Symfony\Component\PropertyInfo\Tests\Fixtures\DummyExtractor;`
`16`	`17`	`use Symfony\Component\PropertyInfo\Tests\Fixtures\NullExtractor;`
`@@ -69,4 +70,13 @@ public function testGetProperties()`
`69`	`70`	`{`
`70`	`71`	`$this->assertEquals(array('a', 'b'), $this->propertyInfo->getProperties('Foo'));`
`71`	`72`	`}`
	`73`	`+`
	`74`	`+ public function testCache()`
	`75`	`+ {`
	`76`	`+ $extractors = array(new NullExtractor(), new DummyExtractor());`
	`77`	`+ $this->propertyInfo = new PropertyInfoExtractor($extractors, $extractors, $extractors, $extractors, new ArrayCache());`
	`78`	`+`
	`79`	`+ $this->assertSame('short', $this->propertyInfo->getShortDescription('Foo', 'bar', array()));`
	`80`	`+ $this->assertSame('short', $this->propertyInfo->getShortDescription('Foo', 'bar', array()));`
	`81`	`+ }`
`72`	`82`	`}`