class_tools_1_1_context.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530
  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: Context 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_context.html">Context</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="#pub-static-methods">Static Public Member Functions</a> &#124;
  91. <a href="#pri-attribs">Private Attributes</a> &#124;
  92. <a href="#pri-static-attribs">Static Private Attributes</a> </div>
  93. <div class="headertitle">
  94. <div class="title">Context Class Reference</div> </div>
  95. </div><!--header-->
  96. <div class="contents">
  97. <table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  99. Public Member Functions</h2></td></tr>
  100. <tr class="memitem:a4a9ed3cc0b3551a50aa35c18eb9bb352"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#a4a9ed3cc0b3551a50aa35c18eb9bb352">__construct</a> ($server=null)</td></tr>
  101. <tr class="separator:a4a9ed3cc0b3551a50aa35c18eb9bb352"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:aa9e0b443b9575f62bf9f8e85b1742c96"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#aa9e0b443b9575f62bf9f8e85b1742c96">serve</a> ()</td></tr>
  103. <tr class="separator:aa9e0b443b9575f62bf9f8e85b1742c96"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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_context.html#a4537dad3b44254124991341cc91b28fb">__get</a> ($key)</td></tr>
  105. <tr class="separator:a4537dad3b44254124991341cc91b28fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a7e7fa404cfa0e6aff17bf034f719fa12"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#a7e7fa404cfa0e6aff17bf034f719fa12">isTestingEnvironment</a> ()</td></tr>
  107. <tr class="separator:a7e7fa404cfa0e6aff17bf034f719fa12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. </table><table class="memberdecls">
  109. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  110. Static Public Member Functions</h2></td></tr>
  111. <tr class="memitem:aa3fe42ba4c6ff4bf9fe17a836d6b593f"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#aa3fe42ba4c6ff4bf9fe17a836d6b593f">getContext</a> ()</td></tr>
  112. <tr class="separator:aa3fe42ba4c6ff4bf9fe17a836d6b593f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. </table><table class="memberdecls">
  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
  115. Private Attributes</h2></td></tr>
  116. <tr class="memitem:aafbd9a1b51b1f8a2f339c26667b737f7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#aafbd9a1b51b1f8a2f339c26667b737f7">$hookManager</a></td></tr>
  117. <tr class="separator:aafbd9a1b51b1f8a2f339c26667b737f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a98e337617fa9647176db165d050037a6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#a98e337617fa9647176db165d050037a6">$moduleManager</a></td></tr>
  119. <tr class="separator:a98e337617fa9647176db165d050037a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:aa37a3471877826e6468824f3f4bbe045"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#aa37a3471877826e6468824f3f4bbe045">$router</a></td></tr>
  121. <tr class="separator:aa37a3471877826e6468824f3f4bbe045"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a02e30d1742d35e696b2c57d76fbaa477"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#a02e30d1742d35e696b2c57d76fbaa477">$cart</a></td></tr>
  123. <tr class="separator:a02e30d1742d35e696b2c57d76fbaa477"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a8b7726f763e4795501ee2a0327960dc0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#a8b7726f763e4795501ee2a0327960dc0">$user</a></td></tr>
  125. <tr class="separator:a8b7726f763e4795501ee2a0327960dc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a232854b8e97359df1687d6c24460eacf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#a232854b8e97359df1687d6c24460eacf">$controller</a></td></tr>
  127. <tr class="separator:a232854b8e97359df1687d6c24460eacf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:acc9f557e674bc4c5e37c43fd1b140adc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#acc9f557e674bc4c5e37c43fd1b140adc">$ip</a></td></tr>
  129. <tr class="separator:acc9f557e674bc4c5e37c43fd1b140adc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a73dd99ff94413eda94afa6627c21b868"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#a73dd99ff94413eda94afa6627c21b868">$server</a></td></tr>
  131. <tr class="separator:a73dd99ff94413eda94afa6627c21b868"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. </table><table class="memberdecls">
  133. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
  134. Static Private Attributes</h2></td></tr>
  135. <tr class="memitem:ad9d7ce33ebb142b70e58b68052ca0ea8"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_context.html#ad9d7ce33ebb142b70e58b68052ca0ea8">$instance</a></td></tr>
  136. <tr class="separator:ad9d7ce33ebb142b70e58b68052ca0ea8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. </table>
  138. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  139. <div class="textblock"><p>Cms context Contains all website informations Will be passed to themes files and to modules </p>
  140. <p>Definition at line <a class="el" href="_context_8php_source.html#l00010">10</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  141. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  142. <a class="anchor" id="a4a9ed3cc0b3551a50aa35c18eb9bb352"></a>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">__construct </td>
  148. <td>(</td>
  149. <td class="paramtype">&#160;</td>
  150. <td class="paramname"><em>$server</em> = <code>null</code></td><td>)</td>
  151. <td></td>
  152. </tr>
  153. </table>
  154. </div><div class="memdoc">
  155. <p>Create context from $_SERVER environment and initialize all data </p><dl class="params"><dt>Parameters</dt><dd>
  156. <table class="params">
  157. <tr><td class="paramtype">array</td><td class="paramname">$server</td><td>optional, contains $_SERVER configuration -&gt; REMOTE_ADDR client's ip -&gt; SCRIPT_NAME -&gt; DOCUMENT_ROOT -&gt; REQUEST_SCHEME '<a href="http:https'">http:https'</a> -&gt; REQUEST_URI -&gt; HTTP_HOST </td></tr>
  158. </table>
  159. </dd>
  160. </dl>
  161. <p>Definition at line <a class="el" href="_context_8php_source.html#l00090">90</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  162. <div class="fragment"><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; {</div>
  163. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; self::$instance = $this;</div>
  164. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="class_tools_1_1_context.html#a73dd99ff94413eda94afa6627c21b868">$server</a> == null)</div>
  165. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <a class="code" href="class_tools_1_1_context.html#a73dd99ff94413eda94afa6627c21b868">$server</a> = $_SERVER;</div>
  166. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; $this-&gt;ip = <a class="code" href="class_tools_1_1_context.html#a73dd99ff94413eda94afa6627c21b868">$server</a>[<span class="stringliteral">&quot;REMOTE_ADDR&quot;</span>];</div>
  167. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; $this-&gt;hookManager = <span class="keyword">new</span> Hooks($this);</div>
  168. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; $this-&gt;server = <a class="code" href="class_tools_1_1_context.html#a73dd99ff94413eda94afa6627c21b868">$server</a>;</div>
  169. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; $this-&gt;router = <span class="keyword">new</span> Router($this-&gt;server, $this);</div>
  170. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; }</div>
  171. <div class="ttc" id="class_tools_1_1_context_html_a73dd99ff94413eda94afa6627c21b868"><div class="ttname"><a href="class_tools_1_1_context.html#a73dd99ff94413eda94afa6627c21b868">Tools\Context\$server</a></div><div class="ttdeci">$server</div><div class="ttdef"><b>Definition:</b> <a href="_context_8php_source.html#l00077">Context.php:77</a></div></div>
  172. </div><!-- fragment -->
  173. </div>
  174. </div>
  175. <h2 class="groupheader">Member Function Documentation</h2>
  176. <a class="anchor" id="a4537dad3b44254124991341cc91b28fb"></a>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">__get </td>
  182. <td>(</td>
  183. <td class="paramtype">&#160;</td>
  184. <td class="paramname"><em>$key</em></td><td>)</td>
  185. <td></td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <p>Getter function </p>
  190. <p>Definition at line <a class="el" href="_context_8php_source.html#l00128">128</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  191. <div class="fragment"><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; {</div>
  192. <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keywordflow">switch</span> ($key)</div>
  193. <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; {</div>
  194. <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;router&quot;</span>: <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_context.html#aa37a3471877826e6468824f3f4bbe045">$this-&gt;router</a>; <span class="keywordflow">break</span>;</div>
  195. <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;cart&quot;</span>: <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_context.html#a02e30d1742d35e696b2c57d76fbaa477">$this-&gt;cart</a>; <span class="keywordflow">break</span>;</div>
  196. <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;user&quot;</span>: <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_context.html#a8b7726f763e4795501ee2a0327960dc0">$this-&gt;user</a>; <span class="keywordflow">break</span>;</div>
  197. <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;moduleManager&quot;</span>: <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_context.html#a98e337617fa9647176db165d050037a6">$this-&gt;moduleManager</a>; <span class="keywordflow">break</span>;</div>
  198. <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;hookManager&quot;</span>: <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_context.html#aafbd9a1b51b1f8a2f339c26667b737f7">$this-&gt;hookManager</a>; <span class="keywordflow">break</span>;</div>
  199. <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;ip&quot;</span>: <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_context.html#acc9f557e674bc4c5e37c43fd1b140adc">$this-&gt;ip</a>; <span class="keywordflow">break</span>;</div>
  200. <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;controller&quot;</span>: <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_context.html#a232854b8e97359df1687d6c24460eacf">$this-&gt;controller</a>; <span class="keywordflow">break</span>;</div>
  201. <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; }</div>
  202. <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keywordflow">throw</span> new \Exception(<span class="stringliteral">&quot;Cannot access attribute {$key}&quot;</span>);</div>
  203. <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; }</div>
  204. <div class="ttc" id="class_tools_1_1_context_html_a8b7726f763e4795501ee2a0327960dc0"><div class="ttname"><a href="class_tools_1_1_context.html#a8b7726f763e4795501ee2a0327960dc0">Tools\Context\$user</a></div><div class="ttdeci">$user</div><div class="ttdef"><b>Definition:</b> <a href="_context_8php_source.html#l00057">Context.php:57</a></div></div>
  205. <div class="ttc" id="class_tools_1_1_context_html_a02e30d1742d35e696b2c57d76fbaa477"><div class="ttname"><a href="class_tools_1_1_context.html#a02e30d1742d35e696b2c57d76fbaa477">Tools\Context\$cart</a></div><div class="ttdeci">$cart</div><div class="ttdef"><b>Definition:</b> <a href="_context_8php_source.html#l00049">Context.php:49</a></div></div>
  206. <div class="ttc" id="class_tools_1_1_context_html_aafbd9a1b51b1f8a2f339c26667b737f7"><div class="ttname"><a href="class_tools_1_1_context.html#aafbd9a1b51b1f8a2f339c26667b737f7">Tools\Context\$hookManager</a></div><div class="ttdeci">$hookManager</div><div class="ttdef"><b>Definition:</b> <a href="_context_8php_source.html#l00018">Context.php:18</a></div></div>
  207. <div class="ttc" id="class_tools_1_1_context_html_a98e337617fa9647176db165d050037a6"><div class="ttname"><a href="class_tools_1_1_context.html#a98e337617fa9647176db165d050037a6">Tools\Context\$moduleManager</a></div><div class="ttdeci">$moduleManager</div><div class="ttdef"><b>Definition:</b> <a href="_context_8php_source.html#l00031">Context.php:31</a></div></div>
  208. <div class="ttc" id="class_tools_1_1_context_html_aa37a3471877826e6468824f3f4bbe045"><div class="ttname"><a href="class_tools_1_1_context.html#aa37a3471877826e6468824f3f4bbe045">Tools\Context\$router</a></div><div class="ttdeci">$router</div><div class="ttdef"><b>Definition:</b> <a href="_context_8php_source.html#l00040">Context.php:40</a></div></div>
  209. <div class="ttc" id="class_tools_1_1_context_html_a232854b8e97359df1687d6c24460eacf"><div class="ttname"><a href="class_tools_1_1_context.html#a232854b8e97359df1687d6c24460eacf">Tools\Context\$controller</a></div><div class="ttdeci">$controller</div><div class="ttdef"><b>Definition:</b> <a href="_context_8php_source.html#l00064">Context.php:64</a></div></div>
  210. <div class="ttc" id="class_tools_1_1_context_html_acc9f557e674bc4c5e37c43fd1b140adc"><div class="ttname"><a href="class_tools_1_1_context.html#acc9f557e674bc4c5e37c43fd1b140adc">Tools\Context\$ip</a></div><div class="ttdeci">$ip</div><div class="ttdef"><b>Definition:</b> <a href="_context_8php_source.html#l00071">Context.php:71</a></div></div>
  211. </div><!-- fragment -->
  212. </div>
  213. </div>
  214. <a class="anchor" id="aa3fe42ba4c6ff4bf9fe17a836d6b593f"></a>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="mlabels">
  218. <tr>
  219. <td class="mlabels-left">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">static getContext </td>
  223. <td>(</td>
  224. <td class="paramname"></td><td>)</td>
  225. <td></td>
  226. </tr>
  227. </table>
  228. </td>
  229. <td class="mlabels-right">
  230. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. <dl class="section return"><dt>Returns</dt><dd>context Get the last <a class="el" href="class_tools_1_1_context.html">Context</a> instance </dd></dl>
  235. <p>Definition at line <a class="el" href="_context_8php_source.html#l00155">155</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  236. <div class="fragment"><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; {</div>
  237. <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <span class="keywordflow">return</span> self::$instance;</div>
  238. <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; }</div>
  239. </div><!-- fragment -->
  240. </div>
  241. </div>
  242. <a class="anchor" id="a7e7fa404cfa0e6aff17bf034f719fa12"></a>
  243. <div class="memitem">
  244. <div class="memproto">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname">isTestingEnvironment </td>
  248. <td>(</td>
  249. <td class="paramname"></td><td>)</td>
  250. <td></td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. <p>Check if executed from phpUnit </p>
  255. <p>Definition at line <a class="el" href="_context_8php_source.html#l00146">146</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  256. <div class="fragment"><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; {</div>
  257. <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keywordflow">return</span> isset($this-&gt;server[<span class="stringliteral">&quot;phpUnit&quot;</span>]) &amp;&amp; $this-&gt;server[<span class="stringliteral">&quot;phpUnit&quot;</span>] == <span class="keyword">true</span>;</div>
  258. <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; }</div>
  259. </div><!-- fragment -->
  260. </div>
  261. </div>
  262. <a class="anchor" id="aa9e0b443b9575f62bf9f8e85b1742c96"></a>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname">serve </td>
  268. <td>(</td>
  269. <td class="paramname"></td><td>)</td>
  270. <td></td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. <p>Definition at line <a class="el" href="_context_8php_source.html#l00101">101</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  275. <div class="fragment"><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; {</div>
  276. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="comment">// @codeCoverageIgnoreStart</span></div>
  277. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordflow">if</span> (!\<a class="code" href="namespace_entity.html">Entity</a>\ModelBase::init())</div>
  278. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; {</div>
  279. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; @require_once(getcwd().<span class="stringliteral">&#39;/core/setup/index.php&#39;</span>);</div>
  280. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; die;</div>
  281. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; }</div>
  282. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="comment">// @codeCoverageIgnoreEnd</span></div>
  283. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; $this-&gt;router-&gt;init($this-&gt;server);</div>
  284. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; $this-&gt;moduleManager = <span class="keyword">new</span> ModuleManager($this);</div>
  285. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; $this-&gt;hookManager-&gt;trigger(<span class="stringliteral">&quot;routerSetup&quot;</span>);</div>
  286. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordflow">try</span></div>
  287. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; {</div>
  288. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; $this-&gt;controller = $this-&gt;router-&gt;serveUrl();</div>
  289. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordflow">if</span> (!$this-&gt;controller)</div>
  290. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordflow">throw</span> new \Exception\Error404();</div>
  291. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; }</div>
  292. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordflow">catch</span> (\<a class="code" href="namespace_exception.html">Exception</a>\Error404 $e)</div>
  293. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; {</div>
  294. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; $this-&gt;controller = new \Controller\Error404($this, array());</div>
  295. <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; }</div>
  296. <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; }</div>
  297. <div class="ttc" id="namespace_entity_html"><div class="ttname"><a href="namespace_entity.html">Entity</a></div><div class="ttdef"><b>Definition:</b> <a href="_address_8php_source.html#l00003">Address.php:3</a></div></div>
  298. <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>
  299. </div><!-- fragment -->
  300. </div>
  301. </div>
  302. <h2 class="groupheader">Field Documentation</h2>
  303. <a class="anchor" id="a02e30d1742d35e696b2c57d76fbaa477"></a>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="mlabels">
  307. <tr>
  308. <td class="mlabels-left">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">Tools Cart $cart</td>
  312. </tr>
  313. </table>
  314. </td>
  315. <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>TODO</p>
  321. <p>/core/tools/Cart.php Not defined yet Can be accessed read-only via $instance-&gt;cart </p>
  322. <p>Definition at line <a class="el" href="_context_8php_source.html#l00049">49</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  323. </div>
  324. </div>
  325. <a class="anchor" id="a232854b8e97359df1687d6c24460eacf"></a>
  326. <div class="memitem">
  327. <div class="memproto">
  328. <table class="mlabels">
  329. <tr>
  330. <td class="mlabels-left">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">Tools <a class="el" href="class_tools_1_1_a_controller.html">AController</a> $controller</td>
  334. </tr>
  335. </table>
  336. </td>
  337. <td class="mlabels-right">
  338. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  339. </tr>
  340. </table>
  341. </div><div class="memdoc">
  342. <p>/core/tools/AController.php <a class="el" href="namespace_controller.html">Controller</a> being called by user's request </p>
  343. <p>Definition at line <a class="el" href="_context_8php_source.html#l00064">64</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  344. </div>
  345. </div>
  346. <a class="anchor" id="aafbd9a1b51b1f8a2f339c26667b737f7"></a>
  347. <div class="memitem">
  348. <div class="memproto">
  349. <table class="mlabels">
  350. <tr>
  351. <td class="mlabels-left">
  352. <table class="memname">
  353. <tr>
  354. <td class="memname">Tools <a class="el" href="class_tools_1_1_hooks.html">Hooks</a> $hookManager</td>
  355. </tr>
  356. </table>
  357. </td>
  358. <td class="mlabels-right">
  359. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  360. </tr>
  361. </table>
  362. </div><div class="memdoc">
  363. <p>/core/tools/Hooks.php allow triggering hooks and registers module's endpoints Can be accessed read-only via $instance-&gt;hookManager </p>
  364. <p>Definition at line <a class="el" href="_context_8php_source.html#l00018">18</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  365. </div>
  366. </div>
  367. <a class="anchor" id="ad9d7ce33ebb142b70e58b68052ca0ea8"></a>
  368. <div class="memitem">
  369. <div class="memproto">
  370. <table class="mlabels">
  371. <tr>
  372. <td class="mlabels-left">
  373. <table class="memname">
  374. <tr>
  375. <td class="memname">$instance</td>
  376. </tr>
  377. </table>
  378. </td>
  379. <td class="mlabels-right">
  380. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
  381. </tr>
  382. </table>
  383. </div><div class="memdoc">
  384. <p>Definition at line <a class="el" href="_context_8php_source.html#l00023">23</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  385. </div>
  386. </div>
  387. <a class="anchor" id="acc9f557e674bc4c5e37c43fd1b140adc"></a>
  388. <div class="memitem">
  389. <div class="memproto">
  390. <table class="mlabels">
  391. <tr>
  392. <td class="mlabels-left">
  393. <table class="memname">
  394. <tr>
  395. <td class="memname">string $ip</td>
  396. </tr>
  397. </table>
  398. </td>
  399. <td class="mlabels-right">
  400. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  401. </tr>
  402. </table>
  403. </div><div class="memdoc">
  404. <p>Contains the remote client's IP, or empty Can be accessed via -&gt;ip </p>
  405. <p>Definition at line <a class="el" href="_context_8php_source.html#l00071">71</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  406. </div>
  407. </div>
  408. <a class="anchor" id="a98e337617fa9647176db165d050037a6"></a>
  409. <div class="memitem">
  410. <div class="memproto">
  411. <table class="mlabels">
  412. <tr>
  413. <td class="mlabels-left">
  414. <table class="memname">
  415. <tr>
  416. <td class="memname">Tools <a class="el" href="class_tools_1_1_module_manager.html">ModuleManager</a> $moduleManager</td>
  417. </tr>
  418. </table>
  419. </td>
  420. <td class="mlabels-right">
  421. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  422. </tr>
  423. </table>
  424. </div><div class="memdoc">
  425. <p>/core/tools/ModuleManager.php load all active modules and contains informations about them Can be accessed read-only via $instance-&gt;moduleManager </p>
  426. <p>Definition at line <a class="el" href="_context_8php_source.html#l00031">31</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  427. </div>
  428. </div>
  429. <a class="anchor" id="aa37a3471877826e6468824f3f4bbe045"></a>
  430. <div class="memitem">
  431. <div class="memproto">
  432. <table class="mlabels">
  433. <tr>
  434. <td class="mlabels-left">
  435. <table class="memname">
  436. <tr>
  437. <td class="memname">Tools <a class="el" href="class_tools_1_1_router.html">Router</a> $router</td>
  438. </tr>
  439. </table>
  440. </td>
  441. <td class="mlabels-right">
  442. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  443. </tr>
  444. </table>
  445. </div><div class="memdoc">
  446. <p>/core/tools/Router.php Contains information about directories and paths Allow user to generate links Can be accessed read-only via $instance-&gt;router </p>
  447. <p>Definition at line <a class="el" href="_context_8php_source.html#l00040">40</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  448. </div>
  449. </div>
  450. <a class="anchor" id="a73dd99ff94413eda94afa6627c21b868"></a>
  451. <div class="memitem">
  452. <div class="memproto">
  453. <table class="mlabels">
  454. <tr>
  455. <td class="mlabels-left">
  456. <table class="memname">
  457. <tr>
  458. <td class="memname">array $server</td>
  459. </tr>
  460. </table>
  461. </td>
  462. <td class="mlabels-right">
  463. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  464. </tr>
  465. </table>
  466. </div><div class="memdoc">
  467. <p>contains $_SERVER or Unit test environment </p>
  468. <p>Definition at line <a class="el" href="_context_8php_source.html#l00077">77</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  469. </div>
  470. </div>
  471. <a class="anchor" id="a8b7726f763e4795501ee2a0327960dc0"></a>
  472. <div class="memitem">
  473. <div class="memproto">
  474. <table class="mlabels">
  475. <tr>
  476. <td class="mlabels-left">
  477. <table class="memname">
  478. <tr>
  479. <td class="memname">Tools User $user</td>
  480. </tr>
  481. </table>
  482. </td>
  483. <td class="mlabels-right">
  484. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  485. </tr>
  486. </table>
  487. </div><div class="memdoc">
  488. <p>TODO</p>
  489. <p>/core/tools/User.php Can be accessed read-only via $instance-&gt;user </p>
  490. <p>Definition at line <a class="el" href="_context_8php_source.html#l00057">57</a> of file <a class="el" href="_context_8php_source.html">Context.php</a>.</p>
  491. </div>
  492. </div>
  493. <hr/>The documentation for this class was generated from the following file:<ul>
  494. <li>core/tools/<a class="el" href="_context_8php_source.html">Context.php</a></li>
  495. </ul>
  496. </div><!-- contents -->
  497. <!-- start footer part -->
  498. <hr class="footer"/><address class="footer"><small>
  499. Generated on Wed Aug 12 2015 21:31:31 for ecom by &#160;<a href="http://www.doxygen.org/index.html">
  500. <img class="footer" src="doxygen.png" alt="doxygen"/>
  501. </a> 1.8.8
  502. </small></address>
  503. </body>
  504. </html>