Xoad 0.5.0.0 - Docs / Source / XOAD / XOAD Cache / XOAD Cache.html

XOAD Cache.html:

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 
 <title>Docs For Class XOAD_Cache</title>
 <link rel="stylesheet" href="../../media/stylesheet.css" />
 <script src="../../media/lib/classTree.js"></script>
 <script language="javascript" type="text/javascript">
 var imgPlus = new Image();
 var imgMinus = new Image();
 imgPlus.src = "../../media/images/plus.png";
 imgMinus.src = "../../media/images/minus.png";

 function showNode(Node){
 switch(navigator.family){
 case 'nn4':
 // Nav 4.x code fork...
 var oTable = document.layers["span" + Node];
 var oImg = document.layers["img" + Node];
 break;
 case 'ie4':
 // IE 4/5 code fork...
 var oTable = document.all["span" + Node];
 var oImg = document.all["img" + Node];
 break;
 case 'gecko':
 // Standards Compliant code fork...
 var oTable = document.getElementById("span" + Node);
 var oImg = document.getElementById("img" + Node);
 break;
 }
 oImg.src = imgMinus.src;
 oTable.style.display = "block";
 }

 function hideNode(Node){
 switch(navigator.family){
 case 'nn4':
 // Nav 4.x code fork...
 var oTable = document.layers["span" + Node];
 var oImg = document.layers["img" + Node];
 break;
 case 'ie4':
 // IE 4/5 code fork...
 var oTable = document.all["span" + Node];
 var oImg = document.all["img" + Node];
 break;
 case 'gecko':
 // Standards Compliant code fork...
 var oTable = document.getElementById("span" + Node);
 var oImg = document.getElementById("img" + Node);
 break;
 }
 oImg.src = imgPlus.src;
 oTable.style.display = "none";
 }

 function nodeIsVisible(Node){
 switch(navigator.family){
 case 'nn4':
 // Nav 4.x code fork...
 var oTable = document.layers["span" + Node];
 break;
 case 'ie4':
 // IE 4/5 code fork...
 var oTable = document.all["span" + Node];
 break;
 case 'gecko':
 // Standards Compliant code fork...
 var oTable = document.getElementById("span" + Node);
 break;
 }
 return (oTable && oTable.style.display == "block");
 }

 function toggleNodeVisibility(Node){
 if (nodeIsVisible(Node)){
 hideNode(Node);
 }else{
 showNode(Node);
 }
 }
 </script>
 </head>
 <body>
 <div class="page-body">
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
 alt=" Class"
 title=" Class"
 style="vertical-align: middle"> XOAD_Cache</h2>

<a name="sec-description"></a>
<div class="info-box">
 <div class="info-box-title">Description</div>
 <div class="nav-bar">
 Description |
 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

 </div>
 <div class="info-box-body">
 
