238 lines
12 KiB
HTML
238 lines
12 KiB
HTML
<!-- HTML header for doxygen 1.8.5-->
|
|
<!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>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.9"/>
|
|
<title>Fat-Free Framework: DB\Mongo Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Fat-Free Framework
|
|
 <span id="projectnumber">3.4.0</span>
|
|
 <span class="menu"><a href="index.html">Overview</a> <a href="annotated.html">Class List</a> <a href="hierarchy.html">Hierarchy</a></span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.9 -->
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>DB</b></li><li class="navelem"><a class="el" href="classDB_1_1Mongo.html">Mongo</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classDB_1_1Mongo-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">DB\Mongo Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>MongoDB wrapper.
|
|
<a href="classDB_1_1Mongo.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a6d02e7af24acfa0e0dcd49e5781b8c35"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#a6d02e7af24acfa0e0dcd49e5781b8c35">dsn</a> ()</td></tr>
|
|
<tr class="separator:a6d02e7af24acfa0e0dcd49e5781b8c35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a706b45e6c16e85da11cbd65c2e87a06e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#a706b45e6c16e85da11cbd65c2e87a06e">uuid</a> ()</td></tr>
|
|
<tr class="separator:a706b45e6c16e85da11cbd65c2e87a06e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a732714277e3cb18f360b070aa7708091"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#a732714277e3cb18f360b070aa7708091">log</a> ()</td></tr>
|
|
<tr class="separator:a732714277e3cb18f360b070aa7708091"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acca9b2ed14c8c80438b0ffafe5de8a7a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#acca9b2ed14c8c80438b0ffafe5de8a7a">drop</a> ()</td></tr>
|
|
<tr class="separator:acca9b2ed14c8c80438b0ffafe5de8a7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3c9b718c839d1862a6ba5e8ba2085bc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#ad3c9b718c839d1862a6ba5e8ba2085bc">__call</a> ($func, array $args)</td></tr>
|
|
<tr class="separator:ad3c9b718c839d1862a6ba5e8ba2085bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14496dc525b00aaab5c7a42caef17ac7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#a14496dc525b00aaab5c7a42caef17ac7">__construct</a> ($<a class="el" href="classDB_1_1Mongo.html#a6d02e7af24acfa0e0dcd49e5781b8c35">dsn</a>, $dbname, array $options=NULL)</td></tr>
|
|
<tr class="separator:a14496dc525b00aaab5c7a42caef17ac7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a4466e742d29cc989b7c63f1feb43d069"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4466e742d29cc989b7c63f1feb43d069"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#a4466e742d29cc989b7c63f1feb43d069">$dsn</a></td></tr>
|
|
<tr class="memdesc:a4466e742d29cc989b7c63f1feb43d069"><td class="mdescLeft"> </td><td class="mdescRight">Data source name. <br /></td></tr>
|
|
<tr class="separator:a4466e742d29cc989b7c63f1feb43d069"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8361d9a2324ce56f63754b223f462fe7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8361d9a2324ce56f63754b223f462fe7"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#a8361d9a2324ce56f63754b223f462fe7">$db</a></td></tr>
|
|
<tr class="memdesc:a8361d9a2324ce56f63754b223f462fe7"><td class="mdescLeft"> </td><td class="mdescRight">MongoDB object. <br /></td></tr>
|
|
<tr class="separator:a8361d9a2324ce56f63754b223f462fe7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad723539ac2b35bc601a73f31ddf72545"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad723539ac2b35bc601a73f31ddf72545"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#ad723539ac2b35bc601a73f31ddf72545">$log</a></td></tr>
|
|
<tr class="memdesc:ad723539ac2b35bc601a73f31ddf72545"><td class="mdescLeft"> </td><td class="mdescRight">MongoDB log. <br /></td></tr>
|
|
<tr class="separator:ad723539ac2b35bc601a73f31ddf72545"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
|
|
<tr class="memitem:a1a1ec45a79fdee34fd31548070368d5e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a1ec45a79fdee34fd31548070368d5e"></a>
|
|
const </td><td class="memItemRight" valign="bottom"><b>E_Profiler</b> ='MongoDB profiler is disabled'</td></tr>
|
|
<tr class="separator:a1a1ec45a79fdee34fd31548070368d5e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:aa597b3135cae90926f91701f377093f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa597b3135cae90926f91701f377093f8"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#aa597b3135cae90926f91701f377093f8">$uuid</a></td></tr>
|
|
<tr class="memdesc:aa597b3135cae90926f91701f377093f8"><td class="mdescLeft"> </td><td class="mdescRight">UUID. <br /></td></tr>
|
|
<tr class="separator:aa597b3135cae90926f91701f377093f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>MongoDB wrapper. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a14496dc525b00aaab5c7a42caef17ac7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DB\Mongo::__construct </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$dsn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$dbname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">array </td>
|
|
<td class="paramname"><em>$options</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Instantiate class </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$dsn</td><td>string </td></tr>
|
|
<tr><td class="paramname">$dbname</td><td>string </td></tr>
|
|
<tr><td class="paramname">$options</td><td>array </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ad3c9b718c839d1862a6ba5e8ba2085bc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DB\Mongo::__call </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$func</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">array </td>
|
|
<td class="paramname"><em>$args</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Redirect call to MongoDB object </p><dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">$func</td><td>string </td></tr>
|
|
<tr><td class="paramname">$args</td><td>array </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acca9b2ed14c8c80438b0ffafe5de8a7a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DB\Mongo::drop </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Intercept native call to re-enable profiler </p><dl class="section return"><dt>Returns</dt><dd>int </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6d02e7af24acfa0e0dcd49e5781b8c35"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DB\Mongo::dsn </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return data source name </p><dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a732714277e3cb18f360b070aa7708091"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DB\Mongo::log </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return MongoDB profiler results </p><dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a706b45e6c16e85da11cbd65c2e87a06e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DB\Mongo::uuid </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return UUID </p><dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>db/mongo.php</li>
|
|
</ul>
|
|
</div><!-- contents -->
|