Просмотр файла AlberT-cache/Documentation/AlberT-cache/_config_inc_php.html

Размер файла: 12.75Kb
<?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 page config.inc.php</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" ><h2>File: /config.inc.php</h2>
<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>
<!-- ========== Info from phpDoc block ========= -->
<h5>AlberT-cache   fast and portable full-page caching system</h5>
<div class="desc"><p>You have simply to include the main cache filename  <a href="../AlberT-cache/_AlberT-cache_inc_php.html">AlberT-cache.inc.php</a>, eventually overwriting some  configuration variables just <strong>before</strong> inclusion</p></div>
<ul>
		<li><strong>filesource:</strong> - <a href="..//__filesource/fsource_AlberT-cache__config.inc.php.html">Source Code for this file</a></li>
		<li><strong>version:</strong> - $Id: config.inc.php,v 1.6 2004/12/14 17:38:07 albert Exp $</li>
		<li><strong>author:</strong> - Emiliano Gabrielli &lt;<a href="mailto:[email protected]">mailto:[email protected]</a>&gt;</li>
		<li><strong>license:</strong> - <a href="http://opensource.org/licenses/gpl-license.php">GNU Public License</a></li>
		<li><strong>copyright:</strong> - Copyleft &amp;copy; Emiliano Gabrielli</li>
	</ul>
<!-- =========== Used Classes =========== -->
<A NAME='classes_summary'><!-- --></A>
<h3>Classes defined in this file</h3>

<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
	<THEAD>
		<TR><TD STYLE="width:20%"><h4>CLASS NAME</h4></TD><TD STYLE="width: 80%"><h4>DESCRIPTION</h4></TD></TR>
	</THEAD>
	<TBODY>
			</TBODY>
</TABLE>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">
<!-- ============ Includes DETAIL =========== -->

<h2 class="tab">Include/Require Statements</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>


</div>
<div class="tab-page" id="tabPage2">
<!-- ============ GLOBAL DETAIL =========== -->

<h2 class="tab">Global Variables</h2>

<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script>

<a name="global$CACHE_1SITE" id="global$CACHE_1SITE"><!-- --></a>
<div style="background='#eeeeee'">
<h4>
  <img src="../media/images/Constants.gif" border="0" /> <strong class="Property">$CACHE_1SITE</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__config.inc.php.html#a89">89</a></span>)
 </h4> 
<h4><i>bool</i> $CACHE_1SITE : 1</h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Set if the hostname has to be appended to the cache filename,  turn it to 0 in a multi site environment; defaults to 1.</h5>
<div class="desc"><p>The value of this variable affects the entire site.</p></div>
<ul>
	</ul>
</div>
<a name="global$CACHE_ALSO" id="global$CACHE_ALSO"><!-- --></a>
<div style="background='#ffffff'">
<h4>
  <img src="../media/images/Constants.gif" border="0" /> <strong class="Property">$CACHE_ALSO</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__config.inc.php.html#a57">57</a></span>)
 </h4> 
<h4><i>mixed</i> $CACHE_ALSO : NULL</h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Put here additional variables you want the cache to be based on.</h5>
<div class="desc"><p>This configuration variable may be overwritten in every page.   This is usefull if you want a different page based on the  value of a particular variable not yet in POST or GET.  i.e.: your pages are different based on the value of  $_SESSION['username'].</p></div>
<ul>
	</ul>
</div>
<a name="global$CACHE_DEBUG" id="global$CACHE_DEBUG"><!-- --></a>
<div style="background='#eeeeee'">
<h4>
  <img src="../media/images/Constants.gif" border="0" /> <strong class="Property">$CACHE_DEBUG</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__config.inc.php.html#a69">69</a></span>)
 </h4> 
<h4><i>bool</i> $CACHE_DEBUG : 0</h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Turn debugging on/off, defaults to 0.</h5>
<div class="desc"><p>The value of this variable affects the entire site.</p></div>
<ul>
	</ul>
</div>
<a name="global$CACHE_DIR" id="global$CACHE_DIR"><!-- --></a>
<div style="background='#ffffff'">
<h4>
  <img src="../media/images/Constants.gif" border="0" /> <strong class="Property">$CACHE_DIR</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__config.inc.php.html#a95">95</a></span>)
 </h4> 
<h4><i>string</i> $CACHE_DIR : dirname(__FILE__).'/cache'</h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Set the directory name in which to store cache files.</h5>
<div class="desc"><p>The value of this variable affects the entire site.</p></div>
<ul>
	</ul>
</div>
<a name="global$CACHE_EXP" id="global$CACHE_EXP"><!-- --></a>
<div style="background='#eeeeee'">
<h4>
  <img src="../media/images/Constants.gif" border="0" /> <strong class="Property">$CACHE_EXP</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__config.inc.php.html#a82">82</a></span>)
 </h4> 
