174 lines
5.9 KiB
HTML
174 lines
5.9 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||
|
|
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
|
||
|
|
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
|
||
|
|
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
|
||
|
|
|
||
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
|
||
|
|
<link rel="start" href="../../../overview-summary.html">
|
||
|
|
|
||
|
|
<title>Cache (Doctrine)</title>
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body id="definition" onload="parent.document.title=document.title;">
|
||
|
|
|
||
|
|
<div class="header">
|
||
|
|
<h1>Doctrine</h1>
|
||
|
|
<ul>
|
||
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
||
|
|
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
|
||
|
|
<li class="active">Class</li>
|
||
|
|
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
|
||
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
||
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="small_links">
|
||
|
|
<a href="../../../index.html" target="_top">Frames</a>
|
||
|
|
<a href="../../../doctrine/common/cache/cache.html" target="_top">No frames</a>
|
||
|
|
</div>
|
||
|
|
<div class="small_links">
|
||
|
|
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
|
||
|
|
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
|
||
|
|
</div>
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<div class="qualifiedName">Doctrine\Common\Cache\Cache</div>
|
||
|
|
<div class="location">/Doctrine/Common/Cache/Cache.php at line 36</div>
|
||
|
|
|
||
|
|
<h1>Interface Cache</h1>
|
||
|
|
|
||
|
|
<pre class="tree"><strong>Cache</strong><br /></pre>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<p class="signature">public interface <strong>Cache</strong></p>
|
||
|
|
|
||
|
|
<div class="comment" id="overview_description"><p>Interface for cache drivers.</p></div>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt>License:</dt>
|
||
|
|
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd><code>www.doctrine-project.org</code></dd>
|
||
|
|
<dt>Since:</dt>
|
||
|
|
<dd>2.0</dd>
|
||
|
|
<dt>Version:</dt>
|
||
|
|
<dd>$Revision: 3938 $</dd>
|
||
|
|
<dt>Author:</dt>
|
||
|
|
<dd>Benjamin Eberlei <kontakt@beberlei.de></dd>
|
||
|
|
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
|
||
|
|
<dd>Jonathan Wage <jonwage@gmail.com></dd>
|
||
|
|
<dd>Roman Borschel <roman@code-factory.org></dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<table id="summary_method">
|
||
|
|
<tr><th colspan="2">Method Summary</th></tr>
|
||
|
|
<tr>
|
||
|
|
<td class="type"> boolean</td>
|
||
|
|
<td class="description"><p class="name"><a href="#contains()">contains</a>(string id)</p><p class="description">Test if an entry exists in the cache.</p></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="type"> boolean</td>
|
||
|
|
<td class="description"><p class="name"><a href="#delete()">delete</a>(string id)</p><p class="description">Deletes a cache entry.</p></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="type"> string</td>
|
||
|
|
<td class="description"><p class="name"><a href="#fetch()">fetch</a>(string id)</p><p class="description">Fetches an entry from the cache.</p></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="type"> boolean</td>
|
||
|
|
<td class="description"><p class="name"><a href="#save()">save</a>(string id, string data, int lifeTime)</p><p class="description">Puts data into the cache.</p></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h2 id="detail_method">Method Detail</h2>
|
||
|
|
<div class="location">/Doctrine/Common/Cache/Cache.php at line 52</div>
|
||
|
|
<h3 id="contains()">contains</h3>
|
||
|
|
<code class="signature">public boolean <strong>contains</strong>(string id)</code>
|
||
|
|
<div class="details">
|
||
|
|
<p>Test if an entry exists in the cache.</p><dl>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd>id - cache id The cache id of the entry to check for.</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>TRUE if a cache entry exists for the given cache id, FALSE otherwise.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<div class="location">/Doctrine/Common/Cache/Cache.php at line 70</div>
|
||
|
|
<h3 id="delete()">delete</h3>
|
||
|
|
<code class="signature">public boolean <strong>delete</strong>(string id)</code>
|
||
|
|
<div class="details">
|
||
|
|
<p>Deletes a cache entry.</p><dl>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd>id - cache id</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>TRUE if the cache entry was successfully deleted, FALSE otherwise.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<div class="location">/Doctrine/Common/Cache/Cache.php at line 44</div>
|
||
|
|
<h3 id="fetch()">fetch</h3>
|
||
|
|
<code class="signature">public string <strong>fetch</strong>(string id)</code>
|
||
|
|
<div class="details">
|
||
|
|
<p>Fetches an entry from the cache.</p><dl>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd>id - cache id The id of the cache entry to fetch.</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>The cached data or FALSE, if no cache entry exists for the given id.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<div class="location">/Doctrine/Common/Cache/Cache.php at line 62</div>
|
||
|
|
<h3 id="save()">save</h3>
|
||
|
|
<code class="signature">public boolean <strong>save</strong>(string id, string data, int lifeTime)</code>
|
||
|
|
<div class="details">
|
||
|
|
<p>Puts data into the cache.</p><dl>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd>id - The cache id.</dd>
|
||
|
|
<dd>data - The cache entry/data.</dd>
|
||
|
|
<dd>lifeTime - The lifetime. If != 0, sets a specific lifetime for this cache entry (0 => infinite lifeTime).</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>TRUE if the entry was successfully stored in the cache, FALSE otherwise.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<div class="header">
|
||
|
|
<h1>Doctrine</h1>
|
||
|
|
<ul>
|
||
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
||
|
|
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
|
||
|
|
<li class="active">Class</li>
|
||
|
|
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
|
||
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
||
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="small_links">
|
||
|
|
<a href="../../../index.html" target="_top">Frames</a>
|
||
|
|
<a href="../../../doctrine/common/cache/cache.html" target="_top">No frames</a>
|
||
|
|
</div>
|
||
|
|
<div class="small_links">
|
||
|
|
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
|
||
|
|
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
|
||
|
|
</div>
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
|
||
|
|
</html>
|