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/07/10 17:31:24 UTC
[zeta-commits] svn commit: r1144915 [18/37] - in /incubator/zetacomponents:
trunk/Authentication/docs/ trunk/AuthenticationDatabaseTiein/docs/
trunk/Base/docs/ trunk/Configuration/docs/ trunk/Document/docs/
trunk/EventLog/docs/ trunk/Feed/docs/ trunk/File/docs/ trunk...
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileArray.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileArray.html?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileArray.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileArray.html Sun Jul 10 17:30:59 2011
@@ -12,13 +12,13 @@
<meta name="keywords" content="" />
<meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
+ <meta name="date" content="Sun, 10 Jul 2011 11:10:50 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="ezcCacheStorageFileArray.html" />
<meta name="DC.creator" content="jerome" />
- <meta name="DC.date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
+ <meta name="DC.date" content="Sun, 10 Jul 2011 11:10:50 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileArray.rdf" />
@@ -68,7 +68,10 @@
<div class="content">
<ul class="tabs">
- <li class="requested">
+ <li >
+ <a href="/zetacomponents/documentation/trunk/Cache/tutorial.html" title="Tutorial">Tutorial</a>
+ </li>
+<li class="requested">
<a href="/zetacomponents/documentation/trunk/Cache/phpdoc/classtrees.html" title="API">API</a>
</li>
@@ -83,70 +86,44 @@
<a name="sec-description"></a>
<h3>Class ezcCacheStorageFileArray</h3>
-<p>This cache storage implementation stores arrays and scalar values</p>
-<div>
-<p>(int, float, string, bool) in files on your hard disk as PHP code. This makes the restoring of cache data extremly fast, since the stored data is simply included and parsed by the PHP interpreter. It takes its base methods from the extended storage base class <a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a>.</p>
-<p>Another storage class with a similar approach exists, <a href="../Cache/ezcCacheStorageFileEvalArray.html">ezcCacheStorageFileEvalArray</a>. This class is uses exactly the same mechanisms as ezcCacheStorageFileArray, except that is does not simply require the stored source code, but uses eval() to restore the data.</p>
-<p>Main purpose behind these 2 similar implementations is the following: Most byte code caches are capable of caching code for included files, but not for eval()ed strings. Therefore the *Evalarray class will permit you to get your cached data not cached a second time by an accellerator like APC, whereas the *Array class will permit you to explicitly allow this. ATTENTION: If you do not use a byte code cache with your PHP installation, the use of ezcCacheStorageFileArray is recommende over the usage of ezcCacheStorageEvalarray.</p>
-<p>For example code of using a cache storage, see <a href="../Cache/ezcCacheManager.html">ezcCacheManager</a>.</p>
-<p>The Cache package contains several other implementations of <a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a>. As there are:</p>
-<p></p>
-<ul>
-<li>ezcCacheStorageFileEvalArray</li>
-<li>ezcCacheStorageFilePlain</li>
-</ul>
-</div>
+<p>This cache storage implementation stores arrays and scalar values</p><div><p>(int, float, string, bool) in files on your hard disk as PHP code. This makes the restoring of cache data extremly fast, since the stored data is simply included and parsed by the PHP interpreter. It takes its base methods from the extended storage base class <a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a>.</p><p>Another storage class with a similar approach exists, <a href="ezcCacheStorageFileEvalArray.html">ezcCacheStorageFileEvalArray</a>. This class is uses exactly the same mechanisms as ezcCacheStorageFileArray, except that is does not simply require the stored source code, but uses eval() to restore the data.</p><p>Main purpose behind these 2 similar implementations is the following: Most byte code caches are capable of caching code for included files, but not for eval()ed strings. Therefore the *Evalarray class will permit you to get your cached data not cached a second
time by an accellerator like APC, whereas the *Array class will permit you to explicitly allow this. ATTENTION: If you do not use a byte code cache with your PHP installation, the use of ezcCacheStorageFileArray is recommende over the usage of ezcCacheStorageEvalarray.</p><p>For example code of using a cache storage, see <a href="ezcCacheManager.html">ezcCacheManager</a>.</p><p>The Cache package contains several other implementations of <a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a>. As there are:</p><p></p><ul><li>ezcCacheStorageFileEvalArray</li><li>ezcCacheStorageFilePlain</li></ul></div>
<p>Source for this file: <a href="http://fisheye6.atlassian.com/browse/zetacomponents/trunk/Cache/src/storage/file/array.php?r=HEAD">/Cache/src/storage/file/array.php</a></p>
-<pre><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a>
+<pre><a href="ezcCacheStorage.html">ezcCacheStorage</a>
|
- --<a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a>
+ --<a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a>
|
--ezcCacheStorageFileArray</pre>
- <table><tr>
-<td>
+ <table><tr><td>
<strong>Version:</strong>  
</td>
<td>//autogentag//</td>
- </tr></table>
-<h3>Inherited Member Variables</h3>
- <table class="summary">
-<thead><tr>
-<th colspan="2">
- From <span class="classname"><a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a></span>
+ </tr></table><h3>Inherited Member Variables</h3>
+ <table class="summary"><thead><tr><th colspan="2">
+ From <span class="classname"><a href="ezcCacheStorageFile.html">ezcCacheStorageFile</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="../Cache/ezcCacheStorageFile.html#var%24lockResource">ezcCacheStorageFile::$lockResource</a></code>
+ <code><a href="ezcCacheStorageFile.html#var%24lockResource">ezcCacheStorageFile::$lockResource</a></code>
</td>
- </tr></tbody>
-<thead><tr>
-<th colspan="2">
- From <span class="classname"><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a></span>
+ </tr></tbody><thead><tr><th colspan="2">
+ From <span class="classname"><a href="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="../Cache/ezcCacheStorage.html#var%24properties">ezcCacheStorage::$properties</a></code>
+ <code><a href="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>
@@ -155,9 +132,7 @@
)
</code>
<br><div style="margin-left: 20px">Fetch data from the cache.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>protected</em> <em>string</em> </td>
<td>
<code>
@@ -166,243 +141,169 @@
)
</code>
<br><div style="margin-left: 20px">Serialize the data for storing.</div> </td>
- </tr>
-</table>
-<h3>Inherited Methods</h3>
- <table class="summary">
-<thead><tr>
-<th colspan="2">
- From <span class="classname"><a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a></span>
+ </tr></table><h3>Inherited Methods</h3>
+ <table class="summary"><thead><tr><th colspan="2">
+ From <span class="classname"><a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a></span>
</th>
- </tr></thead>
-<tbody>
-<tr>
-<td class="right">
+ </tr></thead><tbody><tr><td class="right">
<em>public</em> <em>ezcCacheStorageFile</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#method__construct">ezcCacheStorageFile::__construct()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#method__construct">ezcCacheStorageFile::__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="../Cache/ezcCacheStorageFile.html#methodcalcLifetime">ezcCacheStorageFile::calcLifetime()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodcalcLifetime">ezcCacheStorageFile::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="../Cache/ezcCacheStorageFile.html#methodcountDataItems">ezcCacheStorageFile::countDataItems()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodcountDataItems">ezcCacheStorageFile::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> <em>void</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methoddelete">ezcCacheStorageFile::delete()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methoddelete">ezcCacheStorageFile::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>protected</em> abstract <em>mixed</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodfetchData">ezcCacheStorageFile::fetchData()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodfetchData">ezcCacheStorageFile::fetchData()</a></b></code>
<br><div style="margin-left: 20px">Fetch 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="../Cache/ezcCacheStorageFile.html#methodgenerateIdentifier">ezcCacheStorageFile::generateIdentifier()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodgenerateIdentifier">ezcCacheStorageFile::generateIdentifier()</a></b></code>
<br><div style="margin-left: 20px">Generate 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="../Cache/ezcCacheStorageFile.html#methodgetRemainingLifetime">ezcCacheStorageFile::getRemainingLifetime()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodgetRemainingLifetime">ezcCacheStorageFile::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 exist, 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="../Cache/ezcCacheStorageFile.html#methodlock">ezcCacheStorageFile::lock()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodlock">ezcCacheStorageFile::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>protected</em> abstract <em>string</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></b></code>
<br><div style="margin-left: 20px">Serialize the data for storing.</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="../Cache/ezcCacheStorageFile.html#methodpurge">ezcCacheStorageFile::purge()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodpurge">ezcCacheStorageFile::purge()</a></b></code>
<br><div style="margin-left: 20px">Purges the given number of cache items.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodreset">ezcCacheStorageFile::reset()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodreset">ezcCacheStorageFile::reset()</a></b></code>
<br><div style="margin-left: 20px">Resets the whole storage.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>mixed|bool</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodrestore">ezcCacheStorageFile::restore()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodrestore">ezcCacheStorageFile::restore()</a></b></code>
<br><div style="margin-left: 20px">Restore data from the cache.</div> </td>
- </tr>
-<tr>
-<td class="right">
- <em>public</em> <em><a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>|null</em> </td>
+ </tr><tr><td class="right">
+ <em>public</em> <em><a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>|null</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodrestoreMetaData">ezcCacheStorageFile::restoreMetaData()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodrestoreMetaData">ezcCacheStorageFile::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(int=>string)</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodsearch">ezcCacheStorageFile::search()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodsearch">ezcCacheStorageFile::search()</a></b></code>
<br><div style="margin-left: 20px">Search the storage for data.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>protected</em> <em>array(int=>string)</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodsearchRecursive">ezcCacheStorageFile::searchRecursive()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodsearchRecursive">ezcCacheStorageFile::searchRecursive()</a></b></code>
<br><div style="margin-left: 20px">Search the storage for data recursively.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodsetOptions">ezcCacheStorageFile::setOptions()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodsetOptions">ezcCacheStorageFile::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> <em>string</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodstore">ezcCacheStorageFile::store()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodstore">ezcCacheStorageFile::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>public</em> <em>void</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodstoreMetaData">ezcCacheStorageFile::storeMetaData()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodstoreMetaData">ezcCacheStorageFile::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="../Cache/ezcCacheStorageFile.html#methodstoreRawData">ezcCacheStorageFile::storeRawData()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodstoreRawData">ezcCacheStorageFile::storeRawData()</a></b></code>
<br><div style="margin-left: 20px">Actually stores the given data.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodunlock">ezcCacheStorageFile::unlock()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodunlock">ezcCacheStorageFile::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="../Cache/ezcCacheStorageFile.html#methodvalidateLocation">ezcCacheStorageFile::validateLocation()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodvalidateLocation">ezcCacheStorageFile::validateLocation()</a></b></code>
<br><div style="margin-left: 20px">Checks the path in the location property exists, and is read-/writable. It throws an exception if not.</div> </td>
- </tr>
-</tbody>
-<thead><tr>
-<th colspan="2">
- From <span class="classname"><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a></span>
+ </tr></tbody><thead><tr><th colspan="2">
+ From <span class="classname"><a href="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="../Cache/ezcCacheStorage.html#method__construct">ezcCacheStorage::__construct()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodcountDataItems">ezcCacheStorage::countDataItems()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methoddelete">ezcCacheStorage::delete()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodgetLocation">ezcCacheStorage::getLocation()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorageOptions.html">ezcCacheStorageOptions</a></em> </td>
+ </tr><tr><td class="right">
+ <em>public</em> <em><a href="ezcCacheStorageOptions.html">ezcCacheStorageOptions</a></em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorage.html#methodgetOptions">ezcCacheStorage::getOptions()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodgetRemainingLifetime">ezcCacheStorage::getRemainingLifetime()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodrestore">ezcCacheStorage::restore()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodsetOptions">ezcCacheStorage::setOptions()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodstore">ezcCacheStorage::store()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodvalidateLocation">ezcCacheStorage::validateLocation()</a></b></code>
+ <code><b><a href="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>
@@ -418,37 +319,24 @@
)
</div>
- <p>Fetch data from the cache.</p>
-<div><p>This method does the fetching of the data itself. In this case, the method simply includes the file and returns the value returned by the include (or false on failure).</p></div>
+ <p>Fetch data from the cache.</p><div><p>This method does the fetching of the data itself. In this case, the method simply includes the file and returns the value returned by the include (or false on failure).</p></div>
<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>$filename</code></td>
+ </tr></thead><tbody><tr><td><code>$filename</code></td>
<td><em>string</em></td>
<td>
The file to fetch data from.
</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="../Cache/ezcCacheStorageFile.html#methodfetchData">ezcCacheStorageFile::fetchData()</a></code></td>
+ </tr></thead><tbody><tr><td><code><a href="ezcCacheStorageFile.html#methodfetchData">ezcCacheStorageFile::fetchData()</a></code></td>
<td>
Fetch 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>
@@ -460,50 +348,31 @@
)
</div>
- <p>Serialize the data for storing.</p>
-<div><p>Serializes a PHP variable (except type resource and object) to a executable PHP code representation string.</p></div>
+ <p>Serialize the data for storing.</p><div><p>Serializes a PHP variable (except type resource and object) to a executable PHP code representation string.</p></div>
<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="../Cache/ezcCacheInvalidDataException.html">ezcCacheInvalidDataException</a></code></td>
+ </tr></thead><tbody><tr><td><code><a href="ezcCacheInvalidDataException.html">ezcCacheInvalidDataException</a></code></td>
<td>
- If the data submitted is an object or a resource, since this implementation of <a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a> can only deal with scalar and array values.
+ If the data submitted is an object or a resource, since this implementation of <a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a> can only deal with scalar and array values.
</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="../Cache/ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></code></td>
+ </tr></thead><tbody><tr><td><code><a href="ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></code></td>
<td>
Serialize 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>
Modified: incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileEvalArray.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileEvalArray.html?rev=1144915&r1=1144914&r2=1144915&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileEvalArray.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileEvalArray.html Sun Jul 10 17:30:59 2011
@@ -12,13 +12,13 @@
<meta name="keywords" content="" />
<meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
+ <meta name="date" content="Sun, 10 Jul 2011 11:10:50 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="ezcCacheStorageFileEvalArray.html" />
<meta name="DC.creator" content="jerome" />
- <meta name="DC.date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
+ <meta name="DC.date" content="Sun, 10 Jul 2011 11:10:50 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileEvalArray.rdf" />
@@ -68,7 +68,10 @@
<div class="content">
<ul class="tabs">
- <li class="requested">
+ <li >
+ <a href="/zetacomponents/documentation/trunk/Cache/tutorial.html" title="Tutorial">Tutorial</a>
+ </li>
+<li class="requested">
<a href="/zetacomponents/documentation/trunk/Cache/phpdoc/classtrees.html" title="API">API</a>
</li>
@@ -83,69 +86,44 @@
<a name="sec-description"></a>
<h3>Class ezcCacheStorageFileEvalArray</h3>
-<p>This cache storage implementation stores arrays and scalar values (int,</p>
-<div>
-<p>float, string, bool) in files on your hard disk as PHP code. In contrast to its sibling class <a href="../Cache/ezcCacheStorageFileArray.html">ezcCacheStorageFileArray</a>, the stored PHP code is not simply required to restore the cache data, but is evaluated using PHP's eval() function. It takes its base methods from the extended storage base class <a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a>.</p>
-<p>Main purpose behind these 2 similar implementations is the following: Most byte code caches are capable of caching code for included files, but not for eval()'ed strings. Therefore the ezcCacheStorageFileEvalarray class will permit you to get your cached data not cached a second time by an accellerator like APC, whereas the <a href="../Cache/ezcCacheStorageFileArray.html">ezcCacheStorageFileArray</a> class will permit you to explicitly allow this. ATTENTION: If you do not use a byte code cache with your PHP installation, the use of <a href="../Cache/ezcCacheStorageFileArray.html">ezcCacheStorageFileArray</a> is recommended over the usage of ezcCacheStorageEvalarray, since eval() is much slower than directly requiring the stored PHP code.</p>
-<p>For example code of using a cache storage, see <a href="../Cache/ezcCacheManager.html">ezcCacheManager</a>.</p>
-<p>The Cache package contains several other implementations of <a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a>. As there are:</p>
-<p></p>
-<ul>
-<li>ezcCacheStorageFileArray</li>
-<li>ezcCacheStorageFilePlain</li>
-</ul>
-</div>
+<p>This cache storage implementation stores arrays and scalar values (int,</p><div><p>float, string, bool) in files on your hard disk as PHP code. In contrast to its sibling class <a href="ezcCacheStorageFileArray.html">ezcCacheStorageFileArray</a>, the stored PHP code is not simply required to restore the cache data, but is evaluated using PHP's eval() function. It takes its base methods from the extended storage base class <a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a>.</p><p>Main purpose behind these 2 similar implementations is the following: Most byte code caches are capable of caching code for included files, but not for eval()'ed strings. Therefore the ezcCacheStorageFileEvalarray class will permit you to get your cached data not cached a second time by an accellerator like APC, whereas the <a href="ezcCacheStorageFileArray.html">ezcCacheStorageFileArray</a> class will permit you to explicitly allow this. ATTENTION: If you do not use a byte code
cache with your PHP installation, the use of <a href="ezcCacheStorageFileArray.html">ezcCacheStorageFileArray</a> is recommended over the usage of ezcCacheStorageEvalarray, since eval() is much slower than directly requiring the stored PHP code.</p><p>For example code of using a cache storage, see <a href="ezcCacheManager.html">ezcCacheManager</a>.</p><p>The Cache package contains several other implementations of <a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a>. As there are:</p><p></p><ul><li>ezcCacheStorageFileArray</li><li>ezcCacheStorageFilePlain</li></ul></div>
<p>Source for this file: <a href="http://fisheye6.atlassian.com/browse/zetacomponents/trunk/Cache/src/storage/file/eval_array.php?r=HEAD">/Cache/src/storage/file/eval_array.php</a></p>
-<pre><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a>
+<pre><a href="ezcCacheStorage.html">ezcCacheStorage</a>
|
- --<a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a>
+ --<a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a>
|
--ezcCacheStorageFileEvalArray</pre>
- <table><tr>
-<td>
+ <table><tr><td>
<strong>Version:</strong>  
</td>
<td>//autogentag//</td>
- </tr></table>
-<h3>Inherited Member Variables</h3>
- <table class="summary">
-<thead><tr>
-<th colspan="2">
- From <span class="classname"><a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a></span>
+ </tr></table><h3>Inherited Member Variables</h3>
+ <table class="summary"><thead><tr><th colspan="2">
+ From <span class="classname"><a href="ezcCacheStorageFile.html">ezcCacheStorageFile</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="../Cache/ezcCacheStorageFile.html#var%24lockResource">ezcCacheStorageFile::$lockResource</a></code>
+ <code><a href="ezcCacheStorageFile.html#var%24lockResource">ezcCacheStorageFile::$lockResource</a></code>
</td>
- </tr></tbody>
-<thead><tr>
-<th colspan="2">
- From <span class="classname"><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a></span>
+ </tr></tbody><thead><tr><th colspan="2">
+ From <span class="classname"><a href="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="../Cache/ezcCacheStorage.html#var%24properties">ezcCacheStorage::$properties</a></code>
+ <code><a href="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>
@@ -154,9 +132,7 @@
)
</code>
<br><div style="margin-left: 20px">Fetch data from a given file name.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>protected</em> <em>string</em> </td>
<td>
<code>
@@ -165,243 +141,169 @@
)
</code>
<br><div style="margin-left: 20px">Serialize the data for storing.</div> </td>
- </tr>
-</table>
-<h3>Inherited Methods</h3>
- <table class="summary">
-<thead><tr>
-<th colspan="2">
- From <span class="classname"><a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a></span>
+ </tr></table><h3>Inherited Methods</h3>
+ <table class="summary"><thead><tr><th colspan="2">
+ From <span class="classname"><a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a></span>
</th>
- </tr></thead>
-<tbody>
-<tr>
-<td class="right">
+ </tr></thead><tbody><tr><td class="right">
<em>public</em> <em>ezcCacheStorageFile</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#method__construct">ezcCacheStorageFile::__construct()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#method__construct">ezcCacheStorageFile::__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="../Cache/ezcCacheStorageFile.html#methodcalcLifetime">ezcCacheStorageFile::calcLifetime()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodcalcLifetime">ezcCacheStorageFile::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="../Cache/ezcCacheStorageFile.html#methodcountDataItems">ezcCacheStorageFile::countDataItems()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodcountDataItems">ezcCacheStorageFile::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> <em>void</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methoddelete">ezcCacheStorageFile::delete()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methoddelete">ezcCacheStorageFile::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>protected</em> abstract <em>mixed</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodfetchData">ezcCacheStorageFile::fetchData()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodfetchData">ezcCacheStorageFile::fetchData()</a></b></code>
<br><div style="margin-left: 20px">Fetch 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="../Cache/ezcCacheStorageFile.html#methodgenerateIdentifier">ezcCacheStorageFile::generateIdentifier()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodgenerateIdentifier">ezcCacheStorageFile::generateIdentifier()</a></b></code>
<br><div style="margin-left: 20px">Generate 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="../Cache/ezcCacheStorageFile.html#methodgetRemainingLifetime">ezcCacheStorageFile::getRemainingLifetime()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodgetRemainingLifetime">ezcCacheStorageFile::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 exist, 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="../Cache/ezcCacheStorageFile.html#methodlock">ezcCacheStorageFile::lock()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodlock">ezcCacheStorageFile::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>protected</em> abstract <em>string</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></b></code>
<br><div style="margin-left: 20px">Serialize the data for storing.</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="../Cache/ezcCacheStorageFile.html#methodpurge">ezcCacheStorageFile::purge()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodpurge">ezcCacheStorageFile::purge()</a></b></code>
<br><div style="margin-left: 20px">Purges the given number of cache items.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodreset">ezcCacheStorageFile::reset()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodreset">ezcCacheStorageFile::reset()</a></b></code>
<br><div style="margin-left: 20px">Resets the whole storage.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>mixed|bool</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodrestore">ezcCacheStorageFile::restore()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodrestore">ezcCacheStorageFile::restore()</a></b></code>
<br><div style="margin-left: 20px">Restore data from the cache.</div> </td>
- </tr>
-<tr>
-<td class="right">
- <em>public</em> <em><a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>|null</em> </td>
+ </tr><tr><td class="right">
+ <em>public</em> <em><a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>|null</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodrestoreMetaData">ezcCacheStorageFile::restoreMetaData()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodrestoreMetaData">ezcCacheStorageFile::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(int=>string)</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodsearch">ezcCacheStorageFile::search()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodsearch">ezcCacheStorageFile::search()</a></b></code>
<br><div style="margin-left: 20px">Search the storage for data.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>protected</em> <em>array(int=>string)</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodsearchRecursive">ezcCacheStorageFile::searchRecursive()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodsearchRecursive">ezcCacheStorageFile::searchRecursive()</a></b></code>
<br><div style="margin-left: 20px">Search the storage for data recursively.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodsetOptions">ezcCacheStorageFile::setOptions()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodsetOptions">ezcCacheStorageFile::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> <em>string</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodstore">ezcCacheStorageFile::store()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodstore">ezcCacheStorageFile::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>public</em> <em>void</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodstoreMetaData">ezcCacheStorageFile::storeMetaData()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodstoreMetaData">ezcCacheStorageFile::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="../Cache/ezcCacheStorageFile.html#methodstoreRawData">ezcCacheStorageFile::storeRawData()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodstoreRawData">ezcCacheStorageFile::storeRawData()</a></b></code>
<br><div style="margin-left: 20px">Actually stores the given data.</div> </td>
- </tr>
-<tr>
-<td class="right">
+ </tr><tr><td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorageFile.html#methodunlock">ezcCacheStorageFile::unlock()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodunlock">ezcCacheStorageFile::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="../Cache/ezcCacheStorageFile.html#methodvalidateLocation">ezcCacheStorageFile::validateLocation()</a></b></code>
+ <code><b><a href="ezcCacheStorageFile.html#methodvalidateLocation">ezcCacheStorageFile::validateLocation()</a></b></code>
<br><div style="margin-left: 20px">Checks the path in the location property exists, and is read-/writable. It throws an exception if not.</div> </td>
- </tr>
-</tbody>
-<thead><tr>
-<th colspan="2">
- From <span class="classname"><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a></span>
+ </tr></tbody><thead><tr><th colspan="2">
+ From <span class="classname"><a href="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="../Cache/ezcCacheStorage.html#method__construct">ezcCacheStorage::__construct()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodcountDataItems">ezcCacheStorage::countDataItems()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methoddelete">ezcCacheStorage::delete()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodgetLocation">ezcCacheStorage::getLocation()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorageOptions.html">ezcCacheStorageOptions</a></em> </td>
+ </tr><tr><td class="right">
+ <em>public</em> <em><a href="ezcCacheStorageOptions.html">ezcCacheStorageOptions</a></em> </td>
<td>
- <code><b><a href="../Cache/ezcCacheStorage.html#methodgetOptions">ezcCacheStorage::getOptions()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodgetRemainingLifetime">ezcCacheStorage::getRemainingLifetime()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodrestore">ezcCacheStorage::restore()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodsetOptions">ezcCacheStorage::setOptions()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodstore">ezcCacheStorage::store()</a></b></code>
+ <code><b><a href="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="../Cache/ezcCacheStorage.html#methodvalidateLocation">ezcCacheStorage::validateLocation()</a></b></code>
+ <code><b><a href="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>
@@ -419,34 +321,22 @@
<p>Fetch data from a given file name.</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>$filename</code></td>
+ </tr></thead><tbody><tr><td><code>$filename</code></td>
<td><em>string</em></td>
<td>
The file to fetch data from.
</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="../Cache/ezcCacheStorageFile.html#methodfetchData">ezcCacheStorageFile::fetchData()</a></code></td>
+ </tr></thead><tbody><tr><td><code><a href="ezcCacheStorageFile.html#methodfetchData">ezcCacheStorageFile::fetchData()</a></code></td>
<td>
Fetch 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>
@@ -458,50 +348,31 @@
)
</div>
- <p>Serialize the data for storing.</p>
-<div><p>Serializes a PHP variable (except type resource and object) to a executable PHP code representation string.</p></div>
+ <p>Serialize the data for storing.</p><div><p>Serializes a PHP variable (except type resource and object) to a executable PHP code representation string.</p></div>
<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 to serialize.
</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="../Cache/ezcCacheInvalidDataException.html">ezcCacheInvalidDataException</a></code></td>
+ </tr></thead><tbody><tr><td><code><a href="ezcCacheInvalidDataException.html">ezcCacheInvalidDataException</a></code></td>
<td>
- If the data submitted is an object or a resource, since this implementation of <a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a> can only deal with scalar and array values.
+ If the data submitted is an object or a resource, since this implementation of <a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a> can only deal with scalar and array values.
</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="../Cache/ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></code></td>
+ </tr></thead><tbody><tr><td><code><a href="ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></code></td>
<td>
Serialize 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>