Source for file INFA_OCSP_CACHE.phpclass

Documentation is available at INFA_OCSP_CACHE.phpclass

  1. <?php
  2. /**
  3.   * openCSP interface file INFA_OCSP_CACHE.phpclass
  4.   *
  5.   * @project Open CSP-Management
  6.   * @package cache
  7.   *
  8.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  9.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.   *
  11.   * @since pk-11.06.2008
  12.   * @version $Id: INFA_OCSP_CACHE.phpclass,v 1.2 2008/06/20 15:29:55 pitlinz Exp $
  13.   */
  14.  
  15. // ---------------------------------------------------------
  16. // requirements
  17. // ---------------------------------------------------------
  18.  
  19.  
  20. /**
  21.   * openCSP interface INFA_OCSP_CACHE
  22.   *
  23.   * @project Open CSP-Management
  24.   * @package cache
  25.   *
  26.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  27.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  28.   *
  29.   * @since pk-11.06.2008
  30.   * @version $Id: INFA_OCSP_CACHE.phpclass,v 1.2 2008/06/20 15:29:55 pitlinz Exp $
  31.   */
  32. interface INFA_OCSP_CACHE
  33. {
  34.     /*** class constants  --------------------------------------------- */
  35.  
  36.     /*** class variables  --------------------------------------------- */
  37.  
  38.     /*** class functions  --------------------------------------------- */
  39.     
  40.     /**
  41.      * returns if the cache type is usable on the system
  42.      *
  43.      * @param boolean $debug 
  44.      * @return boolean 
  45.      */
  46.     public static function isUseable($debug=False);
  47.     
  48.     /*** compostion --------------------------------------------------- */
  49.     
  50.     /*** attributes  -------------------------------------------------- */
  51.     
  52.     /*** factory / construct  ----------------------------------------- */
  53.     
  54.     /**
  55.      * returns the instance of the singleton class
  56.      *
  57.      * @param string $group 
  58.      * 
  59.      * @return OCSP_CACHE 
  60.      * @access public
  61.      */
  62.     static function getInstance($group='DEFAULT');    
  63.     
  64.     /*** getter / setter ---------------------------------------------- */
  65.     
  66.     /**
  67.      * returns a cached value
  68.      *
  69.      * @param string $aName 
  70.      * 
  71.      * @return mixed 
  72.      * 
  73.      * @access public
  74.      */
  75.     function getValue($aName);
  76.  
  77.     /**
  78.      * sets a value
  79.      * 
  80.      * NOTE the value is stored on destruct
  81.      *
  82.      * @param string $aName 
  83.      * @param mixed $aValue 
  84.      * @param mixed $ttl 
  85.      * @param boolean $autotouch (if true ttl will be expanded on every use of the value)
  86.      * 
  87.      * @access public
  88.      */
  89.     function setValue($aName,$aValue,$ttl=0,$autotouch=False);
  90.  
  91.     /**
  92.      * removes a value from the cache
  93.      * 
  94.      * @param string $aName 
  95.      * 
  96.      * @access public
  97.      */
  98.     function unsetValue($aName);
  99.     
  100.     /*** persistent storage ------------------------------------------- */
  101.     
  102.     /**
  103.      * returns a stored value
  104.      * 
  105.      * @param string $aName 
  106.      * 
  107.      * @return array 
  108.      * 
  109.      * @access protected
  110.      */    
  111.     function getStoredValueArr($aName);
  112.     
  113.     /**
  114.      * stores all temp cached values
  115.      * 
  116.      * @param boolean $debug 
  117.      * 
  118.      * @access public
  119.      */
  120.     function storeMyValues($debug=False);
  121.     
  122. }
  123.  
  124. ?>

Documentation generated on Thu, 08 Jan 2009 17:44:28 +0100 by phpDocumentor 1.4.0a2