XOAD Cache Storage MySQL.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>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class XOAD_Cache_Storage_MySQL</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_Storage_MySQL</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">XOAD_Cache Storage MySQL Class.</p>
<p class="description"><p>This class is a <a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage.html#methodXOAD_Cache_Storage">XOAD_Cache_Storage</a> successor.</p><p></p></p>
<ul class="tags">
<li><span class="field">version:</span> 0.5.0.0</li>
<li><span class="field">author:</span> Stanimir Angeloff</li>
</ul>
<p class="notes">
Located in <a class="field" href="_extensions_Cache_classes_storage_MySQL_class_php.html">/extensions/Cache/classes/storage/MySQL.class.php</a> (line <span class="field"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a42">42</a></span>)
</p>
<pre><a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage.html">XOAD_Cache_Storage</a>
|
--XOAD_Cache_Storage_MySQL</pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">string</span>
<a href="#$database" title="details" class="var-name">$database</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">bool</span>
<a href="#$openNew" title="details" class="var-name">$openNew</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">string</span>
<a href="#$password" title="details" class="var-name">$password</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">string</span>
<a href="#$port" title="details" class="var-name">$port</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">string</span>
<a href="#$server" title="details" class="var-name">$server</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">string</span>
<a href="#$user" title="details" class="var-name">$user</a>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<img src="../../media/images/Constructor.png" alt=" "/>
<span class="method-result">XOAD_Cache_Storage_MySQL</span>
<a href="#XOAD_Cache_Storage_MySQL" title="details" class="method-name">XOAD_Cache_Storage_MySQL</a>
(<span class="var-type">string</span> <span class="var-name">$dsn</span>)
</div>
<div class="method-definition">
<img src="../../media/images/PrivateMethod.png" alt=" "/>
<span class="method-result">void</span>
<a href="#closeConnection" title="details" class="method-name">closeConnection</a>
(<span class="var-type">mixed</span> <span class="var-name">&$connection</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">bool</span>
<a href="#collectGarbage" title="details" class="method-name">collectGarbage</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/PrivateMethod.png" alt=" "/>
<span class="method-result">string</span>
<a href="#escapeString" title="details" class="method-name">escapeString</a>
(<span class="var-type">mixed</span> <span class="var-name">$unescapedString</span>, <span class="var-type">mixed</span> <span class="var-name">$connection</span>)
</div>
<div class="method-definition">
<img src="../../media/images/PrivateMethod.png" alt=" "/>
<span class="method-result">resource</span>
<a href="#getConnection" title="details" class="method-name">&getConnection</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">mixed</span>
<a href="#load" title="details" class="method-name">load</a>
(<span class="var-type">string</span> <span class="var-name">$id</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">bool</span>
<a href="#save" title="details" class="method-name">save</a>
(<span class="var-type">mixed</span> <span class="var-name">$id</span>, <span class="var-type">int</span> <span class="var-name">$expires</span>, <span class="var-type">mixed</span> <span class="var-name">$data</span>)
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$database" id="$database"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$database</span>
(line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a82">82</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Holds the MySQL database used in the connection string.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$openNew" id="$openNew"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">bool</span>
<span class="var-name">$openNew</span>
(line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a103">103</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Indicates whether to open a new connection to the MySQL server if an old one already exists.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$password" id="$password"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$password</span>
(line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a72">72</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Holds the MySQL password used in the connection string.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$port" id="$port"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$port</span>
= <span class="var-default"> 3306</span> (line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a92">92</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Holds the MySQL port used in the connection string.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$server" id="$server"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$server</span>
(line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a52">52</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Holds the MySQL server used in the connection string.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$user" id="$user"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$user</span>
(line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a62">62</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Holds the MySQL user used in the connection string.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodXOAD_Cache_Storage_MySQL" id="XOAD_Cache_Storage_MySQL"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Constructor.png" />
<span class="method-title">Constructor XOAD_Cache_Storage_MySQL</span> (line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a114">114</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates a new instance of the <a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage_MySQL.html">XOAD_Cache_Storage_MySQL</a> class.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">XOAD_Cache_Storage_MySQL</span>
<span class="method-name">
XOAD_Cache_Storage_MySQL
</span>
(<span class="var-type">string</span> <span class="var-name">$dsn</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$dsn</span><span class="var-description">: The data source name and parameters to use when creating the instance.</span> </li>
</ul>
</div>
<a name="methodcloseConnection" id="closeConnection"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/PrivateMethod.png" />
<span class="method-title">closeConnection</span> (line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a151">151</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Closes a MySQL connection link.</p>
<ul class="tags">
<li><span class="field">access:</span> private</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
closeConnection
</span>
(<span class="var-type">mixed</span> <span class="var-name">&$connection</span>)
</div>
</div>
<a name="methodcollectGarbage" id="collectGarbage"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">collectGarbage</span> (line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a188">188</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deletes old data from the cache.</p>
<p class="description"><p>This method is called before calling <a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage_MySQL.html#methodload">load</a> to delete all expired data from the cache.</p><p></p></p>
<ul class="tags">
<li><span class="field">return:</span> true on success, false otherwise.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
collectGarbage
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage.html#methodcollectGarbage">XOAD_Cache_Storage::collectGarbage()</a></dt>
<dd>Abstract base class method.</dd>
</dl>
</div>
<a name="methodescapeString" id="escapeString"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/PrivateMethod.png" />
<span class="method-title">escapeString</span> (line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a167">167</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Escapes special characters in the $unescapedString, taking into account the current charset of the connection.</p>
<ul class="tags">
<li><span class="field">access:</span> private</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
escapeString
</span>
(<span class="var-type">mixed</span> <span class="var-name">$unescapedString</span>, <span class="var-type">mixed</span> <span class="var-name">$connection</span>)
</div>
</div>
<a name="methodgetConnection" id="getConnection"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/PrivateMethod.png" />
<span class="method-title">getConnection</span> (line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a127">127</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates a MySQL connection link.</p>
<ul class="tags">
<li><span class="field">access:</span> private</li>
</ul>
<div class="method-signature">
<span class="method-result">resource</span>
<span class="method-name">
&getConnection
</span>
()
</div>
</div>
<a name="methodload" id="load"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">load</span> (line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a211">211</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads data from the cache with a given ID.</p>
<ul class="tags">
<li><span class="field">return:</span> The data in the cache with the given ID or null.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
load
</span>
(<span class="var-type">string</span> <span class="var-name">$id</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$id</span><span class="var-description">: The ID of the cached data.</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage.html#methodload">XOAD_Cache_Storage::load()</a></dt>
<dd>Abstract base class method.</dd>
</dl>
</div>
<a name="methodsave" id="save"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">save</span> (line <span class="line-number"><a href="../..//__filesource/fsource_XOAD_XOAD_Cache_extensionsCacheclassesstorageMySQL.class.php.html#a248">248</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Saves data in the cache with a given ID and lifetime.</p>
<ul class="tags">
<li><span class="field">return:</span> True on success, false otherwise.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
save
</span>
(<span class="var-type">mixed</span> <span class="var-name">$id</span>, <span class="var-type">int</span> <span class="var-name">$expires</span>, <span class="var-type">mixed</span> <span class="var-name">$data</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$id</span><span class="var-description">: The ID to use when saving the data.</span> </li>
<li>
<span class="var-type">int</span>
<span class="var-name">$expires</span><span class="var-description">: The lifetime time in seconds for the cached data.</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$data</span><span class="var-description">: The data to cache.</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage.html#methodsave">XOAD_Cache_Storage::save()</a></dt>
<dd>Abstract base class method.</dd>
</dl>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage.html">XOAD_Cache_Storage</a></span></p>
<blockquote>
<img src="../../media/images/Constructor.png" alt=" "/>
<span class="method-name"><a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage.html#methodXOAD_Cache_Storage">XOAD_Cache_Storage::XOAD_Cache_Storage()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage.html#methodcollectGarbage">XOAD_Cache_Storage::collectGarbage()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage.html#methodgenerateID">XOAD_Cache_Storage::generateID()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage.html#methodload">XOAD_Cache_Storage::load()</a></span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../../XOAD/XOAD_Cache/XOAD_Cache_Storage.html#methodsave">XOAD_Cache_Storage::save()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 13 Oct 2005 09:56:07 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
</p>
</div></body>
</html>
Other Development Tools Scripts:
