Source for file Memcached.php

Documentation is available at Memcached.php

  1. <?php
  2. /**
  3.  *  Memcached.php
  4.  *
  5.  *  @author     Sotaro Karasawa <sotaro.k /at/ gmail.com>
  6.  *  @package    Ethna
  7.  *  @version    $Id: 1fbc96e645255b34b8b3d8f9e60bc75fb270f213 $
  8.  */
  9.  
  10. /**
  11.  *  キャッシュマネージャクラス(pecl::memcached 版)
  12.  *
  13.  *  @author     Sotaro Karasawa <sotaro.k /at/ gmail.com>
  14.  *  @access     public
  15.  *  @package    Ethna
  16.  */
  17. class Ethna_Plugin_Cachemanager_Memcached extends Ethna_Plugin_Cachemanager
  18. {
  19.     /**#@+  @access private */
  20.  
  21.     /** @var    object  Memcached    Memcached オブジェクト */
  22.     private $m = null;
  23.  
  24.     /** @var    array   plugin configure */
  25.     public $config_default = array(
  26.         'host' => 'localhost',
  27.         'port' => '11211',
  28.         'use_pconnect' => false,
  29.         'retry' => 3,
  30.         'timeout' => 3,
  31.     );
  32.  
  33.     protected $_get_data_cache = array();
  34.  
  35.     /**#@-*/
  36.  
  37.     /**
  38.      *  _load
  39.      *
  40.      *  @access protected
  41.      */
  42.     protected function _load()
  43.     {
  44.         parent::_load();
  45.  
  46.         if ($this->config['use_pconnect']) {
  47.             $this->m = new Memcached($this->ctl->getAppId());
  48.         }
  49.         else {
  50.             $this->m = new Memcached();
  51.         }
  52.  
  53.         if (isset($this->config['servers']) && is_array($this->config['servers'])) {
  54.             $this->m->addServers($this->config['servers']);
  55.         }
  56.         else {
  57.             $this->m->addServer($this->config['host'], $this->config['port']);
  58.         }
  59.  
  60.         $this->m->setOption(Memcached::OPT_CONNECT_TIMEOUT, $this->config['timeout'] * 1000);
  61.         //$this->m->setOption(Memcached::OPT_CONNECT_TIMEOUT, $this->config['retry']);
  62.     }
  63.  
  64.     /**
  65.      *  get cached data
  66.      *
  67.      *  キャッシュに値が設定されている場合はキャッシュ値
  68.      *  が戻り値となる。キャッシュに値が無い場合やlifetime
  69.      *  を過ぎている場合、エラーが発生した場合はEthna_Error
  70.      *  オブジェクトが戻り値となる。
  71.      *
  72.      *  @access public
  73.      *  @param  string  $key        cache key
  74.      *  @param  int     $lifetime   cache lifetime
  75.      *  @param  string  $namespace  namespace
  76.      *  @return mixed   value
  77.      */
  78.     public function get($key, $lifetime = null, $namespace = null)
  79.     {
  80.         $cache_key = $this->_getCacheKey($namespace, $key);
  81.         if ($cache_key == null) {
  82.             return Ethna::raiseError('invalid cache key (too long?)', E_CACHE_NO_VALUE);
  83.         }
  84.  
  85.         if (isset($this->_get_data_cache[$cache_key])) {
  86.             return $this->_get_data_cache[$cache_key]['data'];
  87.         }
  88.  
  89.         $value = $this->m->get($cache_key);
  90.         if (!$value) {
  91.             return Ethna::raiseWarning(
  92.                 sprintf('no such cache, key="%s", message="%s"', $key, $this->m->getResultMessage()),
  93.                 E_CACHE_NO_VALUE
  94.             );
  95.         }
  96.  
  97.         $time = $value['time'];
  98.         $data = $value['data'];
  99.  
  100.         // ライフタイムチェック
  101.         if ($lifetime !== null) {
  102.             if (($time + $lifetime) < time()) {
  103.                 return Ethna::raiseWarning('lifetime expired', E_CACHE_EXPIRED);
  104.             }
  105.         }
  106.  
  107.         // result cache
  108.         $this->_get_data_cache[$cache_key] = $value;
  109.  
  110.         return $data;
  111.     }
  112.  
  113.     /**
  114.      *  キャッシュの最終更新日時を取得する
  115.      *
  116.      *  @access public
  117.      *  @param  string  $key        cache key
  118.      *  @param  string  $namespace  cache namespace
  119.      *  @return int     unixtime
  120.      */
  121.     public function getLastModified($key, $namespace = null)
  122.     {
  123.         $cache_key = $this->_getCacheKey($namespace, $key);
  124.         if ($cache_key == null) {
  125.             return Ethna::raiseError('invalid cache key (too long?)', E_CACHE_NO_VALUE);
  126.         }
  127.  
  128.         $value = $this->get($cache_key);
  129.         if (Ethna::isError($value)) {
  130.             return $value;
  131.         }
  132.  
  133.         return $value['time'];
  134.     }
  135.  
  136.     /**
  137.      *  check cache exists
  138.      *
  139.      *  @access public
  140.      *  @param  string  $key        cache key
  141.      *  @param  int     $lifetime   lifetime
  142.      *  @param  string  $namespace  namespace
  143.      */
  144.     public function isCached($key, $lifetime = null, $namespace = null)
  145.     {
  146.         $r = $this->get($key, $lifetime, $namespace);
  147.  
  148.         return !Ethna::isError($r);
  149.     }
  150.  
  151.     /**
  152.      *  set cache
  153.      *
  154.      *  @access public
  155.      *  @param  string  $key        cache key
  156.      *  @param  mixed   $value      cache value
  157.      *  @param  int     $timestamp  timestamp of last modified
  158.      *  @param  string  $namespace  namespace
  159.      *  @param  int     $lifetime   expiration
  160.      */
  161.     public function set($key, $value, $timestamp = null, $namespace = null, $expiration = null)
  162.     {
  163.         $cache_key = $this->_getCacheKey($namespace, $key);
  164.         if ($cache_key === null) {
  165.             return Ethna::raiseError('invalid cache key (too long?)', E_CACHE_NO_VALUE);
  166.         }
  167.  
  168.         $time = $timestamp ? $timestamp : time();
  169.         $expiration = $expiration ? $expiration : 0;
  170.         if (!$this->m->set($cache_key, array('time' => $time, 'data' => $value), $expiration)) {
  171.             return Ethna::raiseError(
  172.                 sprintf('failed to set cache, key="%s", message="%s"', $key, $this->m->getResultMessage()),
  173.                 E_CACHE_GENERAL
  174.             );
  175.         }
  176.  
  177.         return true;
  178.     }
  179.  
  180.     /**
  181.      *  delete cache
  182.      *
  183.      *  @access public
  184.      *  @param  string  $key        キャッシュキー
  185.      *  @param  string  $namespace  キャッシュネームスペース
  186.      */
  187.     public function clear($key, $namespace = null)
  188.     {
  189.         $cache_key = $this->_getCacheKey($namespace, $key);
  190.         if ($cache_key === null) {
  191.             return Ethna::raiseError('invalid cache key (too long?)', E_CACHE_NO_VALUE);
  192.         }
  193.  
  194.         if (!$this->m->delete($cache_key)) {
  195.             return Ethna::raiseError(
  196.                 sprintf('failed to clear cache, key="%s", message="%s"', $key, $this->m->getResultMessage()),
  197.                 E_CACHE_NO_VALUE
  198.             );
  199.         }
  200.  
  201.         return true;
  202.     }
  203.  
  204.     /**
  205.      *  キャッシュデータをロックする
  206.      *
  207.      *  @access public
  208.      *  @param  string  $key        キャッシュキー
  209.      *  @param  int     $timeout    ロックタイムアウト
  210.      *  @param  string  $namespace  キャッシュネームスペース
  211.      *  @return bool    true:成功 false:失敗
  212.      */
  213.     public function lock($key, $timeout = 5, $namespace = null)
  214.     {
  215.         // not supported
  216.         return true;
  217.     }
  218.  
  219.     /**
  220.      *  キャッシュデータのロックを解除する
  221.      *
  222.      *  @access public
  223.      *  @param  string  $key        キャッシュキー
  224.      *  @param  string  $namespace  キャッシュネームスペース
  225.      *  @return bool    true:成功 false:失敗
  226.      */
  227.     public function unlock($key, $namespace = null)
  228.     {
  229.         // not supported
  230.         return true;
  231.     }
  232.  
  233.     /**
  234.      *  set option of pecl::memcached directly
  235.      *
  236.      *  @access public
  237.      *  @param  string  $opt    option key
  238.      *  @param  string  $value  opeion value
  239.      *  @return bool 
  240.      *  @see http://jp.php.net/manual/memcached.setoption.php
  241.      */
  242.     public function setMemcachedOption($opt, $value)
  243.     {
  244.         return $this->m->setOption($opt, $value);
  245.     }
  246.  
  247.     /**
  248.      *  get option of pecl::memcached directly
  249.      *
  250.      *  @access public
  251.      *  @param  string  $opt    option key
  252.      *  @return mixed 
  253.      *  @see http://jp.php.net/manual/memcached.getoption.php
  254.      */
  255.     public function getMemcachedOption($opt)
  256.     {
  257.         return $this->m->getOption($opt);
  258.     }
  259.  
  260.     /**
  261.      *  ネームスペースからキャッシュキーを生成する
  262.      *
  263.      *  @access private
  264.      */
  265.     private function _getCacheKey($namespace, $key)
  266.     {
  267.         $namespace = $this->getNamespace($namespace);
  268.  
  269.         $key = str_replace(":", "_", $key);
  270.         $cache_key = $namespace . "::" . $key;
  271.         if (strlen($cache_key) > 250) {
  272.             return null;
  273.         }
  274.         return $cache_key;
  275.     }
  276. }

Documentation generated on Fri, 11 Nov 2011 03:58:41 +0900 by phpDocumentor 1.4.3