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 [10/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/ezcCacheStackOptions.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackOptions.html?rev=1089394&r1=1089393&r2=1089394&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackOptions.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackOptions.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="ezcCacheStackOptions.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/ezcCacheStackOptions.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,32 @@
<a name="sec-description"></a>
<h3>Class ezcCacheStackOptions</h3>
-<p>Options class for ezcCacheStack instances.</p><div><p>This options class is used with <a href="ezcCacheStack.html">ezcCacheStack</a> instances.</p><p>The $configurator property is special, since it only takes effect during construction of the stack. The idea is, to use this in combination with <a href="ezcCacheManager.html">ezcCacheManager</a>. The method <a href="ezcCacheStackConfigurator.html#methodconfigure">ezcCacheStackConfigurator::configure()</a> will called by the constructor of <a href="ezcCacheStack.html">ezcCacheStack</a>. Inside this method, the configuration of the stack can happen as needed. Therefore, the <a href="ezcCacheStackableStorage.html">ezcCacheStackableStorage</a> instances for the stack do not need to exist when the stack is configured in the <a href="ezcCacheManager.html">ezcCacheManager</a>.</p><p>The rest of the options is used as usual to affect the behavior of the <a href="ezcCacheStack.html">ezcCacheStack</a>. However, it is highly re
commended to not change $metaStorage and $replacementStrategy once they have been set for a stack. If these options are changed, the whole stack needs to be resetted using <a href="ezcCacheStack.html#methodreset">ezcCacheStack::reset()</a>. Aside of that, the previous $metaStorage needs to be resetted.</p></div>
+<p>Options class for ezcCacheStack instances.</p>
+<div>
+<p>This options class is used with <a href="../Cache/ezcCacheStack.html">ezcCacheStack</a> instances.</p>
+<p>The $configurator property is special, since it only takes effect during construction of the stack. The idea is, to use this in combination with <a href="../Cache/ezcCacheManager.html">ezcCacheManager</a>. The method <a href="../Cache/ezcCacheStackConfigurator.html#methodconfigure">ezcCacheStackConfigurator::configure()</a> will called by the constructor of <a href="../Cache/ezcCacheStack.html">ezcCacheStack</a>. Inside this method, the configuration of the stack can happen as needed. Therefore, the <a href="../Cache/ezcCacheStackableStorage.html">ezcCacheStackableStorage</a> instances for the stack do not need to exist when the stack is configured in the <a href="../Cache/ezcCacheManager.html">ezcCacheManager</a>.</p>
+<p>The rest of the options is used as usual to affect the behavior of the <a href="../Cache/ezcCacheStack.html">ezcCacheStack</a>. However, it is highly recommended to not change $metaStorage and $replacementStrategy once they have been set for a stack. If these options are changed, the whole stack needs to be resetted using <a href="../Cache/ezcCacheStack.html#methodreset">ezcCacheStack::reset()</a>. Aside of that, the previous $metaStorage needs to be resetted.</p>
+</div>
<p>Source for this file: <a href="http://fisheye6.atlassian.com/browse/zetacomponents/trunk/Cache/src/options/stack.php?r=HEAD">/Cache/src/options/stack.php</a></p>
-<pre><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html">ezcBaseOptions</a>
+<pre><a href="../Base/ezcBaseOptions.html">ezcBaseOptions</a>
|
--ezcCacheStackOptions</pre>
- <table><tr><td>
+ <table><tr>
+<td>
<strong>Version:</strong>  
</td>
<td>//autogen//</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%24bubbleUpOnRestore" id="$bubbleUpOnRestore"></a>
<a name="prop-%24bubbleUpOnRestore" id="$bubbleUpOnRestore"></a>
<em>bool</em> </td>
@@ -113,8 +119,10 @@
<code>
<a href="#prop-%24bubbleUpOnRestore" title="details" class="var-name-summary">$bubbleUpOnRestore</a>
</code>
- <br><div style="margin-left: 20px">This option determines if data that is restored from a storage in the stack will be bubbled up to higher caches. The default here is false, since it might significantly reduce the <a href="ezcCacheStack.html#methodrestore">ezcCacheStack::restore()</a> performance. In addition, for bubbled up items, only the attributes will be used that have been provided while restoring the desired item. Also the lifetime of the item will practically be reset, since higher storages will start with a fresh TTL value.</div> </td>
- </tr><tr><td class="right">
+ <br><div style="margin-left: 20px">This option determines if data that is restored from a storage in the stack will be bubbled up to higher caches. The default here is false, since it might significantly reduce the <a href="../Cache/ezcCacheStack.html#methodrestore">ezcCacheStack::restore()</a> performance. In addition, for bubbled up items, only the attributes will be used that have been provided while restoring the desired item. Also the lifetime of the item will practically be reset, since higher storages will start with a fresh TTL value.</div> </td>
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24configurator" id="$configurator"></a>
<a name="prop-%24configurator" id="$configurator"></a>
<em>string</em> </td>
@@ -126,10 +134,12 @@
<a href="#prop-%24configurator" title="details" class="var-name-summary">$configurator</a>
</code>
<br><div style="margin-left: 20px">Name of a class implementing ezcCacheStackConfigurator. This class will be used right after construction of the stack, to perform initial configuration. After the construction process, this option does not have any effect. Null (default) means no configuration.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24metaStorage" id="$metaStorage"></a>
<a name="prop-%24metaStorage" id="$metaStorage"></a>
- <em><a href="ezcCacheStackMetaDataStorage.html">ezcCacheStackMetaDataStorage</a></em> </td>
+ <em><a href="../Cache/ezcCacheStackMetaDataStorage.html">ezcCacheStackMetaDataStorage</a></em> </td>
<td class="right">
<em>read/write</em>
</td>
@@ -138,7 +148,9 @@
<a href="#prop-%24metaStorage" title="details" class="var-name-summary">$metaStorage</a>
</code>
<br><div style="margin-left: 20px">This storage will be used to store the meta data of the replacement strategy used by the stack. If null (default) is given, the top most storage will be used.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24replacementStrategy" id="$replacementStrategy"></a>
<a name="prop-%24replacementStrategy" id="$replacementStrategy"></a>
<em>string</em> </td>
@@ -150,19 +162,28 @@
<a href="#prop-%24replacementStrategy" title="details" class="var-name-summary">$replacementStrategy</a>
</code>
<br><div style="margin-left: 20px">The name of the class given in this property must extend ezcCacheReplacementStrategy. The class will be used as the replacement strategy in the stack. ezcCacheLruReplacementStrategy is the default.</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>ezcCacheStackOptions</em> </td>
<td>
<code>
@@ -171,41 +192,60 @@
= array()] )
</code>
<br><div style="margin-left: 20px">Construct a new options object.</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>
@@ -221,35 +261,58 @@
= array()] )
</div>
- <p>Construct a new options object.</p><div><p>Options are constructed from an option array by default. The constructor automatically passes the given options to the __set() method to set them in the class.</p></div>
+ <p>Construct a new options object.</p>
+<div><p>Options are constructed from an option array by default. The constructor automatically passes the given options to the __set() method to set them in the class.</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 a property is out of range.
</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 access a non existent property.
</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/ezcCacheStackReplacementStrategy.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackReplacementStrategy.html?rev=1089394&r1=1089393&r2=1089394&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackReplacementStrategy.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackReplacementStrategy.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="ezcCacheStackReplacementStrategy.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/ezcCacheStackReplacementStrategy.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>
@@ -87,29 +84,40 @@
<a name="sec-description"></a>
<h3>Interface ezcCacheStackReplacementStrategy</h3>
-<p>Interface to be implemented by stack replacement strategies.</p><div><p>This interface is to be implemented by replacement strategy classes, which can be configured to be used by an <a href="ezcCacheStack.html">ezcCacheStack</a>. The defined methods wrap around their counterparts on <a href="ezcCacheStackableStorage.html">ezcCacheStackableStorage</a>.</p><p>A replacement strategy must take care about the actual storing/restoring/deleting of cache items in the given storage. In addition it must take care about keeping the needed <a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a> up to date and about purging data from the cache storage, if it runs full.</p><p>A replacement strategy must define its own meta data class which implements <a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>. It must check in each method call, that the given $metaData is of correct type. If this is not the case, <a href="ezcCacheInvalidMetaDataException.html">ezcCache
InvalidMetaDataException</a> must be throwen.</p></div>
+<p>Interface to be implemented by stack replacement strategies.</p>
+<div>
+<p>This interface is to be implemented by replacement strategy classes, which can be configured to be used by an <a href="../Cache/ezcCacheStack.html">ezcCacheStack</a>. The defined methods wrap around their counterparts on <a href="../Cache/ezcCacheStackableStorage.html">ezcCacheStackableStorage</a>.</p>
+<p>A replacement strategy must take care about the actual storing/restoring/deleting of cache items in the given storage. In addition it must take care about keeping the needed <a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a> up to date and about purging data from the cache storage, if it runs full.</p>
+<p>A replacement strategy must define its own meta data class which implements <a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>. It must check in each method call, that the given $metaData is of correct type. If this is not the case, <a href="../Cache/ezcCacheInvalidMetaDataException.html">ezcCacheInvalidMetaDataException</a> must be throwen.</p>
+</div>
<p>Source for this file: <a href="http://fisheye6.atlassian.com/browse/zetacomponents/trunk/Cache/src/interfaces/replacement_strategy.php?r=HEAD">/Cache/src/interfaces/replacement_strategy.php</a></p>
- <table><tr><td>
+ <table><tr>
+<td>
<strong>Version:</strong>  
</td>
<td>//autogentag//</td>
- </tr></table><a name="sec-method-summary"></a>
+ </tr></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> static
- <em><a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em> </td>
+ <em><a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em> </td>
<td>
<code>
<a href="#createMetaData"><b>createMetaData</b></a>(
)
</code>
<br><div style="margin-left: 20px">Returns a fresh meta data object.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> static
<em>array(string)</em> </td>
<td>
@@ -123,7 +131,9 @@
= false] )
</code>
<br><div style="margin-left: 20px">Deletes the data with the given $itemId from the given $storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> static
<em>mixed</em> </td>
<td>
@@ -137,7 +147,9 @@
= false] )
</code>
<br><div style="margin-left: 20px">Restores the data with the given $dataId from the storage given in $conf.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> static
<em>void</em> </td>
<td>
@@ -151,7 +163,9 @@
= array()] )
</code>
<br><div style="margin-left: 20px">Stores the given $itemData in the storage given in $conf.</div> </td>
- </tr></table><a name="sec-methods"></a>
+ </tr>
+</table>
+<a name="sec-methods"></a>
<h3>Methods</h3>
<a name="method_detail"></a>
<a name="methodcreateMetaData" id="createMetaData"><!-- --></a>
@@ -159,12 +173,13 @@
<h4>createMetaData</h4>
<div class="method-signature">
- static <a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>
+ static <a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>
createMetaData(
)
</div>
- <p>Returns a fresh meta data object.</p><div><p>Different replacement strategies will use different meta data classes. This method must return a freshly created instance of the meta data object used by this meta data.</p></div>
+ <p>Returns a fresh meta data object.</p>
+<div><p>Different replacement strategies will use different meta data classes. This method must return a freshly created instance of the meta data object used by this meta data.</p></div>
@@ -177,9 +192,9 @@
<div class="method-signature">
static array(string)
delete(
- <a href="ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a>
+ <a href="../Cache/ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a>
$conf
- , <a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>
+ , <a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>
$metaData
, string
$itemId
@@ -190,48 +205,71 @@
= false] )
</div>
- <p>Deletes the data with the given $itemId from the given $storage.</p><div><p>This method takes care about deleting the item identified by $itemId and optionally $itemAttributes from the <a href="ezcCacheStackableStorage.html">ezcCacheStackableStorage</a> give in $conf. The parameters $itemId, $itemAttributes and $search are therefore forwarded to ezcCacheStackableStorage::delete(). This method returns a list of all item IDs that have been deleted by the call. The method reflects these changes in $metaData.</p></div>
+ <p>Deletes the data with the given $itemId from the given $storage.</p>
+<div><p>This method takes care about deleting the item identified by $itemId and optionally $itemAttributes from the <a href="../Cache/ezcCacheStackableStorage.html">ezcCacheStackableStorage</a> give in $conf. The parameters $itemId, $itemAttributes and $search are therefore forwarded to ezcCacheStackableStorage::delete(). This method returns a list of all item IDs that have been deleted by the call. The method reflects these changes in $metaData.</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>$conf</code></td>
- <td><em><a href="ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a></em></td>
- <td>
- </td>
- </tr><tr><td><code>$metaData</code></td>
- <td><em><a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em></td>
- <td>
- </td>
- </tr><tr><td><code>$itemId</code></td>
+ </tr></thead>
+<tbody>
+<tr>
+<td><code>$conf</code></td>
+ <td><em><a href="../Cache/ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a></em></td>
+ <td>
+ </td>
+ </tr>
+<tr>
+<td><code>$metaData</code></td>
+ <td><em><a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em></td>
+ <td>
+ </td>
+ </tr>
+<tr>
+<td><code>$itemId</code></td>
<td><em>string</em></td>
<td>
</td>
- </tr><tr><td><code>$itemAttributes</code></td>
+ </tr>
+<tr>
+<td><code>$itemAttributes</code></td>
<td><em>array(string=>string)</em></td>
<td>
</td>
- </tr><tr><td><code>$search</code></td>
+ </tr>
+<tr>
+<td><code>$search</code></td>
<td><em>bool</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="ezcCacheInvalidMetaDataException.html">ezcCacheInvalidMetaDataException</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheInvalidMetaDataException.html">ezcCacheInvalidMetaDataException</a></code></td>
<td>
if the given $metaData is not processable by this replacement strategy.
</td>
- </tr></tbody></table><a name="methodrestore" id="restore"><!-- --></a>
+ </tr></tbody>
+</table>
+<a name="methodrestore" id="restore"><!-- --></a>
<h4>restore</h4>
<div class="method-signature">
static mixed
restore(
- <a href="ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a>
+ <a href="../Cache/ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a>
$conf
- , <a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>
+ , <a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>
$metaData
, string
$itemId
@@ -242,48 +280,74 @@
= false] )
</div>
- <p>Restores the data with the given $dataId from the storage given in $conf.</p><div><p>This method takes care of restoring the item with ID $itemId and optionally $itemAttributes from the <a href="ezcCacheStackableStorage.html">ezcCacheStackableStorage</a> given in $conf. The parameters $itemId, $itemAttributes and $search are forwarded to ezcCacheStackableStorage::restore(), the returned value (item data on successful restore, otherwise false) are returned by this method.</p><p>The method must take care that the restore process is reflected in $metaData according to the spcific replacement strategy implementation.</p></div>
+ <p>Restores the data with the given $dataId from the storage given in $conf.</p>
+<div>
+<p>This method takes care of restoring the item with ID $itemId and optionally $itemAttributes from the <a href="../Cache/ezcCacheStackableStorage.html">ezcCacheStackableStorage</a> given in $conf. The parameters $itemId, $itemAttributes and $search are forwarded to ezcCacheStackableStorage::restore(), the returned value (item data on successful restore, otherwise false) are returned by this method.</p>
+<p>The method must take care that the restore process is reflected in $metaData according to the spcific replacement strategy implementation.</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>$conf</code></td>
- <td><em><a href="ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a></em></td>
- <td>
- </td>
- </tr><tr><td><code>$metaData</code></td>
- <td><em><a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em></td>
- <td>
- </td>
- </tr><tr><td><code>$itemId</code></td>
+ </tr></thead>
+<tbody>
+<tr>
+<td><code>$conf</code></td>
+ <td><em><a href="../Cache/ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a></em></td>
+ <td>
+ </td>
+ </tr>
+<tr>
+<td><code>$metaData</code></td>
+ <td><em><a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em></td>
+ <td>
+ </td>
+ </tr>
+<tr>
+<td><code>$itemId</code></td>
<td><em>string</em></td>
<td>
</td>
- </tr><tr><td><code>$itemAttributes</code></td>
+ </tr>
+<tr>
+<td><code>$itemAttributes</code></td>
<td><em>array(string=>string)</em></td>
<td>
</td>
- </tr><tr><td><code>$search</code></td>
+ </tr>
+<tr>
+<td><code>$search</code></td>
<td><em>bool</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="ezcCacheInvalidMetaDataException.html">ezcCacheInvalidMetaDataException</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheInvalidMetaDataException.html">ezcCacheInvalidMetaDataException</a></code></td>
<td>
if the given $metaData is not processable by this replacement strategy.
</td>
- </tr></tbody></table><a name="methodstore" id="store"><!-- --></a>
+ </tr></tbody>
+</table>
+<a name="methodstore" id="store"><!-- --></a>
<h4>store</h4>
<div class="method-signature">
static void
store(
- <a href="ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a>
+ <a href="../Cache/ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a>
$conf
- , <a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>
+ , <a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a>
$metaData
, string
$itemId
@@ -294,39 +358,66 @@
= array()] )
</div>
- <p>Stores the given $itemData in the storage given in $conf.</p><div><p>This method stores the given $itemData assigned to $itemId and optionally $itemAttributes in the <a href="ezcCacheStackableStorage.html">ezcCacheStackableStorage</a> given in $conf. In case the storage has reached the $itemLimit defined in $conf, it must be freed according to $freeRate <a href="ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a>.</p><p>The freeing of items from the storage must first happen via <a href="ezcCacheStackableStorage.html#methodpurge">ezcCacheStackableStorage::purge()</a>, which removes outdated items from the storage and returns the affected IDs. In case this does not last to free the desired number of items, the replacement strategy specific algorithm for freeing takes effect.</p><p>After the necessary freeing process has been performed, the item is stored in the storage and the $metaData is updated accordingly.</p></div>
+ <p>Stores the given $itemData in the storage given in $conf.</p>
+<div>
+<p>This method stores the given $itemData assigned to $itemId and optionally $itemAttributes in the <a href="../Cache/ezcCacheStackableStorage.html">ezcCacheStackableStorage</a> given in $conf. In case the storage has reached the $itemLimit defined in $conf, it must be freed according to $freeRate <a href="../Cache/ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a>.</p>
+<p>The freeing of items from the storage must first happen via <a href="../Cache/ezcCacheStackableStorage.html#methodpurge">ezcCacheStackableStorage::purge()</a>, which removes outdated items from the storage and returns the affected IDs. In case this does not last to free the desired number of items, the replacement strategy specific algorithm for freeing takes effect.</p>
+<p>After the necessary freeing process has been performed, the item is stored in the storage and the $metaData is updated accordingly.</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>$conf</code></td>
- <td><em><a href="ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a></em></td>
- <td>
- </td>
- </tr><tr><td><code>$metaData</code></td>
- <td><em><a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em></td>
- <td>
- </td>
- </tr><tr><td><code>$itemId</code></td>
+ </tr></thead>
+<tbody>
+<tr>
+<td><code>$conf</code></td>
+ <td><em><a href="../Cache/ezcCacheStackStorageConfiguration.html">ezcCacheStackStorageConfiguration</a></em></td>
+ <td>
+ </td>
+ </tr>
+<tr>
+<td><code>$metaData</code></td>
+ <td><em><a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em></td>
+ <td>
+ </td>
+ </tr>
+<tr>
+<td><code>$itemId</code></td>
<td><em>string</em></td>
<td>
</td>
- </tr><tr><td><code>$itemData</code></td>
+ </tr>
+<tr>
+<td><code>$itemData</code></td>
<td><em>mixed</em></td>
<td>
</td>
- </tr><tr><td><code>$itemAttributes</code></td>
+ </tr>
+<tr>
+<td><code>$itemAttributes</code></td>
<td><em>array(string=>string)</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="ezcCacheInvalidMetaDataException.html">ezcCacheInvalidMetaDataException</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheInvalidMetaDataException.html">ezcCacheInvalidMetaDataException</a></code></td>
<td>
if the given $metaData is not processable by this replacement strategy.
</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/ezcCacheStackStorageConfiguration.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackStorageConfiguration.html?rev=1089394&r1=1089393&r2=1089394&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackStorageConfiguration.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackStorageConfiguration.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="ezcCacheStackStorageConfiguration.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/ezcCacheStackStorageConfiguration.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,20 +83,25 @@
<a name="sec-description"></a>
<h3>Class ezcCacheStackStorageConfiguration</h3>
-<p>ezcCacheStackStorageConfiguration</p><div><p>Configuration for a <a href="ezcCacheStackableStorage.html">ezcCacheStackableStorage</a> inside an <a href="ezcCacheStack.html">ezcCacheStack</a>. The configuration consists of a string $id that identifies the $storage uniquely inside the stack. The $itemLimit is the maximum number of items that might be stored in the $storage at once. This number is determined by the used <a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a> used in the stack. The $freeRate is the fraction of $itemLimit that will be freed by the used <a href="ezcCacheStackReplacementStrategy.html">ezcCacheStackReplacementStrategy</a> when the storage runs full.</p></div>
+<p>ezcCacheStackStorageConfiguration</p>
+<div><p>Configuration for a <a href="../Cache/ezcCacheStackableStorage.html">ezcCacheStackableStorage</a> inside an <a href="../Cache/ezcCacheStack.html">ezcCacheStack</a>. The configuration consists of a string $id that identifies the $storage uniquely inside the stack. The $itemLimit is the maximum number of items that might be stored in the $storage at once. This number is determined by the used <a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a> used in the stack. The $freeRate is the fraction of $itemLimit that will be freed by the used <a href="../Cache/ezcCacheStackReplacementStrategy.html">ezcCacheStackReplacementStrategy</a> when the storage runs full.</p></div>
<p>Source for this file: <a href="http://fisheye6.atlassian.com/browse/zetacomponents/trunk/Cache/src/stack/storage_configuration.php?r=HEAD">/Cache/src/stack/storage_configuration.php</a></p>
- <table><tr><td>
+ <table><tr>
+<td>
<strong>Version:</strong>  
</td>
<td>//autogen//</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%24freeRate" id="$freeRate"></a>
<a name="prop-%24freeRate" id="$freeRate"></a>
<em>float</em> </td>
@@ -111,7 +113,9 @@
<a href="#prop-%24freeRate" title="details" class="var-name-summary">$freeRate</a>
</code>
<br><div style="margin-left: 20px">Fraction of $itemLimit that is freed if $storage runs full.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24id" id="$id"></a>
<a name="prop-%24id" id="$id"></a>
<em>string</em> </td>
@@ -123,7 +127,9 @@
<a href="#prop-%24id" title="details" class="var-name-summary">$id</a>
</code>
<br><div style="margin-left: 20px">The unique ID of the configured storage in the stack.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24itemLimit" id="$itemLimit"></a>
<a name="prop-%24itemLimit" id="$itemLimit"></a>
<em>int</em> </td>
@@ -135,10 +141,12 @@
<a href="#prop-%24itemLimit" title="details" class="var-name-summary">$itemLimit</a>
</code>
<br><div style="margin-left: 20px">Maximum number of items to be stored in $storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24storage" id="$storage"></a>
<a name="prop-%24storage" id="$storage"></a>
- <em><a href="ezcCacheStackableStorage.html">ezcCacheStackableStorage</a></em> </td>
+ <em><a href="../Cache/ezcCacheStackableStorage.html">ezcCacheStackableStorage</a></em> </td>
<td class="right">
<em>read</em>
</td>
@@ -147,18 +155,23 @@
<a href="#prop-%24storage" title="details" class="var-name-summary">$storage</a>
</code>
<br><div style="margin-left: 20px">The storage that is configured with this configuration. A storage might only be part of 1 stack and this only once.</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">
+ <table class="summary"><tr>
+<td class="right">
<em>protected</em> <em>array(string=>mixed)</em> </td>
<td>
<code>
$properties
= <span class="var-default">array(<br> 'id' => null,<br> 'storage' => null,<br> 'itemLimit' => null,<br> 'freeRate' => null,<br> )</span> </code>
<br><div style="margin-left: 20px">Properties</div> </td>
- </tr></table><a name="sec-method-summary"></a>
+ </tr></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>ezcCacheStackStorageConfiguration</em> </td>
<td>
<code>
@@ -170,7 +183,8 @@
)
</code>
<br><div style="margin-left: 20px">Creates a new storage configuration.</div> </td>
- </tr></table><a name="sec-methods"></a>
+ </tr></table>
+<a name="sec-methods"></a>
<h3>Methods</h3>
<a name="method_detail"></a>
@@ -183,7 +197,7 @@
__construct(
string
$id
- , <a href="ezcCacheStackableStorage.html">ezcCacheStackableStorage</a>
+ , <a href="../Cache/ezcCacheStackableStorage.html">ezcCacheStackableStorage</a>
$storage
, int
$itemLimit
@@ -192,35 +206,59 @@
)
</div>
- <p>Creates a new storage configuration.</p><div><p>This method creates an new configuration with the given values. Note that, once set, these values cannot be changed anymore to avoid inconsistencies in the stack. For details about the parameters, please refer to the properties documentation of this class.</p><p>Note that the properties can only be set once, using this constructore, and are not changeable via property access.</p></div>
+ <p>Creates a new storage configuration.</p>
+<div>
+<p>This method creates an new configuration with the given values. Note that, once set, these values cannot be changed anymore to avoid inconsistencies in the stack. For details about the parameters, please refer to the properties documentation of this class.</p>
+<p>Note that the properties can only be set once, using this constructore, and are not changeable via property access.</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>$id</code></td>
+ </tr></thead>
+<tbody>
+<tr>
+<td><code>$id</code></td>
<td><em>string</em></td>
<td>
</td>
- </tr><tr><td><code>$storage</code></td>
- <td><em><a href="ezcCacheStackableStorage.html">ezcCacheStackableStorage</a></em></td>
+ </tr>
+<tr>
+<td><code>$storage</code></td>
+ <td><em><a href="../Cache/ezcCacheStackableStorage.html">ezcCacheStackableStorage</a></em></td>
<td>
</td>
- </tr><tr><td><code>$itemLimit</code></td>
+ </tr>
+<tr>
+<td><code>$itemLimit</code></td>
<td><em>int</em></td>
<td>
</td>
- </tr><tr><td><code>$freeRate</code></td>
+ </tr>
+<tr>
+<td><code>$freeRate</code></td>
<td><em>float</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="/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 a given value does not conform to the indicated format.
</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/ezcCacheStackStorageUsedTwiceException.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackStorageUsedTwiceException.html?rev=1089394&r1=1089393&r2=1089394&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackStorageUsedTwiceException.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackStorageUsedTwiceException.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="ezcCacheStackStorageUsedTwiceException.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/ezcCacheStackStorageUsedTwiceException.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>
@@ -93,75 +90,102 @@
<pre>Exception
|
- --<a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html">ezcBaseException</a>
+ --<a href="../Base/ezcBaseException.html">ezcBaseException</a>
|
- --<a href="ezcCacheException.html">ezcCacheException</a>
+ --<a href="../Cache/ezcCacheException.html">ezcCacheException</a>
|
--ezcCacheStackStorageUsedTwiceException</pre>
- <table><tr><td>
+ <table><tr>
+<td>
<strong>Version:</strong>  
</td>
<td>//autogen//</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/ezcBaseException.html">ezcBaseException</a></span>
+ </tr></table>
+<h3>Inherited Member Variables</h3>
+ <table class="summary">
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Base/ezcBaseException.html">ezcBaseException</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody><tr>
+<td class="right">
<em>public</em> </td>
<td>
- <code><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html#var%24originalMessage">ezcBaseException::$originalMessage</a></code>
+ <code><a href="../Base/ezcBaseException.html#var%24originalMessage">ezcBaseException::$originalMessage</a></code>
</td>
- </tr></tbody><thead><tr><th colspan="2">
+ </tr></tbody>
+<thead><tr>
+<th colspan="2">
From <span class="classname">Exception (Internal Class)</span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
<code>$code</code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
<code>$file</code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
<code>$line</code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
<code>$message</code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>private</em> </td>
<td>
<code>$previous</code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>private</em> </td>
<td>
<code>$string</code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>private</em> </td>
<td>
<code>$trace</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>void</em> </td>
<td>
<code>
@@ -170,69 +194,100 @@
)
</code>
<br><div style="margin-left: 20px">Creates a new ezcCacheStackStorageUsedTwiceException.</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/ezcBaseException.html">ezcBaseException</a></span>
+ </tr></table>
+<h3>Inherited Methods</h3>
+ <table class="summary">
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Base/ezcBaseException.html">ezcBaseException</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody><tr>
+<td class="right">
<em>public</em> <em>ezcBaseException</em> </td>
<td>
- <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html#method__construct">ezcBaseException::__construct()</a></b></code>
+ <code><b><a href="../Base/ezcBaseException.html#method__construct">ezcBaseException::__construct()</a></b></code>
<br><div style="margin-left: 20px">Constructs a new ezcBaseException with $message</div> </td>
- </tr></tbody><thead><tr><th colspan="2">
+ </tr></tbody>
+<thead><tr>
+<th colspan="2">
From <span class="classname">Exception (Internal Class)</span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
<em>public</em> <em>Exception</em> </td>
<td>
<code><b>constructor __construct ( [$message = ], [$code = ], [$previous = ] )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getCode ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getFile ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getLine ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getMessage ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getPrevious ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getTrace ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getTraceAsString ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>__clone ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>__toString ( )</b></code>
</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>
@@ -243,28 +298,41 @@
<div class="method-signature">
void
__construct(
- <a href="ezcCacheStackableStorage.html">ezcCacheStackableStorage</a>
+ <a href="../Cache/ezcCacheStackableStorage.html">ezcCacheStackableStorage</a>
$storage
)
</div>
- <p>Creates a new ezcCacheStackStorageUsedTwiceException.</p><div><p>The $storage is the object that is used twice in the <a href="ezcCacheStack.html">ezcCacheStack</a>.</p></div>
+ <p>Creates a new ezcCacheStackStorageUsedTwiceException.</p>
+<div><p>The $storage is the object that is used twice in the <a href="../Cache/ezcCacheStack.html">ezcCacheStack</a>.</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>$storage</code></td>
- <td><em><a href="ezcCacheStackableStorage.html">ezcCacheStackableStorage</a></em></td>
+ </tr></thead>
+<tbody><tr>
+<td><code>$storage</code></td>
+ <td><em><a href="../Cache/ezcCacheStackableStorage.html">ezcCacheStackableStorage</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="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html#method__construct">ezcBaseException::__construct()</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Base/ezcBaseException.html#method__construct">ezcBaseException::__construct()</a></code></td>
<td>
Constructs a new ezcBaseException with $message
</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/ezcCacheStackUnderflowException.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackUnderflowException.html?rev=1089394&r1=1089393&r2=1089394&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackUnderflowException.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackUnderflowException.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="ezcCacheStackUnderflowException.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/ezcCacheStackUnderflowException.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>
@@ -93,75 +90,102 @@
<pre>Exception
|
- --<a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html">ezcBaseException</a>
+ --<a href="../Base/ezcBaseException.html">ezcBaseException</a>
|
- --<a href="ezcCacheException.html">ezcCacheException</a>
+ --<a href="../Cache/ezcCacheException.html">ezcCacheException</a>
|
--ezcCacheStackUnderflowException</pre>
- <table><tr><td>
+ <table><tr>
+<td>
<strong>Version:</strong>  
</td>
<td>//autogen//</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/ezcBaseException.html">ezcBaseException</a></span>
+ </tr></table>
+<h3>Inherited Member Variables</h3>
+ <table class="summary">
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Base/ezcBaseException.html">ezcBaseException</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody><tr>
+<td class="right">
<em>public</em> </td>
<td>
- <code><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html#var%24originalMessage">ezcBaseException::$originalMessage</a></code>
+ <code><a href="../Base/ezcBaseException.html#var%24originalMessage">ezcBaseException::$originalMessage</a></code>
</td>
- </tr></tbody><thead><tr><th colspan="2">
+ </tr></tbody>
+<thead><tr>
+<th colspan="2">
From <span class="classname">Exception (Internal Class)</span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
<code>$code</code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
<code>$file</code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
<code>$line</code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
<code>$message</code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>private</em> </td>
<td>
<code>$previous</code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>private</em> </td>
<td>
<code>$string</code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>private</em> </td>
<td>
<code>$trace</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>void</em> </td>
<td>
<code>
@@ -171,69 +195,100 @@
)
</code>
<br><div style="margin-left: 20px">Creates a new ezcCacheStackUnderflowException.</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/ezcBaseException.html">ezcBaseException</a></span>
+ </tr></table>
+<h3>Inherited Methods</h3>
+ <table class="summary">
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Base/ezcBaseException.html">ezcBaseException</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody><tr>
+<td class="right">
<em>public</em> <em>ezcBaseException</em> </td>
<td>
- <code><b><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseException.html#method__construct">ezcBaseException::__construct()</a></b></code>
+ <code><b><a href="../Base/ezcBaseException.html#method__construct">ezcBaseException::__construct()</a></b></code>
<br><div style="margin-left: 20px">Constructs a new ezcBaseException with $message</div> </td>
- </tr></tbody><thead><tr><th colspan="2">
+ </tr></tbody>
+<thead><tr>
+<th colspan="2">
From <span class="classname">Exception (Internal Class)</span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
<em>public</em> <em>Exception</em> </td>
<td>
<code><b>constructor __construct ( [$message = ], [$code = ], [$previous = ] )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getCode ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getFile ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getLine ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getMessage ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getPrevious ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getTrace ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>getTraceAsString ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>__clone ( )</b></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code><b>__toString ( )</b></code>
</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>
@@ -253,27 +308,43 @@
<p>Creates a new ezcCacheStackUnderflowException.</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>$actualType</code></td>
+ </tr></thead>
+<tbody>
+<tr>
+<td><code>$actualType</code></td>
<td><em>mixed</em></td>
<td>
Type of data received.
</td>
- </tr><tr><td><code>$expectedTypes</code></td>
+ </tr>
+<tr>
+<td><code>$expectedTypes</code></td>
<td><em>array</em></td>
<td>
Expected data types.
</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/ezcBaseException.html#method__construct">ezcBaseException::__construct()</a></code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Base/ezcBaseException.html#method__construct">ezcBaseException::__construct()</a></code></td>
<td>
Constructs a new ezcBaseException with $message
</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/ezcCacheStackableStorage.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackableStorage.html?rev=1089394&r1=1089393&r2=1089394&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackableStorage.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStackableStorage.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="ezcCacheStackableStorage.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/ezcCacheStackableStorage.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>
@@ -87,20 +84,25 @@
<a name="sec-description"></a>
<h3>Interface ezcCacheStackableStorage</h3>
-<p>Interface for stackable storage classes.</p><div><p>This interface must be implemented by storages that can be combined into a <a href="ezcCacheStack.html">ezcCacheStack</a>.</p></div>
+<p>Interface for stackable storage classes.</p>
+<div><p>This interface must be implemented by storages that can be combined into a <a href="../Cache/ezcCacheStack.html">ezcCacheStack</a>.</p></div>
<p>Source for this file: <a href="http://fisheye6.atlassian.com/browse/zetacomponents/trunk/Cache/src/interfaces/stackable_storage.php?r=HEAD">/Cache/src/interfaces/stackable_storage.php</a></p>
- <table><tr><td>
+ <table><tr>
+<td>
<strong>Version:</strong>  
</td>
<td>//autogentag//</td>
- </tr></table><a name="sec-method-summary"></a>
+ </tr></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>array(string)</em> </td>
<td>
<code>
@@ -109,7 +111,9 @@
= null] )
</code>
<br><div style="margin-left: 20px">Purge outdated data from the storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code>
@@ -117,7 +121,9 @@
)
</code>
<br><div style="margin-left: 20px">Reset the complete storage.</div> </td>
- </tr></table><a name="sec-methods"></a>
+ </tr>
+</table>
+<a name="sec-methods"></a>
<h3>Methods</h3>
<a name="method_detail"></a>
@@ -133,16 +139,23 @@
= null] )
</div>
- <p>Purge outdated data from the storage.</p><div><p>This method purges outdated data from the cache. If $limit is given, a maximum of $limit items is purged. Otherwise all outdated items are purged. The method returns an array containing the IDs of all cache items that have been purged.</p></div>
+ <p>Purge outdated data from the storage.</p>
+<div><p>This method purges outdated data from the cache. If $limit is given, a maximum of $limit items is purged. Otherwise all outdated items are purged. The method returns an array containing the IDs of all cache items that have been purged.</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>$limit</code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code>$limit</code></td>
<td><em>int</em></td>
<td>
</td>
- </tr></tbody></table><a name="methodreset" id="reset"><!-- --></a>
+ </tr></tbody>
+</table>
+<a name="methodreset" id="reset"><!-- --></a>
<h4>reset</h4>
@@ -152,7 +165,8 @@
)
</div>
- <p>Reset the complete storage.</p><div><p>This method resets the complete cache storage. All content (including content stored with the <a href="ezcCacheStackMetaDataStorage.html">ezcCacheStackMetaDataStorage</a> interfacer) must be deleted and the cache storage must appear as if it has just newly been created.</p></div>
+ <p>Reset the complete storage.</p>
+<div><p>This method resets the complete cache storage. All content (including content stored with the <a href="../Cache/ezcCacheStackMetaDataStorage.html">ezcCacheStackMetaDataStorage</a> interfacer) must be deleted and the cache storage must appear as if it has just newly been created.</p></div>