_a_restfull_controller_8php_source.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.8"/>
  7. <title>ecom: core/tools/ARestfullController.php Source File</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">ecom
  26. </div>
  27. <div id="projectbrief">E-commerce cms</div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.8 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  42. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li class="current"><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="files.html"><span>File&#160;List</span></a></li>
  65. <li><a href="globals.html"><span>Globals</span></a></li>
  66. </ul>
  67. </div>
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a></div>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. <div id="nav-path" class="navpath">
  81. <ul>
  82. <li class="navelem"><a class="el" href="dir_4270bfced15e0e73154b13468c7c9ad9.html">core</a></li><li class="navelem"><a class="el" href="dir_dff40b844157c216598c968cb799cc0b.html">tools</a></li> </ul>
  83. </div>
  84. </div><!-- top -->
  85. <div class="header">
  86. <div class="headertitle">
  87. <div class="title">ARestfullController.php</div> </div>
  88. </div><!--header-->
  89. <div class="contents">
  90. <a href="_a_restfull_controller_8php.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;&lt;?php</div>
  91. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;</div>
  92. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_tools.html">Tools</a>;</div>
  93. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div>
  94. <div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="class_tools_1_1_restfull_controller.html"> 8</a></span>&#160;<span class="keyword">abstract</span> <span class="keyword">class </span><a class="code" href="class_tools_1_1_restfull_controller.html">RestfullController</a> <span class="keyword">extends</span> <a class="code" href="class_tools_1_1_a_controller.html">AController</a></div>
  95. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;{</div>
  96. <div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="class_tools_1_1_restfull_controller.html#a208675491a46097876bd6f43cf477147"> 10</a></span>&#160; <span class="keyword">private</span> <a class="code" href="class_tools_1_1_restfull_controller.html#a208675491a46097876bd6f43cf477147">$encode_fnc</a>;</div>
  97. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div>
  98. <div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="class_tools_1_1_restfull_controller.html#a1abf6cdff8906e6b63e361f00344f7e1"> 12</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_restfull_controller.html#a1abf6cdff8906e6b63e361f00344f7e1">__construct</a>($context, $params, $encode_fnc = null)</div>
  99. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; {</div>
  100. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <span class="keywordflow">if</span> (!\<a class="code" href="namespace_entity.html">Entity</a>\Config::getConfig(null, <span class="stringliteral">&quot;restfullEnabled&quot;</span>, <span class="keyword">false</span>))</div>
  101. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keywordflow">throw</span> new \Exception\Error404();</div>
  102. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; parent::__construct($context, $params);</div>
  103. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keywordflow">if</span> ($encode_fnc === null)</div>
  104. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; $encode_fnc = array(<span class="stringliteral">&quot;method&quot;</span> =&gt; json_encode, <span class="stringliteral">&quot;mime&quot;</span> =&gt; <span class="stringliteral">&quot;application/json&quot;</span>);</div>
  105. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; $this-&gt;encode_fnc = $encode_fnc;</div>
  106. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; }</div>
  107. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
  108. <div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="class_tools_1_1_restfull_controller.html#af8fa59992209e36dccb3eefb0f75531f"> 22</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_restfull_controller.html#af8fa59992209e36dccb3eefb0f75531f">start</a>()</div>
  109. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; {</div>
  110. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="comment">//TODO call some hooks</span></div>
  111. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; header(<span class="stringliteral">&quot;Content-Type: {$this-&gt;encode_fnc[&quot;</span>mime<span class="stringliteral">&quot;]}&quot;</span>);</div>
  112. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; echo $this-&gt;encode_fnc[<span class="stringliteral">&quot;method&quot;</span>]($this-&gt;run());</div>
  113. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="comment">//TODO call some hooks</span></div>
  114. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; }</div>
  115. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
  116. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">abstract</span> <span class="keyword">public</span> <span class="keyword">function</span> run();</div>
  117. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;}</div>
  118. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
  119. <div class="ttc" id="class_tools_1_1_restfull_controller_html_a1abf6cdff8906e6b63e361f00344f7e1"><div class="ttname"><a href="class_tools_1_1_restfull_controller.html#a1abf6cdff8906e6b63e361f00344f7e1">Tools\RestfullController\__construct</a></div><div class="ttdeci">__construct($context, $params, $encode_fnc=null)</div><div class="ttdef"><b>Definition:</b> <a href="_a_restfull_controller_8php_source.html#l00012">ARestfullController.php:12</a></div></div>
  120. <div class="ttc" id="namespace_entity_html"><div class="ttname"><a href="namespace_entity.html">Entity</a></div><div class="ttdef"><b>Definition:</b> <a href="_address_8php_source.html#l00003">Address.php:3</a></div></div>
  121. <div class="ttc" id="class_tools_1_1_restfull_controller_html_a208675491a46097876bd6f43cf477147"><div class="ttname"><a href="class_tools_1_1_restfull_controller.html#a208675491a46097876bd6f43cf477147">Tools\RestfullController\$encode_fnc</a></div><div class="ttdeci">$encode_fnc</div><div class="ttdef"><b>Definition:</b> <a href="_a_restfull_controller_8php_source.html#l00010">ARestfullController.php:10</a></div></div>
  122. <div class="ttc" id="class_tools_1_1_restfull_controller_html"><div class="ttname"><a href="class_tools_1_1_restfull_controller.html">Tools\RestfullController</a></div><div class="ttdef"><b>Definition:</b> <a href="_a_restfull_controller_8php_source.html#l00008">ARestfullController.php:8</a></div></div>
  123. <div class="ttc" id="namespace_tools_html"><div class="ttname"><a href="namespace_tools.html">Tools</a></div><div class="ttdef"><b>Definition:</b> <a href="_a_controller_8php_source.html#l00003">AController.php:3</a></div></div>
  124. <div class="ttc" id="class_tools_1_1_a_controller_html"><div class="ttname"><a href="class_tools_1_1_a_controller.html">Tools\AController</a></div><div class="ttdef"><b>Definition:</b> <a href="_a_controller_8php_source.html#l00008">AController.php:8</a></div></div>
  125. <div class="ttc" id="class_tools_1_1_restfull_controller_html_af8fa59992209e36dccb3eefb0f75531f"><div class="ttname"><a href="class_tools_1_1_restfull_controller.html#af8fa59992209e36dccb3eefb0f75531f">Tools\RestfullController\start</a></div><div class="ttdeci">start()</div><div class="ttdef"><b>Definition:</b> <a href="_a_restfull_controller_8php_source.html#l00022">ARestfullController.php:22</a></div></div>
  126. </div><!-- fragment --></div><!-- contents -->
  127. <!-- start footer part -->
  128. <hr class="footer"/><address class="footer"><small>
  129. Generated on Sun Aug 16 2015 15:52:07 for ecom by &#160;<a href="http://www.doxygen.org/index.html">
  130. <img class="footer" src="doxygen.png" alt="doxygen"/>
  131. </a> 1.8.8
  132. </small></address>
  133. </body>
  134. </html>