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 [18/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/ezcCacheStorageMemcache.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcache.html?rev=1089394&r1=1089393&r2=1089394&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcache.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcache.html Wed Apr 6 10:44:44 2011
@@ -9,16 +9,16 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Apache Zeta Components - reusable set of high quality PHP components to fasten your development." />
- <meta name="keywords" content="PHP, apache, components, framework, quality" />
- <meta name="author" content="dotxp" />
+ <meta name="keywords" content="" />
+ <meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Wed, 04 Aug 2010 13:07:18 +0200" />
+ <meta name="date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="ezcCacheStorageMemcache.html" />
- <meta name="DC.creator" content="dotxp" />
- <meta name="DC.date" content="Wed, 04 Aug 2010 13:07:18 +0200" />
+ <meta name="DC.creator" content="jerome" />
+ <meta name="DC.date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcache.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,32 +83,47 @@
<a name="sec-description"></a>
<h3>Class ezcCacheStorageMemcache</h3>
-<p>This class is a common base class for all Memcache based storage classes.</p><div><p>To implement a Memcache based cache storage, you simply have to derive from this class and implement the <a href="ezcCacheStorageMemcache.html#methodfetchData">ezcCacheStorageMemcache::fetchData()</a> and <a href="ezcCacheStorageMemcache.html#methodprepareData">ezcCacheStorageMemcache::prepareData()</a> methods.</p><p>For example code of using a cache storage, see <a href="ezcCacheManager.html">ezcCacheManager</a>.</p><p>The Cache package already contains an implementation this class: </p><ul><li><a href="ezcCacheStorageMemcachePlain.html">ezcCacheStorageMemcachePlain</a></li></ul> Options for this class are defined in <a href="ezcCacheStorageMemcacheOptions.html">ezcCacheStorageMemcacheOptions</a>.</div>
+<p>This class is a common base class for all Memcache based storage classes.</p>
+<div>
+<p>To implement a Memcache based cache storage, you simply have to derive from this class and implement the <a href="../Cache/ezcCacheStorageMemcache.html#methodfetchData">ezcCacheStorageMemcache::fetchData()</a> and <a href="../Cache/ezcCacheStorageMemcache.html#methodprepareData">ezcCacheStorageMemcache::prepareData()</a> methods.</p>
+<p>For example code of using a cache storage, see <a href="../Cache/ezcCacheManager.html">ezcCacheManager</a>.</p>
+<p>The Cache package already contains an implementation this class: </p>
+<ul><li><a href="../Cache/ezcCacheStorageMemcachePlain.html">ezcCacheStorageMemcachePlain</a></li></ul> Options for this class are defined in <a href="../Cache/ezcCacheStorageMemcacheOptions.html">ezcCacheStorageMemcacheOptions</a>.</div>
<p>Source for this file: <a href="http://fisheye6.atlassian.com/browse/zetacomponents/trunk/Cache/src/storage/memcache.php?r=HEAD">/Cache/src/storage/memcache.php</a></p>
-<pre><a href="ezcCacheStorage.html">ezcCacheStorage</a>
+<pre><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a>
|
- --<a href="ezcCacheStorageMemory.html">ezcCacheStorageMemory</a>
+ --<a href="../Cache/ezcCacheStorageMemory.html">ezcCacheStorageMemory</a>
|
--ezcCacheStorageMemcache</pre>
- <table><tr><td>
+ <table><tr>
+<td>
<strong>Version:</strong>  
</td>
<td>//autogentag//</td>
- </tr></table><a name="sec-descendants"></a>
+ </tr></table>
+<a name="sec-descendants"></a>
<h3>Descendants</h3>
- <table class="detail"><thead><tr><th>Child Class</th>
+ <table class="detail">
+<thead><tr>
+<th>Child Class</th>
<th>Description</th>
- </tr></thead><tbody><tr><td><a href="ezcCacheStorageMemcachePlain.html">ezcCacheStorageMemcachePlain</a></td>
<td>
+ </tr></thead>
+<tbody><tr>
+<td><a href="../Cache/ezcCacheStorageMemcachePlain.html">ezcCacheStorageMemcachePlain</a></td>
<td>
This storage implementation stores data in a Memcache cache.
</td>
- </tr></tbody></table><a name="sec-const-summary"></a>
+ </tr></tbody>
+</table>
+<a name="sec-const-summary"></a>
<h3>Constants</h3>
- <table class="summary"><tr><td class="right">
+ <table class="summary">
+<tr>
+<td class="right">
<a name="const-BACKEND_NAME" id=""></a>
<code>
<a href="#const-BACKEND_NAME" title="details" class="const-name-summary">BACKEND_NAME</a>
@@ -120,7 +132,9 @@
</td>
<td>
The backend name. </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="const-REGISTRY_NAME" id=""></a>
<code>
<a href="#const-REGISTRY_NAME" title="details" class="const-name-summary">REGISTRY_NAME</a>
@@ -129,52 +143,76 @@
</td>
<td>
The registry name. </td>
- </tr></table><h3>Inherited Member Variables</h3>
- <table class="summary"><thead><tr><th colspan="2">
- From <span class="classname"><a href="ezcCacheStorageMemory.html">ezcCacheStorageMemory</a></span>
+ </tr>
+</table>
+<h3>Inherited Member Variables</h3>
+ <table class="summary">
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Cache/ezcCacheStorageMemory.html">ezcCacheStorageMemory</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
- <code><a href="ezcCacheStorageMemory.html#var%24backend">ezcCacheStorageMemory::$backend</a></code>
+ <code><a href="../Cache/ezcCacheStorageMemory.html#var%24backend">ezcCacheStorageMemory::$backend</a></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
- <code><a href="ezcCacheStorageMemory.html#var%24backendName">ezcCacheStorageMemory::$backendName</a></code>
+ <code><a href="../Cache/ezcCacheStorageMemory.html#var%24backendName">ezcCacheStorageMemory::$backendName</a></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
- <code><a href="ezcCacheStorageMemory.html#var%24registry">ezcCacheStorageMemory::$registry</a></code>
+ <code><a href="../Cache/ezcCacheStorageMemory.html#var%24registry">ezcCacheStorageMemory::$registry</a></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
- <code><a href="ezcCacheStorageMemory.html#var%24registryName">ezcCacheStorageMemory::$registryName</a></code>
+ <code><a href="../Cache/ezcCacheStorageMemory.html#var%24registryName">ezcCacheStorageMemory::$registryName</a></code>
</td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> </td>
<td>
- <code><a href="ezcCacheStorageMemory.html#var%24searchRegistry">ezcCacheStorageMemory::$searchRegistry</a></code>
+ <code><a href="../Cache/ezcCacheStorageMemory.html#var%24searchRegistry">ezcCacheStorageMemory::$searchRegistry</a></code>
</td>
- </tr></tbody><thead><tr><th colspan="2">
- From <span class="classname"><a href="ezcCacheStorage.html">ezcCacheStorage</a></span>
+ </tr>
+</tbody>
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody><tr>
+<td class="right">
<em>protected</em> </td>
<td>
- <code><a href="ezcCacheStorage.html#var%24properties">ezcCacheStorage::$properties</a></code>
+ <code><a href="../Cache/ezcCacheStorage.html#var%24properties">ezcCacheStorage::$properties</a></code>
</td>
- </tr></tbody></table><a name="sec-method-summary"></a>
+ </tr></tbody>
+</table>
+<a name="sec-method-summary"></a>
<h3>Method Summary</h3>
- <table class="summary"><tr><td class="right">
+ <table class="summary">
+<tr>
+<td class="right">
<em>public</em> <em>ezcCacheStorageMemcache</em> </td>
<td>
<code>
@@ -184,7 +222,9 @@
= array()] )
</code>
<br><div style="margin-left: 20px">Creates a new cache storage in the given location.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> abstract <em>mixed</em> </td>
<td>
<code>
@@ -193,7 +233,9 @@
)
</code>
<br><div style="margin-left: 20px">Fetches the data from the cache.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> abstract <em>mixed</em> </td>
<td>
<code>
@@ -202,7 +244,9 @@
)
</code>
<br><div style="margin-left: 20px">Prepare the data for storing.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
<code>
@@ -211,169 +255,243 @@
)
</code>
<br><div style="margin-left: 20px">Set new options.</div> </td>
- </tr></table><h3>Inherited Methods</h3>
- <table class="summary"><thead><tr><th colspan="2">
- From <span class="classname"><a href="ezcCacheStorageMemory.html">ezcCacheStorageMemory</a></span>
+ </tr>
+</table>
+<h3>Inherited Methods</h3>
+ <table class="summary">
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Cache/ezcCacheStorageMemory.html">ezcCacheStorageMemory</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
<em>public</em> <em>ezcCacheStorageMemory</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#method__construct">ezcCacheStorageMemory::__construct()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#method__construct">ezcCacheStorageMemory::__construct()</a></b></code>
<br><div style="margin-left: 20px">Creates a new cache storage in the given location.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>int</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodcalcLifetime">ezcCacheStorageMemory::calcLifetime()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodcalcLifetime">ezcCacheStorageMemory::calcLifetime()</a></b></code>
<br><div style="margin-left: 20px">Calculates the lifetime remaining for a cache object.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>int</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodcountDataItems">ezcCacheStorageMemory::countDataItems()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodcountDataItems">ezcCacheStorageMemory::countDataItems()</a></b></code>
<br><div style="margin-left: 20px">Returns the number of items in the cache matching a certain criteria.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methoddelete">ezcCacheStorageMemory::delete()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methoddelete">ezcCacheStorageMemory::delete()</a></b></code>
<br><div style="margin-left: 20px">Deletes the data associated with $id or $attributes from the cache.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodfetchSearchRegistry">ezcCacheStorageMemory::fetchSearchRegistry()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodfetchSearchRegistry">ezcCacheStorageMemory::fetchSearchRegistry()</a></b></code>
<br><div style="margin-left: 20px">Fetches the search registry from the backend or creates it if empty.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>string</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodgenerateAttrStr">ezcCacheStorageMemory::generateAttrStr()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodgenerateAttrStr">ezcCacheStorageMemory::generateAttrStr()</a></b></code>
<br><div style="margin-left: 20px">Generates a string from the $attributes array.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>string</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodgenerateIdentifier">ezcCacheStorageMemory::generateIdentifier()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodgenerateIdentifier">ezcCacheStorageMemory::generateIdentifier()</a></b></code>
<br><div style="margin-left: 20px">Generates the storage internal identifier from ID and attributes.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>int</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodgetRemainingLifetime">ezcCacheStorageMemory::getRemainingLifetime()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodgetRemainingLifetime">ezcCacheStorageMemory::getRemainingLifetime()</a></b></code>
<br><div style="margin-left: 20px">Returns the time in seconds which remains for a cache object, before it gets outdated. In case the cache object is already outdated or does not exists, this method returns 0.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodlock">ezcCacheStorageMemory::lock()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodlock">ezcCacheStorageMemory::lock()</a></b></code>
<br><div style="margin-left: 20px">Acquire a lock on the storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>array(string)</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodpurge">ezcCacheStorageMemory::purge()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodpurge">ezcCacheStorageMemory::purge()</a></b></code>
<br><div style="margin-left: 20px">Purge outdated data from the storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodregisterIdentifier">ezcCacheStorageMemory::registerIdentifier()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodregisterIdentifier">ezcCacheStorageMemory::registerIdentifier()</a></b></code>
<br><div style="margin-left: 20px">Registers an identifier to facilitate searching.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodreset">ezcCacheStorageMemory::reset()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodreset">ezcCacheStorageMemory::reset()</a></b></code>
<br><div style="margin-left: 20px">Reset the complete storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>mixed</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodrestore">ezcCacheStorageMemory::restore()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodrestore">ezcCacheStorageMemory::restore()</a></b></code>
<br><div style="margin-left: 20px">Restores the data from the cache.</div> </td>
- </tr><tr><td class="right">
- <em>public</em> <em><a href="ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em> </td>
+ </tr>
+<tr>
+<td class="right">
+ <em>public</em> <em><a href="../Cache/ezcCacheStackMetaData.html">ezcCacheStackMetaData</a></em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodrestoreMetaData">ezcCacheStorageMemory::restoreMetaData()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodrestoreMetaData">ezcCacheStorageMemory::restoreMetaData()</a></b></code>
<br><div style="margin-left: 20px">Restores and returns the meta data struct.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>array(mixed)</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodsearch">ezcCacheStorageMemory::search()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodsearch">ezcCacheStorageMemory::search()</a></b></code>
<br><div style="margin-left: 20px">Searches the storage for data defined by ID and/or attributes.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>string</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodstore">ezcCacheStorageMemory::store()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodstore">ezcCacheStorageMemory::store()</a></b></code>
<br><div style="margin-left: 20px">Stores data to the cache storage under the key $id.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodstoreMetaData">ezcCacheStorageMemory::storeMetaData()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodstoreMetaData">ezcCacheStorageMemory::storeMetaData()</a></b></code>
<br><div style="margin-left: 20px">Stores the given meta data struct.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodstoreSearchRegistry">ezcCacheStorageMemory::storeSearchRegistry()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodstoreSearchRegistry">ezcCacheStorageMemory::storeSearchRegistry()</a></b></code>
<br><div style="margin-left: 20px">Stores the search registry in the backend.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodunlock">ezcCacheStorageMemory::unlock()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodunlock">ezcCacheStorageMemory::unlock()</a></b></code>
<br><div style="margin-left: 20px">Release a lock on the storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodunRegisterIdentifier">ezcCacheStorageMemory::unRegisterIdentifier()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodunRegisterIdentifier">ezcCacheStorageMemory::unRegisterIdentifier()</a></b></code>
<br><div style="margin-left: 20px">Un-registers a previously registered identifier.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorageMemory.html#methodvalidateLocation">ezcCacheStorageMemory::validateLocation()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorageMemory.html#methodvalidateLocation">ezcCacheStorageMemory::validateLocation()</a></b></code>
<br><div style="margin-left: 20px">Checks if the location property is valid.</div> </td>
- </tr></tbody><thead><tr><th colspan="2">
- From <span class="classname"><a href="ezcCacheStorage.html">ezcCacheStorage</a></span>
+ </tr>
+</tbody>
+<thead><tr>
+<th colspan="2">
+ From <span class="classname"><a href="../Cache/ezcCacheStorage.html">ezcCacheStorage</a></span>
</th>
- </tr></thead><tbody><tr><td class="right">
+ </tr></thead>
+<tbody>
+<tr>
+<td class="right">
<em>public</em> <em>ezcCacheStorage</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#method__construct">ezcCacheStorage::__construct()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#method__construct">ezcCacheStorage::__construct()</a></b></code>
<br><div style="margin-left: 20px">Creates a new cache storage in the given location.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> abstract <em>int</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodcountDataItems">ezcCacheStorage::countDataItems()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodcountDataItems">ezcCacheStorage::countDataItems()</a></b></code>
<br><div style="margin-left: 20px">Return the number of items in the cache matching a certain criteria.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> abstract <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methoddelete">ezcCacheStorage::delete()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methoddelete">ezcCacheStorage::delete()</a></b></code>
<br><div style="margin-left: 20px">Delete data from the cache.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>string</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodgetLocation">ezcCacheStorage::getLocation()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodgetLocation">ezcCacheStorage::getLocation()</a></b></code>
<br><div style="margin-left: 20px">Returns the location.</div> </td>
- </tr><tr><td class="right">
- <em>public</em> <em><a href="ezcCacheStorageOptions.html">ezcCacheStorageOptions</a></em> </td>
+ </tr>
+<tr>
+<td class="right">
+ <em>public</em> <em><a href="../Cache/ezcCacheStorageOptions.html">ezcCacheStorageOptions</a></em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodgetOptions">ezcCacheStorage::getOptions()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodgetOptions">ezcCacheStorage::getOptions()</a></b></code>
<br><div style="margin-left: 20px">Return the currently set options.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> abstract <em>int</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodgetRemainingLifetime">ezcCacheStorage::getRemainingLifetime()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodgetRemainingLifetime">ezcCacheStorage::getRemainingLifetime()</a></b></code>
<br><div style="margin-left: 20px">Returns the time ( in seconds ) that remains for a cache object, before it gets outdated. In case the cache object is already outdated or does not exist, this method returns 0.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> abstract <em>mixed</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodrestore">ezcCacheStorage::restore()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodrestore">ezcCacheStorage::restore()</a></b></code>
<br><div style="margin-left: 20px">Restore data from the cache.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodsetOptions">ezcCacheStorage::setOptions()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodsetOptions">ezcCacheStorage::setOptions()</a></b></code>
<br><div style="margin-left: 20px">Set new options.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>public</em> abstract <em>string</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodstore">ezcCacheStorage::store()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodstore">ezcCacheStorage::store()</a></b></code>
<br><div style="margin-left: 20px">Store data to the cache storage.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<em>protected</em> abstract <em>void</em> </td>
<td>
- <code><b><a href="ezcCacheStorage.html#methodvalidateLocation">ezcCacheStorage::validateLocation()</a></b></code>
+ <code><b><a href="../Cache/ezcCacheStorage.html#methodvalidateLocation">ezcCacheStorage::validateLocation()</a></b></code>
<br><div style="margin-left: 20px">Checks if the location property is valid.</div> </td>
- </tr></tbody></table><a name="sec-methods"></a>
+ </tr>
+</tbody>
+</table>
+<a name="sec-methods"></a>
<h3>Methods</h3>
<a name="method_detail"></a>
@@ -391,36 +509,62 @@
= array()] )
</div>
- <p>Creates a new cache storage in the given location.</p><div><p>Options can contain the 'ttl' ( Time-To-Life ). This is per default set to 1 day.</p><p>For details about the options see <a href="ezcCacheStorageMemcacheOptions.html">ezcCacheStorageMemcacheOptions</a>.</p></div>
+ <p>Creates a new cache storage in the given location.</p>
+<div>
+<p>Options can contain the 'ttl' ( Time-To-Life ). This is per default set to 1 day.</p>
+<p>For details about the options see <a href="../Cache/ezcCacheStorageMemcacheOptions.html">ezcCacheStorageMemcacheOptions</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>$location</code></td>
+ </tr></thead>
+<tbody>
+<tr>
+<td><code>$location</code></td>
<td><em>string</em></td>
<td>
Path to the cache location
</td>
- </tr><tr><td><code>$options</code></td>
+ </tr>
+<tr>
+<td><code>$options</code></td>
<td><em>array(string=>string)</em></td>
<td>
Options for the cache
</td>
- </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/ezcBasePropertyNotFoundException.html">ezcBasePropertyNotFoundException</a></code></td>
+ </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="../Base/ezcBasePropertyNotFoundException.html">ezcBasePropertyNotFoundException</a></code></td>
<td>
If you tried to set a non-existent option value.
</td>
- </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="ezcCacheStorageMemory.html#method__construct">ezcCacheStorageMemory::__construct()</a></code></td>
+ </tr></tbody>
+</table>
+<h5>Redefinition of:</h5>
+ <table class="detail">
+<thead><tr>
+<th>Method</th>
+ <th class="desc">Description</th>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheStorageMemory.html#method__construct">ezcCacheStorageMemory::__construct()</a></code></td>
<td>
Creates a new cache storage in the given location.
</td>
- </tr></tbody></table><a name="methodfetchData" id="fetchData"><!-- --></a>
+ </tr></tbody>
+</table>
+<a name="methodfetchData" id="fetchData"><!-- --></a>
<h4>fetchData</h4>
@@ -434,22 +578,34 @@
<p>Fetches the data from the cache.</p>
<h5>Parameters:</h5>
- <table class="detail"><thead><tr><th>Name</th>
+ <table class="detail">
+<thead><tr>
+<th>Name</th>
<th>Type</th>
<th class="desc">Description</th>
- </tr></thead><tbody><tr><td><code>$identifier</code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code>$identifier</code></td>
<td><em>string</em></td>
<td>
The memcache identifier to fetch data from
</td>
- </tr></tbody></table><h5>Redefined in descendants as:</h5>
- <table class="detail"><thead><tr><th>Method</th>
- <th class="desc">Description</th>
- </tr></thead><tbody><tr><td><code><a href="ezcCacheStorageMemcachePlain.html#methodfetchData">ezcCacheStorageMemcachePlain::fetchData()</a></code></td>
+ </tr></tbody>
+</table>
+<h5>Redefined in descendants as:</h5>
+ <table class="detail">
+<thead><tr>
+<th>Method</th>
+ <th class="desc">Description</th>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheStorageMemcachePlain.html#methodfetchData">ezcCacheStorageMemcachePlain::fetchData()</a></code></td>
<td>
Fetches 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>
@@ -463,73 +619,116 @@
<p>Prepare the data for storing.</p>
<h5>Parameters:</h5>
- <table class="detail"><thead><tr><th>Name</th>
+ <table class="detail">
+<thead><tr>
+<th>Name</th>
<th>Type</th>
<th class="desc">Description</th>
- </tr></thead><tbody><tr><td><code>$data</code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code>$data</code></td>
<td><em>mixed</em></td>
<td>
Simple type or array
</td>
- </tr></tbody></table><h5>Exceptions:</h5>
- <table class="detail"><thead><tr><th>Type</th>
- <th class="desc">Description</th>
- </tr></thead><tbody><tr><td><code><a href="ezcCacheInvalidDataException.html">ezcCacheInvalidDataException</a></code></td>
+ </tr></tbody>
+</table>
+<h5>Exceptions:</h5>
+ <table class="detail">
+<thead><tr>
+<th>Type</th>
+ <th class="desc">Description</th>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheInvalidDataException.html">ezcCacheInvalidDataException</a></code></td>
<td>
If the data submitted can not be handled by this storage (object, resource).
</td>
- </tr></tbody></table><h5>Redefined in descendants as:</h5>
- <table class="detail"><thead><tr><th>Method</th>
- <th class="desc">Description</th>
- </tr></thead><tbody><tr><td><code><a href="ezcCacheStorageMemcachePlain.html#methodprepareData">ezcCacheStorageMemcachePlain::prepareData()</a></code></td>
+ </tr></tbody>
+</table>
+<h5>Redefined in descendants as:</h5>
+ <table class="detail">
+<thead><tr>
+<th>Method</th>
+ <th class="desc">Description</th>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheStorageMemcachePlain.html#methodprepareData">ezcCacheStorageMemcachePlain::prepareData()</a></code></td>
<td>
Wraps the data in an ezcCacheStorageMemoryDataStruct structure in order to store it. 
</td>
- </tr></tbody></table><a name="methodsetOptions" id="setOptions"><!-- --></a>
+ </tr></tbody>
+</table>
+<a name="methodsetOptions" id="setOptions"><!-- --></a>
<h4>setOptions</h4>
<div class="method-signature">
void
setOptions(
- <a href="ezcCacheStorageMemcacheOptions.html">ezcCacheStorageMemcacheOptions</a>
+ <a href="../Cache/ezcCacheStorageMemcacheOptions.html">ezcCacheStorageMemcacheOptions</a>
$options
)
</div>
- <p>Set new options.</p><div><p>Overwrites the options with the given ones.</p></div>
+ <p>Set new options.</p>
+<div><p>Overwrites the options with the given ones.</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>
- <td><em><a href="ezcCacheStorageMemcacheOptions.html">ezcCacheStorageMemcacheOptions</a></em></td>
+ </tr></thead>
+<tbody><tr>
+<td><code>$options</code></td>
+ <td><em><a href="../Cache/ezcCacheStorageMemcacheOptions.html">ezcCacheStorageMemcacheOptions</a></em></td>
<td>
The options to set.
</td>
- </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/ezcBasePropertyNotFoundException.html">ezcBasePropertyNotFoundException</a></code></td>
+ </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="../Base/ezcBasePropertyNotFoundException.html">ezcBasePropertyNotFoundException</a></code></td>
<td>
If you tried to set a non-existent option value. The accepted options depend on the ezcCacheStorage implementation and may vary.
</td>
- </tr><tr><td><code><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseValueException.html">ezcBaseValueException</a></code></td>
+ </tr>
+<tr>
+<td><code><a href="../Base/ezcBaseValueException.html">ezcBaseValueException</a></code></td>
<td>
If the value is not valid for the desired option.
</td>
- </tr><tr><td><code><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseValueException.html">ezcBaseValueException</a></code></td>
+ </tr>
+<tr>
+<td><code><a href="../Base/ezcBaseValueException.html">ezcBaseValueException</a></code></td>
<td>
If you submit neither an array nor an instance of ezcCacheStorageOptions.
</td>
- </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="ezcCacheStorage.html#methodsetOptions">ezcCacheStorage::setOptions()</a></code></td>
+ </tr>
+</tbody>
+</table>
+<h5>Redefinition of:</h5>
+ <table class="detail">
+<thead><tr>
+<th>Method</th>
+ <th class="desc">Description</th>
+ </tr></thead>
+<tbody><tr>
+<td><code><a href="../Cache/ezcCacheStorage.html#methodsetOptions">ezcCacheStorage::setOptions()</a></code></td>
<td>
Set new options.
</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/ezcCacheStorageMemcacheOptions.html
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcacheOptions.html?rev=1089394&r1=1089393&r2=1089394&view=diff
==============================================================================
--- incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcacheOptions.html (original)
+++ incubator/zetacomponents/website/htdocs/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcacheOptions.html Wed Apr 6 10:44:44 2011
@@ -9,16 +9,16 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Apache Zeta Components - reusable set of high quality PHP components to fasten your development." />
- <meta name="keywords" content="PHP, apache, components, framework, quality" />
- <meta name="author" content="dotxp" />
+ <meta name="keywords" content="" />
+ <meta name="author" content="jerome" />
<meta name="language" content="en" />
- <meta name="date" content="Wed, 04 Aug 2010 13:07:18 +0200" />
+ <meta name="date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
<meta name="robots" content="all" />
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
<meta name="DC.title" content="ezcCacheStorageMemcacheOptions.html" />
- <meta name="DC.creator" content="dotxp" />
- <meta name="DC.date" content="Wed, 04 Aug 2010 13:07:18 +0200" />
+ <meta name="DC.creator" content="jerome" />
+ <meta name="DC.date" content="Wed, 06 Apr 2011 12:38:18 +0200" />
<meta name="DC.rights" content="Copyright" />
<link rel="meta" href="/zetacomponents/documentation/trunk/Cache/phpdoc/ezcCacheStorageMemcacheOptions.rdf" />
@@ -68,10 +68,7 @@
<div class="content">
<ul class="tabs">
- <li >
- <a href="/zetacomponents/documentation/trunk/Cache/tutorial.html" title="Tutorial">Tutorial</a>
- </li>
-<li class="requested">
+ <li class="requested">
<a href="/zetacomponents/documentation/trunk/Cache/phpdoc/classtrees.html" title="API">API</a>
</li>
@@ -91,18 +88,22 @@
-<pre><a href="/zetacomponents/documentation/trunk/Base/phpdoc/ezcBaseOptions.html">ezcBaseOptions</a>
+<pre><a href="../Base/ezcBaseOptions.html">ezcBaseOptions</a>
|
--ezcCacheStorageMemcacheOptions</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%24compressed" id="$compressed"></a>
<a name="prop-%24compressed" id="$compressed"></a>
<em>bool</em> </td>
@@ -114,7 +115,9 @@
<a href="#prop-%24compressed" title="details" class="var-name-summary">$compressed</a>
</code>
<br><div style="margin-left: 20px">If on-the-fly compression is needed. Default is false. Requires the zlib PHP extension.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24host" id="$host"></a>
<a name="prop-%24host" id="$host"></a>
<em>string</em> </td>
@@ -126,7 +129,9 @@
<a href="#prop-%24host" title="details" class="var-name-summary">$host</a>
</code>
<br><div style="margin-left: 20px">The name of the Memcache host to use, usually localhost.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24lockKey" id="$lockKey"></a>
<a name="prop-%24lockKey" id="$lockKey"></a>
<em>string</em> </td>
@@ -138,7 +143,9 @@
<a href="#prop-%24lockKey" title="details" class="var-name-summary">$lockKey</a>
</code>
<br><div style="margin-left: 20px">Cache key to use for locking. 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>
@@ -150,7 +157,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>
@@ -162,7 +171,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%24metaDataKey" id="$metaDataKey"></a>
<a name="prop-%24metaDataKey" id="$metaDataKey"></a>
<em>string</em> </td>
@@ -174,7 +185,9 @@
<a href="#prop-%24metaDataKey" title="details" class="var-name-summary">$metaDataKey</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%24persistent" id="$persistent"></a>
<a name="prop-%24persistent" id="$persistent"></a>
<em>bool</em> </td>
@@ -186,7 +199,9 @@
<a href="#prop-%24persistent" title="details" class="var-name-summary">$persistent</a>
</code>
<br><div style="margin-left: 20px">If a persistent connection to the Memcache host is needed. Default is false. A persistent connection stays open between requests.</div> </td>
- </tr><tr><td class="right">
+ </tr>
+<tr>
+<td class="right">
<a name="prop%24port" id="$port"></a>
<a name="prop-%24port" id="$port"></a>
<em>int</em> </td>
@@ -198,28 +213,39 @@
<a href="#prop-%24port" title="details" class="var-name-summary">$port</a>
</code>
<br><div style="margin-left: 20px">The port on which to connect to host, usually 11211.</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>ezcCacheStorageMemcacheOptions</em> </td>
<td>
<code>
@@ -228,41 +254,60 @@
= array()] )
</code>
<br><div style="margin-left: 20px">Constructs an object with the specified values.</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>
@@ -280,32 +325,54 @@
<p>Constructs an object with the specified values.</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>$options</code></td>
+ </tr></thead>
+<tbody><tr>
+<td><code>$options</code></td>
<td><em>array(string=>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="/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 $options contains a property with a value not allowed.
</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 $options contains a property not defined.
</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>