You are viewing a plain text version of this content. The canonical link for it is here.
Posted to zeta-commits@incubator.apache.org by je...@apache.org on 2011/04/06 10:44:47 UTC
[zeta-commits] svn commit: r1089394 [19/21] - in /incubator/zetacomponents/website:
content/community/ htdocs/community/ htdocs/documentation/trunk/Cache/
htdocs/documentation/trunk/Cache/phpdoc/
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcachePlain.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcachePlain.html?rev=1089394&r1=1089393&r2=1089394&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcachePlain.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcachePlain.html Wed Apr 6 10:44:44 2011
@@ -9,16 +9,16 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Apache Zeta Components - reusable set of high quality PHP components to fasten your development." />
- <meta name="keywords" content="PHP, apache, components, framework, quality" />
- <meta name="author" content="dotxp" />
+ <meta name="keywords" content="" />
+ <meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Wed, 04 Aug 2010 13:07:18 +0200" />
+ <meta name="date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="ezcCacheStorageMemcachePlain.html" />
- <meta name="DC.creator" content="dotxp" />
- <meta name="DC.date" content="Wed, 04 Aug 2010 13:07:18 +0200" />
+ <meta name="DC.creator" content="jerome" />
+ <meta name="DC.date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcachePlain.rdf" />
@@ -68,10 +68,7 @@
<div class="content">
<ul class="tabs">
- <li >
- <a href="/zetacomponents/documentation/trunk/Cache/tutorial.html" title="Tutorial">Tutorial</a>
- </li>
-<li class="requested">
+ <li class="requested">
<a href="/zetacomponents/documentation/trunk/Cache/phpdoc/classtrees.html" title="API">API</a>
</li>
@@ -91,80 +88,114 @@
-<pre><a href="ezcCacheStorage.html">ezcCacheStorage</a>
+<pre><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a>
|
- --<a href="ezcCacheStorageMemory.html">ezcCacheStorageMemory</a>
+ --<a href="../Cache/ezcCacheStorageMemory.html">ezcCacheStorageMemory</a>
|
- --<a href="ezcCacheStorageMemcache.html">ezcCacheStorageMemcache</a>
+ --<a href="../Cache/ezcCacheStorageMemcache.html">ezcCacheStorageMemcache</a>
|
--ezcCacheStorageMemcachePlain</pre>
- <table><tr><td>
+ <table><tr>
+<td>
<strong>Version:</strong>  
</td>
<td>//autogentag//</td>
- </tr></table><a name="sec-inherited-consts"></a>
+ </tr></table>
+<a name="sec-inherited-consts"></a>
<h3>Inherited Constants</h3>
- <table class="summary"><thead><tr><th colspan="2">
- From <span class="classname"><a href="ezcCacheStorageMemcache.html">ezcCacheStorageMemcache</a></span>:
+ <table class="summary">
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Cache/ezcCacheStorageMemcache.html">ezcCacheStorageMemcache</a></span>:
</th>
- </tr></thead><tbody><tr><td class="right">
- <code><a href="ezcCacheStorageMemcache.html#constBACKEND_NAME">ezcCacheStorageMemcache::BACKEND_NAME</a></code>
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
+ <code><a href="../Cache/ezcCacheStorageMemcache.html#constBACKEND_NAME">ezcCacheStorageMemcache::BACKEND_NAME</a></code>
</td>
<td>
   The backend name. </td>
- </tr><tr><td class="right">
- <code><a href="ezcCacheStorageMemcache.html#constREGISTRY_NAME">ezcCacheStorageMemcache::REGISTRY_NAME</a></code>
+ </tr>
+<tr>
+<td class="right">
+ <code><a href="../Cache/ezcCacheStorageMemcache.html#constREGISTRY_NAME">ezcCacheStorageMemcache::REGISTRY_NAME</a></code>
</td>
<td>
   The registry name. </td>
