PhpMyObject
[ class tree: PhpMyObject ] [ index: PhpMyObject ] [ all elements ]
Packages:
PhpMyObject

Source for file PMO_MemCache.php

Documentation is available at PMO_MemCache.php

  1. <?php
  2. /**
  3.  * This file contains the PMO_MemCache interface.
  4.  *
  5.  * This file is part of the PhpMyObject project,
  6.  * an Object-Relational Mapping (ORM) system.
  7.  * 
  8.  * For questions, help, comments, discussion, etc., please join our
  9.  * forum at {@link http://www.developpez.net/forums/forumdisplay.php?f=770}
  10.  * or our mailing list at {@link http://groups.google.com/group/pmo-dev}.
  11.  *
  12.  * PhpMyObject is free software: you can redistribute it and/or modify
  13.  * it under the terms of the GNU General Public License as published by
  14.  * the Free Software Foundation, either version 3 of the License, or
  15.  * (at your option) any later version.
  16.  *
  17.  * This program is distributed in the hope that it will be useful,
  18.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.    See the
  20.  * GNU General Public License for more details.
  21.  *
  22.  * You should have received a copy of the GNU General Public License
  23.  * along with this program.  If not, see {@link http://www.gnu.org/licenses/}.
  24.  *
  25.  * @package        PhpMyObject
  26.  * @subpackage PMO_Core
  27.  * @author        Nicolas Boiteux <nicolas_boiteux@yahoo.fr>
  28.  * @link            http://pmo.developpez.com/
  29.  * @since        PhpMyObject v0.1
  30.  * @version        $Revision: $
  31.  * @copyright    Copyright (C) 2007-2008 Nicolas Boiteux
  32.  * @license        GPLv3 {@link http://www.gnu.org/licenses/gpl}
  33.  * @filesource
  34.  *
  35.  */ 
  36.  
  37. /**
  38.  * This interface defines the methods a class must implement
  39.  * to provide a working MemCache class.
  40.  * 
  41.  * @package        PhpMyObject
  42.  * @subpackage PMO_Core
  43.  * @see            PMO_MyMemCache
  44.  */ 
  45. interface PMO_MemCache{
  46.  
  47.     /**
  48.      * connects to the memcache server
  49.      *
  50.      * connect() uses the configuration information from
  51.      * your_config.php
  52.      */
  53.     public function connect();
  54.  
  55.     /**
  56.      * closes the connection to the memcache server
  57.      */
  58.     public function close();
  59.  
  60.     /**
  61.      * retrieve a PMO_Object into the memcache
  62.      * 
  63.      * @return PMO_Object 
  64.      */    
  65.     public function get(PMO_Object $object);    
  66.     
  67.     /**
  68.      * replaces an existing object in the memcache
  69.      */
  70.     public function replace(PMO_Object $object);
  71.  
  72.     /**
  73.      * inserts a new PMO_Object into the memcache
  74.      */
  75.     public function set($key, PMO_Object $object);
  76.  
  77.     /**
  78.      * deletes an existing PMO_Object from the memcache server
  79.      */
  80.     public function delete(PMO_Object $object);
  81.     
  82.     public function flush();
  83.  
  84. }
  85. ?>
Documentation generated on Wed, 15 Oct 2008 09:16:39 -0400 by phpDocumentor 1.4.1