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

Размер файла: 45.67Kb
  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\Cursor 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_1Cursor.html">Cursor</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_1Cursor-members.html">List of all members</a> </div>
  43. <div class="headertitle">
  44. <div class="title">DB\Cursor Class Reference</div> </div>
  45. </div><!--header-->
  46. <div class="contents">
  47.  
  48. <p>Simple cursor implementation.
  49. <a href="classDB_1_1Cursor.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\Cursor:</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_1Cursor.png" usemap="#DB\Cursor_map" alt=""/>
  57. <map id="DB\Cursor_map" name="DB\Cursor_map">
  58. <area href="classMagic.html" title="PHP magic wrapper. " alt="Magic" shape="rect" coords="130,56,250,80"/>
  59. <area href="classDB_1_1Jig_1_1Mapper.html" title="Flat-file DB mapper. " alt="DB\Jig\Mapper" shape="rect" coords="0,168,120,192"/>
  60. <area href="classDB_1_1Mongo_1_1Mapper.html" title="MongoDB mapper. " alt="DB\Mongo\Mapper" shape="rect" coords="130,168,250,192"/>
  61. <area href="classDB_1_1SQL_1_1Mapper.html" title="SQL data mapper. " alt="DB\SQL\Mapper" shape="rect" coords="260,168,380,192"/>
  62. <area href="classDB_1_1Jig_1_1Session.html" title="Jig-managed session handler. " alt="DB\Jig\Session" shape="rect" coords="0,224,120,248"/>
  63. <area href="classDB_1_1Mongo_1_1Session.html" title="MongoDB-managed session handler. " alt="DB\Mongo\Session" shape="rect" coords="130,224,250,248"/>
  64. <area href="classDB_1_1SQL_1_1Session.html" title="SQL-managed session handler. " alt="DB\SQL\Session" shape="rect" coords="260,224,380,248"/>
  65. </map>
  66. </div></div>
  67. <table class="memberdecls">
  68. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  69. Public Member Functions</h2></td></tr>
  70. <tr class="memitem:a7c161bf3f4e312dc9a6a1158913535da"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a7c161bf3f4e312dc9a6a1158913535da">dbtype</a> ()</td></tr>
  71. <tr class="separator:a7c161bf3f4e312dc9a6a1158913535da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a897e1753b25384caef56fce6e4cde7df"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a897e1753b25384caef56fce6e4cde7df">cast</a> ($obj=NULL)</td></tr>
  73. <tr class="separator:a897e1753b25384caef56fce6e4cde7df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a58b00aa94b1e3ba226de1985a9a43bab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a58b00aa94b1e3ba226de1985a9a43bab">find</a> ($filter=NULL, array $options=NULL, $ttl=0)</td></tr>
  75. <tr class="separator:a58b00aa94b1e3ba226de1985a9a43bab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a18b6617cb56faa5353d6017bff6c04af"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a18b6617cb56faa5353d6017bff6c04af">count</a> ($filter=NULL, $ttl=0)</td></tr>
  77. <tr class="separator:a18b6617cb56faa5353d6017bff6c04af"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:aaf3cfe39694afdfd5f44d376eaa22760"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#aaf3cfe39694afdfd5f44d376eaa22760">insert</a> ()</td></tr>
  79. <tr class="separator:aaf3cfe39694afdfd5f44d376eaa22760"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a18fa093c9875a639f7271e13cdb46a50"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a18fa093c9875a639f7271e13cdb46a50">update</a> ()</td></tr>
  81. <tr class="separator:a18fa093c9875a639f7271e13cdb46a50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:aa6acc858a1068a6ac628d27e97a5d49e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#aa6acc858a1068a6ac628d27e97a5d49e">copyfrom</a> ($key, $func=NULL)</td></tr>
  83. <tr class="separator:aa6acc858a1068a6ac628d27e97a5d49e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:abe34ef9c4dc60204086b5c4455bfa69e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#abe34ef9c4dc60204086b5c4455bfa69e">copyto</a> ($key)</td></tr>
  85. <tr class="separator:abe34ef9c4dc60204086b5c4455bfa69e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a51139e47ffcf9fecd0189f050c32db72"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a51139e47ffcf9fecd0189f050c32db72">dry</a> ()</td></tr>
  87. <tr class="separator:a51139e47ffcf9fecd0189f050c32db72"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:aead717ff46a2e8cca673ebb4948705c4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#aead717ff46a2e8cca673ebb4948705c4">findone</a> ($filter=NULL, array $options=NULL, $ttl=0)</td></tr>
  89. <tr class="separator:aead717ff46a2e8cca673ebb4948705c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:acc8dc83b5137f234a53f179969df1770"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#acc8dc83b5137f234a53f179969df1770">paginate</a> ($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)</td></tr>
  91. <tr class="separator:acc8dc83b5137f234a53f179969df1770"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a8c0f0122663bb7d239222042efbdb4b0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a8c0f0122663bb7d239222042efbdb4b0">load</a> ($filter=NULL, array $options=NULL, $ttl=0)</td></tr>
  93. <tr class="separator:a8c0f0122663bb7d239222042efbdb4b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a535d17681f9758454f0afd12547fa3ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a535d17681f9758454f0afd12547fa3ae">first</a> ()</td></tr>
  95. <tr class="separator:a535d17681f9758454f0afd12547fa3ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a8d5a715c028b6c7c7a90f8b0ce3e089f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a8d5a715c028b6c7c7a90f8b0ce3e089f">last</a> ()</td></tr>
  97. <tr class="separator:a8d5a715c028b6c7c7a90f8b0ce3e089f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ae6863afa3f23ded1fc545a50d76efd50"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#ae6863afa3f23ded1fc545a50d76efd50">skip</a> ($ofs=1)</td></tr>
  99. <tr class="separator:ae6863afa3f23ded1fc545a50d76efd50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:addcbf18b7c0c621f78312f39785b5e2e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#addcbf18b7c0c621f78312f39785b5e2e">next</a> ()</td></tr>
  101. <tr class="separator:addcbf18b7c0c621f78312f39785b5e2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ae8de1d05cf812e21e08297c6117cf425"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#ae8de1d05cf812e21e08297c6117cf425">prev</a> ()</td></tr>
  103. <tr class="separator:ae8de1d05cf812e21e08297c6117cf425"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ad03f49090f8243e0fad945ce219fb296"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#ad03f49090f8243e0fad945ce219fb296">save</a> ()</td></tr>
  105. <tr class="separator:ad03f49090f8243e0fad945ce219fb296"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a5d5ada095f2c923d4c3ba7e58ff0489c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a5d5ada095f2c923d4c3ba7e58ff0489c">erase</a> ()</td></tr>
  107. <tr class="separator:a5d5ada095f2c923d4c3ba7e58ff0489c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a925c2b682efadd6718394b344678a24e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a925c2b682efadd6718394b344678a24e">onload</a> ($func)</td></tr>
  109. <tr class="separator:a925c2b682efadd6718394b344678a24e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:aabe978f26ab37732a59289c5f95fb3c2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#aabe978f26ab37732a59289c5f95fb3c2">beforeinsert</a> ($func)</td></tr>
  111. <tr class="separator:aabe978f26ab37732a59289c5f95fb3c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a0c89cfe8faf7b55122ada1a4f9d1e9ca"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a0c89cfe8faf7b55122ada1a4f9d1e9ca">afterinsert</a> ($func)</td></tr>
  113. <tr class="separator:a0c89cfe8faf7b55122ada1a4f9d1e9ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a05948a1b0762aec19d2b6b40a228f9bb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a05948a1b0762aec19d2b6b40a228f9bb">oninsert</a> ($func)</td></tr>
  115. <tr class="separator:a05948a1b0762aec19d2b6b40a228f9bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ae199229f816ab78b942be1ae9c4a3581"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#ae199229f816ab78b942be1ae9c4a3581">beforeupdate</a> ($func)</td></tr>
  117. <tr class="separator:ae199229f816ab78b942be1ae9c4a3581"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a943a1cacfc57b79bc24bdda194525b21"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a943a1cacfc57b79bc24bdda194525b21">afterupdate</a> ($func)</td></tr>
  119. <tr class="separator:a943a1cacfc57b79bc24bdda194525b21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a32b1bf6076239faef22cd05553a2f6e0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a32b1bf6076239faef22cd05553a2f6e0">onupdate</a> ($func)</td></tr>
  121. <tr class="separator:a32b1bf6076239faef22cd05553a2f6e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:af718ecf50c76d4720758a029a6da06ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#af718ecf50c76d4720758a029a6da06ae">beforeerase</a> ($func)</td></tr>
  123. <tr class="separator:af718ecf50c76d4720758a029a6da06ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a14ab0b84738dc86db5676343c82b5242"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a14ab0b84738dc86db5676343c82b5242">aftererase</a> ($func)</td></tr>
  125. <tr class="separator:a14ab0b84738dc86db5676343c82b5242"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:ab49fcd9ec9f37f853986265729a9c49e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#ab49fcd9ec9f37f853986265729a9c49e">onerase</a> ($func)</td></tr>
  127. <tr class="separator:ab49fcd9ec9f37f853986265729a9c49e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a03eb1bc2a60bfc0be7e3e51c09a6072a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#a03eb1bc2a60bfc0be7e3e51c09a6072a">reset</a> ()</td></tr>
  129. <tr class="separator:a03eb1bc2a60bfc0be7e3e51c09a6072a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="inherit_header pub_methods_classMagic"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classMagic')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classMagic.html">Magic</a></td></tr>
  131. <tr class="memitem:ad242c359b007dc35794690e744924974 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#ad242c359b007dc35794690e744924974">exists</a> ($key)</td></tr>
  132. <tr class="separator:ad242c359b007dc35794690e744924974 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:af5969f61e6fcb580733fba9302de076a inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#af5969f61e6fcb580733fba9302de076a">set</a> ($key, $val)</td></tr>
  134. <tr class="separator:af5969f61e6fcb580733fba9302de076a inherit pub_methods_classMagic"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ab809dfcdbba37cb93b82d526b25f3112 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#ab809dfcdbba37cb93b82d526b25f3112">get</a> ($key)</td></tr>
  136. <tr class="separator:ab809dfcdbba37cb93b82d526b25f3112 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:ad9aa6fe25a7c2ed6d90c98e5f517aa78 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#ad9aa6fe25a7c2ed6d90c98e5f517aa78">clear</a> ($key)</td></tr>
  138. <tr class="separator:ad9aa6fe25a7c2ed6d90c98e5f517aa78 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a8146b8fc5ed9a0e30e9612afb9cd8d80 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a8146b8fc5ed9a0e30e9612afb9cd8d80">offsetexists</a> ($key)</td></tr>
  140. <tr class="separator:a8146b8fc5ed9a0e30e9612afb9cd8d80 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a5e02946d9f8d5314fc60c5ff3badd6ef inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a5e02946d9f8d5314fc60c5ff3badd6ef">__isset</a> ($key)</td></tr>
  142. <tr class="separator:a5e02946d9f8d5314fc60c5ff3badd6ef inherit pub_methods_classMagic"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:add3add2badb418eb7712b7b789b6e52b inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#add3add2badb418eb7712b7b789b6e52b">offsetset</a> ($key, $val)</td></tr>
  144. <tr class="separator:add3add2badb418eb7712b7b789b6e52b inherit pub_methods_classMagic"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a66319e2327b1fdf7643e3dff9b786495 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a66319e2327b1fdf7643e3dff9b786495">__set</a> ($key, $val)</td></tr>
  146. <tr class="separator:a66319e2327b1fdf7643e3dff9b786495 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a91b6f39d7c711d0abe8f66715eaad0f1 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a91b6f39d7c711d0abe8f66715eaad0f1">offsetget</a> ($key)</td></tr>
  148. <tr class="separator:a91b6f39d7c711d0abe8f66715eaad0f1 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a72010b7bf92e61a7b8279de02b8c5820 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a72010b7bf92e61a7b8279de02b8c5820">__get</a> ($key)</td></tr>
  150. <tr class="separator:a72010b7bf92e61a7b8279de02b8c5820 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a1bdb5f01422cda7f03c76674cd82812d inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a1bdb5f01422cda7f03c76674cd82812d">offsetunset</a> ($key)</td></tr>
  152. <tr class="separator:a1bdb5f01422cda7f03c76674cd82812d inherit pub_methods_classMagic"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a93e1d416a15653d133228111c7b5eb20 inherit pub_methods_classMagic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagic.html#a93e1d416a15653d133228111c7b5eb20">__unset</a> ($key)</td></tr>
  154. <tr class="separator:a93e1d416a15653d133228111c7b5eb20 inherit pub_methods_classMagic"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. </table><table class="memberdecls">
  156. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  157. Public Attributes</h2></td></tr>
  158. <tr class="memitem:aa9bd1bd956c019df75353f84cbc2b9f1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9bd1bd956c019df75353f84cbc2b9f1"></a>
  159. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#aa9bd1bd956c019df75353f84cbc2b9f1">$ptr</a> =0</td></tr>
  160. <tr class="memdesc:aa9bd1bd956c019df75353f84cbc2b9f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current position. <br/></td></tr>
  161. <tr class="separator:aa9bd1bd956c019df75353f84cbc2b9f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:ab3310c0b515201e7565a36ce2c841a97"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3310c0b515201e7565a36ce2c841a97"></a>
  163. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#ab3310c0b515201e7565a36ce2c841a97">$trigger</a> =array()</td></tr>
  164. <tr class="memdesc:ab3310c0b515201e7565a36ce2c841a97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event listeners. <br/></td></tr>
  165. <tr class="separator:ab3310c0b515201e7565a36ce2c841a97"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr><td colspan="2"><div class="groupHeader"></div></td></tr>
  167. <tr class="memitem:aa57f3721f9d2dc83a2e8a16a864c57be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa57f3721f9d2dc83a2e8a16a864c57be"></a>
  168. const&#160;</td><td class="memItemRight" valign="bottom"><b>E_Field</b> ='Undefined field %s'</td></tr>
  169. <tr class="separator:aa57f3721f9d2dc83a2e8a16a864c57be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. </table><table class="memberdecls">
  171. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  172. Protected Attributes</h2></td></tr>
  173. <tr class="memitem:ab4f2192be8a29ca3b63a8594face7f2b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4f2192be8a29ca3b63a8594face7f2b"></a>
  174. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDB_1_1Cursor.html#ab4f2192be8a29ca3b63a8594face7f2b">$query</a> =array()</td></tr>
  175. <tr class="memdesc:ab4f2192be8a29ca3b63a8594face7f2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query results. <br/></td></tr>
  176. <tr class="separator:ab4f2192be8a29ca3b63a8594face7f2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. </table>
  178. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  179. <div class="textblock"><p>Simple cursor implementation. </p>
  180. </div><h2 class="groupheader">Member Function Documentation</h2>
  181. <a class="anchor" id="a14ab0b84738dc86db5676343c82b5242"></a>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">DB\Cursor::aftererase </td>
  187. <td>(</td>
  188. <td class="paramtype">&#160;</td>
  189. <td class="paramname"><em>$func</em></td><td>)</td>
  190. <td></td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. <p>Define aftererase trigger </p>
  195. <dl class="section return"><dt>Returns</dt><dd>callback </dd></dl>
  196. <dl class="params"><dt>Parameters</dt><dd>
  197. <table class="params">
  198. <tr><td class="paramname">$func</td><td>callback </td></tr>
  199. </table>
  200. </dd>
  201. </dl>
  202.  
  203. </div>
  204. </div>
  205. <a class="anchor" id="a0c89cfe8faf7b55122ada1a4f9d1e9ca"></a>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">DB\Cursor::afterinsert </td>
  211. <td>(</td>
  212. <td class="paramtype">&#160;</td>
  213. <td class="paramname"><em>$func</em></td><td>)</td>
  214. <td></td>
  215. </tr>
  216. </table>
  217. </div><div class="memdoc">
  218. <p>Define afterinsert trigger </p>
  219. <dl class="section return"><dt>Returns</dt><dd>callback </dd></dl>
  220. <dl class="params"><dt>Parameters</dt><dd>
  221. <table class="params">
  222. <tr><td class="paramname">$func</td><td>callback </td></tr>
  223. </table>
  224. </dd>
  225. </dl>
  226.  
  227. </div>
  228. </div>
  229. <a class="anchor" id="a943a1cacfc57b79bc24bdda194525b21"></a>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname">DB\Cursor::afterupdate </td>
  235. <td>(</td>
  236. <td class="paramtype">&#160;</td>
  237. <td class="paramname"><em>$func</em></td><td>)</td>
  238. <td></td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Define afterupdate trigger </p>
  243. <dl class="section return"><dt>Returns</dt><dd>callback </dd></dl>
  244. <dl class="params"><dt>Parameters</dt><dd>
  245. <table class="params">
  246. <tr><td class="paramname">$func</td><td>callback </td></tr>
  247. </table>
  248. </dd>
  249. </dl>
  250.  
  251. </div>
  252. </div>
  253. <a class="anchor" id="af718ecf50c76d4720758a029a6da06ae"></a>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">DB\Cursor::beforeerase </td>
  259. <td>(</td>
  260. <td class="paramtype">&#160;</td>
  261. <td class="paramname"><em>$func</em></td><td>)</td>
  262. <td></td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>Define beforeerase trigger </p>
  267. <dl class="section return"><dt>Returns</dt><dd>callback </dd></dl>
  268. <dl class="params"><dt>Parameters</dt><dd>
  269. <table class="params">
  270. <tr><td class="paramname">$func</td><td>callback </td></tr>
  271. </table>
  272. </dd>
  273. </dl>
  274.  
  275. </div>
  276. </div>
  277. <a class="anchor" id="aabe978f26ab37732a59289c5f95fb3c2"></a>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">DB\Cursor::beforeinsert </td>
  283. <td>(</td>
  284. <td class="paramtype">&#160;</td>
  285. <td class="paramname"><em>$func</em></td><td>)</td>
  286. <td></td>
  287. </tr>
  288. </table>
  289. </div><div class="memdoc">
  290. <p>Define beforeinsert trigger </p>
  291. <dl class="section return"><dt>Returns</dt><dd>callback </dd></dl>
  292. <dl class="params"><dt>Parameters</dt><dd>
  293. <table class="params">
  294. <tr><td class="paramname">$func</td><td>callback </td></tr>
  295. </table>
  296. </dd>
  297. </dl>
  298.  
  299. </div>
  300. </div>
  301. <a class="anchor" id="ae199229f816ab78b942be1ae9c4a3581"></a>
  302. <div class="memitem">
  303. <div class="memproto">
  304. <table class="memname">
  305. <tr>
  306. <td class="memname">DB\Cursor::beforeupdate </td>
  307. <td>(</td>
  308. <td class="paramtype">&#160;</td>
  309. <td class="paramname"><em>$func</em></td><td>)</td>
  310. <td></td>
  311. </tr>
  312. </table>
  313. </div><div class="memdoc">
  314. <p>Define beforeupdate trigger </p>
  315. <dl class="section return"><dt>Returns</dt><dd>callback </dd></dl>
  316. <dl class="params"><dt>Parameters</dt><dd>
  317. <table class="params">
  318. <tr><td class="paramname">$func</td><td>callback </td></tr>
  319. </table>
  320. </dd>
  321. </dl>
  322.  
  323. </div>
  324. </div>
  325. <a class="anchor" id="a897e1753b25384caef56fce6e4cde7df"></a>
  326. <div class="memitem">
  327. <div class="memproto">
  328. <table class="mlabels">
  329. <tr>
  330. <td class="mlabels-left">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">DB\Cursor::cast </td>
  334. <td>(</td>
  335. <td class="paramtype">&#160;</td>
  336. <td class="paramname"><em>$obj</em> = <code>NULL</code></td><td>)</td>
  337. <td></td>
  338. </tr>
  339. </table>
  340. </td>
  341. <td class="mlabels-right">
  342. <span class="mlabels"><span class="mlabel">abstract</span></span> </td>
  343. </tr>
  344. </table>
  345. </div><div class="memdoc">
  346. <p>Return fields of mapper object as an associative array </p>
  347. <dl class="section return"><dt>Returns</dt><dd>array </dd></dl>
  348. <dl class="params"><dt>Parameters</dt><dd>
  349. <table class="params">
  350. <tr><td class="paramname">$obj</td><td>object </td></tr>
  351. </table>
  352. </dd>
  353. </dl>
  354.  
  355. </div>
  356. </div>
  357. <a class="anchor" id="aa6acc858a1068a6ac628d27e97a5d49e"></a>
  358. <div class="memitem">
  359. <div class="memproto">
  360. <table class="mlabels">
  361. <tr>
  362. <td class="mlabels-left">
  363. <table class="memname">
  364. <tr>
  365. <td class="memname">DB\Cursor::copyfrom </td>
  366. <td>(</td>
  367. <td class="paramtype">&#160;</td>
  368. <td class="paramname"><em>$key</em>, </td>
  369. </tr>
  370. <tr>
  371. <td class="paramkey"></td>
  372. <td></td>
  373. <td class="paramtype">&#160;</td>
  374. <td class="paramname"><em>$func</em> = <code>NULL</code>&#160;</td>
  375. </tr>
  376. <tr>
  377. <td></td>
  378. <td>)</td>
  379. <td></td><td></td>
  380. </tr>
  381. </table>
  382. </td>
  383. <td class="mlabels-right">
  384. <span class="mlabels"><span class="mlabel">abstract</span></span> </td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <p>Hydrate mapper object using hive array variable </p>
  389. <dl class="section return"><dt>Returns</dt><dd>NULL </dd></dl>
  390. <dl class="params"><dt>Parameters</dt><dd>
  391. <table class="params">
  392. <tr><td class="paramname">$key</td><td>string </td></tr>
  393. <tr><td class="paramname">$func</td><td>callback </td></tr>
  394. </table>
  395. </dd>
  396. </dl>
  397.  
  398. </div>
  399. </div>
  400. <a class="anchor" id="abe34ef9c4dc60204086b5c4455bfa69e"></a>
  401. <div class="memitem">
  402. <div class="memproto">
  403. <table class="mlabels">
  404. <tr>
  405. <td class="mlabels-left">
  406. <table class="memname">
  407. <tr>
  408. <td class="memname">DB\Cursor::copyto </td>
  409. <td>(</td>
  410. <td class="paramtype">&#160;</td>
  411. <td class="paramname"><em>$key</em></td><td>)</td>
  412. <td></td>
  413. </tr>
  414. </table>
  415. </td>
  416. <td class="mlabels-right">
  417. <span class="mlabels"><span class="mlabel">abstract</span></span> </td>
  418. </tr>
  419. </table>
  420. </div><div class="memdoc">
  421. <p>Populate hive array variable with mapper fields </p>
  422. <dl class="section return"><dt>Returns</dt><dd>NULL </dd></dl>
  423. <dl class="params"><dt>Parameters</dt><dd>
  424. <table class="params">
  425. <tr><td class="paramname">$key</td><td>string </td></tr>
  426. </table>
  427. </dd>
  428. </dl>
  429.  
  430. </div>
  431. </div>
  432. <a class="anchor" id="a18b6617cb56faa5353d6017bff6c04af"></a>
  433. <div class="memitem">
  434. <div class="memproto">
  435. <table class="mlabels">
  436. <tr>
  437. <td class="mlabels-left">
  438. <table class="memname">
  439. <tr>
  440. <td class="memname">DB\Cursor::count </td>
  441. <td>(</td>
  442. <td class="paramtype">&#160;</td>
  443. <td class="paramname"><em>$filter</em> = <code>NULL</code>, </td>
  444. </tr>
  445. <tr>
  446. <td class="paramkey"></td>
  447. <td></td>
  448. <td class="paramtype">&#160;</td>
  449. <td class="paramname"><em>$ttl</em> = <code>0</code>&#160;</td>
  450. </tr>
  451. <tr>
  452. <td></td>
  453. <td>)</td>
  454. <td></td><td></td>
  455. </tr>
  456. </table>
  457. </td>
  458. <td class="mlabels-right">
  459. <span class="mlabels"><span class="mlabel">abstract</span></span> </td>
  460. </tr>
  461. </table>
  462. </div><div class="memdoc">
  463. <p>Count records that match criteria </p>
  464. <dl class="section return"><dt>Returns</dt><dd>int </dd></dl>
  465. <dl class="params"><dt>Parameters</dt><dd>
  466. <table class="params">
  467. <tr><td class="paramname">$filter</td><td>array </td></tr>
  468. <tr><td class="paramname">$ttl</td><td>int </td></tr>
  469. </table>
  470. </dd>
  471. </dl>
  472.  
  473. </div>
  474. </div>
  475. <a class="anchor" id="a7c161bf3f4e312dc9a6a1158913535da"></a>
  476. <div class="memitem">
  477. <div class="memproto">
  478. <table class="mlabels">
  479. <tr>
  480. <td class="mlabels-left">
  481. <table class="memname">
  482. <tr>
  483. <td class="memname">DB\Cursor::dbtype </td>
  484. <td>(</td>
  485. <td class="paramname"></td><td>)</td>
  486. <td></td>
  487. </tr>
  488. </table>
  489. </td>
  490. <td class="mlabels-right">
  491. <span class="mlabels"><span class="mlabel">abstract</span></span> </td>
  492. </tr>
  493. </table>
  494. </div><div class="memdoc">
  495. <p>Return database type </p>
  496. <dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
  497.  
  498. </div>
  499. </div>
  500. <a class="anchor" id="a51139e47ffcf9fecd0189f050c32db72"></a>
  501. <div class="memitem">
  502. <div class="memproto">
  503. <table class="memname">
  504. <tr>
  505. <td class="memname">DB\Cursor::dry </td>
  506. <td>(</td>
  507. <td class="paramname"></td><td>)</td>
  508. <td></td>
  509. </tr>
  510. </table>
  511. </div><div class="memdoc">
  512. <p>Return TRUE if current cursor position is not mapped to any record </p>
  513. <dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
  514.  
  515. </div>
  516. </div>
  517. <a class="anchor" id="a5d5ada095f2c923d4c3ba7e58ff0489c"></a>
  518. <div class="memitem">
  519. <div class="memproto">
  520. <table class="memname">
  521. <tr>
  522. <td class="memname">DB\Cursor::erase </td>
  523. <td>(</td>
  524. <td class="paramname"></td><td>)</td>
  525. <td></td>
  526. </tr>
  527. </table>
  528. </div><div class="memdoc">
  529. <p>Delete current record </p>
  530. <dl class="section return"><dt>Returns</dt><dd>int|bool </dd></dl>
  531.  
  532. </div>
  533. </div>
  534. <a class="anchor" id="a58b00aa94b1e3ba226de1985a9a43bab"></a>
  535. <div class="memitem">
  536. <div class="memproto">
  537. <table class="mlabels">
  538. <tr>
  539. <td class="mlabels-left">
  540. <table class="memname">
  541. <tr>
  542. <td class="memname">DB\Cursor::find </td>
  543. <td>(</td>
  544. <td class="paramtype">&#160;</td>
  545. <td class="paramname"><em>$filter</em> = <code>NULL</code>, </td>
  546. </tr>
  547. <tr>
  548. <td class="paramkey"></td>
  549. <td></td>
  550. <td class="paramtype">array&#160;</td>
  551. <td class="paramname"><em>$options</em> = <code>NULL</code>, </td>
  552. </tr>
  553. <tr>
  554. <td class="paramkey"></td>
  555. <td></td>
  556. <td class="paramtype">&#160;</td>
  557. <td class="paramname"><em>$ttl</em> = <code>0</code>&#160;</td>
  558. </tr>
  559. <tr>
  560. <td></td>
  561. <td>)</td>
  562. <td></td><td></td>
  563. </tr>
  564. </table>
  565. </td>
  566. <td class="mlabels-right">
  567. <span class="mlabels"><span class="mlabel">abstract</span></span> </td>
  568. </tr>
  569. </table>
  570. </div><div class="memdoc">
  571. <p>Return records (array of mapper objects) that match criteria </p>
  572. <dl class="section return"><dt>Returns</dt><dd>array </dd></dl>
  573. <dl class="params"><dt>Parameters</dt><dd>
  574. <table class="params">
  575. <tr><td class="paramname">$filter</td><td>string|array </td></tr>
  576. <tr><td class="paramname">$options</td><td>array </td></tr>
  577. <tr><td class="paramname">$ttl</td><td>int </td></tr>
  578. </table>
  579. </dd>
  580. </dl>
  581.  
  582. </div>
  583. </div>
  584. <a class="anchor" id="aead717ff46a2e8cca673ebb4948705c4"></a>
  585. <div class="memitem">
  586. <div class="memproto">
  587. <table class="memname">
  588. <tr>
  589. <td class="memname">DB\Cursor::findone </td>
  590. <td>(</td>
  591. <td class="paramtype">&#160;</td>
  592. <td class="paramname"><em>$filter</em> = <code>NULL</code>, </td>
  593. </tr>
  594. <tr>
  595. <td class="paramkey"></td>
  596. <td></td>
  597. <td class="paramtype">array&#160;</td>
  598. <td class="paramname"><em>$options</em> = <code>NULL</code>, </td>
  599. </tr>
  600. <tr>
  601. <td class="paramkey"></td>
  602. <td></td>
  603. <td class="paramtype">&#160;</td>
  604. <td class="paramname"><em>$ttl</em> = <code>0</code>&#160;</td>
  605. </tr>
  606. <tr>
  607. <td></td>
  608. <td>)</td>
  609. <td></td><td></td>
  610. </tr>
  611. </table>
  612. </div><div class="memdoc">
  613. <p>Return first record (mapper object) that matches criteria </p>
  614. <dl class="section return"><dt>Returns</dt><dd>object|FALSE </dd></dl>
  615. <dl class="params"><dt>Parameters</dt><dd>
  616. <table class="params">
  617. <tr><td class="paramname">$filter</td><td>string|array </td></tr>
  618. <tr><td class="paramname">$options</td><td>array </td></tr>
  619. <tr><td class="paramname">$ttl</td><td>int </td></tr>
  620. </table>
  621. </dd>
  622. </dl>
  623.  
  624. </div>
  625. </div>
  626. <a class="anchor" id="a535d17681f9758454f0afd12547fa3ae"></a>
  627. <div class="memitem">
  628. <div class="memproto">
  629. <table class="memname">
  630. <tr>
  631. <td class="memname">DB\Cursor::first </td>
  632. <td>(</td>
  633. <td class="paramname"></td><td>)</td>
  634. <td></td>
  635. </tr>
  636. </table>
  637. </div><div class="memdoc">
  638. <p>Map to first record in cursor </p>
  639. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  640.  
  641. </div>
  642. </div>
  643. <a class="anchor" id="aaf3cfe39694afdfd5f44d376eaa22760"></a>
  644. <div class="memitem">
  645. <div class="memproto">
  646. <table class="mlabels">
  647. <tr>
  648. <td class="mlabels-left">
  649. <table class="memname">
  650. <tr>
  651. <td class="memname">DB\Cursor::insert </td>
  652. <td>(</td>
  653. <td class="paramname"></td><td>)</td>
  654. <td></td>
  655. </tr>
  656. </table>
  657. </td>
  658. <td class="mlabels-right">
  659. <span class="mlabels"><span class="mlabel">abstract</span></span> </td>
  660. </tr>
  661. </table>
  662. </div><div class="memdoc">
  663. <p>Insert new record </p>
  664. <dl class="section return"><dt>Returns</dt><dd>array </dd></dl>
  665.  
  666. </div>
  667. </div>
  668. <a class="anchor" id="a8d5a715c028b6c7c7a90f8b0ce3e089f"></a>
  669. <div class="memitem">
  670. <div class="memproto">
  671. <table class="memname">
  672. <tr>
  673. <td class="memname">DB\Cursor::last </td>
  674. <td>(</td>
  675. <td class="paramname"></td><td>)</td>
  676. <td></td>
  677. </tr>
  678. </table>
  679. </div><div class="memdoc">
  680. <p>Map to last record in cursor </p>
  681. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  682.  
  683. </div>
  684. </div>
  685. <a class="anchor" id="a8c0f0122663bb7d239222042efbdb4b0"></a>
  686. <div class="memitem">
  687. <div class="memproto">
  688. <table class="memname">
  689. <tr>
  690. <td class="memname">DB\Cursor::load </td>
  691. <td>(</td>
  692. <td class="paramtype">&#160;</td>
  693. <td class="paramname"><em>$filter</em> = <code>NULL</code>, </td>
  694. </tr>
  695. <tr>
  696. <td class="paramkey"></td>
  697. <td></td>
  698. <td class="paramtype">array&#160;</td>
  699. <td class="paramname"><em>$options</em> = <code>NULL</code>, </td>
  700. </tr>
  701. <tr>
  702. <td class="paramkey"></td>
  703. <td></td>
  704. <td class="paramtype">&#160;</td>
  705. <td class="paramname"><em>$ttl</em> = <code>0</code>&#160;</td>
  706. </tr>
  707. <tr>
  708. <td></td>
  709. <td>)</td>
  710. <td></td><td></td>
  711. </tr>
  712. </table>
  713. </div><div class="memdoc">
  714. <p>Map to first record that matches criteria </p>
  715. <dl class="section return"><dt>Returns</dt><dd>array|FALSE </dd></dl>
  716. <dl class="params"><dt>Parameters</dt><dd>
  717. <table class="params">
  718. <tr><td class="paramname">$filter</td><td>string|array </td></tr>
  719. <tr><td class="paramname">$options</td><td>array </td></tr>
  720. <tr><td class="paramname">$ttl</td><td>int </td></tr>
  721. </table>
  722. </dd>
  723. </dl>
  724.  
  725. </div>
  726. </div>
  727. <a class="anchor" id="addcbf18b7c0c621f78312f39785b5e2e"></a>
  728. <div class="memitem">
  729. <div class="memproto">
  730. <table class="memname">
  731. <tr>
  732. <td class="memname">DB\Cursor::next </td>
  733. <td>(</td>
  734. <td class="paramname"></td><td>)</td>
  735. <td></td>
  736. </tr>
  737. </table>
  738. </div><div class="memdoc">
  739. <p>Map next record </p>
  740. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  741.  
  742. </div>
  743. </div>
  744. <a class="anchor" id="ab49fcd9ec9f37f853986265729a9c49e"></a>
  745. <div class="memitem">
  746. <div class="memproto">
  747. <table class="memname">
  748. <tr>
  749. <td class="memname">DB\Cursor::onerase </td>
  750. <td>(</td>
  751. <td class="paramtype">&#160;</td>
  752. <td class="paramname"><em>$func</em></td><td>)</td>
  753. <td></td>
  754. </tr>
  755. </table>
  756. </div><div class="memdoc">
  757. <p>Define onerase trigger </p>
  758. <dl class="section return"><dt>Returns</dt><dd>callback </dd></dl>
  759. <dl class="params"><dt>Parameters</dt><dd>
  760. <table class="params">
  761. <tr><td class="paramname">$func</td><td>callback </td></tr>
  762. </table>
  763. </dd>
  764. </dl>
  765.  
  766. </div>
  767. </div>
  768. <a class="anchor" id="a05948a1b0762aec19d2b6b40a228f9bb"></a>
  769. <div class="memitem">
  770. <div class="memproto">
  771. <table class="memname">
  772. <tr>
  773. <td class="memname">DB\Cursor::oninsert </td>
  774. <td>(</td>
  775. <td class="paramtype">&#160;</td>
  776. <td class="paramname"><em>$func</em></td><td>)</td>
  777. <td></td>
  778. </tr>
  779. </table>
  780. </div><div class="memdoc">
  781. <p>Define oninsert trigger </p>
  782. <dl class="section return"><dt>Returns</dt><dd>callback </dd></dl>
  783. <dl class="params"><dt>Parameters</dt><dd>
  784. <table class="params">
  785. <tr><td class="paramname">$func</td><td>callback </td></tr>
  786. </table>
  787. </dd>
  788. </dl>
  789.  
  790. </div>
  791. </div>
  792. <a class="anchor" id="a925c2b682efadd6718394b344678a24e"></a>
  793. <div class="memitem">
  794. <div class="memproto">
  795. <table class="memname">
  796. <tr>
  797. <td class="memname">DB\Cursor::onload </td>
  798. <td>(</td>
  799. <td class="paramtype">&#160;</td>
  800. <td class="paramname"><em>$func</em></td><td>)</td>
  801. <td></td>
  802. </tr>
  803. </table>
  804. </div><div class="memdoc">
  805. <p>Define onload trigger </p>
  806. <dl class="section return"><dt>Returns</dt><dd>callback </dd></dl>
  807. <dl class="params"><dt>Parameters</dt><dd>
  808. <table class="params">
  809. <tr><td class="paramname">$func</td><td>callback </td></tr>
  810. </table>
  811. </dd>
  812. </dl>
  813.  
  814. </div>
  815. </div>
  816. <a class="anchor" id="a32b1bf6076239faef22cd05553a2f6e0"></a>
  817. <div class="memitem">
  818. <div class="memproto">
  819. <table class="memname">
  820. <tr>
  821. <td class="memname">DB\Cursor::onupdate </td>
  822. <td>(</td>
  823. <td class="paramtype">&#160;</td>
  824. <td class="paramname"><em>$func</em></td><td>)</td>
  825. <td></td>
  826. </tr>
  827. </table>
  828. </div><div class="memdoc">
  829. <p>Define onupdate trigger </p>
  830. <dl class="section return"><dt>Returns</dt><dd>callback </dd></dl>
  831. <dl class="params"><dt>Parameters</dt><dd>
  832. <table class="params">
  833. <tr><td class="paramname">$func</td><td>callback </td></tr>
  834. </table>
  835. </dd>
  836. </dl>
  837.  
  838. </div>
  839. </div>
  840. <a class="anchor" id="acc8dc83b5137f234a53f179969df1770"></a>
  841. <div class="memitem">
  842. <div class="memproto">
  843. <table class="memname">
  844. <tr>
  845. <td class="memname">DB\Cursor::paginate </td>
  846. <td>(</td>
  847. <td class="paramtype">&#160;</td>
  848. <td class="paramname"><em>$pos</em> = <code>0</code>, </td>
  849. </tr>
  850. <tr>
  851. <td class="paramkey"></td>
  852. <td></td>
  853. <td class="paramtype">&#160;</td>
  854. <td class="paramname"><em>$size</em> = <code>10</code>, </td>
  855. </tr>
  856. <tr>
  857. <td class="paramkey"></td>
  858. <td></td>
  859. <td class="paramtype">&#160;</td>
  860. <td class="paramname"><em>$filter</em> = <code>NULL</code>, </td>
  861. </tr>
  862. <tr>
  863. <td class="paramkey"></td>
  864. <td></td>
  865. <td class="paramtype">array&#160;</td>
  866. <td class="paramname"><em>$options</em> = <code>NULL</code>, </td>
  867. </tr>
  868. <tr>
  869. <td class="paramkey"></td>
  870. <td></td>
  871. <td class="paramtype">&#160;</td>
  872. <td class="paramname"><em>$ttl</em> = <code>0</code>&#160;</td>
  873. </tr>
  874. <tr>
  875. <td></td>
  876. <td>)</td>
  877. <td></td><td></td>
  878. </tr>
  879. </table>
  880. </div><div class="memdoc">
  881. <p>Return array containing subset of records matching criteria, total number of records in superset, specified limit, number of subsets available, and actual subset position </p>
  882. <dl class="section return"><dt>Returns</dt><dd>array </dd></dl>
  883. <dl class="params"><dt>Parameters</dt><dd>
  884. <table class="params">
  885. <tr><td class="paramname">$pos</td><td>int </td></tr>
  886. <tr><td class="paramname">$size</td><td>int </td></tr>
  887. <tr><td class="paramname">$filter</td><td>string|array </td></tr>
  888. <tr><td class="paramname">$options</td><td>array </td></tr>
  889. <tr><td class="paramname">$ttl</td><td>int </td></tr>
  890. </table>
  891. </dd>
  892. </dl>
  893.  
  894. </div>
  895. </div>
  896. <a class="anchor" id="ae8de1d05cf812e21e08297c6117cf425"></a>
  897. <div class="memitem">
  898. <div class="memproto">
  899. <table class="memname">
  900. <tr>
  901. <td class="memname">DB\Cursor::prev </td>
  902. <td>(</td>
  903. <td class="paramname"></td><td>)</td>
  904. <td></td>
  905. </tr>
  906. </table>
  907. </div><div class="memdoc">
  908. <p>Map previous record </p>
  909. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  910.  
  911. </div>
  912. </div>
  913. <a class="anchor" id="a03eb1bc2a60bfc0be7e3e51c09a6072a"></a>
  914. <div class="memitem">
  915. <div class="memproto">
  916. <table class="memname">
  917. <tr>
  918. <td class="memname">DB\Cursor::reset </td>
  919. <td>(</td>
  920. <td class="paramname"></td><td>)</td>
  921. <td></td>
  922. </tr>
  923. </table>
  924. </div><div class="memdoc">
  925. <p>Reset cursor </p>
  926. <dl class="section return"><dt>Returns</dt><dd>NULL </dd></dl>
  927.  
  928. </div>
  929. </div>
  930. <a class="anchor" id="ad03f49090f8243e0fad945ce219fb296"></a>
  931. <div class="memitem">
  932. <div class="memproto">
  933. <table class="memname">
  934. <tr>
  935. <td class="memname">DB\Cursor::save </td>
  936. <td>(</td>
  937. <td class="paramname"></td><td>)</td>
  938. <td></td>
  939. </tr>
  940. </table>
  941. </div><div class="memdoc">
  942. <p>Save mapped record </p>
  943. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  944.  
  945. </div>
  946. </div>
  947. <a class="anchor" id="ae6863afa3f23ded1fc545a50d76efd50"></a>
  948. <div class="memitem">
  949. <div class="memproto">
  950. <table class="memname">
  951. <tr>
  952. <td class="memname">DB\Cursor::skip </td>
  953. <td>(</td>
  954. <td class="paramtype">&#160;</td>
  955. <td class="paramname"><em>$ofs</em> = <code>1</code></td><td>)</td>
  956. <td></td>
  957. </tr>
  958. </table>
  959. </div><div class="memdoc">
  960. <p>Map to nth record relative to current cursor position </p>
  961. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  962. <dl class="params"><dt>Parameters</dt><dd>
  963. <table class="params">
  964. <tr><td class="paramname">$ofs</td><td>int </td></tr>
  965. </table>
  966. </dd>
  967. </dl>
  968.  
  969. </div>
  970. </div>
  971. <a class="anchor" id="a18fa093c9875a639f7271e13cdb46a50"></a>
  972. <div class="memitem">
  973. <div class="memproto">
  974. <table class="mlabels">
  975. <tr>
  976. <td class="mlabels-left">
  977. <table class="memname">
  978. <tr>
  979. <td class="memname">DB\Cursor::update </td>
  980. <td>(</td>
  981. <td class="paramname"></td><td>)</td>
  982. <td></td>
  983. </tr>
  984. </table>
  985. </td>
  986. <td class="mlabels-right">
  987. <span class="mlabels"><span class="mlabel">abstract</span></span> </td>
  988. </tr>
  989. </table>
  990. </div><div class="memdoc">
  991. <p>Update current record </p>
  992. <dl class="section return"><dt>Returns</dt><dd>array </dd></dl>
  993.  
  994. </div>
  995. </div>
  996. <hr/>The documentation for this class was generated from the following file:<ul>
  997. <li>db/cursor.php</li>
  998. </ul>
  999. </div><!-- contents -->