XOAD_Cache Class.
This class allows you to cache the callbacks to the server. By default the caching is disabled and you must call XOAD_Cache::allowCaching to configure which classes and methods will be cached.Example:<pre><ol><code><pre><li> <?php</li>
<li> </li>
<li> <a href="../../XOAD/XOAD_Cache/XOAD_Cache.html">XOAD_Cache</a>::<a href="../../XOAD/XOAD_Cache/XOAD_Cache.html#methodallowCaching">allowCaching</a>('ExampleClass', 'invokeMethod', 30);</li>
<li> </li>
<li> ?></li>
</pre></code></ol></pre>
 <ul class="tags">
 <li>version: 0.5.0.0</li>
 <li>author: Stanimir Angeloff</li>
 </ul>
 
 Located in <a class="field" href="_extensions_Cache_classes_Cache_class_php.html">/extensions/Cache/classes/Cache.class.php</a> (line <a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesCache.class.php.html#a56">56</a>)
 


 <pre></pre>

 </div>
</div>

 <a name="sec-method-summary"></a>
 <div class="info-box">
 <div class="info-box-title">Method Summary</div>
 <div class="nav-bar">
 <a href="#sec-description">Description</a> |
 Methods (<a href="#sec-methods">details</a>)
 </div>
 <div class="info-box-body">
 <div class="method-summary">

 <div class="method-definition">
 <img src="../../media/images/Method.png" alt=" "/>
 void
 <a href="#allowCaching" title="details" class="method-name">allowCaching</a>
 ([array $className = null], [array $method = null], [array $expire = null], [array $arguments = null], [array $members = null])
 </div>

 <div class="method-definition">
 <img src="../../media/images/Method.png" alt=" "/>
 bool
 <a href="#cacheRequest" title="details" class="method-name">cacheRequest</a>
 (array &$request, array &$response)
 </div>

 <div class="method-definition">
 <img src="../../media/images/Method.png" alt=" "/>
 bool
 <a href="#dispatch" title="details" class="method-name">dispatch</a>
 (array &$request, array &$cacheData)
 </div>

 <div class="method-definition">
 <img src="../../media/images/PrivateMethod.png" alt=" "/>
 object Singleton
 <a href="#getStorage" title="details" class="method-name">&getStorage</a>
 ()
 </div>

 <div class="method-definition">
 <img src="../../media/images/Method.png" alt=" "/>
 bool
 <a href="#initialize" title="details" class="method-name">initialize</a>
 (array &$request)
 </div>
 </div>
 </div>
 </div>


 <a name="sec-methods"></a>
 <div class="info-box">
 <div class="info-box-title">Methods</div>
 <div class="nav-bar">
 <a href="#sec-description">Description</a> |
 <a href="#sec-method-summary">Methods</a> (details)

 </div>
 <div class="info-box-body">
 <A NAME='method_detail'></A>
<a name="methodallowCaching" id="allowCaching"></a>
<div class="evenrow">

 <div class="method-header">
 <img src="../../media/images/Method.png" />
 allowCaching (line <a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesCache.class.php.html#a348">348</a>)
 </div>

 
Installs a new caching criteria.
By default the caching is disabled and you must call this method to configure which classes and methods will be cached.If you call this method with no arguments, caching will be enabled for all classes and methods.When generating the ID for each request the class name, method name and arguments list is used to build a long string which is later used for the ID. You can configure <a href="../../XOAD/XOAD_Cache/XOAD_Cache.html">XOAD_Cache</a> to include some of the class variables too.Example:<pre><ol><code><pre><li> <?php</li>
<li> </li>
<li> // Allow caching for all classes.</li>
<li> <a href="../../XOAD/XOAD_Cache/XOAD_Cache.html">XOAD_Cache</a>::<a href="../../XOAD/XOAD_Cache/XOAD_Cache.html#methodallowCaching">allowCaching</a>();</li>
<li> </li>
<li> // Allow caching only for the 'Example' class.</li>
<li> <a href="../../XOAD/XOAD_Cache/XOAD_Cache.html">XOAD_Cache</a>::<a href="../../XOAD/XOAD_Cache/XOAD_Cache.html#methodallowCaching">allowCaching</a>('Example');</li>
<li> </li>
<li> // Allow caching only for the 'Example->invoke' method.</li>
<li> <a href="../../XOAD/XOAD_Cache/XOAD_Cache.html">XOAD_Cache</a>::<a href="../../XOAD/XOAD_Cache/XOAD_Cache.html#methodallowCaching">allowCaching</a>('Example', 'invoke');</li>
<li> </li>
<li> // Allow caching for the 'invoke' method in every class.</li>
<li> <a href="../../XOAD/XOAD_Cache/XOAD_Cache.html">XOAD_Cache</a>::<a href="../../XOAD/XOAD_Cache/XOAD_Cache.html#methodallowCaching">allowCaching</a>(null, 'invoke');</li>
<li> </li>
<li> ?></li>
</pre></code></ol></pre>
 <ul class="tags">
 <li>static: </li>
 <li>access: public</li>
 </ul>

 <div class="method-signature">
 void
 
 allowCaching
 
 ([array $className = null], [array $method = null], [array $expire = null], [array $arguments = null], [array $members = null])
 </div>

 <ul class="parameters">
 <li>
 array
 $className: The class name filter. This value can be null. </li>
 <li>
 array
 $method: The method name filter. This value can be null. </li>
 <li>
 array
 $expire: The lifetime time in seconds for the cached data. This value can be null. </li>
 <li>
 array
 $arguments: Array that contains the list of arguments to use when generating the request ID. By default each argument is used. This value can be null. </li>
 <li>
 array
 $members: Array that contains the list of class variables to use when generating the request ID. By default no class variables are used. This value can be null. </li>
 </ul>


 </div>
<a name="methodcacheRequest" id="cacheRequest"></a>
<div class="oddrow">

 <div class="method-header">
 <img src="../../media/images/Method.png" />
 cacheRequest (line <a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesCache.class.php.html#a278">278</a>)
 </div>

 
This method is called when the request matches the configurated criterias for caching, but there is no data in the cache.
 <ul class="tags">
 <li>return: True if the request is cached, false otherwise.</li>
 <li>static: </li>
 <li>access: public</li>
 </ul>

 <div class="method-signature">
 bool
 
 cacheRequest
 
 (array &$request, array &$response)
 </div>

 <ul class="parameters">
 <li>
 array
 $request: The data that is associated with the callback. </li>
 <li>
 array
 $response: The data that is associated with the response. </li>
 </ul>


 </div>
<a name="methoddispatch" id="dispatch"></a>
<div class="evenrow">

 <div class="method-header">
 <img src="../../media/images/Method.png" />
 dispatch (line <a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesCache.class.php.html#a185">185</a>)
 </div>

 
This method is called when the request matches the configurated criterias for caching.
If the request is cached and it's not expired then the cached response is used, otherwise the server dispatches the call and the response is cached.
 <ul class="tags">
 <li>return: True if the request is cached, false otherwise.</li>
 <li>static: </li>
 <li>access: public</li>
 </ul>

 <div class="method-signature">
 bool
 
 dispatch
 
 (array &$request, array &$cacheData)
 </div>

 <ul class="parameters">
 <li>
 array
 $request: The data that is associated with the callback. </li>
 <li>
 array
 $cacheData: The data that is associated with the caching criteria. </li>
 </ul>


 </div>
<a name="methodgetStorage" id="getStorage"></a>
<div class="oddrow">

 <div class="method-header">
 <img src="../../media/images/PrivateMethod.png" />
 getStorage (line <a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesCache.class.php.html#a69">69</a>)
 </div>

 
Retrieves an instanse to the configurated XOAD_Cache storage provider.
 <ul class="tags">
 <li>return: <a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage.html">XOAD_Cache_Storage</a> inherited class based on the configuration (see <a href="../../XOAD/_config_extensions_config_php.html#defineXOAD_CACHE_STORAGE_DSN">XOAD_CACHE_STORAGE_DSN</a>).</li>
 <li>static: </li>
 <li>access: private</li>
 </ul>

 <div class="method-signature">
 object Singleton
 
 &getStorage
 
 ()
 </div>



 </div>
<a name="methodinitialize" id="initialize"></a>
<div class="evenrow">

 <div class="method-header">
 <img src="../../media/images/Method.png" />
 initialize (line <a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesCache.class.php.html#a140">140</a>)
 </div>

 
This method is called on every request to the server.
If the request matches the configurated criterias for caching this method will call XOAD_Cache::dispatch.
 <ul class="tags">
 <li>return: True if the request is cached, false otherwise.</li>
 <li>static: </li>
 <li>access: public</li>
 </ul>

 <div class="method-signature">
 bool
 
 initialize
 
 (array &$request)
 </div>

 <ul class="parameters">
 <li>
 array
 $request: The data that is associated with the callback. </li>
 </ul>


 </div>

 </div>
 </div>


 
 Documentation generated on Thu, 13 Oct 2005 09:55:42 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
 
 </div></body>
</html>

Xoad 0.5.0.0 > Docs / Source / XOAD / XOAD Cache / XOAD Cache.html

Archive Content:

XOAD Cache.html:

Other Development Tools Scripts: