[Summary view]

   1  <?php
   2  /*
   3   * Copyright 2008 Google Inc.
   4   *
   5   * Licensed under the Apache License, Version 2.0 (the "License");
   6   * you may not use this file except in compliance with the License.
   7   * You may obtain a copy of the License at
   8   *
   9   *     http://www.apache.org/licenses/LICENSE-2.0
  10   *
  11   * Unless required by applicable law or agreed to in writing, software
  12   * distributed under the License is distributed on an "AS IS" BASIS,
  13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14   * See the License for the specific language governing permissions and
  15   * limitations under the License.
  16   */
  17  
  18  /**
  19   * Abstract storage class
  20   *
  21   * @author Chris Chabot <chabotc@google.com>
  22   */
  23  abstract class Google_Cache_Abstract
  24  {
  25    
  26    abstract public function __construct(Google_Client $client);
  27  
  28    /**
  29     * Retrieves the data for the given key, or false if they
  30     * key is unknown or expired
  31     *
  32     * @param String $key The key who's data to retrieve
  33     * @param boolean|int $expiration Expiration time in seconds
  34     *
  35     */
  36    abstract public function get($key, $expiration = false);
  37  
  38    /**
  39     * Store the key => $value set. The $value is serialized
  40     * by this function so can be of any type
  41     *
  42     * @param string $key Key of the data
  43     * @param string $value data
  44     */
  45    abstract public function set($key, $value);
  46  
  47    /**
  48     * Removes the key/data pair for the given $key
  49     *
  50     * @param String $key
  51     */
  52    abstract public function delete($key);
  53  }