1 <?php

     2 /*

     3  *  $Id$

     4  *

     5  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

     6  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

     7  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

     8  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

     9  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

    10  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

    11  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

    12  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

    13  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

    14  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

    15  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    16  *

    17  * This software consists of voluntary contributions made by many individuals

    18  * and is licensed under the LGPL. For more information, see

    19  * <http://www.doctrine-project.org>.

    20  */

    21 

    22 namespace Doctrine\Common\Cache;

    23 

    24 /**

    25  * Interface for cache drivers.

    26  *

    27  * @license http://www.opensource.org/licenses/lgpl-license.php LGPL

    28  * @link    www.doctrine-project.org

    29  * @since   2.0

    30  * @version $Revision: 3938 $

    31  * @author  Benjamin Eberlei <kontakt@beberlei.de>

    32  * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>

    33  * @author  Jonathan Wage <jonwage@gmail.com>

    34  * @author  Roman Borschel <roman@code-factory.org>

    35  */

    36 interface Cache

    37 {

    38     /**

    39      * Fetches an entry from the cache.

    40      * 

    41      * @param string $id cache id The id of the cache entry to fetch.

    42      * @return string The cached data or FALSE, if no cache entry exists for the given id.

    43      */

    44     function fetch($id);

    45 

    46     /**

    47      * Test if an entry exists in the cache.

    48      *

    49      * @param string $id cache id The cache id of the entry to check for.

    50      * @return boolean TRUE if a cache entry exists for the given cache id, FALSE otherwise.

    51      */

    52     function contains($id);

    53 

    54     /**

    55      * Puts data into the cache.

    56      *

    57      * @param string $id The cache id.

    58      * @param string $data The cache entry/data.

    59      * @param int $lifeTime The lifetime. If != 0, sets a specific lifetime for this cache entry (0 => infinite lifeTime).

    60      * @return boolean TRUE if the entry was successfully stored in the cache, FALSE otherwise.

    61      */

    62     function save($id, $data, $lifeTime = 0);

    63 

    64     /**

    65      * Deletes a cache entry.

    66      * 

    67      * @param string $id cache id

    68      * @return boolean TRUE if the cache entry was successfully deleted, FALSE otherwise.

    69      */

    70     function delete($id);

    71 }