class_tools_1_1_router.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672
  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: Router 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_router.html">Router</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-methods">Private Member Functions</a> &#124;
  91. <a href="#pri-attribs">Private Attributes</a> </div>
  92. <div class="headertitle">
  93. <div class="title">Router Class Reference</div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  98. Public Member Functions</h2></td></tr>
  99. <tr class="memitem:a2e9488ba4915c293adea1fd7933de39b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#a2e9488ba4915c293adea1fd7933de39b">__construct</a> ($server, $context)</td></tr>
  100. <tr class="separator:a2e9488ba4915c293adea1fd7933de39b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a2d1b9c00619ae1b43fa06167ab04cc7b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#a2d1b9c00619ae1b43fa06167ab04cc7b">init</a> ($server)</td></tr>
  102. <tr class="separator:a2d1b9c00619ae1b43fa06167ab04cc7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a4001f7ed8b89fa23b5b1c77c8e320262"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#a4001f7ed8b89fa23b5b1c77c8e320262">serveUrl</a> ()</td></tr>
  104. <tr class="separator:a4001f7ed8b89fa23b5b1c77c8e320262"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:aaba248f1b462a6b58536ee8c2a835054"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#aaba248f1b462a6b58536ee8c2a835054">routeAdd</a> ($route, $controller)</td></tr>
  106. <tr class="separator:aaba248f1b462a6b58536ee8c2a835054"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a4537dad3b44254124991341cc91b28fb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#a4537dad3b44254124991341cc91b28fb">__get</a> ($key)</td></tr>
  108. <tr class="separator:a4537dad3b44254124991341cc91b28fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. </table><table class="memberdecls">
  110. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
  111. Private Member Functions</h2></td></tr>
  112. <tr class="memitem:ac721ad55028ff6c8fd3c006570fc475e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#ac721ad55028ff6c8fd3c006570fc475e">createController</a> ($className, $params)</td></tr>
  113. <tr class="separator:ac721ad55028ff6c8fd3c006570fc475e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:aca9c4092ad41ef8f6db2c3ca579a1a47"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#aca9c4092ad41ef8f6db2c3ca579a1a47">routeMatch</a> ($request, $route)</td></tr>
  115. <tr class="separator:aca9c4092ad41ef8f6db2c3ca579a1a47"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a5203c224e8eb5fc1072a980c264d33c1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#a5203c224e8eb5fc1072a980c264d33c1">prepareUrl</a> ()</td></tr>
  117. <tr class="separator:a5203c224e8eb5fc1072a980c264d33c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a3dc609b3f27a881888ccf4a8c2df6ff4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#a3dc609b3f27a881888ccf4a8c2df6ff4">doRouteAdd</a> ($route, $controller)</td></tr>
  119. <tr class="separator:a3dc609b3f27a881888ccf4a8c2df6ff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table><table class="memberdecls">
  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
  122. Private Attributes</h2></td></tr>
  123. <tr class="memitem:abaa9f54c924a22e8c0169f443efd1055"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#abaa9f54c924a22e8c0169f443efd1055">$rootPath</a></td></tr>
  124. <tr class="separator:abaa9f54c924a22e8c0169f443efd1055"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a0de279007713709c32cdf155ad3c63cd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#a0de279007713709c32cdf155ad3c63cd">$rootUrl</a></td></tr>
  126. <tr class="separator:a0de279007713709c32cdf155ad3c63cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:acbb09e02c973fc56c7395cc5b9a85123"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#acbb09e02c973fc56c7395cc5b9a85123">$requestUrl</a></td></tr>
  128. <tr class="separator:acbb09e02c973fc56c7395cc5b9a85123"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a8f7eb04a54e0f0bfc0cedeb9899ce4a8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#a8f7eb04a54e0f0bfc0cedeb9899ce4a8">$routes</a></td></tr>
  130. <tr class="separator:a8f7eb04a54e0f0bfc0cedeb9899ce4a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a7c294642225a6c91f5d7932dde75c2ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a></td></tr>
  132. <tr class="separator:a7c294642225a6c91f5d7932dde75c2ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:ad167d71585142809d420fe2a3b66d56c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#ad167d71585142809d420fe2a3b66d56c">$routeParams</a></td></tr>
  134. <tr class="separator:ad167d71585142809d420fe2a3b66d56c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table>
  136. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  137. <div class="textblock"><p>Will manager new connections to the server and try to match the requests and the controllers </p>
  138. <p>Definition at line <a class="el" href="_router_8php_source.html#l00009">9</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  139. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  140. <a class="anchor" id="a2e9488ba4915c293adea1fd7933de39b"></a>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">__construct </td>
  146. <td>(</td>
  147. <td class="paramtype">&#160;</td>
  148. <td class="paramname"><em>$server</em>, </td>
  149. </tr>
  150. <tr>
  151. <td class="paramkey"></td>
  152. <td></td>
  153. <td class="paramtype">&#160;</td>
  154. <td class="paramname"><em>$context</em>&#160;</td>
  155. </tr>
  156. <tr>
  157. <td></td>
  158. <td>)</td>
  159. <td></td><td></td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. <p>Create the router, initialize url and path </p>
  164. <p>Definition at line <a class="el" href="_router_8php_source.html#l00076">76</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  165. <div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; {</div>
  166. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; $pos = strrpos($server[<span class="stringliteral">&quot;SCRIPT_NAME&quot;</span>], <span class="stringliteral">&quot;/&quot;</span>);</div>
  167. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; $relativePath = (($pos === FALSE) ? <span class="stringliteral">&quot;&quot;</span> : substr($server[<span class="stringliteral">&quot;SCRIPT_NAME&quot;</span>], 0, $pos));</div>
  168. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; $this-&gt;rootPath = $server[<span class="stringliteral">&quot;DOCUMENT_ROOT&quot;</span>] . $relativePath . <span class="stringliteral">&quot;/&quot;</span>;</div>
  169. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; $this-&gt;rootUrl = $server[<span class="stringliteral">&quot;REQUEST_SCHEME&quot;</span>] . <span class="stringliteral">&quot;://&quot;</span> . $server[<span class="stringliteral">&quot;HTTP_HOST&quot;</span>] . $relativePath .<span class="stringliteral">&quot;/&quot;</span>;</div>
  170. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; $this-&gt;requestUrl = substr($server[<span class="stringliteral">&quot;REQUEST_URI&quot;</span>], count($this-&gt;rootUrl) -1);</div>
  171. <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; $this-&gt;context = <a class="code" href="class_tools_1_1_router.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>;</div>
  172. <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; $this-&gt;routes = array();</div>
  173. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; }</div>
  174. <div class="ttc" id="class_tools_1_1_router_html_a7c294642225a6c91f5d7932dde75c2ae"><div class="ttname"><a href="class_tools_1_1_router.html#a7c294642225a6c91f5d7932dde75c2ae">Tools\Router\$context</a></div><div class="ttdeci">$context</div><div class="ttdef"><b>Definition:</b> <a href="_router_8php_source.html#l00041">Router.php:41</a></div></div>
  175. </div><!-- fragment -->
  176. </div>
  177. </div>
  178. <h2 class="groupheader">Member Function Documentation</h2>
  179. <a class="anchor" id="a4537dad3b44254124991341cc91b28fb"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">__get </td>
  185. <td>(</td>
  186. <td class="paramtype">&#160;</td>
  187. <td class="paramname"><em>$key</em></td><td>)</td>
  188. <td></td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>Getter </p>
  193. <p>Definition at line <a class="el" href="_router_8php_source.html#l00219">219</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  194. <div class="fragment"><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160; {</div>
  195. <div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; <span class="keywordflow">switch</span> ($key)</div>
  196. <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; {</div>
  197. <div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;rootPath&quot;</span>: <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_router.html#abaa9f54c924a22e8c0169f443efd1055">$this-&gt;rootPath</a>; <span class="keywordflow">break</span>;</div>
  198. <div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;rootUrl&quot;</span>: <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_router.html#a0de279007713709c32cdf155ad3c63cd">$this-&gt;rootUrl</a>; <span class="keywordflow">break</span>;</div>
  199. <div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;modulesPath&quot;</span>: <span class="keywordflow">return</span> $this-&gt;rootPath.<span class="stringliteral">&quot;content/modules/&quot;</span>; <span class="keywordflow">break</span>;</div>
  200. <div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;modulesUrl&quot;</span>: <span class="keywordflow">return</span> $this-&gt;rootUrl.<span class="stringliteral">&quot;content/modules/&quot;</span>; <span class="keywordflow">break</span>;</div>
  201. <div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;themesPath&quot;</span>: <span class="keywordflow">return</span> $this-&gt;rootPath.<span class="stringliteral">&quot;content/theme/&quot;</span>; <span class="keywordflow">break</span>;</div>
  202. <div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;themesUrl&quot;</span>: <span class="keywordflow">return</span> $this-&gt;rootUrl.<span class="stringliteral">&quot;content/theme/&quot;</span>; <span class="keywordflow">break</span>;</div>
  203. <div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; }</div>
  204. <div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; <span class="keywordflow">throw</span> new \Exception(<span class="stringliteral">&quot;Cannot access attribute {$key}&quot;</span>);</div>
  205. <div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; }</div>
  206. <div class="ttc" id="class_tools_1_1_router_html_abaa9f54c924a22e8c0169f443efd1055"><div class="ttname"><a href="class_tools_1_1_router.html#abaa9f54c924a22e8c0169f443efd1055">Tools\Router\$rootPath</a></div><div class="ttdeci">$rootPath</div><div class="ttdef"><b>Definition:</b> <a href="_router_8php_source.html#l00016">Router.php:16</a></div></div>
  207. <div class="ttc" id="class_tools_1_1_router_html_a0de279007713709c32cdf155ad3c63cd"><div class="ttname"><a href="class_tools_1_1_router.html#a0de279007713709c32cdf155ad3c63cd">Tools\Router\$rootUrl</a></div><div class="ttdeci">$rootUrl</div><div class="ttdef"><b>Definition:</b> <a href="_router_8php_source.html#l00023">Router.php:23</a></div></div>
  208. </div><!-- fragment -->
  209. </div>
  210. </div>
  211. <a class="anchor" id="ac721ad55028ff6c8fd3c006570fc475e"></a>
  212. <div class="memitem">
  213. <div class="memproto">
  214. <table class="mlabels">
  215. <tr>
  216. <td class="mlabels-left">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname">createController </td>
  220. <td>(</td>
  221. <td class="paramtype">&#160;</td>
  222. <td class="paramname"><em>$className</em>, </td>
  223. </tr>
  224. <tr>
  225. <td class="paramkey"></td>
  226. <td></td>
  227. <td class="paramtype">&#160;</td>
  228. <td class="paramname"><em>$params</em>&#160;</td>
  229. </tr>
  230. <tr>
  231. <td></td>
  232. <td>)</td>
  233. <td></td><td></td>
  234. </tr>
  235. </table>
  236. </td>
  237. <td class="mlabels-right">
  238. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Create and return <a class="el" href="namespace_controller.html">Controller</a> for the given route </p><dl class="params"><dt>Parameters</dt><dd>
  243. <table class="params">
  244. <tr><td class="paramtype"></td><td class="paramname">$className</td><td></td></tr>
  245. <tr><td class="paramtype">array</td><td class="paramname">$routeParameters</td><td></td></tr>
  246. </table>
  247. </dd>
  248. </dl>
  249. <dl class="section return"><dt>Returns</dt><dd>on succes, false otherwise </dd></dl>
  250. <p>Definition at line <a class="el" href="_router_8php_source.html#l00132">132</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  251. <div class="fragment"><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; {</div>
  252. <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordflow">if</span> (!class_exists($className))</div>
  253. <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  254. <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keywordflow">try</span></div>
  255. <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; {</div>
  256. <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; $this-&gt;routeParams = $params;</div>
  257. <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; $result = <span class="keyword">new</span> $className($this-&gt;context, $params);</div>
  258. <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; }</div>
  259. <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keywordflow">catch</span> (\<a class="code" href="namespace_exception.html">Exception</a>\Error404 $e)</div>
  260. <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; {</div>
  261. <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  262. <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; }</div>
  263. <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keywordflow">if</span> (!($result instanceof \<a class="code" href="namespace_tools.html">Tools</a>\AController))</div>
  264. <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  265. <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keywordflow">return</span> $result;</div>
  266. <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; }</div>
  267. <div class="ttc" id="namespace_exception_html"><div class="ttname"><a href="namespace_exception.html">Exception</a></div><div class="ttdef"><b>Definition:</b> <a href="_error404_8php_source.html#l00003">Error404.php:3</a></div></div>
  268. <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>
  269. </div><!-- fragment -->
  270. </div>
  271. </div>
  272. <a class="anchor" id="a3dc609b3f27a881888ccf4a8c2df6ff4"></a>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="mlabels">
  276. <tr>
  277. <td class="mlabels-left">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">doRouteAdd </td>
  281. <td>(</td>
  282. <td class="paramtype">&#160;</td>
  283. <td class="paramname"><em>$route</em>, </td>
  284. </tr>
  285. <tr>
  286. <td class="paramkey"></td>
  287. <td></td>
  288. <td class="paramtype">&#160;</td>
  289. <td class="paramname"><em>$controller</em>&#160;</td>
  290. </tr>
  291. <tr>
  292. <td></td>
  293. <td>)</td>
  294. <td></td><td></td>
  295. </tr>
  296. </table>
  297. </td>
  298. <td class="mlabels-right">
  299. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  300. </tr>
  301. </table>
  302. </div><div class="memdoc">
  303. <p>Add a route to the internal route list Internal procedure </p>
  304. <p>Definition at line <a class="el" href="_router_8php_source.html#l00194">194</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  305. <div class="fragment"><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; {</div>
  306. <div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; $this-&gt;routes[] = array($route, $controller);</div>
  307. <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; }</div>
  308. </div><!-- fragment -->
  309. </div>
  310. </div>
  311. <a class="anchor" id="a2d1b9c00619ae1b43fa06167ab04cc7b"></a>
  312. <div class="memitem">
  313. <div class="memproto">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname">init </td>
  317. <td>(</td>
  318. <td class="paramtype">&#160;</td>
  319. <td class="paramname"><em>$server</em></td><td>)</td>
  320. <td></td>
  321. </tr>
  322. </table>
  323. </div><div class="memdoc">
  324. <p>Called after database initialization Check the site url and redirect user if the HOST does not match If the site url is not defined in database, do not redirect </p>
  325. <p>Definition at line <a class="el" href="_router_8php_source.html#l00092">92</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  326. <div class="fragment"><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; {</div>
  327. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; $siteUrl = <a class="code" href="class_entity_1_1_config.html#af66f143ec797389e3ade6952ef7808e2">\Entity\Config::getConfig</a>(null, <span class="stringliteral">&quot;siteUrl&quot;</span>);</div>
  328. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordflow">if</span> ($siteUrl != $server[<span class="stringliteral">&quot;HTTP_HOST&quot;</span>] &amp;&amp; $siteUrl !== null)</div>
  329. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; {</div>
  330. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; header(<span class="stringliteral">&quot;location: http://{$siteUrl}{$server[&#39;REQUEST_URI&#39;]}&quot;</span>);</div>
  331. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; die;</div>
  332. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; }</div>
  333. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; }</div>
  334. <div class="ttc" id="class_entity_1_1_config_html_af66f143ec797389e3ade6952ef7808e2"><div class="ttname"><a href="class_entity_1_1_config.html#af66f143ec797389e3ade6952ef7808e2">Entity\Config\getConfig</a></div><div class="ttdeci">static getConfig($lang=null, $key=null, $defaultValue=null)</div><div class="ttdef"><b>Definition:</b> <a href="_config_8php_source.html#l00023">Config.php:23</a></div></div>
  335. </div><!-- fragment -->
  336. </div>
  337. </div>
  338. <a class="anchor" id="a5203c224e8eb5fc1072a980c264d33c1"></a>
  339. <div class="memitem">
  340. <div class="memproto">
  341. <table class="mlabels">
  342. <tr>
  343. <td class="mlabels-left">
  344. <table class="memname">
  345. <tr>
  346. <td class="memname">prepareUrl </td>
  347. <td>(</td>
  348. <td class="paramname"></td><td>)</td>
  349. <td></td>
  350. </tr>
  351. </table>
  352. </td>
  353. <td class="mlabels-right">
  354. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  355. </tr>
  356. </table>
  357. </div><div class="memdoc">
  358. <p>Append local routes to router Will load CMS pages, categories page, products page, cart pages, etc. </p>
  359. <p>Definition at line <a class="el" href="_router_8php_source.html#l00182">182</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  360. <div class="fragment"><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; {</div>
  361. <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; $fetcher = new \Entity\Cms();</div>
  362. <div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; $pages = $fetcher-&gt;selects(null, array(<span class="stringliteral">&quot;order&quot;</span>));</div>
  363. <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; <span class="keywordflow">foreach</span> ($pages as $i)</div>
  364. <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; $this-&gt;<a class="code" href="class_tools_1_1_router.html#a3dc609b3f27a881888ccf4a8c2df6ff4">doRouteAdd</a>($i-&gt;shurl, $i-&gt;controller);</div>
  365. <div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; }</div>
  366. <div class="ttc" id="class_tools_1_1_router_html_a3dc609b3f27a881888ccf4a8c2df6ff4"><div class="ttname"><a href="class_tools_1_1_router.html#a3dc609b3f27a881888ccf4a8c2df6ff4">Tools\Router\doRouteAdd</a></div><div class="ttdeci">doRouteAdd($route, $controller)</div><div class="ttdef"><b>Definition:</b> <a href="_router_8php_source.html#l00194">Router.php:194</a></div></div>
  367. </div><!-- fragment -->
  368. </div>
  369. </div>
  370. <a class="anchor" id="aaba248f1b462a6b58536ee8c2a835054"></a>
  371. <div class="memitem">
  372. <div class="memproto">
  373. <table class="memname">
  374. <tr>
  375. <td class="memname">routeAdd </td>
  376. <td>(</td>
  377. <td class="paramtype">&#160;</td>
  378. <td class="paramname"><em>$route</em>, </td>
  379. </tr>
  380. <tr>
  381. <td class="paramkey"></td>
  382. <td></td>
  383. <td class="paramtype">&#160;</td>
  384. <td class="paramname"><em>$controller</em>&#160;</td>
  385. </tr>
  386. <tr>
  387. <td></td>
  388. <td>)</td>
  389. <td></td><td></td>
  390. </tr>
  391. </table>
  392. </div><div class="memdoc">
  393. <dl class="params"><dt>Parameters</dt><dd>
  394. <table class="params">
  395. <tr><td class="paramtype">string</td><td class="paramname">$route</td><td>Uri to match the controller Uri can be formatted as '/:param/static'. expl. '/product/:id/' </td></tr>
  396. <tr><td class="paramtype">string</td><td class="paramname">$controller</td><td><a class="el" href="namespace_controller.html">Controller</a> class name. new $controller() MUST return a instance</td></tr>
  397. </table>
  398. </dd>
  399. </dl>
  400. <p>Add a route and a <a class="el" href="namespace_controller.html">Controller</a> to the list Can only be called from `routerSetup' hook </p>
  401. <p>Definition at line <a class="el" href="_router_8php_source.html#l00209">209</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  402. <div class="fragment"><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; {</div>
  403. <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; <span class="keywordflow">if</span> (!$this-&gt;context-&gt;hookManager-&gt;isInHook(<span class="stringliteral">&quot;routerSetup&quot;</span>))</div>
  404. <div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; <span class="keywordflow">throw</span> <span class="keyword">new</span> \<a class="code" href="namespace_exception.html">Exception</a>(<span class="stringliteral">&quot;You can only add routes from `routerSetup&#39; hook&quot;</span>);</div>
  405. <div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; $this-&gt;<a class="code" href="class_tools_1_1_router.html#a3dc609b3f27a881888ccf4a8c2df6ff4">doRouteAdd</a>($route, $controller);</div>
  406. <div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160; }</div>
  407. <div class="ttc" id="class_tools_1_1_router_html_a3dc609b3f27a881888ccf4a8c2df6ff4"><div class="ttname"><a href="class_tools_1_1_router.html#a3dc609b3f27a881888ccf4a8c2df6ff4">Tools\Router\doRouteAdd</a></div><div class="ttdeci">doRouteAdd($route, $controller)</div><div class="ttdef"><b>Definition:</b> <a href="_router_8php_source.html#l00194">Router.php:194</a></div></div>
  408. <div class="ttc" id="namespace_exception_html"><div class="ttname"><a href="namespace_exception.html">Exception</a></div><div class="ttdef"><b>Definition:</b> <a href="_error404_8php_source.html#l00003">Error404.php:3</a></div></div>
  409. </div><!-- fragment -->
  410. </div>
  411. </div>
  412. <a class="anchor" id="aca9c4092ad41ef8f6db2c3ca579a1a47"></a>
  413. <div class="memitem">
  414. <div class="memproto">
  415. <table class="mlabels">
  416. <tr>
  417. <td class="mlabels-left">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname">routeMatch </td>
  421. <td>(</td>
  422. <td class="paramtype">&#160;</td>
  423. <td class="paramname"><em>$request</em>, </td>
  424. </tr>
  425. <tr>
  426. <td class="paramkey"></td>
  427. <td></td>
  428. <td class="paramtype">&#160;</td>
  429. <td class="paramname"><em>$route</em>&#160;</td>
  430. </tr>
  431. <tr>
  432. <td></td>
  433. <td>)</td>
  434. <td></td><td></td>
  435. </tr>
  436. </table>
  437. </td>
  438. <td class="mlabels-right">
  439. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  440. </tr>
  441. </table>
  442. </div><div class="memdoc">
  443. <p>Check if the request match route </p><dl class="params"><dt>Parameters</dt><dd>
  444. <table class="params">
  445. <tr><td class="paramtype">array</td><td class="paramname">$request</td><td>User request </td></tr>
  446. <tr><td class="paramtype">array</td><td class="paramname">$route</td><td>Route to check </td></tr>
  447. </table>
  448. </dd>
  449. </dl>
  450. <dl class="section return"><dt>Returns</dt><dd>array on success, false on failure </dd></dl>
  451. <p>Definition at line <a class="el" href="_router_8php_source.html#l00156">156</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  452. <div class="fragment"><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; {</div>
  453. <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; $i = count($request);</div>
  454. <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; $params = array();</div>
  455. <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; <span class="keywordflow">if</span> ($i != count($route))</div>
  456. <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  457. <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; <span class="keywordflow">while</span> ($i)</div>
  458. <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; {</div>
  459. <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; $i--;</div>
  460. <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <span class="keywordflow">if</span> ($route[$i] == <span class="stringliteral">&#39;&#39;</span> &amp;&amp; $request[$i] == <span class="stringliteral">&#39;&#39;</span>)</div>
  461. <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keywordflow">continue</span>;</div>
  462. <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <span class="keywordflow">if</span> ($route[$i] == <span class="stringliteral">&#39;&#39;</span> || $request[$i] == <span class="stringliteral">&#39;&#39;</span>)</div>
  463. <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  464. <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="keywordflow">if</span> ($route[$i][0] != <span class="charliteral">&#39;:&#39;</span> &amp;&amp; ($route[$i] != $request[$i]))</div>
  465. <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  466. <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <span class="keywordflow">if</span> ($route[$i][0] == <span class="charliteral">&#39;:&#39;</span>)</div>
  467. <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; $params[$route[$i]] = $request[$i];</div>
  468. <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; $params[$i -1] = $request[$i];</div>
  469. <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; }</div>
  470. <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; <span class="keywordflow">return</span> array_reverse($params);</div>
  471. <div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; }</div>
  472. </div><!-- fragment -->
  473. </div>
  474. </div>
  475. <a class="anchor" id="a4001f7ed8b89fa23b5b1c77c8e320262"></a>
  476. <div class="memitem">
  477. <div class="memproto">
  478. <table class="memname">
  479. <tr>
  480. <td class="memname">serveUrl </td>
  481. <td>(</td>
  482. <td class="paramname"></td><td>)</td>
  483. <td></td>
  484. </tr>
  485. </table>
  486. </div><div class="memdoc">
  487. <dl class="section return"><dt>Returns</dt><dd>controller /core/controller/AController.php Match request to a controller return FALSE on failure (eg. 404) </dd></dl>
  488. <p>Definition at line <a class="el" href="_router_8php_source.html#l00108">108</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  489. <div class="fragment"><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; {</div>
  490. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="comment">//TODO trigger hook GET, POST</span></div>
  491. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; $this-&gt;<a class="code" href="class_tools_1_1_router.html#a5203c224e8eb5fc1072a980c264d33c1">prepareUrl</a>();</div>
  492. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; $requestParams = explode(<span class="stringliteral">&quot;/&quot;</span>, $this-&gt;requestUrl);</div>
  493. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordflow">foreach</span> ($this-&gt;routes as $i)</div>
  494. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; {</div>
  495. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <a class="code" href="class_tools_1_1_router.html#ad167d71585142809d420fe2a3b66d56c">$routeParams</a> = explode(<span class="stringliteral">&quot;/&quot;</span>, $i[0]);</div>
  496. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; $p = $this-&gt;<a class="code" href="class_tools_1_1_router.html#aca9c4092ad41ef8f6db2c3ca579a1a47">routeMatch</a>($requestParams, <a class="code" href="class_tools_1_1_router.html#ad167d71585142809d420fe2a3b66d56c">$routeParams</a>);</div>
  497. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordflow">if</span> (!$p)</div>
  498. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordflow">continue</span>;</div>
  499. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; $controller = $this-&gt;<a class="code" href="class_tools_1_1_router.html#ac721ad55028ff6c8fd3c006570fc475e">createController</a>($i[1], $p);</div>
  500. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keywordflow">if</span> ($controller)</div>
  501. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keywordflow">return</span> $controller;</div>
  502. <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; }</div>
  503. <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  504. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; }</div>
  505. <div class="ttc" id="class_tools_1_1_router_html_a5203c224e8eb5fc1072a980c264d33c1"><div class="ttname"><a href="class_tools_1_1_router.html#a5203c224e8eb5fc1072a980c264d33c1">Tools\Router\prepareUrl</a></div><div class="ttdeci">prepareUrl()</div><div class="ttdef"><b>Definition:</b> <a href="_router_8php_source.html#l00182">Router.php:182</a></div></div>
  506. <div class="ttc" id="class_tools_1_1_router_html_ad167d71585142809d420fe2a3b66d56c"><div class="ttname"><a href="class_tools_1_1_router.html#ad167d71585142809d420fe2a3b66d56c">Tools\Router\$routeParams</a></div><div class="ttdeci">$routeParams</div><div class="ttdef"><b>Definition:</b> <a href="_router_8php_source.html#l00051">Router.php:51</a></div></div>
  507. <div class="ttc" id="class_tools_1_1_router_html_ac721ad55028ff6c8fd3c006570fc475e"><div class="ttname"><a href="class_tools_1_1_router.html#ac721ad55028ff6c8fd3c006570fc475e">Tools\Router\createController</a></div><div class="ttdeci">createController($className, $params)</div><div class="ttdef"><b>Definition:</b> <a href="_router_8php_source.html#l00132">Router.php:132</a></div></div>
  508. <div class="ttc" id="class_tools_1_1_router_html_aca9c4092ad41ef8f6db2c3ca579a1a47"><div class="ttname"><a href="class_tools_1_1_router.html#aca9c4092ad41ef8f6db2c3ca579a1a47">Tools\Router\routeMatch</a></div><div class="ttdeci">routeMatch($request, $route)</div><div class="ttdef"><b>Definition:</b> <a href="_router_8php_source.html#l00156">Router.php:156</a></div></div>
  509. </div><!-- fragment -->
  510. </div>
  511. </div>
  512. <h2 class="groupheader">Field Documentation</h2>
  513. <a class="anchor" id="a7c294642225a6c91f5d7932dde75c2ae"></a>
  514. <div class="memitem">
  515. <div class="memproto">
  516. <table class="mlabels">
  517. <tr>
  518. <td class="mlabels-left">
  519. <table class="memname">
  520. <tr>
  521. <td class="memname">Tools <a class="el" href="class_tools_1_1_context.html">Context</a> $context</td>
  522. </tr>
  523. </table>
  524. </td>
  525. <td class="mlabels-right">
  526. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  527. </tr>
  528. </table>
  529. </div><div class="memdoc">
  530. <p>/core/tools/Context.php Contains website's informations </p>
  531. <p>Definition at line <a class="el" href="_router_8php_source.html#l00041">41</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  532. </div>
  533. </div>
  534. <a class="anchor" id="acbb09e02c973fc56c7395cc5b9a85123"></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">string $requestUrl</td>
  543. </tr>
  544. </table>
  545. </td>
  546. <td class="mlabels-right">
  547. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  548. </tr>
  549. </table>
  550. </div><div class="memdoc">
  551. <p>Contains request </p>
  552. <p>Definition at line <a class="el" href="_router_8php_source.html#l00029">29</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  553. </div>
  554. </div>
  555. <a class="anchor" id="abaa9f54c924a22e8c0169f443efd1055"></a>
  556. <div class="memitem">
  557. <div class="memproto">
  558. <table class="mlabels">
  559. <tr>
  560. <td class="mlabels-left">
  561. <table class="memname">
  562. <tr>
  563. <td class="memname">string $rootPath</td>
  564. </tr>
  565. </table>
  566. </td>
  567. <td class="mlabels-right">
  568. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  569. </tr>
  570. </table>
  571. </div><div class="memdoc">
  572. <p>Contains the application's root path (ex: <a href="http://myshop.com/">http://myshop.com/</a>) with trailing slash Can be accessed read-only via $instance-&gt;rootPath</p>
  573. <p>Contains the application's root path (ex: /srv/http/myshop/) with trailing slash Can be accessed read-only via $instance-&gt;rootUrl </p>
  574. <p>Definition at line <a class="el" href="_router_8php_source.html#l00016">16</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  575. </div>
  576. </div>
  577. <a class="anchor" id="a0de279007713709c32cdf155ad3c63cd"></a>
  578. <div class="memitem">
  579. <div class="memproto">
  580. <table class="mlabels">
  581. <tr>
  582. <td class="mlabels-left">
  583. <table class="memname">
  584. <tr>
  585. <td class="memname">$rootUrl</td>
  586. </tr>
  587. </table>
  588. </td>
  589. <td class="mlabels-right">
  590. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  591. </tr>
  592. </table>
  593. </div><div class="memdoc">
  594. <p>Definition at line <a class="el" href="_router_8php_source.html#l00023">23</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  595. </div>
  596. </div>
  597. <a class="anchor" id="ad167d71585142809d420fe2a3b66d56c"></a>
  598. <div class="memitem">
  599. <div class="memproto">
  600. <table class="mlabels">
  601. <tr>
  602. <td class="mlabels-left">
  603. <table class="memname">
  604. <tr>
  605. <td class="memname">$routeParams</td>
  606. </tr>
  607. </table>
  608. </td>
  609. <td class="mlabels-right">
  610. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  611. </tr>
  612. </table>
  613. </div><div class="memdoc">
  614. <p>Definition at line <a class="el" href="_router_8php_source.html#l00051">51</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  615. </div>
  616. </div>
  617. <a class="anchor" id="a8f7eb04a54e0f0bfc0cedeb9899ce4a8"></a>
  618. <div class="memitem">
  619. <div class="memproto">
  620. <table class="mlabels">
  621. <tr>
  622. <td class="mlabels-left">
  623. <table class="memname">
  624. <tr>
  625. <td class="memname">$routes</td>
  626. </tr>
  627. </table>
  628. </td>
  629. <td class="mlabels-right">
  630. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  631. </tr>
  632. </table>
  633. </div><div class="memdoc">
  634. <p>Definition at line <a class="el" href="_router_8php_source.html#l00034">34</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
  635. </div>
  636. </div>
  637. <hr/>The documentation for this class was generated from the following file:<ul>
  638. <li>core/tools/<a class="el" href="_router_8php_source.html">Router.php</a></li>
  639. </ul>
  640. </div><!-- contents -->
  641. <!-- start footer part -->
  642. <hr class="footer"/><address class="footer"><small>
  643. Generated on Wed Aug 5 2015 00:58:13 for ecom by &#160;<a href="http://www.doxygen.org/index.html">
  644. <img class="footer" src="doxygen.png" alt="doxygen"/>
  645. </a> 1.8.8
  646. </small></address>
  647. </body>
  648. </html>