Startsida Utforska Hjälp
Registrera dig Logga in
isundil
/
julia
1
0
Fork 0
Filer Ärenden 0 Pull-förfrågningar 0 Wiki
Gren: master
Grenar Taggar
julia
/
doc
/
html
/
class_tools_1_1_router.html

class_tools_1_1_router.html 50 KB
Permalänk Historik Rå

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.8"/>
    7. 

  7. <title>ecom: Router Class Reference</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    12. 

  12. <script type="text/javascript" src="search/search.js"></script>
    13. 

  13. <script type="text/javascript">
    14. 

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });
    15. 

  15. </script>
    16. 

  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    17. 

  17. </head>
    18. 

  18. <body>
    19. 

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    20. 

  20. <div id="titlearea">
    21. 

  21. <table cellspacing="0" cellpadding="0">
    22. 

  22.  <tbody>
    23. 

  23.  <tr style="height: 56px;">
    24. 

  24.   <td style="padding-left: 0.5em;">
    25. 

  25.    <div id="projectname">ecom
    26. 

  26.    </div>
    27. 

  27.    <div id="projectbrief">E-commerce cms</div>
    28. 

  28.   </td>
    29. 

  29.  </tr>
    30. 

  30.  </tbody>
    31. 

  31. </table>
    32. 

  32. </div>
    33. 

  33. <!-- end header part -->
    34. 

  34. <!-- Generated by Doxygen 1.8.8 -->
    35. 

  35. <script type="text/javascript">
    36. 

  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    37. 

  37. </script>
    38. 

  38.   <div id="navrow1" class="tabs">
    39. 

  39.     <ul class="tablist">
    40. 

  40.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    41. 

  41.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    42. 

  42.       <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
    43. 

  43.       <li><a href="files.html"><span>Files</span></a></li>
    44. 

  44.       <li>
    45. 

  45.         <div id="MSearchBox" class="MSearchBoxInactive">
    46. 

  46.         <span class="left">
    47. 

  47.           <img id="MSearchSelect" src="search/mag_sel.png"
    48. 

  48.                onmouseover="return searchBox.OnSearchSelectShow()"
    49. 

  49.                onmouseout="return searchBox.OnSearchSelectHide()"
    50. 

  50.                alt=""/>
    51. 

  51.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    52. 

  52.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    53. 

  53.                onblur="searchBox.OnSearchFieldFocus(false)" 
    54. 

  54.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    55. 

  55.           </span><span class="right">
    56. 

  56.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    57. 

  57.           </span>
    58. 

  58.         </div>
    59. 

  59.       </li>
    60. 

  60.     </ul>
    61. 

  61.   </div>
    62. 

  62.   <div id="navrow2" class="tabs2">
    63. 

  63.     <ul class="tablist">
    64. 

  64.       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
    65. 

  65.       <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
    66. 

  66.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
    67. 

  67.       <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    68. 

  68.     </ul>
    69. 

  69.   </div>
    70. 

  70. <!-- window showing the filter options -->
    71. 

  71. <div id="MSearchSelectWindow"
    72. 

  72.      onmouseover="return searchBox.OnSearchSelectShow()"
    73. 

  73.      onmouseout="return searchBox.OnSearchSelectHide()"
    74. 

  74.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    75. 

  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. 

  76. 

  77. <!-- iframe showing the search results (closed by default) -->
    78. 

  78. <div id="MSearchResultsWindow">
    79. 

  79. <iframe src="javascript:void(0)" frameborder="0" 
    80. 

  80.         name="MSearchResults" id="MSearchResults">
    81. 

  81. </iframe>
    82. 

  82. </div>
    83. 

  83. 

  84. <div id="nav-path" class="navpath">
    85. 

  85.   <ul>
    86. 

  86. <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>
    87. 

  87. </div>
    88. 

  88. </div><!-- top -->
    89. 

  89. <div class="header">
    90. 

  90.   <div class="summary">
    91. 

  91. <a href="#pub-methods">Public Member Functions</a> &#124;
    92. 

  92. <a href="#pri-methods">Private Member Functions</a> &#124;
    93. 

  93. <a href="#pri-attribs">Private Attributes</a>  </div>
    94. 

  94.   <div class="headertitle">
    95. 

  95. <div class="title">Router Class Reference</div>  </div>
    96. 

  96. </div><!--header-->
    97. 

  97. <div class="contents">
    98. 

  98. <table class="memberdecls">
    99. 

  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
    100. 

  100. Public Member Functions</h2></td></tr>
    101. 

  101. <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>
    102. 

  102. <tr class="separator:a2e9488ba4915c293adea1fd7933de39b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    103. 

  103. <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>
    104. 

  104. <tr class="separator:a2d1b9c00619ae1b43fa06167ab04cc7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    105. 

  105. <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>
    106. 

  106. <tr class="separator:a4001f7ed8b89fa23b5b1c77c8e320262"><td class="memSeparator" colspan="2">&#160;</td></tr>
    107. 

  107. <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>
    108. 

  108. <tr class="separator:aaba248f1b462a6b58536ee8c2a835054"><td class="memSeparator" colspan="2">&#160;</td></tr>
    109. 

  109. <tr class="memitem:acccacc202e24a0a615dd1ccf88ff8435"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#acccacc202e24a0a615dd1ccf88ff8435">overrideUrl</a> ($type, $value)</td></tr>
    110. 

  110. <tr class="separator:acccacc202e24a0a615dd1ccf88ff8435"><td class="memSeparator" colspan="2">&#160;</td></tr>
    111. 

  111. <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>
    112. 

  112. <tr class="separator:a4537dad3b44254124991341cc91b28fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
    113. 

  113. </table><table class="memberdecls">
    114. 

  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
    115. 

  115. Private Member Functions</h2></td></tr>
    116. 

  116. <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>
    117. 

  117. <tr class="separator:ac721ad55028ff6c8fd3c006570fc475e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    118. 

  118. <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>
    119. 

  119. <tr class="separator:aca9c4092ad41ef8f6db2c3ca579a1a47"><td class="memSeparator" colspan="2">&#160;</td></tr>
    120. 

  120. <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>
    121. 

  121. <tr class="separator:a5203c224e8eb5fc1072a980c264d33c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
    122. 

  122. <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>
    123. 

  123. <tr class="separator:a3dc609b3f27a881888ccf4a8c2df6ff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
    124. 

  124. </table><table class="memberdecls">
    125. 

  125. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
    126. 

  126. Private Attributes</h2></td></tr>
    127. 

  127. <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>
    128. 

  128. <tr class="separator:abaa9f54c924a22e8c0169f443efd1055"><td class="memSeparator" colspan="2">&#160;</td></tr>
    129. 

  129. <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>
    130. 

  130. <tr class="separator:a0de279007713709c32cdf155ad3c63cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
    131. 

  131. <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>
    132. 

  132. <tr class="separator:acbb09e02c973fc56c7395cc5b9a85123"><td class="memSeparator" colspan="2">&#160;</td></tr>
    133. 

  133. <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>
    134. 

  134. <tr class="separator:a8f7eb04a54e0f0bfc0cedeb9899ce4a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    135. 

  135. <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>
    136. 

  136. <tr class="separator:a7c294642225a6c91f5d7932dde75c2ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
    137. 

  137. <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>
    138. 

  138. <tr class="separator:ad167d71585142809d420fe2a3b66d56c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    139. 

  139. <tr class="memitem:a6f46a4fa02fac7e14d194e8c618cc045"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_router.html#a6f46a4fa02fac7e14d194e8c618cc045">$overridden</a></td></tr>
    140. 

  140. <tr class="separator:a6f46a4fa02fac7e14d194e8c618cc045"><td class="memSeparator" colspan="2">&#160;</td></tr>
    141. 

  141. </table>
    142. 

  142. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    143. 

  143. <div class="textblock"><p>Will manager new connections to the server and try to match the requests and the controllers </p>
    144. 

  144. 

  145. <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>
    146. 

  146. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
    147. 

  147. <a class="anchor" id="a2e9488ba4915c293adea1fd7933de39b"></a>
    148. 

  148. <div class="memitem">
    149. 

  149. <div class="memproto">
    150. 

  150.       <table class="memname">
    151. 

  151.         <tr>
    152. 

  152.           <td class="memname">__construct </td>
    153. 

  153.           <td>(</td>
    154. 

  154.           <td class="paramtype">&#160;</td>
    155. 

  155.           <td class="paramname"><em>$server</em>, </td>
    156. 

  156.         </tr>
    157. 

  157.         <tr>
    158. 

  158.           <td class="paramkey"></td>
    159. 

  159.           <td></td>
    160. 

  160.           <td class="paramtype">&#160;</td>
    161. 

  161.           <td class="paramname"><em>$context</em>&#160;</td>
    162. 

  162.         </tr>
    163. 

  163.         <tr>
    164. 

  164.           <td></td>
    165. 

  165.           <td>)</td>
    166. 

  166.           <td></td><td></td>
    167. 

  167.         </tr>
    168. 

  168.       </table>
    169. 

  169. </div><div class="memdoc">
    170. 

  170. <p>Create the router, initialize url and path </p>
    171. 

  171. 

  172. <p>Definition at line <a class="el" href="_router_8php_source.html#l00082">82</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
    173. 

  173. <div class="fragment"><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    {</div>
    174. 

  174. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;        $pos = strrpos($server[<span class="stringliteral">&quot;SCRIPT_NAME&quot;</span>], <span class="stringliteral">&quot;/&quot;</span>);</div>
    175. 

  175. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;        $relativePath = (($pos === FALSE) ? <span class="stringliteral">&quot;&quot;</span> : substr($server[<span class="stringliteral">&quot;SCRIPT_NAME&quot;</span>], 0, $pos));</div>
    176. 

  176. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;        $this-&gt;rootPath = $server[<span class="stringliteral">&quot;DOCUMENT_ROOT&quot;</span>] . $relativePath . <span class="stringliteral">&quot;/&quot;</span>;</div>
    177. 

  177. <div class="line"><a name="l00087"></a><span class="lineno">   87</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>
    178. 

  178. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;        $this-&gt;requestUrl = substr($server[<span class="stringliteral">&quot;REQUEST_URI&quot;</span>], count($this-&gt;rootUrl) -1);</div>
    179. 

  179. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;        $this-&gt;context = <a class="code" href="class_tools_1_1_router.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>;</div>
    180. 

  180. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;        $this-&gt;routes = array();</div>
    181. 

  181. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;        $this-&gt;overridden = null;</div>
    182. 

  182. <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    }</div>
    183. 

  183. <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>
    184. 

  184. </div><!-- fragment -->
    185. 

  185. </div>
    186. 

  186. </div>
    187. 

  187. <h2 class="groupheader">Member Function Documentation</h2>
    188. 

  188. <a class="anchor" id="a4537dad3b44254124991341cc91b28fb"></a>
    189. 

  189. <div class="memitem">
    190. 

  190. <div class="memproto">
    191. 

  191.       <table class="memname">
    192. 

  192.         <tr>
    193. 

  193.           <td class="memname">__get </td>
    194. 

  194.           <td>(</td>
    195. 

  195.           <td class="paramtype">&#160;</td>
    196. 

  196.           <td class="paramname"><em>$key</em></td><td>)</td>
    197. 

  197.           <td></td>
    198. 

  198.         </tr>
    199. 

  199.       </table>
    200. 

  200. </div><div class="memdoc">
    201. 

  201. <p>Getter </p>
    202. 

  202. 

  203. <p>Definition at line <a class="el" href="_router_8php_source.html#l00245">245</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
    204. 

  204. <div class="fragment"><div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;    {</div>
    205. 

  205. <div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;        <span class="keywordflow">if</span> (isset($this-&gt;overridden) &amp;&amp; in_array($key, array(<span class="stringliteral">&quot;modulesPath&quot;</span>)))</div>
    206. 

  206. <div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;            <span class="keywordflow">return</span> $this-&gt;overridden[$key];</div>
    207. 

  207. <div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;        <span class="keywordflow">switch</span> ($key)</div>
    208. 

  208. <div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;        {</div>
    209. 

  209. <div class="line"><a name="l00251"></a><span class="lineno">  251</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>
    210. 

  210. <div class="line"><a name="l00252"></a><span class="lineno">  252</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>
    211. 

  211. <div class="line"><a name="l00253"></a><span class="lineno">  253</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>
    212. 

  212. <div class="line"><a name="l00254"></a><span class="lineno">  254</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>
    213. 

  213. <div class="line"><a name="l00255"></a><span class="lineno">  255</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>
    214. 

  214. <div class="line"><a name="l00256"></a><span class="lineno">  256</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>
    215. 

  215. <div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;        }</div>
    216. 

  216. <div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;        <span class="keywordflow">throw</span> new \Exception(<span class="stringliteral">&quot;Cannot access attribute {$key}&quot;</span>);</div>
    217. 

  217. <div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;    }</div>
    218. 

  218. <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>
    219. 

  219. <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>
    220. 

  220. </div><!-- fragment -->
    221. 

  221. </div>
    222. 

  222. </div>
    223. 

  223. <a class="anchor" id="ac721ad55028ff6c8fd3c006570fc475e"></a>
    224. 

  224. <div class="memitem">
    225. 

  225. <div class="memproto">
    226. 

  226. <table class="mlabels">
    227. 

  227.   <tr>
    228. 

  228.   <td class="mlabels-left">
    229. 

  229.       <table class="memname">
    230. 

  230.         <tr>
    231. 

  231.           <td class="memname">createController </td>
    232. 

  232.           <td>(</td>
    233. 

  233.           <td class="paramtype">&#160;</td>
    234. 

  234.           <td class="paramname"><em>$className</em>, </td>
    235. 

  235.         </tr>
    236. 

  236.         <tr>
    237. 

  237.           <td class="paramkey"></td>
    238. 

  238.           <td></td>
    239. 

  239.           <td class="paramtype">&#160;</td>
    240. 

  240.           <td class="paramname"><em>$params</em>&#160;</td>
    241. 

  241.         </tr>
    242. 

  242.         <tr>
    243. 

  243.           <td></td>
    244. 

  244.           <td>)</td>
    245. 

  245.           <td></td><td></td>
    246. 

  246.         </tr>
    247. 

  247.       </table>
    248. 

  248.   </td>
    249. 

  249.   <td class="mlabels-right">
    250. 

  250. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    251. 

  251.   </tr>
    252. 

  252. </table>
    253. 

  253. </div><div class="memdoc">
    254. 

  254. <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>
    255. 

  255.   <table class="params">
    256. 

  256.     <tr><td class="paramtype"></td><td class="paramname">$className</td><td></td></tr>
    257. 

  257.     <tr><td class="paramtype">array</td><td class="paramname">$routeParameters</td><td></td></tr>
    258. 

  258.   </table>
    259. 

  259.   </dd>
    260. 

  260. </dl>
    261. 

  261. <dl class="section return"><dt>Returns</dt><dd>on succes, false otherwise </dd></dl>
    262. 

  262. 

  263. <p>Definition at line <a class="el" href="_router_8php_source.html#l00141">141</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
    264. 

  264. <div class="fragment"><div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;    {</div>
    265. 

  265. <div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;        <span class="keywordflow">if</span> (!class_exists($className))</div>
    266. 

  266. <div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
    267. 

  267. <div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;        $this-&gt;routeParams = $params;</div>
    268. 

  268. <div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;        $result = null;</div>
    269. 

  269. <div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;        <span class="keywordflow">try</span></div>
    270. 

  270. <div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;        {</div>
    271. 

  271. <div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;            $result = <span class="keyword">new</span> $className($this-&gt;context, $params);</div>
    272. 

  272. <div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;            <span class="keywordflow">if</span> (!($result instanceof \<a class="code" href="namespace_tools.html">Tools</a>\AController))</div>
    273. 

  273. <div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;                <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
    274. 

  274. <div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;        }</div>
    275. 

  275. <div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;        <span class="keywordflow">catch</span> (\<a class="code" href="namespace_exception.html">Exception</a>\Error404 $e)</div>
    276. 

  276. <div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;        {</div>
    277. 

  277. <div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
    278. 

  278. <div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;        }</div>
    279. 

  279. <div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;        <span class="keywordflow">return</span> $result;</div>
    280. 

  280. <div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;    }</div>
    281. 

  281. <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="exceptions_2_error404_8php_source.html#l00003">Error404.php:3</a></div></div>
    282. 

  282. <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>
    283. 

  283. </div><!-- fragment -->
    284. 

  284. </div>
    285. 

  285. </div>
    286. 

  286. <a class="anchor" id="a3dc609b3f27a881888ccf4a8c2df6ff4"></a>
    287. 

  287. <div class="memitem">
    288. 

  288. <div class="memproto">
    289. 

  289. <table class="mlabels">
    290. 

  290.   <tr>
    291. 

  291.   <td class="mlabels-left">
    292. 

  292.       <table class="memname">
    293. 

  293.         <tr>
    294. 

  294.           <td class="memname">doRouteAdd </td>
    295. 

  295.           <td>(</td>
    296. 

  296.           <td class="paramtype">&#160;</td>
    297. 

  297.           <td class="paramname"><em>$route</em>, </td>
    298. 

  298.         </tr>
    299. 

  299.         <tr>
    300. 

  300.           <td class="paramkey"></td>
    301. 

  301.           <td></td>
    302. 

  302.           <td class="paramtype">&#160;</td>
    303. 

  303.           <td class="paramname"><em>$controller</em>&#160;</td>
    304. 

  304.         </tr>
    305. 

  305.         <tr>
    306. 

  306.           <td></td>
    307. 

  307.           <td>)</td>
    308. 

  308.           <td></td><td></td>
    309. 

  309.         </tr>
    310. 

  310.       </table>
    311. 

  311.   </td>
    312. 

  312.   <td class="mlabels-right">
    313. 

  313. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    314. 

  314.   </tr>
    315. 

  315. </table>
    316. 

  316. </div><div class="memdoc">
    317. 

  317. <p>Add a route to the internal route list Internal procedure </p>
    318. 

  318. 

  319. <p>Definition at line <a class="el" href="_router_8php_source.html#l00204">204</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
    320. 

  320. <div class="fragment"><div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;    {</div>
    321. 

  321. <div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;        $this-&gt;routes[] = array($route, $controller);</div>
    322. 

  322. <div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;    }</div>
    323. 

  323. </div><!-- fragment -->
    324. 

  324. </div>
    325. 

  325. </div>
    326. 

  326. <a class="anchor" id="a2d1b9c00619ae1b43fa06167ab04cc7b"></a>
    327. 

  327. <div class="memitem">
    328. 

  328. <div class="memproto">
    329. 

  329.       <table class="memname">
    330. 

  330.         <tr>
    331. 

  331.           <td class="memname">init </td>
    332. 

  332.           <td>(</td>
    333. 

  333.           <td class="paramtype">&#160;</td>
    334. 

  334.           <td class="paramname"><em>$server</em></td><td>)</td>
    335. 

  335.           <td></td>
    336. 

  336.         </tr>
    337. 

  337.       </table>
    338. 

  338. </div><div class="memdoc">
    339. 

  339. <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>
    340. 

  340. 

  341. <p>Definition at line <a class="el" href="_router_8php_source.html#l00099">99</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
    342. 

  342. <div class="fragment"><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    {</div>
    343. 

  343. <div class="line"><a name="l00101"></a><span class="lineno">  101</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>
    344. 

  344. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;        <span class="comment">// @codeCoverageIgnoreStart</span></div>
    345. 

  345. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;        <span class="comment">// This code is tested under another process</span></div>
    346. 

  346. <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;        <span class="keywordflow">if</span> ($siteUrl != $server[<span class="stringliteral">&quot;HTTP_HOST&quot;</span>] &amp;&amp; $siteUrl !== null)</div>
    347. 

  347. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;        {</div>
    348. 

  348. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;            header(<span class="stringliteral">&quot;location: http://{$siteUrl}{$server[&#39;REQUEST_URI&#39;]}&quot;</span>);</div>
    349. 

  349. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;            die;</div>
    350. 

  350. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;        }</div>
    351. 

  351. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;        <span class="comment">// @codeCoverageIgnoreEnd</span></div>
    352. 

  352. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    }</div>
    353. 

  353. <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#l00044">Config.php:44</a></div></div>
    354. 

  354. </div><!-- fragment -->
    355. 

  355. </div>
    356. 

  356. </div>
    357. 

  357. <a class="anchor" id="acccacc202e24a0a615dd1ccf88ff8435"></a>
    358. 

  358. <div class="memitem">
    359. 

  359. <div class="memproto">
    360. 

  360.       <table class="memname">
    361. 

  361.         <tr>
    362. 

  362.           <td class="memname">overrideUrl </td>
    363. 

  363.           <td>(</td>
    364. 

  364.           <td class="paramtype">&#160;</td>
    365. 

  365.           <td class="paramname"><em>$type</em>, </td>
    366. 

  366.         </tr>
    367. 

  367.         <tr>
    368. 

  368.           <td class="paramkey"></td>
    369. 

  369.           <td></td>
    370. 

  370.           <td class="paramtype">&#160;</td>
    371. 

  371.           <td class="paramname"><em>$value</em>&#160;</td>
    372. 

  372.         </tr>
    373. 

  373.         <tr>
    374. 

  374.           <td></td>
    375. 

  375.           <td>)</td>
    376. 

  376.           <td></td><td></td>
    377. 

  377.         </tr>
    378. 

  378.       </table>
    379. 

  379. </div><div class="memdoc">
    380. 

  380. <p>Override url This SHOULD not be called for security purpose </p><dl class="params"><dt>Parameters</dt><dd>
    381. 

  381.   <table class="params">
    382. 

  382.     <tr><td class="paramtype">string</td><td class="paramname">$type</td><td>the url type to override </td></tr>
    383. 

  383.     <tr><td class="paramtype">string</td><td class="paramname">$value</td><td>the new value Will fail if called from a controller </td></tr>
    384. 

  384.   </table>
    385. 

  385.   </dd>
    386. 

  386. </dl>
    387. 

  387. <dl class="section return"><dt>Returns</dt><dd>boolean false on failure </dd></dl>
    388. 

  388. 

  389. <p>Definition at line <a class="el" href="_router_8php_source.html#l00234">234</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
    390. 

  390. <div class="fragment"><div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;    {</div>
    391. 

  391. <div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;        <span class="keywordflow">if</span> (!$this-&gt;context-&gt;isTestingEnvironment())</div>
    392. 

  392. <div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
    393. 

  393. <div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;        $this-&gt;overridden[$type] = $value;</div>
    394. 

  394. <div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
    395. 

  395. <div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;    }</div>
    396. 

  396. </div><!-- fragment -->
    397. 

  397. </div>
    398. 

  398. </div>
    399. 

  399. <a class="anchor" id="a5203c224e8eb5fc1072a980c264d33c1"></a>
    400. 

  400. <div class="memitem">
    401. 

  401. <div class="memproto">
    402. 

  402. <table class="mlabels">
    403. 

  403.   <tr>
    404. 

  404.   <td class="mlabels-left">
    405. 

  405.       <table class="memname">
    406. 

  406.         <tr>
    407. 

  407.           <td class="memname">prepareUrl </td>
    408. 

  408.           <td>(</td>
    409. 

  409.           <td class="paramname"></td><td>)</td>
    410. 

  410.           <td></td>
    411. 

  411.         </tr>
    412. 

  412.       </table>
    413. 

  413.   </td>
    414. 

  414.   <td class="mlabels-right">
    415. 

  415. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    416. 

  416.   </tr>
    417. 

  417. </table>
    418. 

  418. </div><div class="memdoc">
    419. 

  419. <p>Append local routes to router Will load CMS pages, categories page, products page, cart pages, etc. </p>
    420. 

  420. 

  421. <p>Definition at line <a class="el" href="_router_8php_source.html#l00192">192</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
    422. 

  422. <div class="fragment"><div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;    {</div>
    423. 

  423. <div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;        $fetcher = new \Entity\Cms();</div>
    424. 

  424. <div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;        $pages = $fetcher-&gt;selects(null, array(<span class="stringliteral">&quot;order&quot;</span>));</div>
    425. 

  425. <div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;        <span class="keywordflow">foreach</span> ($pages as $i)</div>
    426. 

  426. <div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;            $this-&gt;<a class="code" href="class_tools_1_1_router.html#a3dc609b3f27a881888ccf4a8c2df6ff4">doRouteAdd</a>($i-&gt;shurl, $i-&gt;controller);</div>
    427. 

  427. <div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;    }</div>
    428. 

  428. <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#l00204">Router.php:204</a></div></div>
    429. 

  429. </div><!-- fragment -->
    430. 

  430. </div>
    431. 

  431. </div>
    432. 

  432. <a class="anchor" id="aaba248f1b462a6b58536ee8c2a835054"></a>
    433. 

  433. <div class="memitem">
    434. 

  434. <div class="memproto">
    435. 

  435.       <table class="memname">
    436. 

  436.         <tr>
    437. 

  437.           <td class="memname">routeAdd </td>
    438. 

  438.           <td>(</td>
    439. 

  439.           <td class="paramtype">&#160;</td>
    440. 

  440.           <td class="paramname"><em>$route</em>, </td>
    441. 

  441.         </tr>
    442. 

  442.         <tr>
    443. 

  443.           <td class="paramkey"></td>
    444. 

  444.           <td></td>
    445. 

  445.           <td class="paramtype">&#160;</td>
    446. 

  446.           <td class="paramname"><em>$controller</em>&#160;</td>
    447. 

  447.         </tr>
    448. 

  448.         <tr>
    449. 

  449.           <td></td>
    450. 

  450.           <td>)</td>
    451. 

  451.           <td></td><td></td>
    452. 

  452.         </tr>
    453. 

  453.       </table>
    454. 

  454. </div><div class="memdoc">
    455. 

  455. <dl class="params"><dt>Parameters</dt><dd>
    456. 

  456.   <table class="params">
    457. 

  457.     <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>
    458. 

  458.     <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>
    459. 

  459.   </table>
    460. 

  460.   </dd>
    461. 

  461. </dl>
    462. 

  462. <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>
    463. 

  463. 

  464. <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>
    465. 

  465. <div class="fragment"><div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;    {</div>
    466. 

  466. <div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;        <span class="keywordflow">if</span> (!$this-&gt;context-&gt;hookManager-&gt;isInHook(<span class="stringliteral">&quot;routerSetup&quot;</span>))</div>
    467. 

  467. <div class="line"><a name="l00222"></a><span class="lineno">  222</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>
    468. 

  468. <div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;        $this-&gt;<a class="code" href="class_tools_1_1_router.html#a3dc609b3f27a881888ccf4a8c2df6ff4">doRouteAdd</a>($route, $controller);</div>
    469. 

  469. <div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;    }</div>
    470. 

  470. <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#l00204">Router.php:204</a></div></div>
    471. 

  471. <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="exceptions_2_error404_8php_source.html#l00003">Error404.php:3</a></div></div>
    472. 

  472. </div><!-- fragment -->
    473. 

  473. </div>
    474. 

  474. </div>
    475. 

  475. <a class="anchor" id="aca9c4092ad41ef8f6db2c3ca579a1a47"></a>
    476. 

  476. <div class="memitem">
    477. 

  477. <div class="memproto">
    478. 

  478. <table class="mlabels">
    479. 

  479.   <tr>
    480. 

  480.   <td class="mlabels-left">
    481. 

  481.       <table class="memname">
    482. 

  482.         <tr>
    483. 

  483.           <td class="memname">routeMatch </td>
    484. 

  484.           <td>(</td>
    485. 

  485.           <td class="paramtype">&#160;</td>
    486. 

  486.           <td class="paramname"><em>$request</em>, </td>
    487. 

  487.         </tr>
    488. 

  488.         <tr>
    489. 

  489.           <td class="paramkey"></td>
    490. 

  490.           <td></td>
    491. 

  491.           <td class="paramtype">&#160;</td>
    492. 

  492.           <td class="paramname"><em>$route</em>&#160;</td>
    493. 

  493.         </tr>
    494. 

  494.         <tr>
    495. 

  495.           <td></td>
    496. 

  496.           <td>)</td>
    497. 

  497.           <td></td><td></td>
    498. 

  498.         </tr>
    499. 

  499.       </table>
    500. 

  500.   </td>
    501. 

  501.   <td class="mlabels-right">
    502. 

  502. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    503. 

  503.   </tr>
    504. 

  504. </table>
    505. 

  505. </div><div class="memdoc">
    506. 

  506. <p>Check if the request match route </p><dl class="params"><dt>Parameters</dt><dd>
    507. 

  507.   <table class="params">
    508. 

  508.     <tr><td class="paramtype">array</td><td class="paramname">$request</td><td>User request </td></tr>
    509. 

  509.     <tr><td class="paramtype">array</td><td class="paramname">$route</td><td>Route to check </td></tr>
    510. 

  510.   </table>
    511. 

  511.   </dd>
    512. 

  512. </dl>
    513. 

  513. <dl class="section return"><dt>Returns</dt><dd>array on success, false on failure </dd></dl>
    514. 

  514. 

  515. <p>Definition at line <a class="el" href="_router_8php_source.html#l00166">166</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
    516. 

  516. <div class="fragment"><div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;    {</div>
    517. 

  517. <div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;        $i = count($request);</div>
    518. 

  518. <div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;        $params = array();</div>
    519. 

  519. <div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;        <span class="keywordflow">if</span> ($i != count($route))</div>
    520. 

  520. <div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
    521. 

  521. <div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;        <span class="keywordflow">while</span> ($i)</div>
    522. 

  522. <div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;        {</div>
    523. 

  523. <div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;            $i--;</div>
    524. 

  524. <div class="line"><a name="l00175"></a><span class="lineno">  175</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>
    525. 

  525. <div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;                <span class="keywordflow">continue</span>;</div>
    526. 

  526. <div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;            <span class="keywordflow">if</span> ($route[$i] == <span class="stringliteral">&#39;&#39;</span> || $request[$i] == <span class="stringliteral">&#39;&#39;</span>)</div>
    527. 

  527. <div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;                <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
    528. 

  528. <div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;            <span class="keywordflow">if</span> ($route[$i][0] != <span class="charliteral">&#39;:&#39;</span> &amp;&amp; ($route[$i] != $request[$i]))</div>
    529. 

  529. <div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;                <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
    530. 

  530. <div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;            <span class="keywordflow">if</span> ($route[$i][0] == <span class="charliteral">&#39;:&#39;</span>)</div>
    531. 

  531. <div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;                $params[$route[$i]] = $request[$i];</div>
    532. 

  532. <div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;            $params[$i -1] = $request[$i];</div>
    533. 

  533. <div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;        }</div>
    534. 

  534. <div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;        <span class="keywordflow">return</span> array_reverse($params);</div>
    535. 

  535. <div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;    }</div>
    536. 

  536. </div><!-- fragment -->
    537. 

  537. </div>
    538. 

  538. </div>
    539. 

  539. <a class="anchor" id="a4001f7ed8b89fa23b5b1c77c8e320262"></a>
    540. 

  540. <div class="memitem">
    541. 

  541. <div class="memproto">
    542. 

  542.       <table class="memname">
    543. 

  543.         <tr>
    544. 

  544.           <td class="memname">serveUrl </td>
    545. 

  545.           <td>(</td>
    546. 

  546.           <td class="paramname"></td><td>)</td>
    547. 

  547.           <td></td>
    548. 

  548.         </tr>
    549. 

  549.       </table>
    550. 

  550. </div><div class="memdoc">
    551. 

  551. <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>
    552. 

  552. 

  553. <p>Definition at line <a class="el" href="_router_8php_source.html#l00118">118</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
    554. 

  554. <div class="fragment"><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;    {</div>
    555. 

  555. <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;        $this-&gt;<a class="code" href="class_tools_1_1_router.html#a5203c224e8eb5fc1072a980c264d33c1">prepareUrl</a>();</div>
    556. 

  556. <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;        $requestParams = explode(<span class="stringliteral">&quot;/&quot;</span>, $this-&gt;requestUrl);</div>
    557. 

  557. <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;        <span class="keywordflow">foreach</span> ($this-&gt;routes as $i)</div>
    558. 

  558. <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;        {</div>
    559. 

  559. <div class="line"><a name="l00124"></a><span class="lineno">  124</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>
    560. 

  560. <div class="line"><a name="l00125"></a><span class="lineno">  125</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>
    561. 

  561. <div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;            <span class="keywordflow">if</span> ($p === <span class="keyword">false</span>)</div>
    562. 

  562. <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;                <span class="keywordflow">continue</span>;</div>
    563. 

  563. <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;            $controller = $this-&gt;<a class="code" href="class_tools_1_1_router.html#ac721ad55028ff6c8fd3c006570fc475e">createController</a>($i[1], $p);</div>
    564. 

  564. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;            <span class="keywordflow">if</span> ($controller)</div>
    565. 

  565. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;                <span class="keywordflow">return</span> $controller;</div>
    566. 

  566. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;        }</div>
    567. 

  567. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
    568. 

  568. <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;    }</div>
    569. 

  569. <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#l00192">Router.php:192</a></div></div>
    570. 

  570. <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>
    571. 

  571. <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#l00141">Router.php:141</a></div></div>
    572. 

  572. <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#l00166">Router.php:166</a></div></div>
    573. 

  573. </div><!-- fragment -->
    574. 

  574. </div>
    575. 

  575. </div>
    576. 

  576. <h2 class="groupheader">Field Documentation</h2>
    577. 

  577. <a class="anchor" id="a7c294642225a6c91f5d7932dde75c2ae"></a>
    578. 

  578. <div class="memitem">
    579. 

  579. <div class="memproto">
    580. 

  580. <table class="mlabels">
    581. 

  581.   <tr>
    582. 

  582.   <td class="mlabels-left">
    583. 

  583.       <table class="memname">
    584. 

  584.         <tr>
    585. 

  585.           <td class="memname">Tools <a class="el" href="class_tools_1_1_context.html">Context</a> $context</td>
    586. 

  586.         </tr>
    587. 

  587.       </table>
    588. 

  588.   </td>
    589. 

  589.   <td class="mlabels-right">
    590. 

  590. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    591. 

  591.   </tr>
    592. 

  592. </table>
    593. 

  593. </div><div class="memdoc">
    594. 

  594. <p>/core/tools/Context.php Contains website's informations </p>
    595. 

  595. 

  596. <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>
    597. 

  597. 

  598. </div>
    599. 

  599. </div>
    600. 

  600. <a class="anchor" id="a6f46a4fa02fac7e14d194e8c618cc045"></a>
    601. 

  601. <div class="memitem">
    602. 

  602. <div class="memproto">
    603. 

  603. <table class="mlabels">
    604. 

  604.   <tr>
    605. 

  605.   <td class="mlabels-left">
    606. 

  606.       <table class="memname">
    607. 

  607.         <tr>
    608. 

  608.           <td class="memname">array $overridden</td>
    609. 

  609.         </tr>
    610. 

  610.       </table>
    611. 

  611.   </td>
    612. 

  612.   <td class="mlabels-right">
    613. 

  613. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    614. 

  614.   </tr>
    615. 

  615. </table>
    616. 

  616. </div><div class="memdoc">
    617. 

  617. <p>contains url and paths to rewrite </p>
    618. 

  618. 

  619. <p>Definition at line <a class="el" href="_router_8php_source.html#l00057">57</a> of file <a class="el" href="_router_8php_source.html">Router.php</a>.</p>
    620. 

  620. 

  621. </div>
    622. 

  622. </div>
    623. 

  623. <a class="anchor" id="acbb09e02c973fc56c7395cc5b9a85123"></a>
    624. 

  624. <div class="memitem">
    625. 

  625. <div class="memproto">
    626. 

  626. <table class="mlabels">
    627. 

  627.   <tr>
    628. 

  628.   <td class="mlabels-left">
    629. 

  629.       <table class="memname">
    630. 

  630.         <tr>
    631. 

  631.           <td class="memname">string $requestUrl</td>
    632. 

  632.         </tr>
    633. 

  633.       </table>
    634. 

  634.   </td>
    635. 

  635.   <td class="mlabels-right">
    636. 

  636. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    637. 

  637.   </tr>
    638. 

  638. </table>
    639. 

  639. </div><div class="memdoc">
    640. 

  640. <p>Contains request </p>
    641. 

  641. 

  642. <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>
    643. 

  643. 

  644. </div>
    645. 

  645. </div>
    646. 

  646. <a class="anchor" id="abaa9f54c924a22e8c0169f443efd1055"></a>
    647. 

  647. <div class="memitem">
    648. 

  648. <div class="memproto">
    649. 

  649. <table class="mlabels">
    650. 

  650.   <tr>
    651. 

  651.   <td class="mlabels-left">
    652. 

  652.       <table class="memname">
    653. 

  653.         <tr>
    654. 

  654.           <td class="memname">string $rootPath</td>
    655. 

  655.         </tr>
    656. 

  656.       </table>
    657. 

  657.   </td>
    658. 

  658.   <td class="mlabels-right">
    659. 

  659. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    660. 

  660.   </tr>
    661. 

  661. </table>
    662. 

  662. </div><div class="memdoc">
    663. 

  663. <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>
    664. 

  664. <p>Contains the application's root path (ex: /srv/http/myshop/) with trailing slash Can be accessed read-only via $instance-&gt;rootUrl </p>
    665. 

  665. 

  666. <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>
    667. 

  667. 

  668. </div>
    669. 

  669. </div>
    670. 

  670. <a class="anchor" id="a0de279007713709c32cdf155ad3c63cd"></a>
    671. 

  671. <div class="memitem">
    672. 

  672. <div class="memproto">
    673. 

  673. <table class="mlabels">
    674. 

  674.   <tr>
    675. 

  675.   <td class="mlabels-left">
    676. 

  676.       <table class="memname">
    677. 

  677.         <tr>
    678. 

  678.           <td class="memname">$rootUrl</td>
    679. 

  679.         </tr>
    680. 

  680.       </table>
    681. 

  681.   </td>
    682. 

  682.   <td class="mlabels-right">
    683. 

  683. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    684. 

  684.   </tr>
    685. 

  685. </table>
    686. 

  686. </div><div class="memdoc">
    687. 

  687. 

  688. <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>
    689. 

  689. 

  690. </div>
    691. 

  691. </div>
    692. 

  692. <a class="anchor" id="ad167d71585142809d420fe2a3b66d56c"></a>
    693. 

  693. <div class="memitem">
    694. 

  694. <div class="memproto">
    695. 

  695. <table class="mlabels">
    696. 

  696.   <tr>
    697. 

  697.   <td class="mlabels-left">
    698. 

  698.       <table class="memname">
    699. 

  699.         <tr>
    700. 

  700.           <td class="memname">$routeParams</td>
    701. 

  701.         </tr>
    702. 

  702.       </table>
    703. 

  703.   </td>
    704. 

  704.   <td class="mlabels-right">
    705. 

  705. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    706. 

  706.   </tr>
    707. 

  707. </table>
    708. 

  708. </div><div class="memdoc">
    709. 

  709. 

  710. <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>
    711. 

  711. 

  712. </div>
    713. 

  713. </div>
    714. 

  714. <a class="anchor" id="a8f7eb04a54e0f0bfc0cedeb9899ce4a8"></a>
    715. 

  715. <div class="memitem">
    716. 

  716. <div class="memproto">
    717. 

  717. <table class="mlabels">
    718. 

  718.   <tr>
    719. 

  719.   <td class="mlabels-left">
    720. 

  720.       <table class="memname">
    721. 

  721.         <tr>
    722. 

  722.           <td class="memname">$routes</td>
    723. 

  723.         </tr>
    724. 

  724.       </table>
    725. 

  725.   </td>
    726. 

  726.   <td class="mlabels-right">
    727. 

  727. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    728. 

  728.   </tr>
    729. 

  729. </table>
    730. 

  730. </div><div class="memdoc">
    731. 

  731. 

  732. <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>
    733. 

  733. 

  734. </div>
    735. 

  735. </div>
    736. 

  736. <hr/>The documentation for this class was generated from the following file:<ul>
    737. 

  737. <li>core/tools/<a class="el" href="_router_8php_source.html">Router.php</a></li>
    738. 

  738. </ul>
    739. 

  739. </div><!-- contents -->
    740. 

  740. <!-- start footer part -->
    741. 

  741. <hr class="footer"/><address class="footer"><small>
    742. 

  742. Generated on Sun Aug 16 2015 21:56:15 for ecom by &#160;<a href="http://www.doxygen.org/index.html">
    743. 

  743. <img class="footer" src="doxygen.png" alt="doxygen"/>
    744. 

  744. </a> 1.8.8
    745. 

  745. </small></address>
    746. 

  746. </body>
    747. 

  747. </html>
    748.