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

Размер файла: 18.59Kb
<?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></title>
  <link rel="stylesheet" href="media/stylesheet.css" />
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><a name="top"></a>
<h1>Index of All Elements</h1>
<a name="top">&nbsp; </a>
<strong>Indexes by package:</strong><br />
<ul>
<li><a href="elementindex_AlberT-cache.html">AlberT-cache</a></li>
</ul>
<br />
	<a href="elementindex.html#a">a</a>
	<a href="elementindex.html#c">c</a>
	<a href="elementindex.html#d">d</a>
	<a href="elementindex.html#e">e</a>
	<a href="elementindex.html#f">f</a>
	<a href="elementindex.html#g">g</a>
	<a href="elementindex.html#i">i</a>
	<a href="elementindex.html#l">l</a>
	<a href="elementindex.html#m">m</a>
	<a href="elementindex.html#o">o</a>
	<a href="elementindex.html#"></a>
	<a href="elementindex.html#s">s</a>
	<a href="elementindex.html#t">t</a>
	<a href="elementindex.html#u">u</a>

<br /><br />
<table border="0" width="100%">
<thead>
  <tr>
    <td><strong>a</strong></td>
    <td align='right'><a name="a">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$absfile</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$absfile">AlberTcache::$absfile</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$also</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$also">AlberTcache::$also</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>add_fs</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodadd_fs">AlberTcache::add_fs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Writes out the cache</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>AlberT-cache.inc.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="AlberT-cache/_AlberT-cache_inc_php.html">AlberT-cache.inc.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>AlberTcache</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, class <a href="AlberT-cache/AlberTcache.html">AlberTcache</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Automatically handles the entire caching stuffs</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>AlberTcache</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodAlberTcache">AlberTcache::AlberTcache()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Class constructor</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>c</strong></td>
    <td align='right'><a name="c">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$CACHE_1SITE</strong></td>
    <td width="100%" align="left" valign="top">in file config.inc.php, global variable <a href="AlberT-cache/_config_inc_php.html#global$CACHE_1SITE">$CACHE_1SITE</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Set if the hostname has to be appended to the cache filename,  turn it to 0 in a multi site environment; defaults to 1.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$CACHE_ALSO</strong></td>
    <td width="100%" align="left" valign="top">in file config.inc.php, global variable <a href="AlberT-cache/_config_inc_php.html#global$CACHE_ALSO">$CACHE_ALSO</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Put here additional variables you want the cache to be based on.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$CACHE_DEBUG</strong></td>
    <td width="100%" align="left" valign="top">in file config.inc.php, global variable <a href="AlberT-cache/_config_inc_php.html#global$CACHE_DEBUG">$CACHE_DEBUG</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Turn debugging on/off, defaults to 0.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$CACHE_DIR</strong></td>
    <td width="100%" align="left" valign="top">in file config.inc.php, global variable <a href="AlberT-cache/_config_inc_php.html#global$CACHE_DIR">$CACHE_DIR</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Set the directory name in which to store cache files.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$CACHE_EXP</strong></td>
    <td width="100%" align="left" valign="top">in file config.inc.php, global variable <a href="AlberT-cache/_config_inc_php.html#global$CACHE_EXP">$CACHE_EXP</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Set the number of seconds the cache will be valid,  defaults to 900 (15 minutes).</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$CACHE_GC</strong></td>
    <td width="100%" align="left" valign="top">in file config.inc.php, global variable <a href="AlberT-cache/_config_inc_php.html#global$CACHE_GC">$CACHE_GC</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Set the probability the Garbage Collector will be run, defaults to 1 (1%)</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$CACHE_GZIP</strong></td>
    <td width="100%" align="left" valign="top">in file config.inc.php, global variable <a href="AlberT-cache/_config_inc_php.html#global$CACHE_GZIP">$CACHE_GZIP</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Whether or not to use GZIP, defaults to 1.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$CACHE_ON</strong></td>
    <td width="100%" align="left" valign="top">in file config.inc.php, global variable <a href="AlberT-cache/_config_inc_php.html#global$CACHE_ON">$CACHE_ON</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Turn caching on/off, defaults to 1.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$CACHE_POST</strong></td>
    <td width="100%" align="left" valign="top">in file config.inc.php, global variable <a href="AlberT-cache/_config_inc_php.html#global$CACHE_POST">$CACHE_POST</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Whether or not to cache POST, defaults to 1.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$CACHE_TIMEOUT</strong></td>
    <td width="100%" align="left" valign="top">in file config.inc.php, global variable <a href="AlberT-cache/_config_inc_php.html#global$CACHE_TIMEOUT">$CACHE_TIMEOUT</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the cache timeout, a value of -1 will disable caching, but still allows gzipping.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$CACHE_UMASK</strong></td>
    <td width="100%" align="left" valign="top">in file config.inc.php, global variable <a href="AlberT-cache/_config_inc_php.html#global$CACHE_UMASK">$CACHE_UMASK</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Set the 'umask' for the cache files.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$crc32</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$crc32">AlberTcache::$crc32</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>cacheAll</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodcacheAll">AlberTcache::cacheAll()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Caches the current page based on the page name and the GET/POST</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>config.inc.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="AlberT-cache/_config_inc_php.html">config.inc.php</a></td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>d</strong></td>
    <td align='right'><a name="d">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$data</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$data">AlberTcache::$data</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$dbg</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$dbg">AlberTcache::$dbg</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>doFlush</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methoddoFlush">AlberTcache::doFlush()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;doFlush()</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>doGC</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methoddoGC">AlberTcache::doGC()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Cache garbage collector</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>doReset</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methoddoReset">AlberTcache::doReset()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Resets the cache state</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>doWrite</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methoddoWrite">AlberTcache::doWrite()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;doWrite()</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>e</strong></td>
    <td align='right'><a name="e">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$expire</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$expire">AlberTcache::$expire</a></td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>f</strong></td>
    <td align='right'><a name="f">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$file</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$file">AlberTcache::$file</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>finalize</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodfinalize">AlberTcache::finalize()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;finalize()</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>g</strong></td>
    <td align='right'><a name="g">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$gcProb</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$gcProb">AlberTcache::$gcProb</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$gzcont</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$gzcont">AlberTcache::$gzcont</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$gzip</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$gzip">AlberTcache::$gzip</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getDefaultKey</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodgetDefaultKey">AlberTcache::getDefaultKey()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Generates the key for the request</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getDefaultObj</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodgetDefaultObj">AlberTcache::getDefaultObj()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the default object used by the helper functions</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getEncoding</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodgetEncoding">AlberTcache::getEncoding()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;getEncoding()</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getStorage</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodgetStorage">AlberTcache::getStorage()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the storage for cache</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>get_fs</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodget_fs">AlberTcache::get_fs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Reads in the cache</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>i</strong></td>
    <td align='right'><a name="i">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$isOn</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$isOn">AlberTcache::$isOn</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>init</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodinit">AlberTcache::init()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;init()</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>l</strong></td>
    <td align='right'><a name="l">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>lock_fs</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodlock_fs">AlberTcache::lock_fs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Obtains a lock on the cache storage</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>m</strong></td>
    <td align='right'><a name="m">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$mask</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$mask">AlberTcache::$mask</a></td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>o</strong></td>
    <td align='right'><a name="o">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$oneSite</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$oneSite">AlberTcache::$oneSite</a></td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>p</strong></td>
    <td align='right'><a name="p">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$post</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$post">AlberTcache::$post</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>pdebug</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodpdebug">AlberTcache::pdebug()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;A simple deguggig handler function</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>s</strong></td>
    <td align='right'><a name="s">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$size</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$size">AlberTcache::$size</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$storDir</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$storDir">AlberTcache::$storDir</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>start</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodstart">AlberTcache::start()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;start()</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>storeVar</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodstoreVar">AlberTcache::storeVar()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Saves a variable state between caching</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>t</strong></td>
    <td align='right'><a name="t">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$timeout</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$timeout">AlberTcache::$timeout</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>theCache</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodtheCache">AlberTcache::theCache()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;theCache()</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>u</strong></td>
    <td align='right'><a name="u">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>unlock_fs</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, method <a href="AlberT-cache/AlberTcache.html#methodunlock_fs">AlberTcache::unlock_fs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Performs the unlock</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>v</strong></td>
    <td align='right'><a name="v">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$variables</strong></td>
    <td width="100%" align="left" valign="top">in file AlberT-cache.inc.php, variable <a href="AlberT-cache/AlberTcache.html#var$variables">AlberTcache::$variables</a></td>
  </tr>
  </tbody>
</table></body>
</html>