File size: 32.96Kb
<?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 AlberTcache</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<script src="../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
<script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
var imgPlus = new Image();
var imgMinus = new Image();
imgPlus.src = "../media/images/plus.gif";
imgMinus.src = "../media/images/minus.gif";
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>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><!-- Start of Class Data -->
<h2>
Class AlberTcache
</h2> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a27">27</a></span>)
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
</script>
<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<pre>
</pre>
<p>
<b><i>Located in File: <a href="_AlberT-cache_inc_php.html">/AlberT-cache.inc.php</a></i></b><br>
</p>
<!-- ========== Info from phpDoc block ========= -->
<h5>Automatically handles the entire caching stuffs</h5>
<div class="desc"><p>It automagically handles everything concerning the caching mechanism: gzipping of the contents when the browser supports it, the browser cache validation, etc..</p></div>
<ul>
</ul>
<br /><hr />
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">
<h2 class="tab">Class Variables</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$absfile" title="details" class="property"><strong>$absfile</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$also" title="details" class="property"><strong>$also</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$crc32" title="details" class="property"><strong>$crc32</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$data" title="details" class="property"><strong>$data</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$dbg" title="details" class="property"><strong>$dbg</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$expire" title="details" class="property"><strong>$expire</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$file" title="details" class="property"><strong>$file</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$gcProb" title="details" class="property"><strong>$gcProb</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$gzcont" title="details" class="property"><strong>$gzcont</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$gzip" title="details" class="property"><strong>$gzip</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$isOn" title="details" class="property"><strong>$isOn</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$mask" title="details" class="property"><strong>$mask</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$oneSite" title="details" class="property"><strong>$oneSite</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$post" title="details" class="property"><strong>$post</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$size" title="details" class="property"><strong>$size</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$storDir" title="details" class="property"><strong>$storDir</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$timeout" title="details" class="property"><strong>$timeout</strong></a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#var$variables" title="details" class="property"><strong>$variables</strong></a>
</div>
<hr />
<a name="var$absfile" id="var$absfile"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$absfile</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a41">41</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$also" id="var$also"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$also</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a34">34</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$crc32" id="var$crc32"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$crc32</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a47">47</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$data" id="var$data"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$data</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a42">42</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$dbg" id="var$dbg"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$dbg</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a29">29</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$expire" id="var$expire"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$expire</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a33">33</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$file" id="var$file"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$file</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a44">44</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$gcProb" id="var$gcProb"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$gcProb</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a37">37</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$gzcont" id="var$gzcont"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$gzcont</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a45">45</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$gzip" id="var$gzip"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$gzip</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a30">30</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$isOn" id="var$isOn"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$isOn</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a38">38</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$mask" id="var$mask"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$mask</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a39">39</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$oneSite" id="var$oneSite"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$oneSite</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a35">35</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$post" id="var$post"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$post</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a31">31</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$size" id="var$size"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$size</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a46">46</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$storDir" id="var$storDir"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$storDir</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a36">36</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$timeout" id="var$timeout"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$timeout</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a32">32</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<a name="var$variables" id="var$variables"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$variables</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a43">43</a></span>)
</h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
</div>
<div class="tab-page" id="tabPage2">
<h2 class="tab">Method Detail</h2>
<!-- ============ METHOD DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="method-summary">
<div class="method-definition">
<span class="method-result">AlberTcache</span>
<a href="#methodAlberTcache" title="details" class="method-name">AlberTcache</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodadd_fs" title="details" class="method-name">add_fs</a>
(<span class="var-type">mixed</span> <span class="var-name">$file</span>, <span class="var-type">mixed</span> <span class="var-name">$data</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodcacheAll" title="details" class="method-name">cacheAll</a>
([<span class="var-type">mixed</span> <span class="var-name">$cachetime</span> = <span class="var-default">60</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methoddoFlush" title="details" class="method-name">doFlush</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methoddoGC" title="details" class="method-name">doGC</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methoddoReset" title="details" class="method-name">doReset</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methoddoWrite" title="details" class="method-name">doWrite</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodfinalize" title="details" class="method-name">finalize</a>
(<span class="var-type">string</span> <span class="var-name">$contents</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodgetDefaultKey" title="details" class="method-name">getDefaultKey</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodgetDefaultObj" title="details" class="method-name">getDefaultObj</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodgetEncoding" title="details" class="method-name">getEncoding</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodgetStorage" title="details" class="method-name">getStorage</a>
(<span class="var-type">mixed</span> <span class="var-name">$cacheobject</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodget_fs" title="details" class="method-name">get_fs</a>
(<span class="var-type">mixed</span> <span class="var-name">$file</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodinit" title="details" class="method-name">init</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodlock_fs" title="details" class="method-name">lock_fs</a>
(<span class="var-type">mixed</span> <span class="var-name">$fp</span>, [<span class="var-type">mixed</span> <span class="var-name">$mode</span> = <span class="var-default">'w'</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodpdebug" title="details" class="method-name">pdebug</a>
(<span class="var-type">string</span> <span class="var-name">$s</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodstart" title="details" class="method-name">start</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodstoreVar" title="details" class="method-name">storeVar</a>
(<span class="var-type">mixed</span> <span class="var-name">$vn</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodtheCache" title="details" class="method-name">theCache</a>
(<span class="var-type">mixed</span> <span class="var-name">$cachetime</span>, [<span class="var-type">mixed</span> <span class="var-name">$key</span> = <span class="var-default">NULL</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodunlock_fs" title="details" class="method-name">unlock_fs</a>
(<span class="var-type">mixed</span> <span class="var-name">$fp</span>)
</div>
</div>
<hr />
<A NAME='method_detail'></A>
<a name="methodAlberTcache" id="methodAlberTcache"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/Constructor.gif" border="0" /> <strong class="method">Constructor AlberTcache</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a52">52</a></span>)
</h4>
<h4><i>AlberTcache</i> <strong>AlberTcache(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Class constructor</h5>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodadd_fs" id="methodadd_fs"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method add_fs</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a190">190</a></span>)
</h4>
<h4><i>void</i> <strong>add_fs(
mixed
$file, mixed
$data)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Writes out the cache</h5>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodcacheAll" id="methodcacheAll"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method cacheAll</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a153">153</a></span>)
</h4>
<h4><i>void</i> <strong>cacheAll(
[mixed
$cachetime = 60])</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Caches the current page based on the page name and the GET/POST</h5>
<div class="desc"><p>variables. All must match or else it will not be fetched from the cache!</p></div>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methoddoFlush" id="methoddoFlush"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method doFlush</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a507">507</a></span>)
</h4>
<h4><i>void</i> <strong>doFlush(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>doFlush()</h5>
<div class="desc"><p>Responsible for final flushing everything. Sets ETag-headers and returns "Not modified" when possible</p><p>When ETag doesn't match (or is invalid), it is tried to send the gzipped data. If that is also not possible, we sadly have to uncompress (assuming $CACHE_GZIP is on)</p></div>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methoddoGC" id="methoddoGC"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method doGC</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a231">231</a></span>)
</h4>
<h4><i>void</i> <strong>doGC(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Cache garbage collector</h5>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methoddoReset" id="methoddoReset"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method doReset</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a81">81</a></span>)
</h4>
<h4><i>void</i> <strong>doReset(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Resets the cache state</h5>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methoddoWrite" id="methoddoWrite"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method doWrite</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a369">369</a></span>)
</h4>
<h4><i>void</i> <strong>doWrite(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>doWrite()</h5>
<div class="desc"><p>Does the actual caching</p></div>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodfinalize" id="methodfinalize"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method finalize</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a474">474</a></span>)
</h4>
<h4><i>void</i> <strong>finalize(
string
$contents)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>finalize()</h5>
<div class="desc"><p>This function is called by the callback-funtion of the ob_start</p></div>
<h4>Parameters</h4>
<ul>
<li><strong>string $contents</strong>: the string representing the page to be flushed out to the client</li>
</ul>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodgetDefaultKey" id="methodgetDefaultKey"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getDefaultKey</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a125">125</a></span>)
</h4>
<h4><i>void</i> <strong>getDefaultKey(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Generates the key for the request</h5>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodgetDefaultObj" id="methodgetDefaultObj"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getDefaultObj</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a135">135</a></span>)
</h4>
<h4><i>void</i> <strong>getDefaultObj(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Returns the default object used by the helper functions</h5>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodgetEncoding" id="methodgetEncoding"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getEncoding</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a398">398</a></span>)
</h4>
<h4><i>void</i> <strong>getEncoding(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>getEncoding()</h5>
<div class="desc"><p>Are we capable of receiving gzipped data ? Returns the encoding that is accepted. Maybe additional check for Mac ?</p></div>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodgetStorage" id="methodgetStorage"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getStorage</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a223">223</a></span>)
</h4>
<h4><i>void</i> <strong>getStorage(
mixed
$cacheobject)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Returns the storage for cache</h5>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodget_fs" id="methodget_fs"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method get_fs</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a207">207</a></span>)
</h4>
<h4><i>void</i> <strong>get_fs(
mixed
$file)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Reads in the cache</h5>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodinit" id="methodinit"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method init</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a416">416</a></span>)
</h4>
<h4><i>void</i> <strong>init(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>init()</h5>
<div class="desc"><p>Checks some global variables and might decide to disable caching and calls appropriate initialization-methods</p></div>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodlock_fs" id="methodlock_fs"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method lock_fs</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a162">162</a></span>)
</h4>
<h4><i>void</i> <strong>lock_fs(
mixed
$fp, [mixed
$mode = 'w'])</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Obtains a lock on the cache storage</h5>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodpdebug" id="methodpdebug"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method pdebug</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a108">108</a></span>)
</h4>
<h4><i>void</i> <strong>pdebug(
string
$s)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>A simple deguggig handler function</h5>
<h4>Parameters</h4>
<ul>
<li><strong>string $s</strong>: The debugging message</li>
</ul>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodstart" id="methodstart"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method start</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a441">441</a></span>)
</h4>
<h4><i>void</i> <strong>start(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>start()</h5>
<div class="desc"><p>Sets the handler for callback</p></div>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodstoreVar" id="methodstoreVar"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method storeVar</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a95">95</a></span>)
</h4>
<h4><i>void</i> <strong>storeVar(
mixed
$vn)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Saves a variable state between caching</h5>
<h4>Parameters</h4>
<ul>
<li><strong>mixed $vn</strong>: the name of the variable to save</li>
</ul>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodtheCache" id="methodtheCache"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method theCache</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a281">281</a></span>)
</h4>
<h4><i>void</i> <strong>theCache(
mixed
$cachetime, [mixed
$key = NULL])</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>theCache()</h5>
<div class="desc"><p>Caches $object based on $key for $cachetime, will return 0 if the object has expired or does not exist.</p></div>
<h4>Info</h4>
<ul>
</ul>
</div>
<a name="methodunlock_fs" id="methodunlock_fs"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method unlock_fs</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__AlberT-cache.inc.php.html#a182">182</a></span>)
</h4>
<h4><i>void</i> <strong>unlock_fs(
mixed
$fp)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Performs the unlock</h5>
<h4>Info</h4>
<ul>
</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script></div>
<div class="tab-page" id="iVars">
<h2 class="tab">Inherited Variables</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
<!-- =========== VAR INHERITED SUMMARY =========== -->
<A NAME='var_inherited_summary'><!-- --></A>
<h3>Inherited Class Variable Summary</h3>
</div>
<div class="tab-page" id="iMethods">
<h2 class="tab">Inherited Methods</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h3>Inherited Method Summary</h3>
</div>
</div>
<script type="text/javascript">
//<![CDATA[
setupAllTabs();
//]]>
</script>
<div id="credit">
<hr />
Documentation generated on Wed, 15 Dec 2004 15:11:09 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
</div>
</body>
</html>