Skip to content

[Cache] Simple Memcached Adapter #20858

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

Merged
merged 1 commit into from
Dec 13, 2016
Merged

[Cache] Simple Memcached Adapter #20858

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
80 changes: 80 additions & 0 deletions src/Symfony/Component/Cache/Adapter/MemcachedAdapter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<?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;

/**
* @author Rob Frawley 2nd <rmf@src.run>
*/
class MemcachedAdapter extends AbstractAdapter
{
private $client;

public static function isSupported()
{
return extension_loaded('memcached') && version_compare(phpversion('memcached'), '2.2.0', '>=');
}

public function __construct(\Memcached $client, $namespace = '', $defaultLifetime = 0)
{
parent::__construct($namespace, $defaultLifetime);
$this->client = $client;
}

/**
* {@inheritdoc}
*/
protected function doSave(array $values, $lifetime)
{
return $this->client->setMulti($values, $lifetime)
&& $this->client->getResultCode() === \Memcached::RES_SUCCESS;
}

/**
* {@inheritdoc}
*/
protected function doFetch(array $ids)
{
return $this->client->getMulti($ids);
}

/**
* {@inheritdoc}
*/
protected function doHave($id)
{
return $this->client->get($id) !== false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since false is a valid value, this can't work, isn't it?
I guess this should be

        $this->client->get($id);

        return $this->client->getResultCode() === \Memcached::RES_SUCCESS;

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is an error on my part: intended for that to be an OR (||). The idea is to avoid the additional call to $this->client->getResultCode() if the $this->client->get($id) isn't false.

Copy link
Contributor Author

@robfrawley robfrawley Dec 11, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what I meant to have there (and what I'd recommend we use):

protected function doHave($id)
    {
        return $this->client->get($id) !== false
            || $this->client->getResultCode() !== \Memcached::RES_NOTFOUND;
    }

Kind of a micro-optimization, but worth avoiding an additional function call if unnecessary, IMHO.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated per above comment.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checking against === RES_SUCCESS looks required to me, !== opens for all the other codes

Copy link
Contributor Author

@robfrawley robfrawley Dec 11, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, that change does make sense. I missed the change from !== RES_NOTFOUND to === RES_SUCCESS in your comment. Updated in latest push.

|| $this->client->getResultCode() === \Memcached::RES_SUCCESS;
}

/**
* {@inheritdoc}
*/
protected function doDelete(array $ids)
{
$toDelete = count($ids);
foreach ($this->client->deleteMulti($ids) as $result) {
if (\Memcached::RES_SUCCESS === $result || \Memcached::RES_NOTFOUND === $result) {
--$toDelete;
}
}

return 0 === $toDelete;
}

/**
* {@inheritdoc}
*/
protected function doClear($namespace)
{
return $this->client->flush();
}
}
50 changes: 50 additions & 0 deletions src/Symfony/Component/Cache/Tests/Adapter/MemcachedAdapterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<?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 Symfony\Component\Cache\Adapter\MemcachedAdapter;

class MemcachedAdapterTest extends AdapterTestCase
{
protected $skippedTests = array(
'testExpiration' => 'Testing expiration slows down the test suite',
'testHasItemReturnsFalseWhenDeferredItemIsExpired' => 'Testing expiration slows down the test suite',
'testDefaultLifeTime' => 'Testing expiration slows down the test suite',
);

private static $client;

public static function setupBeforeClass()
{
if (!MemcachedAdapter::isSupported()) {
self::markTestSkipped('Extension memcached >=2.2.0 required.');
}

self::$client = new \Memcached();
self::$client->addServers(array(array(
getenv('MEMCACHED_HOST') ?: '127.0.0.1',
getenv('MEMCACHED_PORT') ?: 11211,
)));

parent::setupBeforeClass();
}

public function createCachePool($defaultLifetime = 0)
{
return new MemcachedAdapter(self::$client, str_replace('\\', '.', __CLASS__), $defaultLifetime);
}

public function testIsSupported()
{
$this->assertTrue(MemcachedAdapter::isSupported());
}
}