class_tools_1_1_restfull_controller.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267
  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: RestfullController Class Reference</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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
  65. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. <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>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><a class="el" href="namespace_tools.html">Tools</a></li><li class="navelem"><a class="el" href="class_tools_1_1_restfull_controller.html">RestfullController</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#pub-methods">Public Member Functions</a> &#124;
  90. <a href="#pri-attribs">Private Attributes</a> </div>
  91. <div class="headertitle">
  92. <div class="title">RestfullController Class Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <div class="dynheader">
  96. Inheritance diagram for RestfullController:</div>
  97. <div class="dyncontent">
  98. <div class="center">
  99. <img src="class_tools_1_1_restfull_controller.png" usemap="#RestfullController_map" alt=""/>
  100. <map id="RestfullController_map" name="RestfullController_map">
  101. <area href="class_tools_1_1_a_controller.html" alt="AController" shape="rect" coords="0,0,109,24"/>
  102. </map>
  103. </div></div>
  104. <table class="memberdecls">
  105. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  106. Public Member Functions</h2></td></tr>
  107. <tr class="memitem:a1abf6cdff8906e6b63e361f00344f7e1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_restfull_controller.html#a1abf6cdff8906e6b63e361f00344f7e1">__construct</a> ($context, $params, $encode_fnc=null)</td></tr>
  108. <tr class="separator:a1abf6cdff8906e6b63e361f00344f7e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:af8fa59992209e36dccb3eefb0f75531f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_restfull_controller.html#af8fa59992209e36dccb3eefb0f75531f">start</a> ()</td></tr>
  110. <tr class="separator:af8fa59992209e36dccb3eefb0f75531f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:afb0fafe7e02a3ae1993c01c19fad2bae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_restfull_controller.html#afb0fafe7e02a3ae1993c01c19fad2bae">run</a> ()</td></tr>
  112. <tr class="separator:afb0fafe7e02a3ae1993c01c19fad2bae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="inherit_header pub_methods_class_tools_1_1_a_controller"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_tools_1_1_a_controller')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_tools_1_1_a_controller.html">AController</a></td></tr>
  114. <tr class="memitem:a7b7ea19d18501d4214fb4dcb274addea inherit pub_methods_class_tools_1_1_a_controller"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_a_controller.html#a7b7ea19d18501d4214fb4dcb274addea">__construct</a> ($context, $params)</td></tr>
  115. <tr class="separator:a7b7ea19d18501d4214fb4dcb274addea inherit pub_methods_class_tools_1_1_a_controller"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:af8fa59992209e36dccb3eefb0f75531f inherit pub_methods_class_tools_1_1_a_controller"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_a_controller.html#af8fa59992209e36dccb3eefb0f75531f">start</a> ()</td></tr>
  117. <tr class="separator:af8fa59992209e36dccb3eefb0f75531f inherit pub_methods_class_tools_1_1_a_controller"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. </table><table class="memberdecls">
  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
  120. Private Attributes</h2></td></tr>
  121. <tr class="memitem:a208675491a46097876bd6f43cf477147"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_restfull_controller.html#a208675491a46097876bd6f43cf477147">$encode_fnc</a></td></tr>
  122. <tr class="separator:a208675491a46097876bd6f43cf477147"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. </table><table class="memberdecls">
  124. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  125. Additional Inherited Members</h2></td></tr>
  126. <tr class="inherit_header pro_attribs_class_tools_1_1_a_controller"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_tools_1_1_a_controller')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_tools_1_1_a_controller.html">AController</a></td></tr>
  127. <tr class="memitem:a21ae116e22adda72b3971dde67f4ef19 inherit pro_attribs_class_tools_1_1_a_controller"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_a_controller.html#a21ae116e22adda72b3971dde67f4ef19">$params</a></td></tr>
  128. <tr class="separator:a21ae116e22adda72b3971dde67f4ef19 inherit pro_attribs_class_tools_1_1_a_controller"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a7c294642225a6c91f5d7932dde75c2ae inherit pro_attribs_class_tools_1_1_a_controller"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_a_controller.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a></td></tr>
  130. <tr class="separator:a7c294642225a6c91f5d7932dde75c2ae inherit pro_attribs_class_tools_1_1_a_controller"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table>
  132. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  133. <div class="textblock"><p>Abstract <a class="el" href="namespace_controller.html">Controller</a> </p>
  134. <p>Definition at line <a class="el" href="_a_restfull_controller_8php_source.html#l00008">8</a> of file <a class="el" href="_a_restfull_controller_8php_source.html">ARestfullController.php</a>.</p>
  135. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  136. <a class="anchor" id="a1abf6cdff8906e6b63e361f00344f7e1"></a>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">__construct </td>
  142. <td>(</td>
  143. <td class="paramtype">&#160;</td>
  144. <td class="paramname"><em>$context</em>, </td>
  145. </tr>
  146. <tr>
  147. <td class="paramkey"></td>
  148. <td></td>
  149. <td class="paramtype">&#160;</td>
  150. <td class="paramname"><em>$params</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>$encode_fnc</em> = <code>null</code>&#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>Definition at line <a class="el" href="_a_restfull_controller_8php_source.html#l00012">12</a> of file <a class="el" href="_a_restfull_controller_8php_source.html">ARestfullController.php</a>.</p>
  166. <div class="fragment"><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; {</div>
  167. <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>
  168. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keywordflow">throw</span> new \Exception\Error404();</div>
  169. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; parent::__construct(<a class="code" href="class_tools_1_1_a_controller.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>, <a class="code" href="class_tools_1_1_a_controller.html#a21ae116e22adda72b3971dde67f4ef19">$params</a>);</div>
  170. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="class_tools_1_1_restfull_controller.html#a208675491a46097876bd6f43cf477147">$encode_fnc</a> === null)</div>
  171. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <a class="code" href="class_tools_1_1_restfull_controller.html#a208675491a46097876bd6f43cf477147">$encode_fnc</a> = 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>
  172. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; $this-&gt;encode_fnc = <a class="code" href="class_tools_1_1_restfull_controller.html#a208675491a46097876bd6f43cf477147">$encode_fnc</a>;</div>
  173. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; }</div>
  174. <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>
  175. <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>
  176. <div class="ttc" id="class_tools_1_1_a_controller_html_a21ae116e22adda72b3971dde67f4ef19"><div class="ttname"><a href="class_tools_1_1_a_controller.html#a21ae116e22adda72b3971dde67f4ef19">Tools\AController\$params</a></div><div class="ttdeci">$params</div><div class="ttdef"><b>Definition:</b> <a href="_a_controller_8php_source.html#l00018">AController.php:18</a></div></div>
  177. <div class="ttc" id="class_tools_1_1_a_controller_html_a7c294642225a6c91f5d7932dde75c2ae"><div class="ttname"><a href="class_tools_1_1_a_controller.html#a7c294642225a6c91f5d7932dde75c2ae">Tools\AController\$context</a></div><div class="ttdeci">$context</div><div class="ttdef"><b>Definition:</b> <a href="_a_controller_8php_source.html#l00023">AController.php:23</a></div></div>
  178. </div><!-- fragment -->
  179. </div>
  180. </div>
  181. <h2 class="groupheader">Member Function Documentation</h2>
  182. <a class="anchor" id="afb0fafe7e02a3ae1993c01c19fad2bae"></a>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="mlabels">
  186. <tr>
  187. <td class="mlabels-left">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">run </td>
  191. <td>(</td>
  192. <td class="paramname"></td><td>)</td>
  193. <td></td>
  194. </tr>
  195. </table>
  196. </td>
  197. <td class="mlabels-right">
  198. <span class="mlabels"><span class="mlabel">abstract</span></span> </td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. </div>
  203. </div>
  204. <a class="anchor" id="af8fa59992209e36dccb3eefb0f75531f"></a>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">start </td>
  210. <td>(</td>
  211. <td class="paramname"></td><td>)</td>
  212. <td></td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Definition at line <a class="el" href="_a_restfull_controller_8php_source.html#l00022">22</a> of file <a class="el" href="_a_restfull_controller_8php_source.html">ARestfullController.php</a>.</p>
  217. <div class="fragment"><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; {</div>
  218. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="comment">//TODO call some hooks</span></div>
  219. <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>
  220. <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;<a class="code" href="class_tools_1_1_restfull_controller.html#afb0fafe7e02a3ae1993c01c19fad2bae">run</a>());</div>
  221. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="comment">//TODO call some hooks</span></div>
  222. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; }</div>
  223. <div class="ttc" id="class_tools_1_1_restfull_controller_html_afb0fafe7e02a3ae1993c01c19fad2bae"><div class="ttname"><a href="class_tools_1_1_restfull_controller.html#afb0fafe7e02a3ae1993c01c19fad2bae">Tools\RestfullController\run</a></div><div class="ttdeci">run()</div></div>
  224. </div><!-- fragment -->
  225. </div>
  226. </div>
  227. <h2 class="groupheader">Field Documentation</h2>
  228. <a class="anchor" id="a208675491a46097876bd6f43cf477147"></a>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="mlabels">
  232. <tr>
  233. <td class="mlabels-left">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">$encode_fnc</td>
  237. </tr>
  238. </table>
  239. </td>
  240. <td class="mlabels-right">
  241. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. <p>Definition at line <a class="el" href="_a_restfull_controller_8php_source.html#l00010">10</a> of file <a class="el" href="_a_restfull_controller_8php_source.html">ARestfullController.php</a>.</p>
  246. </div>
  247. </div>
  248. <hr/>The documentation for this class was generated from the following file:<ul>
  249. <li>core/tools/<a class="el" href="_a_restfull_controller_8php_source.html">ARestfullController.php</a></li>
  250. </ul>
  251. </div><!-- contents -->
  252. <!-- start footer part -->
  253. <hr class="footer"/><address class="footer"><small>
  254. Generated on Sun Aug 16 2015 21:56:15 for ecom by &#160;<a href="http://www.doxygen.org/index.html">
  255. <img class="footer" src="doxygen.png" alt="doxygen"/>
  256. </a> 1.8.8
  257. </small></address>
  258. </body>
  259. </html>