MemcachedCache.php

<?php

/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */
namespace Doctrine\Common\Cache;

use Memcached;

/**
 * Memcached cache provider.
 *
 * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link    www.doctrine-project.org
 * @since   2.2
 * @author  Benjamin Eberlei <kontakt@beberlei.de>
 * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
 * @author  Jonathan Wage <jonwage@gmail.com>
 * @author  Roman Borschel <roman@code-factory.org>
 * @author  David Abdemoulaie <dave@hobodave.com>
 */
class MemcachedCache extends CacheProvider {

  /**
   * @var Memcached
   */
  private $memcached;

  /**
   * Sets the memcache instance to use.
   *
   * @param Memcached $memcached
   */
  public function setMemcached(Memcached $memcached) {
    $this->memcached = $memcached;
  }

  /**
   * Gets the memcached instance used by the cache.
   *
   * @return Memcached
   */
  public function getMemcached() {
    return $this->memcached;
  }

  /**
   * {@inheritdoc}
   */
  protected function doFetch($id) {
    return $this->memcached
      ->get($id);
  }

  /**
   * {@inheritdoc}
   */
  protected function doContains($id) {
    return false !== $this->memcached
      ->get($id);
  }

  /**
   * {@inheritdoc}
   */
  protected function doSave($id, $data, $lifeTime = 0) {
    if ($lifeTime > 30 * 24 * 3600) {
      $lifeTime = time() + $lifeTime;
    }
    return $this->memcached
      ->set($id, $data, (int) $lifeTime);
  }

  /**
   * {@inheritdoc}
   */
  protected function doDelete($id) {
    return $this->memcached
      ->delete($id);
  }

  /**
   * {@inheritdoc}
   */
  protected function doFlush() {
    return $this->memcached
      ->flush();
  }

  /**
   * {@inheritdoc}
   */
  protected function doGetStats() {
    $stats = $this->memcached
      ->getStats();
    $servers = $this->memcached
      ->getServerList();
    $key = $servers[0]['host'] . ':' . $servers[0]['port'];
    $stats = $stats[$key];
    return array(
      Cache::STATS_HITS => $stats['get_hits'],
      Cache::STATS_MISSES => $stats['get_misses'],
      Cache::STATS_UPTIME => $stats['uptime'],
      Cache::STATS_MEMORY_USAGE => $stats['bytes'],
      Cache::STATS_MEMORY_AVAILIABLE => $stats['limit_maxbytes'],
    );
  }

}