321 lines
No EOL
13 KiB
HTML
321 lines
No EOL
13 KiB
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 Database_Mongo</title>
|
|
<link rel="stylesheet" href="../media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
<div class="page-body">
|
|
<h2 class="class-name">Class Database_Mongo</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">Mongo Database Abstraction Layer</p>
|
|
<p class="description"><p>This database class is still considered incomplete and very experimental.</p></p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_classes---Database---Mongo.php.html">/classes/Database/Mongo.php</a> (line <span class="field">23</span>)
|
|
</p>
|
|
|
|
|
|
<pre><a href="../PICKLES/Object.html">Object</a>
|
|
|
|
|
--<a href="../PICKLES/Database_Common.html">Database_Common</a>
|
|
|
|
|
--Database_Mongo</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">
|
|
<span class="var-type">string</span>
|
|
<a href="#$driver" title="details" class="var-name">$driver</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">
|
|
<span class="method-result">boolean</span>
|
|
<a href="#close" title="details" class="method-name">close</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#fetch" title="details" class="method-name">fetch</a>
|
|
(<span class="var-type"></span> <span class="var-name">$collection</span>, [<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">array()</span>], [<span class="var-type"></span> <span class="var-name">$fields</span> = <span class="var-default">array()</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">boolean</span>
|
|
<a href="#open" title="details" class="method-name">open</a>
|
|
()
|
|
</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$driver" id="$driver"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$driver</span>
|
|
= <span class="var-default"> 'mongo'</span> (line <span class="line-number">31</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Driver</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
<hr class="separator" />
|
|
<div class="notes">Redefinition of:</div>
|
|
<dl>
|
|
<dt><a href="../PICKLES/Database_Common.html#var$driver">Database_Common::$driver</a></dt>
|
|
<dd>Driver</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
</div>
|
|
<h4>Inherited Variables</h4>
|
|
<A NAME='inherited_vars'><!-- --></A>
|
|
<p>Inherited from <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
|
|
<blockquote>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$connection">Database_Common::$connection</a></span><br>
|
|
</span>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$database">Database_Common::$database</a></span><br>
|
|
</span>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$hostname">Database_Common::$hostname</a></span><br>
|
|
</span>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$password">Database_Common::$password</a></span><br>
|
|
</span>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$port">Database_Common::$port</a></span><br>
|
|
</span>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$results">Database_Common::$results</a></span><br>
|
|
</span>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$socket">Database_Common::$socket</a></span><br>
|
|
</span>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Database_Common.html#var$username">Database_Common::$username</a></span><br>
|
|
</span>
|
|
</blockquote>
|
|
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
|
<blockquote>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
|
|
</span>
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../PICKLES/Object.html#var$instances">Object::$instances</a></span><br>
|
|
</span>
|
|
</blockquote>
|
|
|
|
</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="methodclose" id="close"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">close</span> (line <span class="line-number">89</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Closes database connection</p>
|
|
<p class="description"><p>Sets the connection to null regardless of state.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> always true</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
close
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
<hr class="separator" />
|
|
<div class="notes">Redefinition of:</div>
|
|
<dl>
|
|
<dt><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></dt>
|
|
<dd>Closes database connection</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
<a name="methodfetch" id="fetch"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">fetch</span> (line <span class="line-number">108</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Fetch records from the database</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
fetch
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">$collection</span>, [<span class="var-type"></span> <span class="var-name">$query</span> = <span class="var-default">array()</span>], [<span class="var-type"></span> <span class="var-name">$fields</span> = <span class="var-default">array()</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$collection</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$query</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$fields</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodopen" id="open"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">open</span> (line <span class="line-number">41</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Opens database connection</p>
|
|
<p class="description"><p>Establishes a connection to the database based on the set configuration options.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> true on success, throws an exception overwise</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
open
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
<hr class="separator" />
|
|
<div class="notes">Redefinition of:</div>
|
|
<dl>
|
|
<dt><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></dt>
|
|
<dd>Opens database connection</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
<h4>Inherited Methods</h4>
|
|
<a name='inherited_methods'><!-- --></a>
|
|
<!-- =========== Summary =========== -->
|
|
<p>Inherited From <span class="classname"><a href="../PICKLES/Database_Common.html">Database_Common</a></span></p>
|
|
<blockquote>
|
|
<span class="method-name"><a href="../PICKLES/Database_Common.html#method__construct">Database_Common::__construct()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodclose">Database_Common::close()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodgetDriver">Database_Common::getDriver()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodopen">Database_Common::open()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetDatabase">Database_Common::setDatabase()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetHostname">Database_Common::setHostname()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPassword">Database_Common::setPassword()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetPort">Database_Common::setPort()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetSocket">Database_Common::setSocket()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Database_Common.html#methodsetUsername">Database_Common::setUsername()</a></span><br>
|
|
</blockquote>
|
|
<!-- =========== Summary =========== -->
|
|
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
|
|
<blockquote>
|
|
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></span><br>
|
|
<span class="method-name"><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></span><br>
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Sat, 27 Nov 2010 21:43:42 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |