class_tools_1_1_a_controller.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  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: AController 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_a_controller.html">AController</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="#pro-attribs">Protected Attributes</a> </div>
  91. <div class="headertitle">
  92. <div class="title">AController Class Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <div class="dynheader">
  96. Inheritance diagram for AController:</div>
  97. <div class="dyncontent">
  98. <div class="center">
  99. <img src="class_tools_1_1_a_controller.png" usemap="#AController_map" alt=""/>
  100. <map id="AController_map" name="AController_map">
  101. <area href="class_controller_1_1_error404.html" alt="Error404" shape="rect" coords="0,56,120,80"/>
  102. <area href="class_controller_1_1_product_controller.html" alt="ProductController" shape="rect" coords="130,56,250,80"/>
  103. <area href="class_tools_1_1_a_http_controller.html" alt="AHttpController" shape="rect" coords="260,56,380,80"/>
  104. <area href="class_tools_1_1_restfull_controller.html" alt="RestfullController" shape="rect" coords="390,56,510,80"/>
  105. <area href="class_controller_1_1_category_controller.html" alt="CategoryController" shape="rect" coords="195,112,315,136"/>
  106. <area href="class_controller_1_1_home_controller.html" alt="HomeController" shape="rect" coords="325,112,445,136"/>
  107. </map>
  108. </div></div>
  109. <table class="memberdecls">
  110. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  111. Public Member Functions</h2></td></tr>
  112. <tr class="memitem:a7b7ea19d18501d4214fb4dcb274addea"><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>
  113. <tr class="separator:a7b7ea19d18501d4214fb4dcb274addea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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_a_controller.html#af8fa59992209e36dccb3eefb0f75531f">start</a> ()</td></tr>
  115. <tr class="separator:af8fa59992209e36dccb3eefb0f75531f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. </table><table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  118. Protected Attributes</h2></td></tr>
  119. <tr class="memitem:a21ae116e22adda72b3971dde67f4ef19"><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>
  120. <tr class="separator:a21ae116e22adda72b3971dde67f4ef19"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table>
  122. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  123. <div class="textblock"><p><a class="el" href="namespace_controller.html">Controller</a> abstract class </p>
  124. <p>Definition at line <a class="el" href="_a_controller_8php_source.html#l00008">8</a> of file <a class="el" href="_a_controller_8php_source.html">AController.php</a>.</p>
  125. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  126. <a class="anchor" id="a7b7ea19d18501d4214fb4dcb274addea"></a>
  127. <div class="memitem">
  128. <div class="memproto">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname">__construct </td>
  132. <td>(</td>
  133. <td class="paramtype">&#160;</td>
  134. <td class="paramname"><em>$context</em>, </td>
  135. </tr>
  136. <tr>
  137. <td class="paramkey"></td>
  138. <td></td>
  139. <td class="paramtype">&#160;</td>
  140. <td class="paramname"><em>$params</em>&#160;</td>
  141. </tr>
  142. <tr>
  143. <td></td>
  144. <td>)</td>
  145. <td></td><td></td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <dl class="params"><dt>Parameters</dt><dd>
  150. <table class="params">
  151. <tr><td class="paramtype">\Tools\Context</td><td class="paramname">$context</td><td></td></tr>
  152. <tr><td class="paramtype">array</td><td class="paramname">$params</td><td></td></tr>
  153. </table>
  154. </dd>
  155. </dl>
  156. <dl class="exception"><dt>Exceptions</dt><dd>
  157. <table class="exception">
  158. <tr><td class="paramname"></td><td>Exception if parameters does not correspond On 404 error, router will try to find another route Initialize structure </td></tr>
  159. </table>
  160. </dd>
  161. </dl>
  162. <p>Definition at line <a class="el" href="_a_controller_8php_source.html#l00027">27</a> of file <a class="el" href="_a_controller_8php_source.html">AController.php</a>.</p>
  163. <div class="fragment"><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div>
  164. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; $this-&gt;params = <a class="code" href="class_tools_1_1_a_controller.html#a21ae116e22adda72b3971dde67f4ef19">$params</a>;</div>
  165. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; }</div>
  166. <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>
  167. </div><!-- fragment -->
  168. </div>
  169. </div>
  170. <h2 class="groupheader">Member Function Documentation</h2>
  171. <a class="anchor" id="af8fa59992209e36dccb3eefb0f75531f"></a>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="mlabels">
  175. <tr>
  176. <td class="mlabels-left">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">start </td>
  180. <td>(</td>
  181. <td class="paramname"></td><td>)</td>
  182. <td></td>
  183. </tr>
  184. </table>
  185. </td>
  186. <td class="mlabels-right">
  187. <span class="mlabels"><span class="mlabel">abstract</span></span> </td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>Fullfill <a class="el" href="namespace_controller.html">Controller</a>'s request </p>
  192. </div>
  193. </div>
  194. <h2 class="groupheader">Field Documentation</h2>
  195. <a class="anchor" id="a21ae116e22adda72b3971dde67f4ef19"></a>
  196. <div class="memitem">
  197. <div class="memproto">
  198. <table class="mlabels">
  199. <tr>
  200. <td class="mlabels-left">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">array $params</td>
  204. </tr>
  205. </table>
  206. </td>
  207. <td class="mlabels-right">
  208. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. <p>Contains route parameter ex: /product/:id will contains { 0 =&gt; product 1 =&gt; [ID] ':id' =&gt; [ID] </p>
  213. <p>Definition at line <a class="el" href="_a_controller_8php_source.html#l00018">18</a> of file <a class="el" href="_a_controller_8php_source.html">AController.php</a>.</p>
  214. </div>
  215. </div>
  216. <hr/>The documentation for this class was generated from the following file:<ul>
  217. <li>core/tools/<a class="el" href="_a_controller_8php_source.html">AController.php</a></li>
  218. </ul>
  219. </div><!-- contents -->
  220. <!-- start footer part -->
  221. <hr class="footer"/><address class="footer"><small>
  222. Generated on Sun Aug 16 2015 15:52:07 for ecom by &#160;<a href="http://www.doxygen.org/index.html">
  223. <img class="footer" src="doxygen.png" alt="doxygen"/>
  224. </a> 1.8.8
  225. </small></address>
  226. </body>
  227. </html>