- </tr></tbody></table><h3>Inherited Member Variables</h3>
- <table class="summary"><thead><tr><th colspan="2">
- From <span class="classname"><a href="ezcCacheStorageMemory.html">ezcCacheStorageMemory</a></span>
+ </tr>
+</tbody>
+</table>
+<h3>Inherited Member Variables</h3>
+ <table class="summary">
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Cache/ezcCacheStorageMemory.html">ezcCacheStorageMemory</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
- <code><a href="ezcCacheStorageMemory.html#var%24backend">ezcCacheStorageMemory::$backend</a></code>
+ <code><a href="../Cache/ezcCacheStorageMemory.html#var%24backend">ezcCacheStorageMemory::$backend</a></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
- <code><a href="ezcCacheStorageMemory.html#var%24backendName">ezcCacheStorageMemory::$backendName</a></code>
+ <code><a href="../Cache/ezcCacheStorageMemory.html#var%24backendName">ezcCacheStorageMemory::$backendName</a></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
- <code><a href="ezcCacheStorageMemory.html#var%24registry">ezcCacheStorageMemory::$registry</a></code>
+ <code><a href="../Cache/ezcCacheStorageMemory.html#var%24registry">ezcCacheStorageMemory::$registry</a></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
- <code><a href="ezcCacheStorageMemory.html#var%24registryName">ezcCacheStorageMemory::$registryName</a></code>
+ <code><a href="../Cache/ezcCacheStorageMemory.html#var%24registryName">ezcCacheStorageMemory::$registryName</a></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
- <code><a href="ezcCacheStorageMemory.html#var%24searchRegistry">ezcCacheStorageMemory::$searchRegistry</a></code>
+ <code><a href="../Cache/ezcCacheStorageMemory.html#var%24searchRegistry">ezcCacheStorageMemory::$searchRegistry</a></code>
</td>
- </tr></tbody><thead><tr><th colspan="2">
- From <span class="classname"><a href="ezcCacheStorage.html">ezcCacheStorage</a></span>
+ </tr>
+</tbody>
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody><tr>
+<td class="right">
<em>protected</em> </td>
<td>
- <code><a href="ezcCacheStorage.html#var%24properties">ezcCacheStorage::$properties</a></code>
+ <code><a href="../Cache/ezcCacheStorage.html#var%24properties">ezcCacheStorage::$properties</a></code>
</td>
- </tr></tbody></table><a name="sec-method-summary"></a>
+ </tr></tbody>
+</table>
+<a name="sec-method-summary"></a>
<h3>Method Summary</h3>
- <table class="summary"><tr><td class="right">
+ <table class="summary">
+<tr>
+<td class="right">
<em>protected</em> <em>mixed</em> </td>
<td>
<code>
@@ -174,8 +205,10 @@
= false] )
</code>
<br><div style="margin-left: 20px">Fetches data from the cache.</div> </td>
- </tr><tr><td class="right">
- <em>protected</em> <em><a href="ezcCacheStorageMemoryDataStruct.html">ezcCacheStorageMemoryDataStruct</a></em> </td>
+ </tr>
+<tr>
+<td class="right">
+ <em>protected</em> <em><a href="../Cache/ezcCacheStorageMemoryDataStruct.html">ezcCacheStorageMemoryDataStruct</a></em> </td>
<td>
<code>
<a href="#prepareData"><b>prepareData</b></a>(
@@ -183,192 +216,278 @@
)
</code>
<br><div style="margin-left: 20px">Wraps the data in an ezcCacheStorageMemoryDataStruct structure in order to store it.</div> </td>
- </tr></table><h3>Inherited Methods</h3>
- <table class="summary"><thead><tr><th colspan="2">
- From <span class="classname"><a href="ezcCacheStorageMemcache.html">ezcCacheStorageMemcache</a></span>
+ </tr>
+</table>
+<h3>Inherited Methods</h3>
+ <table class="summary">
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Cache/ezcCacheStorageMemcache.html">ezcCacheStorageMemcache</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
<em>public</em> <em>ezcCacheStorageMemcache</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemcache.html#method__construct">ezcCacheStorageMemcache::__construct()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemcache.html#method__construct">ezcCacheStorageMemcache::__construct()</a></b></code>
<br><div style="margin-left: 20px">Creates a new cache storage in the given location.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> abstract <em>mixed</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemcache.html#methodfetchData">ezcCacheStorageMemcache::fetchData()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemcache.html#methodfetchData">ezcCacheStorageMemcache::fetchData()</a></b></code>
<br><div style="margin-left: 20px">Fetches the data from the cache.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> abstract <em>mixed</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemcache.html#methodprepareData">ezcCacheStorageMemcache::prepareData()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemcache.html#methodprepareData">ezcCacheStorageMemcache::prepareData()</a></b></code>
<br><div style="margin-left: 20px">Prepare the data for storing.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemcache.html#methodsetOptions">ezcCacheStorageMemcache::setOptions()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemcache.html#methodsetOptions">ezcCacheStorageMemcache::setOptions()</a></b></code>
<br><div style="margin-left: 20px">Set new options.</div> </td>
- </tr></tbody><thead><tr><th colspan="2">
- From <span class="classname"><a href="ezcCacheStorageMemory.html">ezcCacheStorageMemory</a></span>
+ </tr>
+</tbody>
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Cache/ezcCacheStorageMemory.html">ezcCacheStorageMemory</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
<em>public</em> <em>ezcCacheStorageMemory</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#method__construct">ezcCacheStorageMemory::__construct()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#method__construct">ezcCacheStorageMemory::__construct()</a></b></code>
<br><div style="margin-left: 20px">Creates a new cache storage in the given location.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>int</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodcalcLifetime">ezcCacheStorageMemory::calcLifetime()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodcalcLifetime">ezcCacheStorageMemory::calcLifetime()</a></b></code>
<br><div style="margin-left: 20px">Calculates the lifetime remaining for a cache object.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>int</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodcountDataItems">ezcCacheStorageMemory::countDataItems()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodcountDataItems">ezcCacheStorageMemory::countDataItems()</a></b></code>
<br><div style="margin-left: 20px">Returns the number of items in the cache matching a certain criteria.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methoddelete">ezcCacheStorageMemory::delete()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methoddelete">ezcCacheStorageMemory::delete()</a></b></code>
<br><div style="margin-left: 20px">Deletes the data associated with $id or $attributes from the cache.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodfetchSearchRegistry">ezcCacheStorageMemory::fetchSearchRegistry()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodfetchSearchRegistry">ezcCacheStorageMemory::fetchSearchRegistry()</a></b></code>
<br><div style="margin-left: 20px">Fetches the search registry from the backend or creates it if empty.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>string</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodgenerateAttrStr">ezcCacheStorageMemory::generateAttrStr()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodgenerateAttrStr">ezcCacheStorageMemory::generateAttrStr()</a></b></code>
<br><div style="margin-left: 20px">Generates a string from the $attributes array.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>string</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodgenerateIdentifier">ezcCacheStorageMemory::generateIdentifier()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodgenerateIdentifier">ezcCacheStorageMemory::generateIdentifier()</a></b></code>
<br><div style="margin-left: 20px">Generates the storage internal identifier from ID and attributes.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>int</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodgetRemainingLifetime">ezcCacheStorageMemory::getRemainingLifetime()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodgetRemainingLifetime">ezcCacheStorageMemory::getRemainingLifetime()</a></b></code>
<br><div style="margin-left: 20px">Returns the time in seconds which remains for a cache object, before it gets outdated. In case the cache object is already outdated or does not exists, this method returns 0.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodlock">ezcCacheStorageMemory::lock()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodlock">ezcCacheStorageMemory::lock()</a></b></code>
<br><div style="margin-left: 20px">Acquire a lock on the storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>array(string)</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodpurge">ezcCacheStorageMemory::purge()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodpurge">ezcCacheStorageMemory::purge()</a></b></code>
<br><div style="margin-left: 20px">Purge outdated data from the storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodregisterIdentifier">ezcCacheStorageMemory::registerIdentifier()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodregisterIdentifier">ezcCacheStorageMemory::registerIdentifier()</a></b></code>
<br><div style="margin-left: 20px">Registers an identifier to facilitate searching.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodreset">ezcCacheStorageMemory::reset()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodreset">ezcCacheStorageMemory::reset()</a></b></code>
<br><div style="margin-left: 20px">Reset the complete storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>mixed</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodrestore">ezcCacheStorageMemory::restore()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodrestore">ezcCacheStorageMemory::restore()</a></b></code>
<br><div style="margin-left: 20px">Restores the data from the cache.</div> </td>
- </tr><tr><td class="right">
- <em>public</em> <em><a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em> </td>
+ </tr>
+<tr>
+<td class="right">
+ <em>public</em> <em><a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodrestoreMetaData">ezcCacheStorageMemory::restoreMetaData()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodrestoreMetaData">ezcCacheStorageMemory::restoreMetaData()</a></b></code>
<br><div style="margin-left: 20px">Restores and returns the meta data struct.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>array(mixed)</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodsearch">ezcCacheStorageMemory::search()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodsearch">ezcCacheStorageMemory::search()</a></b></code>
<br><div style="margin-left: 20px">Searches the storage for data defined by ID and/or attributes.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>string</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodstore">ezcCacheStorageMemory::store()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodstore">ezcCacheStorageMemory::store()</a></b></code>
<br><div style="margin-left: 20px">Stores data to the cache storage under the key $id.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodstoreMetaData">ezcCacheStorageMemory::storeMetaData()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodstoreMetaData">ezcCacheStorageMemory::storeMetaData()</a></b></code>
<br><div style="margin-left: 20px">Stores the given meta data struct.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodstoreSearchRegistry">ezcCacheStorageMemory::storeSearchRegistry()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodstoreSearchRegistry">ezcCacheStorageMemory::storeSearchRegistry()</a></b></code>
<br><div style="margin-left: 20px">Stores the search registry in the backend.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodunlock">ezcCacheStorageMemory::unlock()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodunlock">ezcCacheStorageMemory::unlock()</a></b></code>
<br><div style="margin-left: 20px">Release a lock on the storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodunRegisterIdentifier">ezcCacheStorageMemory::unRegisterIdentifier()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodunRegisterIdentifier">ezcCacheStorageMemory::unRegisterIdentifier()</a></b></code>
<br><div style="margin-left: 20px">Un-registers a previously registered identifier.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodvalidateLocation">ezcCacheStorageMemory::validateLocation()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodvalidateLocation">ezcCacheStorageMemory::validateLocation()</a></b></code>
<br><div style="margin-left: 20px">Checks if the location property is valid.</div> </td>
- </tr></tbody><thead><tr><th colspan="2">
- From <span class="classname"><a href="ezcCacheStorage.html">ezcCacheStorage</a></span>
+ </tr>
+</tbody>
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
<em>public</em> <em>ezcCacheStorage</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#method__construct">ezcCacheStorage::__construct()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#method__construct">ezcCacheStorage::__construct()</a></b></code>
<br><div style="margin-left: 20px">Creates a new cache storage in the given location.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> abstract <em>int</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodcountDataItems">ezcCacheStorage::countDataItems()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodcountDataItems">ezcCacheStorage::countDataItems()</a></b></code>
<br><div style="margin-left: 20px">Return the number of items in the cache matching a certain criteria.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> abstract <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methoddelete">ezcCacheStorage::delete()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methoddelete">ezcCacheStorage::delete()</a></b></code>
<br><div style="margin-left: 20px">Delete data from the cache.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>string</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodgetLocation">ezcCacheStorage::getLocation()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodgetLocation">ezcCacheStorage::getLocation()</a></b></code>
<br><div style="margin-left: 20px">Returns the location.</div> </td>
- </tr><tr><td class="right">
- <em>public</em> <em><a href="ezcCacheStorageOptions.html">ezcCacheStorageOptions</a></em> </td>
+ </tr>
+<tr>
+<td class="right">
+ <em>public</em> <em><a href="../Cache/ezcCacheStorageOptions.html">ezcCacheStorageOptions</a></em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodgetOptions">ezcCacheStorage::getOptions()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodgetOptions">ezcCacheStorage::getOptions()</a></b></code>
<br><div style="margin-left: 20px">Return the currently set options.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> abstract <em>int</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodgetRemainingLifetime">ezcCacheStorage::getRemainingLifetime()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodgetRemainingLifetime">ezcCacheStorage::getRemainingLifetime()</a></b></code>
<br><div style="margin-left: 20px">Returns the time ( in seconds ) that remains for a cache object, before it gets outdated. In case the cache object is already outdated or does not exist, this method returns 0.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> abstract <em>mixed</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodrestore">ezcCacheStorage::restore()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodrestore">ezcCacheStorage::restore()</a></b></code>
<br><div style="margin-left: 20px">Restore data from the cache.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodsetOptions">ezcCacheStorage::setOptions()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodsetOptions">ezcCacheStorage::setOptions()</a></b></code>
<br><div style="margin-left: 20px">Set new options.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> abstract <em>string</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodstore">ezcCacheStorage::store()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodstore">ezcCacheStorage::store()</a></b></code>
<br><div style="margin-left: 20px">Store data to the cache storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> abstract <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodvalidateLocation">ezcCacheStorage::validateLocation()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodvalidateLocation">ezcCacheStorage::validateLocation()</a></b></code>
<br><div style="margin-left: 20px">Checks if the location property is valid.</div> </td>
- </tr></tbody></table><a name="sec-methods"></a>
+ </tr>
+</tbody>
+</table>
+<a name="sec-methods"></a>
<h3>Methods</h3>
<a name="method_detail"></a>
@@ -388,32 +507,48 @@
<p>Fetches data from the cache.</p>
<h5>Parameters:</h5>
- <table class="detail"><thead><tr><th>Name</th>
+ <table class="detail">
+<thead><tr>
+<th>Name</th>
<th>Type</th>
<th class="desc">Description</th>
- </tr></thead><tbody><tr><td><code>$identifier</code></td>
+ </tr></thead>
+<tbody>
+<tr>
+<td><code>$identifier</code></td>
<td><em>string</em></td>
<td>
The file to fetch data from
</td>
- </tr><tr><td><code>$object</code></td>
+ </tr>
+<tr>
+<td><code>$object</code></td>
<td><em>bool</em></td>
<td>
Return the object and not the clean data
</td>
- </tr></tbody></table><h5>Redefinition of:</h5>
- <table class="detail"><thead><tr><th>Method</th>
+ </tr>
+</tbody>
+</table>
+<h5>Redefinition of:</h5>
+ <table class="detail">
+<thead><tr>
+<th>Method</th>
<th class="desc">Description</th>
- </tr></thead><tbody><tr><td><code><a href="ezcCacheStorageMemcache.html#methodfetchData">ezcCacheStorageMemcache::fetchData()</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheStorageMemcache.html#methodfetchData">ezcCacheStorageMemcache::fetchData()</a></code></td>
<td>
Fetches the data from the cache.
</td>
- </tr></tbody></table><a name="methodprepareData" id="prepareData"><!-- --></a>
+ </tr></tbody>
+</table>
+<a name="methodprepareData" id="prepareData"><!-- --></a>
<h4>prepareData</h4>
<div class="method-signature">
- <a href="ezcCacheStorageMemoryDataStruct.html">ezcCacheStorageMemoryDataStruct</a>
+ <a href="../Cache/ezcCacheStorageMemoryDataStruct.html">ezcCacheStorageMemoryDataStruct</a>
prepareData(
mixed
$data
@@ -422,29 +557,47 @@
<p>Wraps the data in an ezcCacheStorageMemoryDataStruct structure in order to store it.</p>
<h5>Parameters:</h5>
- <table class="detail"><thead><tr><th>Name</th>
+ <table class="detail">
+<thead><tr>
+<th>Name</th>
<th>Type</th>
<th class="desc">Description</th>
- </tr></thead><tbody><tr><td><code>$data</code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code>$data</code></td>
<td><em>mixed</em></td>
<td>
Simple type or array
</td>
- </tr></tbody></table><h5>Exceptions:</h5>
- <table class="detail"><thead><tr><th>Type</th>
+ </tr></tbody>
+</table>
+<h5>Exceptions:</h5>
+ <table class="detail">
+<thead><tr>
+<th>Type</th>
<th class="desc">Description</th>
- </tr></thead><tbody><tr><td><code><a href="ezcCacheInvalidDataException.html">ezcCacheInvalidDataException</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheInvalidDataException.html">ezcCacheInvalidDataException</a></code></td>
<td>
If the data submitted can not be handled by this storage (resource).
</td>
- </tr></tbody></table><h5>Redefinition of:</h5>
- <table class="detail"><thead><tr><th>Method</th>
+ </tr></tbody>
+</table>
+<h5>Redefinition of:</h5>
+ <table class="detail">
+<thead><tr>
+<th>Method</th>
<th class="desc">Description</th>
- </tr></thead><tbody><tr><td><code><a href="ezcCacheStorageMemcache.html#methodprepareData">ezcCacheStorageMemcache::prepareData()</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheStorageMemcache.html#methodprepareData">ezcCacheStorageMemcache::prepareData()</a></code></td>
<td>
Prepare the data for storing.
</td>
- </tr></tbody></table><div class="credit">
+ </tr></tbody>
+</table>
+<div class="credit">
Documentation generated by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
</div>
</div>