Просмотр файла news/libraries/api/classDB_1_1Mongo.html

Размер файла: 10.23Kb
  1. <!-- HTML header for doxygen 1.8.5-->
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  6. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  7. <meta name="generator" content="Doxygen 1.8.6"/>
  8. <title>Fat-Free Framework: DB\Mongo Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">Fat-Free Framework
  22. &#160;<span id="projectnumber">3.2.2</span>
  23. &#160;<span class="menu"><a href="index.html">Overview</a> <a href="annotated.html">Class List</a> <a href="hierarchy.html">Hierarchy</a></span>
  24. </div>
  25. </td>
  26. </tr>
  27. </tbody>
  28. </table>
  29. </div>
  30. <!-- end header part -->
  31. <!-- Generated by Doxygen 1.8.6 -->
  32. <div id="nav-path" class="navpath">
  33. <ul>
  34. <li class="navelem"><b>DB</b></li><li class="navelem"><a class="el" href="classDB_1_1Mongo.html">Mongo</a></li> </ul>
  35. </div>
  36. </div><!-- top -->
  37. <div class="header">
  38. <div class="summary">
  39. <a href="#pub-methods">Public Member Functions</a> &#124;
  40. <a href="#pub-attribs">Public Attributes</a> &#124;
  41. <a href="#pro-attribs">Protected Attributes</a> &#124;
  42. <a href="classDB_1_1Mongo-members.html">List of all members</a> </div>
  43. <div class="headertitle">
  44. <div class="title">DB\Mongo Class Reference</div> </div>
  45. </div><!--header-->
  46. <div class="contents">
  47.  
  48. <p>MongoDB wrapper.
  49. <a href="classDB_1_1Mongo.html#details">More...</a></p>
  50. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  51. <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for DB\Mongo:</div>
  52. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  53. </div>
  54. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  55. <div class="center">
  56. <img src="classDB_1_1Mongo.png" usemap="#DB\Mongo_map" alt=""/>
  57. <map id="DB\Mongo_map" name="DB\Mongo_map">
  58. </map>
  59. </div></div>
  60. <table class="memberdecls">
  61. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  62. Public Member Functions</h2></td></tr>
  63. <tr class="memitem:a6d02e7af24acfa0e0dcd49e5781b8c35"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#a6d02e7af24acfa0e0dcd49e5781b8c35">dsn</a> ()</td></tr>
  64. <tr class="separator:a6d02e7af24acfa0e0dcd49e5781b8c35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a706b45e6c16e85da11cbd65c2e87a06e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#a706b45e6c16e85da11cbd65c2e87a06e">uuid</a> ()</td></tr>
  66. <tr class="separator:a706b45e6c16e85da11cbd65c2e87a06e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a732714277e3cb18f360b070aa7708091"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#a732714277e3cb18f360b070aa7708091">log</a> ()</td></tr>
  68. <tr class="separator:a732714277e3cb18f360b070aa7708091"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:acca9b2ed14c8c80438b0ffafe5de8a7a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#acca9b2ed14c8c80438b0ffafe5de8a7a">drop</a> ()</td></tr>
  70. <tr class="separator:acca9b2ed14c8c80438b0ffafe5de8a7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a14496dc525b00aaab5c7a42caef17ac7"><td class="memItemLeft" align="right" valign="top">&#160;</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>
  72. <tr class="separator:a14496dc525b00aaab5c7a42caef17ac7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. </table><table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  75. Public Attributes</h2></td></tr>
  76. <tr class="memitem:a4466e742d29cc989b7c63f1feb43d069"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4466e742d29cc989b7c63f1feb43d069"></a>
  77. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#a4466e742d29cc989b7c63f1feb43d069">$dsn</a></td></tr>
  78. <tr class="memdesc:a4466e742d29cc989b7c63f1feb43d069"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data source name. <br/></td></tr>
  79. <tr class="separator:a4466e742d29cc989b7c63f1feb43d069"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ad723539ac2b35bc601a73f31ddf72545"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad723539ac2b35bc601a73f31ddf72545"></a>
  81. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#ad723539ac2b35bc601a73f31ddf72545">$log</a></td></tr>
  82. <tr class="memdesc:ad723539ac2b35bc601a73f31ddf72545"><td class="mdescLeft">&#160;</td><td class="mdescRight">MongoDB log. <br/></td></tr>
  83. <tr class="separator:ad723539ac2b35bc601a73f31ddf72545"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr><td colspan="2"><div class="groupHeader"></div></td></tr>
  85. <tr class="memitem:a1a1ec45a79fdee34fd31548070368d5e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a1ec45a79fdee34fd31548070368d5e"></a>
  86. const&#160;</td><td class="memItemRight" valign="bottom"><b>E_Profiler</b> ='MongoDB profiler is disabled'</td></tr>
  87. <tr class="separator:a1a1ec45a79fdee34fd31548070368d5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. </table><table class="memberdecls">
  89. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  90. Protected Attributes</h2></td></tr>
  91. <tr class="memitem:aa597b3135cae90926f91701f377093f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa597b3135cae90926f91701f377093f8"></a>
  92. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Mongo.html#aa597b3135cae90926f91701f377093f8">$uuid</a></td></tr>
  93. <tr class="memdesc:aa597b3135cae90926f91701f377093f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">UUID. <br/></td></tr>
  94. <tr class="separator:aa597b3135cae90926f91701f377093f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table>
  96. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  97. <div class="textblock"><p>MongoDB wrapper. </p>
  98. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  99. <a class="anchor" id="a14496dc525b00aaab5c7a42caef17ac7"></a>
  100. <div class="memitem">
  101. <div class="memproto">
  102. <table class="memname">
  103. <tr>
  104. <td class="memname">DB\Mongo::__construct </td>
  105. <td>(</td>
  106. <td class="paramtype">&#160;</td>
  107. <td class="paramname"><em>$dsn</em>, </td>
  108. </tr>
  109. <tr>
  110. <td class="paramkey"></td>
  111. <td></td>
  112. <td class="paramtype">&#160;</td>
  113. <td class="paramname"><em>$dbname</em>, </td>
  114. </tr>
  115. <tr>
  116. <td class="paramkey"></td>
  117. <td></td>
  118. <td class="paramtype">array&#160;</td>
  119. <td class="paramname"><em>$options</em> = <code>NULL</code>&#160;</td>
  120. </tr>
  121. <tr>
  122. <td></td>
  123. <td>)</td>
  124. <td></td><td></td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <p>Instantiate class </p>
  129. <dl class="params"><dt>Parameters</dt><dd>
  130. <table class="params">
  131. <tr><td class="paramname">$dsn</td><td>string </td></tr>
  132. <tr><td class="paramname">$dbname</td><td>string </td></tr>
  133. <tr><td class="paramname">$options</td><td>array </td></tr>
  134. </table>
  135. </dd>
  136. </dl>
  137.  
  138. </div>
  139. </div>
  140. <h2 class="groupheader">Member Function Documentation</h2>
  141. <a class="anchor" id="acca9b2ed14c8c80438b0ffafe5de8a7a"></a>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">DB\Mongo::drop </td>
  147. <td>(</td>
  148. <td class="paramname"></td><td>)</td>
  149. <td></td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. <p>Intercept native call to re-enable profiler </p>
  154. <dl class="section return"><dt>Returns</dt><dd>int </dd></dl>
  155.  
  156. </div>
  157. </div>
  158. <a class="anchor" id="a6d02e7af24acfa0e0dcd49e5781b8c35"></a>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">DB\Mongo::dsn </td>
  164. <td>(</td>
  165. <td class="paramname"></td><td>)</td>
  166. <td></td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. <p>Return data source name </p>
  171. <dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
  172.  
  173. </div>
  174. </div>
  175. <a class="anchor" id="a732714277e3cb18f360b070aa7708091"></a>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">DB\Mongo::log </td>
  181. <td>(</td>
  182. <td class="paramname"></td><td>)</td>
  183. <td></td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>Return MongoDB profiler results </p>
  188. <dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
  189.  
  190. </div>
  191. </div>
  192. <a class="anchor" id="a706b45e6c16e85da11cbd65c2e87a06e"></a>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">DB\Mongo::uuid </td>
  198. <td>(</td>
  199. <td class="paramname"></td><td>)</td>
  200. <td></td>
  201. </tr>
  202. </table>
  203. </div><div class="memdoc">
  204. <p>Return UUID </p>
  205. <dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
  206.  
  207. </div>
  208. </div>
  209. <hr/>The documentation for this class was generated from the following file:<ul>
  210. <li>db/mongo.php</li>
  211. </ul>
  212. </div><!-- contents -->