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 [17/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/ezcCacheStorageFileObject.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileObject.html?rev=1089394&r1=1089393&r2=1089394&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileObject.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileObject.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:17 +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="ezcCacheStorageFileObject.html" />
- <meta name="DC.creator" content="dotxp" />
- <meta name="DC.date" content="Wed, 04 Aug 2010 13:07:17 +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/ezcCacheStorageFileObject.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>
@@ -86,44 +83,68 @@
<a name="sec-description"></a>
<h3>Class ezcCacheStorageFileObject</h3>
-<p>This cache storage implementation stores arrays, scalar values</p><div><p>(int, float, string, bool) and objects implementing ezcBaseExportable 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>This cache storage deprecates <a href="ezcCacheStorageFileArray.html">ezcCacheStorageFileArray</a>, since it is also capable of storing exportable objects in addition to arrays and scalar values.</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> Both
of these use different methods for actually storing the data, which are basically not superior to the implementation in this class.</div>
+<p>This cache storage implementation stores arrays, scalar values</p>
+<div>
+<p>(int, float, string, bool) and objects implementing ezcBaseExportable 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>This cache storage deprecates <a href="../Cache/ezcCacheStorageFileArray.html">ezcCacheStorageFileArray</a>, since it is also capable of storing exportable objects in addition to arrays and scalar values.</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> Both of these use different methods for actually storing the data, which are basically not superior to the implementation in this class.</div>
<p>Source for this file: <a href="http://fisheye6.atlassian.com/browse/zetacomponents/trunk/Cache/src/storage/file/object.php?r=HEAD">/Cache/src/storage/file/object.php</a></p>
-<pre><a href="ezcCacheStorage.html">ezcCacheStorage</a>
+<pre><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a>
|
- --<a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a>
+ --<a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a>
|
--ezcCacheStorageFileObject</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="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="../Cache/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="ezcCacheStorageFile.html#var%24lockResource">ezcCacheStorageFile::$lockResource</a></code>
+ <code><a href="../Cache/ezcCacheStorageFile.html#var%24lockResource">ezcCacheStorageFile::$lockResource</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>
@@ -132,7 +153,9 @@
)
</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>
@@ -141,169 +164,243 @@
)
</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="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="../Cache/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="ezcCacheStorageFile.html#method__construct">ezcCacheStorageFile::__construct()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodcalcLifetime">ezcCacheStorageFile::calcLifetime()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodcountDataItems">ezcCacheStorageFile::countDataItems()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methoddelete">ezcCacheStorageFile::delete()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodfetchData">ezcCacheStorageFile::fetchData()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodgenerateIdentifier">ezcCacheStorageFile::generateIdentifier()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodgetRemainingLifetime">ezcCacheStorageFile::getRemainingLifetime()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodlock">ezcCacheStorageFile::lock()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodpurge">ezcCacheStorageFile::purge()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodreset">ezcCacheStorageFile::reset()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodrestore">ezcCacheStorageFile::restore()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>|null</em> </td>
+ </tr>
+<tr>
+<td class="right">
+ <em>public</em> <em><a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>|null</em> </td>
<td>
- <code><b><a href="ezcCacheStorageFile.html#methodrestoreMetaData">ezcCacheStorageFile::restoreMetaData()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodsearch">ezcCacheStorageFile::search()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodsearchRecursive">ezcCacheStorageFile::searchRecursive()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodsetOptions">ezcCacheStorageFile::setOptions()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodstore">ezcCacheStorageFile::store()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodstoreMetaData">ezcCacheStorageFile::storeMetaData()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodstoreRawData">ezcCacheStorageFile::storeRawData()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodunlock">ezcCacheStorageFile::unlock()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodvalidateLocation">ezcCacheStorageFile::validateLocation()</a></b></code>
+ <code><b><a href="../Cache/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="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>
@@ -319,23 +416,36 @@
)
</div>
- <p>Fetch data from the cache.</p><div><p>This method fetches the desired data from the file with $filename from disk. This implementation uses an include statement for fetching. The return value depends on the stored data and might either be an object implementing <a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseExportable.html">ezcBaseExportable</a>, an array or a scalar value.</p></div>
+ <p>Fetch data from the cache.</p>
+<div><p>This method fetches the desired data from the file with $filename from disk. This implementation uses an include statement for fetching. The return value depends on the stored data and might either be an object implementing <a href="../Base/ezcBaseExportable.html">ezcBaseExportable</a>, an array or a scalar value.</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>
</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="ezcCacheStorageFile.html#methodfetchData">ezcCacheStorageFile::fetchData()</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/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>
@@ -347,30 +457,49 @@
)
</div>
- <p>Serialize the data for storing.</p><div><p>Serializes the given $data to a executable PHP code representation string. This works with objects implementing <a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseExportable.html">ezcBaseExportable</a>, arrays and scalar values (int, bool, float, string). The return value is executable PHP code to be stored to disk. The data can be unserialized using the <a href="ezcCacheStorageFileObject.html#methodfetchData">fetchData()</a> method.</p></div>
+ <p>Serialize the data for storing.</p>
+<div><p>Serializes the given $data to a executable PHP code representation string. This works with objects implementing <a href="../Base/ezcBaseExportable.html">ezcBaseExportable</a>, arrays and scalar values (int, bool, float, string). The return value is executable PHP code to be stored to disk. The data can be unserialized using the <a href="../Cache/ezcCacheStorageFileObject.html#methodfetchData">fetchData()</a> method.</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>
</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 can not be serialized (e.g. an object that does not implement ezcBaseExportable, a 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="ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/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/ezcCacheStorageFileOptions.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileOptions.html?rev=1089394&r1=1089393&r2=1089394&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileOptions.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFileOptions.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:17 +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="ezcCacheStorageFileOptions.html" />
- <meta name="DC.creator" content="dotxp" />
- <meta name="DC.date" content="Wed, 04 Aug 2010 13:07:17 +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/ezcCacheStorageFileOptions.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>
@@ -86,23 +83,28 @@
<a name="sec-description"></a>
<h3>Class ezcCacheStorageFileOptions</h3>
-<p>Option class for the ezcCacheStorageFile class.</p><div><p>Instances of this class store the option of ezcCacheStorageFile implementations.</p></div>
+<p>Option class for the ezcCacheStorageFile class.</p>
+<div><p>Instances of this class store the option of ezcCacheStorageFile implementations.</p></div>
<p>Source for this file: <a href="http://fisheye6.atlassian.com/browse/zetacomponents/trunk/Cache/src/options/storage_file.php?r=HEAD">/Cache/src/options/storage_file.php</a></p>
-<pre><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html">ezcBaseOptions</a>
+<pre><a href="../Base/ezcBaseOptions.html">ezcBaseOptions</a>
|
--ezcCacheStorageFileOptions</pre>
- <table><tr><td>
+ <table><tr>
+<td>
<strong>Version:</strong>  
</td>
<td>//autogentag//</td>
- </tr></table><a name="sec-prop-summary"></a>
+ </tr></table>
+<a name="sec-prop-summary"></a>
<h3>Properties</h3>
- <table class="summary"><tr><td class="right">
+ <table class="summary">
+<tr>
+<td class="right">
<a name="prop%24extension" id="$extension"></a>
<a name="prop-%24extension" id="$extension"></a>
<em>string</em> </td>
@@ -114,7 +116,9 @@
<a href="#prop-%24extension" title="details" class="var-name-summary">$extension</a>
</code>
<br><div style="margin-left: 20px">The (file) extension to use for the storage items.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24lockFile" id="$lockFile"></a>
<a name="prop-%24lockFile" id="$lockFile"></a>
<em>string</em> </td>
@@ -126,7 +130,9 @@
<a href="#prop-%24lockFile" title="details" class="var-name-summary">$lockFile</a>
</code>
<br><div style="margin-left: 20px">The name of the file used for locking in the lock() method. Default is '.ezcLock'.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24lockWaitTime" id="$lockWaitTime"></a>
<a name="prop-%24lockWaitTime" id="$lockWaitTime"></a>
<em>int</em> </td>
@@ -138,7 +144,9 @@
<a href="#prop-%24lockWaitTime" title="details" class="var-name-summary">$lockWaitTime</a>
</code>
<br><div style="margin-left: 20px">Time to wait between lock availability checks. Measured in microseconds (<a href="http://www.php.net/usleep">http://www.php.net/usleep</a>). Default is 200000.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24maxLockTime" id="$maxLockTime"></a>
<a name="prop-%24maxLockTime" id="$maxLockTime"></a>
<em>int</em> </td>
@@ -150,7 +158,9 @@
<a href="#prop-%24maxLockTime" title="details" class="var-name-summary">$maxLockTime</a>
</code>
<br><div style="margin-left: 20px">Time before a lock is considered dead, measured in seconds. Default is 5.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24metaDataFile" id="$metaDataFile"></a>
<a name="prop-%24metaDataFile" id="$metaDataFile"></a>
<em>string</em> </td>
@@ -162,7 +172,9 @@
<a href="#prop-%24metaDataFile" title="details" class="var-name-summary">$metaDataFile</a>
</code>
<br><div style="margin-left: 20px">The name of the file used to store meta data. Default is '.ezcMetaData'.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24permissions" id="$permissions"></a>
<a name="prop-%24permissions" id="$permissions"></a>
<em>int</em> </td>
@@ -174,7 +186,9 @@
<a href="#prop-%24permissions" title="details" class="var-name-summary">$permissions</a>
</code>
<br><div style="margin-left: 20px">Permissions to create a file with (Posix only).</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24ttl" id="$ttl"></a>
<a name="prop-%24ttl" id="$ttl"></a>
<em>int</em> </td>
@@ -186,28 +200,39 @@
<a href="#prop-%24ttl" title="details" class="var-name-summary">$ttl</a>
</code>
<br><div style="margin-left: 20px">The time to live of cache entries.</div> </td>
- </tr></table><a name="sec-var-summary"></a>
+ </tr>
+</table>
+<a name="sec-var-summary"></a>
<h3>Member Variables</h3>
- <table class="summary"><tr><td class="right">
- <em>protected</em> <em><a href="ezcCacheStorageOptions.html">ezcCacheStorageOptions</a></em> </td>
+ <table class="summary"><tr>
+<td class="right">
+ <em>protected</em> <em><a href="../Cache/ezcCacheStorageOptions.html">ezcCacheStorageOptions</a></em> </td>
<td>
<code>
$storageOptions
</code>
<br><div style="margin-left: 20px">Parent storage options.</div> </td>
- </tr></table><h3>Inherited Member Variables</h3>
- <table class="summary"><thead><tr><th colspan="2">
- From <span class="classname"><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html">ezcBaseOptions</a></span>
+ </tr></table>
+<h3>Inherited Member Variables</h3>
+ <table class="summary">
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Base/ezcBaseOptions.html">ezcBaseOptions</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="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#var%24properties">ezcBaseOptions::$properties</a></code>
+ <code><a href="../Base/ezcBaseOptions.html#var%24properties">ezcBaseOptions::$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>public</em> <em>ezcCacheStorageFileOptions</em> </td>
<td>
<code>
@@ -216,41 +241,60 @@
= array()] )
</code>
<br><div style="margin-left: 20px">Constructs a new options class.</div> </td>
- </tr></table><h3>Inherited Methods</h3>
- <table class="summary"><thead><tr><th colspan="2">
- From <span class="classname"><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html">ezcBaseOptions</a></span>
+ </tr></table>
+<h3>Inherited Methods</h3>
+ <table class="summary">
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Base/ezcBaseOptions.html">ezcBaseOptions</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
<em>public</em> <em>ezcBaseOptions</em> </td>
<td>
- <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#method__construct">ezcBaseOptions::__construct()</a></b></code>
+ <code><b><a href="../Base/ezcBaseOptions.html#method__construct">ezcBaseOptions::__construct()</a></b></code>
<br><div style="margin-left: 20px">Construct a new options object.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#methodmerge">ezcBaseOptions::merge()</a></b></code>
+ <code><b><a href="../Base/ezcBaseOptions.html#methodmerge">ezcBaseOptions::merge()</a></b></code>
<br><div style="margin-left: 20px">Merge an array into the actual options object.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>bool</em> </td>
<td>
- <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#methodoffsetExists">ezcBaseOptions::offsetExists()</a></b></code>
+ <code><b><a href="../Base/ezcBaseOptions.html#methodoffsetExists">ezcBaseOptions::offsetExists()</a></b></code>
<br><div style="margin-left: 20px">Returns if an option exists.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>mixed</em> </td>
<td>
- <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#methodoffsetGet">ezcBaseOptions::offsetGet()</a></b></code>
+ <code><b><a href="../Base/ezcBaseOptions.html#methodoffsetGet">ezcBaseOptions::offsetGet()</a></b></code>
<br><div style="margin-left: 20px">Returns an option value.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#methodoffsetSet">ezcBaseOptions::offsetSet()</a></b></code>
+ <code><b><a href="../Base/ezcBaseOptions.html#methodoffsetSet">ezcBaseOptions::offsetSet()</a></b></code>
<br><div style="margin-left: 20px">Set an option.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#methodoffsetUnset">ezcBaseOptions::offsetUnset()</a></b></code>
+ <code><b><a href="../Base/ezcBaseOptions.html#methodoffsetUnset">ezcBaseOptions::offsetUnset()</a></b></code>
<br><div style="margin-left: 20px">Unset an option.</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>
@@ -266,35 +310,58 @@
= array()] )
</div>
- <p>Constructs a new options class.</p><div><p>It also sets the default values of the format property</p></div>
+ <p>Constructs a new options class.</p>
+<div><p>It also sets the default values of the format property</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>$options</code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code>$options</code></td>
<td><em>array(string=>mixed)</em></td>
<td>
The initial options to set.
</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="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseValueException.html">ezcBaseValueException</a></code></td>
+ </tr></thead>
+<tbody>
+<tr>
+<td><code><a href="../Base/ezcBaseValueException.html">ezcBaseValueException</a></code></td>
<td>
If the value for the property is incorrect
</td>
- </tr><tr><td><code><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBasePropertyNotFoundException.html">ezcBasePropertyNotFoundException</a></code></td>
+ </tr>
+<tr>
+<td><code><a href="../Base/ezcBasePropertyNotFoundException.html">ezcBasePropertyNotFoundException</a></code></td>
<td>
If trying to assign a property which does not exist
</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="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html#method__construct">ezcBaseOptions::__construct()</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Base/ezcBaseOptions.html#method__construct">ezcBaseOptions::__construct()</a></code></td>
<td>
Construct a new options object.
</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/ezcCacheStorageFilePlain.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFilePlain.html?rev=1089394&r1=1089393&r2=1089394&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFilePlain.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageFilePlain.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:17 +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="ezcCacheStorageFilePlain.html" />
- <meta name="DC.creator" content="dotxp" />
- <meta name="DC.date" content="Wed, 04 Aug 2010 13:07:17 +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/ezcCacheStorageFilePlain.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>
@@ -86,44 +83,69 @@
<a name="sec-description"></a>
<h3>Class ezcCacheStorageFilePlain</h3>
-<p>This class implements a simple storage to cache plain text on the filesystem. It takes its base methods from the extended storage base class <a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a>.</p><div><p>In contrast to other <a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a> implementations, the stored cache data is restored using PHP's file_get_contents() class. This cache is not capable to store array values. If numeric values are stored the restored values will be of type string. The same applies to values of the simple type bool. It is highly recommended that you cast the resulting value to its correct type, also PHP will automatically perform this cast when necessary. An explicit cast ensures that type consistent comparisons (using the === or !== operators) will not fail on restored cache data.</p><p>An even better solution, if you want to store non-string values, are the usage of <a href="ezcCacheStorageFileArray.html">ezcCacheStorageFileAr
ray</a> and <a href="ezcCacheStorageFileEvalArray.html">ezcCacheStorageFileEvalArray</a> storage classes, since those keep the variable types of you cached data consistent.</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>This class implements a simple storage to cache plain text on the filesystem. It takes its base methods from the extended storage base class <a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a>.</p>
+<div>
+<p>In contrast to other <a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a> implementations, the stored cache data is restored using PHP's file_get_contents() class. This cache is not capable to store array values. If numeric values are stored the restored values will be of type string. The same applies to values of the simple type bool. It is highly recommended that you cast the resulting value to its correct type, also PHP will automatically perform this cast when necessary. An explicit cast ensures that type consistent comparisons (using the === or !== operators) will not fail on restored cache data.</p>
+<p>An even better solution, if you want to store non-string values, are the usage of <a href="../Cache/ezcCacheStorageFileArray.html">ezcCacheStorageFileArray</a> and <a href="../Cache/ezcCacheStorageFileEvalArray.html">ezcCacheStorageFileEvalArray</a> storage classes, since those keep the variable types of you cached data consistent.</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>Source for this file: <a href="http://fisheye6.atlassian.com/browse/zetacomponents/trunk/Cache/src/storage/file/plain.php?r=HEAD">/Cache/src/storage/file/plain.php</a></p>
-<pre><a href="ezcCacheStorage.html">ezcCacheStorage</a>
+<pre><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a>
|
- --<a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a>
+ --<a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a>
|
--ezcCacheStorageFilePlain</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="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="../Cache/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="ezcCacheStorageFile.html#var%24lockResource">ezcCacheStorageFile::$lockResource</a></code>
+ <code><a href="../Cache/ezcCacheStorageFile.html#var%24lockResource">ezcCacheStorageFile::$lockResource</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>string</em> </td>
<td>
<code>
@@ -132,7 +154,9 @@
)
</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>
@@ -141,15 +165,19 @@
)
</code>
<br><div style="margin-left: 20px">Serialize the data for storing.</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>
<a href="#restoreMetaData"><b>restoreMetaData</b></a>(
)
</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>public</em> <em>void</em> </td>
<td>
<code>
@@ -158,169 +186,243 @@
)
</code>
<br><div style="margin-left: 20px">Stores the given meta data struct.</div> </td>
- </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>
+ </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>
</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="ezcCacheStorageFile.html#method__construct">ezcCacheStorageFile::__construct()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodcalcLifetime">ezcCacheStorageFile::calcLifetime()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodcountDataItems">ezcCacheStorageFile::countDataItems()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methoddelete">ezcCacheStorageFile::delete()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodfetchData">ezcCacheStorageFile::fetchData()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodgenerateIdentifier">ezcCacheStorageFile::generateIdentifier()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodgetRemainingLifetime">ezcCacheStorageFile::getRemainingLifetime()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodlock">ezcCacheStorageFile::lock()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodpurge">ezcCacheStorageFile::purge()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodreset">ezcCacheStorageFile::reset()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodrestore">ezcCacheStorageFile::restore()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>|null</em> </td>
+ </tr>
+<tr>
+<td class="right">
+ <em>public</em> <em><a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>|null</em> </td>
<td>
- <code><b><a href="ezcCacheStorageFile.html#methodrestoreMetaData">ezcCacheStorageFile::restoreMetaData()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodsearch">ezcCacheStorageFile::search()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodsearchRecursive">ezcCacheStorageFile::searchRecursive()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodsetOptions">ezcCacheStorageFile::setOptions()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodstore">ezcCacheStorageFile::store()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodstoreMetaData">ezcCacheStorageFile::storeMetaData()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodstoreRawData">ezcCacheStorageFile::storeRawData()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodunlock">ezcCacheStorageFile::unlock()</a></b></code>
+ <code><b><a href="../Cache/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="ezcCacheStorageFile.html#methodvalidateLocation">ezcCacheStorageFile::validateLocation()</a></b></code>
+ <code><b><a href="../Cache/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="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>
@@ -336,24 +438,37 @@
)
</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="ezcCacheStorageFile.html#methodfetchData">ezcCacheStorageFile::fetchData()</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/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>
@@ -365,80 +480,119 @@
)
</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="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 is an array,object or a resource, since this implementation of <a href="ezcCacheStorageFile.html">ezcCacheStorageFile</a> can only deal with scalar values.
+ If the data submitted is an array,object or a resource, since this implementation of <a href="../Cache/ezcCacheStorageFile.html">ezcCacheStorageFile</a> can only deal with scalar 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="ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheStorageFile.html#methodprepareData">ezcCacheStorageFile::prepareData()</a></code></td>
<td>
Serialize the data for storing.
</td>
- </tr></tbody></table><a name="methodrestoreMetaData" id="restoreMetaData"><!-- --></a>
+ </tr></tbody>
+</table>
+<a name="methodrestoreMetaData" id="restoreMetaData"><!-- --></a>
<h4>restoreMetaData</h4>
<div class="method-signature">
- <a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>
+ <a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>
restoreMetaData(
)
</div>
- <p>Restores and returns the meta data struct.</p><div><p>This method fetches the meta data stored in the storage and returns the according struct of type <a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>. The meta data must be stored inside the storage, but should not be visible as normal cache items to the user.</p></div>
+ <p>Restores and returns the meta data struct.</p>
+<div><p>This method fetches the meta data stored in the storage and returns the according struct of type <a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>. The meta data must be stored inside the storage, but should not be visible as normal cache items to the user.</p></div>
<h5>Redefinition of:</h5>
- <table class="detail"><thead><tr><th>Method</th>
+ <table class="detail">
+<thead><tr>
+<th>Method</th>
<th class="desc">Description</th>
- </tr></thead><tbody><tr><td><code><a href="ezcCacheStorageFile.html#methodrestoreMetaData">ezcCacheStorageFile::restoreMetaData()</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheStorageFile.html#methodrestoreMetaData">ezcCacheStorageFile::restoreMetaData()</a></code></td>
<td>
Restores and returns the meta data struct.
</td>
- </tr></tbody></table><a name="methodstoreMetaData" id="storeMetaData"><!-- --></a>
+ </tr></tbody>
+</table>
+<a name="methodstoreMetaData" id="storeMetaData"><!-- --></a>
<h4>storeMetaData</h4>
<div class="method-signature">
void
storeMetaData(
- <a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>
+ <a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>
$metaData
)
</div>
- <p>Stores the given meta data struct.</p><div><p>This method stores the given $metaData inside the storage. The data must be stored with the same mechanism that the storage itself uses. However, it should not be stored as a normal cache item, if possible, to avoid accedental user manipulation.</p></div>
+ <p>Stores the given meta data struct.</p>
+<div><p>This method stores the given $metaData inside the storage. The data must be stored with the same mechanism that the storage itself uses. However, it should not be stored as a normal cache item, if possible, to avoid accedental user manipulation.</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>$metaData</code></td>
- <td><em><a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em></td>
+ </tr></thead>
+<tbody><tr>
+<td><code>$metaData</code></td>
+ <td><em><a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em></td>
<td>
</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="ezcCacheStorageFile.html#methodstoreMetaData">ezcCacheStorageFile::storeMetaData()</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheStorageFile.html#methodstoreMetaData">ezcCacheStorageFile::storeMetaData()</a></code></td>
<td>
Stores the given meta data struct.
</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>