<h4><i>int</i> $CACHE_EXP : 900</h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Set the number of seconds the cache will be valid,  defaults to 900 (15 minutes).</h5>
<div class="desc"><p>The value of this variable affects the entire site.</p></div>
<ul>
	</ul>
</div>
<a name="global$CACHE_GC" id="global$CACHE_GC"><!-- --></a>
<div style="background='#ffffff'">
<h4>
  <img src="../media/images/Constants.gif" border="0" /> <strong class="Property">$CACHE_GC</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__config.inc.php.html#a101">101</a></span>)
 </h4> 
<h4><i>bool</i> $CACHE_GC : 1</h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Set the probability the Garbage Collector will be run, defaults to 1 (1%)</h5>
<div class="desc"><p>The value of this variable affects the entire site.</p></div>
<ul>
	</ul>
</div>
<a name="global$CACHE_GZIP" id="global$CACHE_GZIP"><!-- --></a>
<div style="background='#eeeeee'">
<h4>
  <img src="../media/images/Constants.gif" border="0" /> <strong class="Property">$CACHE_GZIP</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__config.inc.php.html#a27">27</a></span>)
 </h4> 
<h4><i>bool</i> $CACHE_GZIP : 1</h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Whether or not to use GZIP, defaults to 1.</h5>
<div class="desc"><p>This configuration variable may be overwritten in every page.</p></div>
<ul>
	</ul>
</div>
<a name="global$CACHE_ON" id="global$CACHE_ON"><!-- --></a>
<div style="background='#ffffff'">
<h4>
  <img src="../media/images/Constants.gif" border="0" /> <strong class="Property">$CACHE_ON</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__config.inc.php.html#a75">75</a></span>)
 </h4> 
<h4><i>bool</i> $CACHE_ON : 1</h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Turn caching on/off, defaults to 1.</h5>
<div class="desc"><p>The value of this variable affects the entire site.</p></div>
<ul>
	</ul>
</div>
<a name="global$CACHE_POST" id="global$CACHE_POST"><!-- --></a>
<div style="background='#eeeeee'">
<h4>
  <img src="../media/images/Constants.gif" border="0" /> <strong class="Property">$CACHE_POST</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__config.inc.php.html#a34">34</a></span>)
 </h4> 
<h4><i>bool</i> $CACHE_POST : 1</h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Whether or not to cache POST, defaults to 1.</h5>
<div class="desc"><p>This configuration variable may be overwritten in every page.</p></div>
<ul>
	</ul>
</div>
<a name="global$CACHE_TIMEOUT" id="global$CACHE_TIMEOUT"><!-- --></a>
<div style="background='#ffffff'">
<h4>
  <img src="../media/images/Constants.gif" border="0" /> <strong class="Property">$CACHE_TIMEOUT</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__config.inc.php.html#a43">43</a></span>)
 </h4> 
<h4><i>int</i> $CACHE_TIMEOUT : NULL</h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Sets the cache timeout, a value of -1 will disable caching, but still allows gzipping.</h5>
<div class="desc"><p>This configuration variable may be overwritten in every page.</p></div>
<ul>
	</ul>
</div>
<a name="global$CACHE_UMASK" id="global$CACHE_UMASK"><!-- --></a>
<div style="background='#eeeeee'">
<h4>
  <img src="../media/images/Constants.gif" border="0" /> <strong class="Property">$CACHE_UMASK</strong> (line <span class="linenumber"><a href="..//__filesource/fsource_AlberT-cache__config.inc.php.html#a108">108</a></span>)
 </h4> 
<h4><i>int</i> $CACHE_UMASK : 0022</h4>

<!-- ========== Info from phpDoc block ========= -->
<h5>Set the 'umask' for the cache files.</h5>
<div class="desc"><p>The value of this variable affects the entire site.  You don't need to change if you don't know what it is :-P</p></div>
<ul>
	</ul>
</div>
</div>
<div class="tab-page" id="tabPage3">
<!-- ============ CONSTANT DETAIL =========== -->

<A NAME='constant_detail'></A>
<h2 class="tab">Constants</h2>

<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage3" ) );</script>

</div>
<div class="tab-page" id="tabPage4">
<!-- ============ FUNCTION DETAIL =========== -->

<h2 class="tab">Functions</h2>

<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage4" ) );</script>

</div>
</div>
<script type="text/javascript">
//<![CDATA[

setupAllTabs();

//]]>
</script>
	<div id="credit">
		<hr />
		Documentation generated on Wed, 15 Dec 2004 15:11:10 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
	</div>
</body>
</html>