CRM/Utils/Cache/Interface.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35 interface CRM_Utils_Cache_Interface {
  36
  37   /**
  38    * Set the value in the cache
  39    *
  40    * @param string $key
  41    * @param mixed $value
  42    * @return void
  43    */
  44   public function set($key, &$value);
  45
  46   /**
  47    * Get a value from the cache
  48    *
  49    * @param string $key
  50    * @return mixed
  51    *   NULL if $key has not been previously set
  52    */
  53   public function get($key);
  54
  55   /**
  56    * Delete a value from the cache
  57    *
  58    * @param string $key
  59    * @return void
  60    */
  61   public function delete($key);
  62
  63   /**
  64    * Delete all values from the cache
  65    *
  66    * @return void
  67    */
  68   public function flush();
  69 }