Source for file Ethna_Plugin_Cachemanager.php

Documentation is available at Ethna_Plugin_Cachemanager.php

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

Documentation generated on Fri, 11 Nov 2011 04:00:02 +0900 by phpDocumentor 1.4.3