[Cache] Create NullAdapter to disable cache if needed #18825
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Cache\Adapter; | ||
|
|
||
| use Psr\Cache\CacheItemInterface; | ||
| use Symfony\Component\Cache\CacheItem; | ||
|
|
||
| /** | ||
| * @author Titouan Galopin <galopintitouan@gmail.com> | ||
| */ | ||
| class NullAdapter implements AdapterInterface | ||
| { | ||
| private $createCacheItem; | ||
|
|
||
| public function __construct() | ||
| { | ||
| $this->createCacheItem = \Closure::bind( | ||
| function ($key) { | ||
| $item = new CacheItem(); | ||
| $item->key = $key; | ||
| $item->isHit = false; | ||
|
|
||
| return $item; | ||
| }, | ||
| $this, | ||
| CacheItem::class | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getItem($key) | ||
| { | ||
| $f = $this->createCacheItem; | ||
|
|
||
| return $f($key); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getItems(array $keys = array()) | ||
| { | ||
| return $this->generateItems($keys); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function hasItem($key) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function clear() | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function deleteItem($key) | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function deleteItems(array $keys) | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function save(CacheItemInterface $item) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function saveDeferred(CacheItemInterface $item) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function commit() | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| private function generateItems(array $keys) | ||
| { | ||
| $f = $this->createCacheItem; | ||
|
|
||
| foreach ($keys as $key) { | ||
| yield $key => $f($key); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Cache\Tests\Adapter; | ||
|
|
||
| use Psr\Cache\CacheItemInterface; | ||
| use Symfony\Component\Cache\Adapter\NullAdapter; | ||
|
|
||
| class NullAdapterTest extends \PHPUnit_Framework_TestCase | ||
| { | ||
| public function createCachePool() | ||
| { | ||
| return new NullAdapter(); | ||
| } | ||
|
|
||
| public function testGetItem() | ||
| { | ||
| $adapter = $this->createCachePool(); | ||
|
|
||
| $item = $adapter->getItem('key'); | ||
| $this->assertFalse($item->isHit()); | ||
| $this->assertNull($item->get(), "Item's value must be null when isHit is false."); | ||
| } | ||
|
|
||
| public function testHasItem() | ||
| { | ||
| $this->assertFalse($this->createCachePool()->hasItem('key')); | ||
| } | ||
|
|
||
| public function testGetItems() | ||
| { | ||
| $adapter = $this->createCachePool(); | ||
|
|
||
| $keys = array('foo', 'bar', 'baz', 'biz'); | ||
|
|
||
| /** @var CacheItemInterface[] $items */ | ||
| $items = $adapter->getItems($keys); | ||
| $count = 0; | ||
|
|
||
| foreach ($items as $key => $item) { | ||
| $itemKey = $item->getKey(); | ||
|
|
||
| $this->assertEquals($itemKey, $key, 'Keys must be preserved when fetching multiple items'); | ||
| $this->assertTrue(in_array($key, $keys), 'Cache key can not change.'); | ||
| $this->assertFalse($item->isHit()); | ||
|
|
||
| // Remove $key for $keys | ||
| foreach ($keys as $k => $v) { | ||
| if ($v === $key) { | ||
| unset($keys[$k]); | ||
| } | ||
| } | ||
|
|
||
| ++$count; | ||
| } | ||
|
|
||
| $this->assertSame(4, $count); | ||
| } | ||
|
|
||
| public function testIsHit() | ||
| { | ||
| $adapter = $this->createCachePool(); | ||
|
|
||
| $item = $adapter->getItem('key'); | ||
| $this->assertFalse($item->isHit()); | ||
| } | ||
|
|
||
| public function testClear() | ||
| { | ||
| $this->assertTrue($this->createCachePool()->clear()); | ||
| } | ||
|
|
||
| public function testDeleteItem() | ||
| { | ||
| $this->assertTrue($this->createCachePool()->deleteItem('key')); | ||
| } | ||
|
|
||
| public function testDeleteItems() | ||
| { | ||
| $this->assertTrue($this->createCachePool()->deleteItems(array('key', 'foo', 'bar'))); | ||
| } | ||
|
|
||
| public function testSave() | ||
| { | ||
| $adapter = $this->createCachePool(); | ||
|
|
||
| $item = $adapter->getItem('key'); | ||
| $this->assertFalse($item->isHit()); | ||
| $this->assertNull($item->get(), "Item's value must be null when isHit is false."); | ||
|
|
||
| $this->assertFalse($adapter->save($item)); | ||
| } | ||
|
|
||
| public function testDeferredSave() | ||
| { | ||
| $adapter = $this->createCachePool(); | ||
|
|
||
| $item = $adapter->getItem('key'); | ||
| $this->assertFalse($item->isHit()); | ||
| $this->assertNull($item->get(), "Item's value must be null when isHit is false."); | ||
|
|
||
| $this->assertFalse($adapter->saveDeferred($item)); | ||
| } | ||
|
|
||
| public function testCommit() | ||
| { | ||
| $adapter = $this->createCachePool(); | ||
|
|
||
| $item = $adapter->getItem('key'); | ||
| $this->assertFalse($item->isHit()); | ||
| $this->assertNull($item->get(), "Item's value must be null when isHit is false."); | ||
|
There was a problem hiding this comment. Not sure about the symfony standard, but i would recommend to use There was a problem hiding this comment. not mandatory: we add double quotes when we need special chars like There was a problem hiding this comment. thank you for the feedback 👍 |
||
|
|
||
| $this->assertFalse($adapter->saveDeferred($item)); | ||
| $this->assertFalse($this->createCachePool()->commit()); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
phpdoc missing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't add phpdoc on private properties when IDEs are able to infer the type from the constructor (which is the case here)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for your feedback 👍