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

Конкурс дизайнеров на 15000 рублей
Автопокупка рекламы
Размер файла: 17.59Kb 
  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: Magic 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><!-- top -->
  33. <div class="header">
  34.   <div class="summary">
  35. <a href="#pub-methods">Public Member Functions</a> &#124;
  36. <a href="classMagic-members.html">List of all members</a>  </div>
  37.   <div class="headertitle">
  38. <div class="title">Magic Class Reference</div>  </div>
  39. </div><!--header-->
  40. <div class="contents">
  41.  
  42. <p>PHP magic wrapper.  
  43.  <a href="classMagic.html#details">More...</a></p>
  44. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  45.   <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Magic:</div>
  46. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  47. </div>
  48. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  49.  <div class="center">
  50.   <img src="classMagic.png" usemap="#Magic_map" alt=""/>
  51.   <map id="Magic_map" name="Magic_map">
  52. <area href="classDB_1_1Cursor.html" title="Simple cursor implementation. " alt="DB\Cursor" shape="rect" coords="130,112,250,136"/>
  53. <area href="classSMTP.html" title="SMTP plug-in. " alt="SMTP" shape="rect" coords="260,112,380,136"/>
  54. <area href="classWeb_1_1OpenID.html" title="OpenID consumer. " alt="Web\OpenID" shape="rect" coords="390,112,510,136"/>
  55. <area href="classDB_1_1Jig_1_1Mapper.html" title="Flat-file DB mapper. " alt="DB\Jig\Mapper" shape="rect" coords="0,168,120,192"/>
  56. <area href="classDB_1_1Mongo_1_1Mapper.html" title="MongoDB mapper. " alt="DB\Mongo\Mapper" shape="rect" coords="130,168,250,192"/>
  57. <area href="classDB_1_1SQL_1_1Mapper.html" title="SQL data mapper. " alt="DB\SQL\Mapper" shape="rect" coords="260,168,380,192"/>
  58. <area href="classDB_1_1Jig_1_1Session.html" title="Jig-managed session handler. " alt="DB\Jig\Session" shape="rect" coords="0,224,120,248"/>
  59. <area href="classDB_1_1Mongo_1_1Session.html" title="MongoDB-managed session handler. " alt="DB\Mongo\Session" shape="rect" coords="130,224,250,248"/>
  60. <area href="classDB_1_1SQL_1_1Session.html" title="SQL-managed session handler. " alt="DB\SQL\Session" shape="rect" coords="260,224,380,248"/>
  61. </map>
  62.  </div></div>
  63. <table class="memberdecls">
  64. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  65. Public Member Functions</h2></td></tr>
  66. <tr class="memitem:ad242c359b007dc35794690e744924974"><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>
  67. <tr class="separator:ad242c359b007dc35794690e744924974"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:af5969f61e6fcb580733fba9302de076a"><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>
  69. <tr class="separator:af5969f61e6fcb580733fba9302de076a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:ab809dfcdbba37cb93b82d526b25f3112"><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>
  71. <tr class="separator:ab809dfcdbba37cb93b82d526b25f3112"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:ad9aa6fe25a7c2ed6d90c98e5f517aa78"><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>
  73. <tr class="separator:ad9aa6fe25a7c2ed6d90c98e5f517aa78"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a8146b8fc5ed9a0e30e9612afb9cd8d80"><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>
  75. <tr class="separator:a8146b8fc5ed9a0e30e9612afb9cd8d80"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a5e02946d9f8d5314fc60c5ff3badd6ef"><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>
  77. <tr class="separator:a5e02946d9f8d5314fc60c5ff3badd6ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:add3add2badb418eb7712b7b789b6e52b"><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>
  79. <tr class="separator:add3add2badb418eb7712b7b789b6e52b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a66319e2327b1fdf7643e3dff9b786495"><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>
  81. <tr class="separator:a66319e2327b1fdf7643e3dff9b786495"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a91b6f39d7c711d0abe8f66715eaad0f1"><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>
  83. <tr class="separator:a91b6f39d7c711d0abe8f66715eaad0f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a72010b7bf92e61a7b8279de02b8c5820"><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>
  85. <tr class="separator:a72010b7bf92e61a7b8279de02b8c5820"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a1bdb5f01422cda7f03c76674cd82812d"><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>
  87. <tr class="separator:a1bdb5f01422cda7f03c76674cd82812d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a93e1d416a15653d133228111c7b5eb20"><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>
  89. <tr class="separator:a93e1d416a15653d133228111c7b5eb20"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table>
  91. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  92. <div class="textblock"><p>PHP magic wrapper. </p>
  93. </div><h2 class="groupheader">Member Function Documentation</h2>
  94. <a class="anchor" id="a72010b7bf92e61a7b8279de02b8c5820"></a>
  95. <div class="memitem">
  96. <div class="memproto">
  97.       <table class="memname">
  98.         <tr>
  99.           <td class="memname">Magic::__get </td>
  100.           <td>(</td>
  101.           <td class="paramtype">&#160;</td>
  102.           <td class="paramname"><em>$key</em></td><td>)</td>
  103.           <td></td>
  104.         </tr>
  105.       </table>
  106. </div><div class="memdoc">
  107. <p>Alias for offsetget() </p>
  108. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  109. <dl class="params"><dt>Parameters</dt><dd>
  110.   <table class="params">
  111.     <tr><td class="paramname">$key</td><td>string </td></tr>
  112.   </table>
  113.   </dd>
  114. </dl>
  115.  
  116. </div>
  117. </div>
  118. <a class="anchor" id="a5e02946d9f8d5314fc60c5ff3badd6ef"></a>
  119. <div class="memitem">
  120. <div class="memproto">
  121.       <table class="memname">
  122.         <tr>
  123.           <td class="memname">Magic::__isset </td>
  124.           <td>(</td>
  125.           <td class="paramtype">&#160;</td>
  126.           <td class="paramname"><em>$key</em></td><td>)</td>
  127.           <td></td>
  128.         </tr>
  129.       </table>
  130. </div><div class="memdoc">
  131. <p>Alias for offsetexists() </p>
  132. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  133. <dl class="params"><dt>Parameters</dt><dd>
  134.   <table class="params">
  135.     <tr><td class="paramname">$key</td><td>string </td></tr>
  136.   </table>
  137.   </dd>
  138. </dl>
  139.  
  140. </div>
  141. </div>
  142. <a class="anchor" id="a66319e2327b1fdf7643e3dff9b786495"></a>
  143. <div class="memitem">
  144. <div class="memproto">
  145.       <table class="memname">
  146.         <tr>
  147.           <td class="memname">Magic::__set </td>
  148.           <td>(</td>
  149.           <td class="paramtype">&#160;</td>
  150.           <td class="paramname"><em>$key</em>, </td>
  151.         </tr>
  152.         <tr>
  153.           <td class="paramkey"></td>
  154.           <td></td>
  155.           <td class="paramtype">&#160;</td>
  156.           <td class="paramname"><em>$val</em>&#160;</td>
  157.         </tr>
  158.         <tr>
  159.           <td></td>
  160.           <td>)</td>
  161.           <td></td><td></td>
  162.         </tr>
  163.       </table>
  164. </div><div class="memdoc">
  165. <p>Alias for offsetset() </p>
  166. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  167. <dl class="params"><dt>Parameters</dt><dd>
  168.   <table class="params">
  169.     <tr><td class="paramname">$key</td><td>string </td></tr>
  170.     <tr><td class="paramname">$val</td><td>scalar </td></tr>
  171.   </table>
  172.   </dd>
  173. </dl>
  174.  
  175. </div>
  176. </div>
  177. <a class="anchor" id="a93e1d416a15653d133228111c7b5eb20"></a>
  178. <div class="memitem">
  179. <div class="memproto">
  180.       <table class="memname">
  181.         <tr>
  182.           <td class="memname">Magic::__unset </td>
  183.           <td>(</td>
  184.           <td class="paramtype">&#160;</td>
  185.           <td class="paramname"><em>$key</em></td><td>)</td>
  186.           <td></td>
  187.         </tr>
  188.       </table>
  189. </div><div class="memdoc">
  190. <p>Alias for offsetunset() </p>
  191. <dl class="section return"><dt>Returns</dt><dd>NULL </dd></dl>
  192. <dl class="params"><dt>Parameters</dt><dd>
  193.   <table class="params">
  194.     <tr><td class="paramname">$key</td><td>string </td></tr>
  195.   </table>
  196.   </dd>
  197. </dl>
  198.  
  199. </div>
  200. </div>
  201. <a class="anchor" id="ad9aa6fe25a7c2ed6d90c98e5f517aa78"></a>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="mlabels">
  205.   <tr>
  206.   <td class="mlabels-left">
  207.       <table class="memname">
  208.         <tr>
  209.           <td class="memname">Magic::clear </td>
  210.           <td>(</td>
  211.           <td class="paramtype">&#160;</td>
  212.           <td class="paramname"><em>$key</em></td><td>)</td>
  213.           <td></td>
  214.         </tr>
  215.       </table>
  216.   </td>
  217.   <td class="mlabels-right">
  218. <span class="mlabels"><span class="mlabel">abstract</span></span>  </td>
  219.   </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Unset key </p>
  223. <dl class="section return"><dt>Returns</dt><dd>NULL </dd></dl>
  224. <dl class="params"><dt>Parameters</dt><dd>
  225.   <table class="params">
  226.     <tr><td class="paramname">$key</td><td>string </td></tr>
  227.   </table>
  228.   </dd>
  229. </dl>
  230.  
  231. </div>
  232. </div>
  233. <a class="anchor" id="ad242c359b007dc35794690e744924974"></a>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="mlabels">
  237.   <tr>
  238.   <td class="mlabels-left">
  239.       <table class="memname">
  240.         <tr>
  241.           <td class="memname">Magic::exists </td>
  242.           <td>(</td>
  243.           <td class="paramtype">&#160;</td>
  244.           <td class="paramname"><em>$key</em></td><td>)</td>
  245.           <td></td>
  246.         </tr>
  247.       </table>
  248.   </td>
  249.   <td class="mlabels-right">
  250. <span class="mlabels"><span class="mlabel">abstract</span></span>  </td>
  251.   </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. <p>Return TRUE if key is not empty </p>
  255. <dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
  256. <dl class="params"><dt>Parameters</dt><dd>
  257.   <table class="params">
  258.     <tr><td class="paramname">$key</td><td>string </td></tr>
  259.   </table>
  260.   </dd>
  261. </dl>
  262.  
  263. </div>
  264. </div>
  265. <a class="anchor" id="ab809dfcdbba37cb93b82d526b25f3112"></a>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="mlabels">
  269.   <tr>
  270.   <td class="mlabels-left">
  271.       <table class="memname">
  272.         <tr>
  273.           <td class="memname">Magic::get </td>
  274.           <td>(</td>
  275.           <td class="paramtype">&#160;</td>
  276.           <td class="paramname"><em>$key</em></td><td>)</td>
  277.           <td></td>
  278.         </tr>
  279.       </table>
  280.   </td>
  281.   <td class="mlabels-right">
  282. <span class="mlabels"><span class="mlabel">abstract</span></span>  </td>
  283.   </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>Retrieve contents of key </p>
  287. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  288. <dl class="params"><dt>Parameters</dt><dd>
  289.   <table class="params">
  290.     <tr><td class="paramname">$key</td><td>string </td></tr>
  291.   </table>
  292.   </dd>
  293. </dl>
  294.  
  295. </div>
  296. </div>
  297. <a class="anchor" id="a8146b8fc5ed9a0e30e9612afb9cd8d80"></a>
  298. <div class="memitem">
  299. <div class="memproto">
  300.       <table class="memname">
  301.         <tr>
  302.           <td class="memname">Magic::offsetexists </td>
  303.           <td>(</td>
  304.           <td class="paramtype">&#160;</td>
  305.           <td class="paramname"><em>$key</em></td><td>)</td>
  306.           <td></td>
  307.         </tr>
  308.       </table>
  309. </div><div class="memdoc">
  310. <p>Convenience method for checking property value </p>
  311. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  312. <dl class="params"><dt>Parameters</dt><dd>
  313.   <table class="params">
  314.     <tr><td class="paramname">$key</td><td>string </td></tr>
  315.   </table>
  316.   </dd>
  317. </dl>
  318.  
  319. </div>
  320. </div>
  321. <a class="anchor" id="a91b6f39d7c711d0abe8f66715eaad0f1"></a>
  322. <div class="memitem">
  323. <div class="memproto">
  324.       <table class="memname">
  325.         <tr>
  326.           <td class="memname">Magic::offsetget </td>
  327.           <td>(</td>
  328.           <td class="paramtype">&#160;</td>
  329.           <td class="paramname"><em>$key</em></td><td>)</td>
  330.           <td></td>
  331.         </tr>
  332.       </table>
  333. </div><div class="memdoc">
  334. <p>Convenience method for retrieving property value </p>
  335. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  336. <dl class="params"><dt>Parameters</dt><dd>
  337.   <table class="params">
  338.     <tr><td class="paramname">$key</td><td>string </td></tr>
  339.   </table>
  340.   </dd>
  341. </dl>
  342.  
  343. </div>
  344. </div>
  345. <a class="anchor" id="add3add2badb418eb7712b7b789b6e52b"></a>
  346. <div class="memitem">
  347. <div class="memproto">
  348.       <table class="memname">
  349.         <tr>
  350.           <td class="memname">Magic::offsetset </td>
  351.           <td>(</td>
  352.           <td class="paramtype">&#160;</td>
  353.           <td class="paramname"><em>$key</em>, </td>
  354.         </tr>
  355.         <tr>
  356.           <td class="paramkey"></td>
  357.           <td></td>
  358.           <td class="paramtype">&#160;</td>
  359.           <td class="paramname"><em>$val</em>&#160;</td>
  360.         </tr>
  361.         <tr>
  362.           <td></td>
  363.           <td>)</td>
  364.           <td></td><td></td>
  365.         </tr>
  366.       </table>
  367. </div><div class="memdoc">
  368. <p>Convenience method for assigning property value </p>
  369. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  370. <dl class="params"><dt>Parameters</dt><dd>
  371.   <table class="params">
  372.     <tr><td class="paramname">$key</td><td>string </td></tr>
  373.     <tr><td class="paramname">$val</td><td>scalar </td></tr>
  374.   </table>
  375.   </dd>
  376. </dl>
  377.  
  378. </div>
  379. </div>
  380. <a class="anchor" id="a1bdb5f01422cda7f03c76674cd82812d"></a>
  381. <div class="memitem">
  382. <div class="memproto">
  383.       <table class="memname">
  384.         <tr>
  385.           <td class="memname">Magic::offsetunset </td>
  386.           <td>(</td>
  387.           <td class="paramtype">&#160;</td>
  388.           <td class="paramname"><em>$key</em></td><td>)</td>
  389.           <td></td>
  390.         </tr>
  391.       </table>
  392. </div><div class="memdoc">
  393. <p>Convenience method for checking property value </p>
  394. <dl class="section return"><dt>Returns</dt><dd>NULL </dd></dl>
  395. <dl class="params"><dt>Parameters</dt><dd>
  396.   <table class="params">
  397.     <tr><td class="paramname">$key</td><td>string </td></tr>
  398.   </table>
  399.   </dd>
  400. </dl>
  401.  
  402. </div>
  403. </div>
  404. <a class="anchor" id="af5969f61e6fcb580733fba9302de076a"></a>
  405. <div class="memitem">
  406. <div class="memproto">
  407. <table class="mlabels">
  408.   <tr>
  409.   <td class="mlabels-left">
  410.       <table class="memname">
  411.         <tr>
  412.           <td class="memname">Magic::set </td>
  413.           <td>(</td>
  414.           <td class="paramtype">&#160;</td>
  415.           <td class="paramname"><em>$key</em>, </td>
  416.         </tr>
  417.         <tr>
  418.           <td class="paramkey"></td>
  419.           <td></td>
  420.           <td class="paramtype">&#160;</td>
  421.           <td class="paramname"><em>$val</em>&#160;</td>
  422.         </tr>
  423.         <tr>
  424.           <td></td>
  425.           <td>)</td>
  426.           <td></td><td></td>
  427.         </tr>
  428.       </table>
  429.   </td>
  430.   <td class="mlabels-right">
  431. <span class="mlabels"><span class="mlabel">abstract</span></span>  </td>
  432.   </tr>
  433. </table>
  434. </div><div class="memdoc">
  435. <p>Bind value to key </p>
  436. <dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
  437. <dl class="params"><dt>Parameters</dt><dd>
  438.   <table class="params">
  439.     <tr><td class="paramname">$key</td><td>string </td></tr>
  440.     <tr><td class="paramname">$val</td><td>mixed </td></tr>
  441.   </table>
  442.   </dd>
  443. </dl>
  444.  
  445. </div>
  446. </div>
  447. <hr/>The documentation for this class was generated from the following file:<ul>
  448. <li>magic.php</li>
  449. </ul>
  450. </div><!-- contents -->