1
0
mirror of synced 2024-12-14 07:06:04 +03:00
doctrine2/lib/Doctrine/ORM/Cache/Cache.php

71 lines
2.6 KiB
PHP
Raw Normal View History

2007-01-29 01:16:26 +03:00
<?php
/*
2008-09-12 13:28:18 +04:00
* $Id: Interface.php 3931 2008-03-05 11:24:33Z romanb $
2007-01-29 01:16:26 +03:00
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.doctrine-project.org>.
2007-01-29 01:16:26 +03:00
*/
namespace Doctrine\ORM\Cache;
2009-01-07 00:47:29 +03:00
2007-01-29 01:16:26 +03:00
/**
2009-01-07 00:47:29 +03:00
* Interface for cache drivers.
2007-01-29 01:16:26 +03:00
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
2009-01-07 00:47:29 +03:00
* @link www.doctrine-project.org
2007-01-29 01:16:26 +03:00
* @since 1.0
2008-09-12 13:28:18 +04:00
* @version $Revision: 3931 $
2007-01-29 01:16:26 +03:00
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
2009-01-07 00:47:29 +03:00
* @author Roman Borschel <roman@code-factory.org>
2007-01-29 01:16:26 +03:00
*/
interface Cache
2007-01-29 01:16:26 +03:00
{
/**
* Test if a cache entry is available for the given id and (if yes) return it (false else).
2007-01-29 01:16:26 +03:00
*
* Note : return value is always "string" (unserialization is done by the core not by the backend)
*
* @param string $id cache id
* @return string cached datas (or false)
*/
public function fetch($id);
2007-01-29 01:16:26 +03:00
/**
* Test if a cache is available or not (for the given id)
*
* @param string $id cache id
* @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record
*/
public function contains($id);
/**
* Puts data into the cache.
2007-01-29 01:16:26 +03:00
*
* @param string $id cache id
* @param string $data data to cache
2007-01-29 01:16:26 +03:00
* @param int $lifeTime if != false, set a specific lifetime for this cache record (null => infinite lifeTime)
* @return boolean true if no problem
*/
public function save($id, $data, $lifeTime = false);
2007-01-29 01:16:26 +03:00
/**
* Remove a cache record
*
* @param string $id cache id
* @return boolean true if no problem
*/
public function delete($id);
}