Source for file Cachemanager.php

Documentation is available at Cachemanager.php

  1. <?php
  2. // vim: foldmethod=marker tabstop=4 shiftwidth=4 autoindent
  3. /**
  4.  *  Cachemanager.php
  5.  *
  6.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id: ac49c11a2da714f9426a4c4fb80dc190ec8a9de1 $
  10.  */
  11.  
  12. /**
  13.  *  キャッシュマネージャプラグインクラス
  14.  *
  15.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  16.  *  @access     public
  17.  *  @package    Ethna
  18.  */
  19. class Ethna_Plugin_Cachemanager extends Ethna_Plugin_Abstract
  20. {
  21.     /**#@+  @access private */
  22.  
  23.     /** @var    string  現在のネームスペース */
  24.     protected $namespace = '';
  25.  
  26.     /**#@-*/
  27.  
  28.     /**
  29.      *  _load
  30.      *
  31.      *  @access protected
  32.      */
  33.     protected function _load()
  34.     {
  35.         if (isset($this->config['namespace'])) {
  36.             $this->namespace = $this->config['namespace'];
  37.         }
  38.     }
  39.  
  40.     /**
  41.      *  キャッシュネームスペースを取得する
  42.      *
  43.      *  @access public
  44.      *  @return string  現在のキャッシュネームスペース
  45.      */
  46.     public function getNamespace($namespace = null)
  47.     {
  48.         if ($namespace === null) {
  49.             return $this->namespace;
  50.         }
  51.         else {
  52.             return $namespace;
  53.         }
  54.     }
  55.  
  56.     /**
  57.      *  キャッシュネームスペースを設定する
  58.      *
  59.      *  @access public
  60.      *  @param  string  $namespace  ネームスペース
  61.      */
  62.     public function setNamespace($namespace)
  63.     {
  64.         $this->namespace = $namespace;
  65.     }
  66.  
  67.     /**
  68.      *  キャッシュに設定された値を取得する
  69.      *
  70.      *  キャッシュに値が設定されている場合はキャッシュ値
  71.      *  が戻り値となる。キャッシュに値が無い場合やlifetime
  72.      *  を過ぎている場合、エラーが発生した場合はEthna_Error
  73.      *  オブジェクトが戻り値となる。
  74.      *
  75.      *  @access public
  76.      *  @param  string  $key        キャッシュキー
  77.      *  @param  int     $lifetime   キャッシュ有効期間
  78.      *  @param  string  $namespace  キャッシュネームスペース
  79.      *  @return mixed   キャッシュ値
  80.      */
  81.     public function get($key, $lifetime = null, $namespace = null)
  82.     {
  83.     }
  84.  
  85.     /**
  86.      *  キャッシュの最終更新日時を取得する
  87.      *
  88.      *  @access public
  89.      *  @param  string  $key        キャッシュキー
  90.      *  @param  string  $namespace  キャッシュネームスペース
  91.      *  @return int     最終更新日時(unixtime)
  92.      */
  93.     public function getLastModified($key, $namespace = null)
  94.     {
  95.     }
  96.  
  97.     /**
  98.      *  キャッシュに値を設定する
  99.      *
  100.      *  @access public
  101.      *  @param  string  $key        キャッシュキー
  102.      *  @param  mixed   $value      キャッシュ値
  103.      *  @param  int     $timestamp  キャッシュ最終更新時刻(unixtime)
  104.      *  @param  string  $namespace  キャッシュネームスペース
  105.      */
  106.     public function set($key, $value, $timestamp = null, $namespace = null)
  107.     {
  108.     }
  109.  
  110.     /**
  111.      *  値がキャッシュされているかどうかを取得する
  112.      *
  113.      *  @access public
  114.      *  @param  string  $key        キャッシュキー
  115.      *  @param  int     $lifetime   キャッシュ有効期間
  116.      *  @param  string  $namespace  キャッシュネームスペース
  117.      */
  118.     public function isCached($key, $timestamp = null, $namespace = null)
  119.     {
  120.     }
  121.  
  122.     /**
  123.      *  キャッシュから値を削除する
  124.      *
  125.      *  @access public
  126.      *  @param  string  $key        キャッシュキー
  127.      *  @param  string  $namespace  キャッシュネームスペース
  128.      */
  129.     public function clear($key, $namespace = null)
  130.     {
  131.     }
  132.  
  133.     /**
  134.      *  キャッシュデータをロックする
  135.      *
  136.      *  @access public
  137.      *  @param  string  $key        キャッシュキー
  138.      *  @param  int     $timeout    ロックタイムアウト
  139.      *  @param  string  $namespace  キャッシュネームスペース
  140.      *  @return bool    true:成功 false:失敗
  141.      */
  142.     public function lock($key, $timeout = 5, $namespace = null)
  143.     {
  144.         return false;
  145.     }
  146.  
  147.     /**
  148.      *  キャッシュデータのロックを解除する
  149.      *
  150.      *  @access public
  151.      *  @param  string  $key        キャッシュキー
  152.      *  @param  string  $namespace  キャッシュネームスペース
  153.      *  @return bool    true:成功 false:失敗
  154.      */
  155.     public function unlock($key, $namespace = null)
  156.     {
  157.         return false;
  158.     }
  159.  
  160.     /**
  161.      * 圧縮フラグを立てる
  162.      *
  163.      * MySQLなどいくつかの子クラスで有効
  164.      * 
  165.      * @access public
  166.      * @param bool $flag フラグ
  167.      */
  168.     public function setCompress($flag) {
  169.         return false;
  170.     }
  171. }

Documentation generated on Fri, 11 Nov 2011 03:57:43 +0900 by phpDocumentor 1.4.3