class_tools_1_1_module_manager.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386
  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: ModuleManager 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="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  43. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  44. <li><a href="files.html"><span>Files</span></a></li>
  45. <li>
  46. <div id="MSearchBox" class="MSearchBoxInactive">
  47. <span class="left">
  48. <img id="MSearchSelect" src="search/mag_sel.png"
  49. onmouseover="return searchBox.OnSearchSelectShow()"
  50. onmouseout="return searchBox.OnSearchSelectHide()"
  51. alt=""/>
  52. <input type="text" id="MSearchField" value="Search" accesskey="S"
  53. onfocus="searchBox.OnSearchFieldFocus(true)"
  54. onblur="searchBox.OnSearchFieldFocus(false)"
  55. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  56. </span><span class="right">
  57. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  58. </span>
  59. </div>
  60. </li>
  61. </ul>
  62. </div>
  63. <div id="navrow2" class="tabs2">
  64. <ul class="tablist">
  65. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  66. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  67. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  68. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  69. </ul>
  70. </div>
  71. <!-- window showing the filter options -->
  72. <div id="MSearchSelectWindow"
  73. onmouseover="return searchBox.OnSearchSelectShow()"
  74. onmouseout="return searchBox.OnSearchSelectHide()"
  75. onkeydown="return searchBox.OnSearchSelectKey(event)">
  76. <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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  77. <!-- iframe showing the search results (closed by default) -->
  78. <div id="MSearchResultsWindow">
  79. <iframe src="javascript:void(0)" frameborder="0"
  80. name="MSearchResults" id="MSearchResults">
  81. </iframe>
  82. </div>
  83. <div id="nav-path" class="navpath">
  84. <ul>
  85. <li class="navelem"><a class="el" href="namespace_tools.html">Tools</a></li><li class="navelem"><a class="el" href="class_tools_1_1_module_manager.html">ModuleManager</a></li> </ul>
  86. </div>
  87. </div><!-- top -->
  88. <div class="header">
  89. <div class="summary">
  90. <a href="#pub-methods">Public Member Functions</a> &#124;
  91. <a href="#pri-methods">Private Member Functions</a> &#124;
  92. <a href="#pri-attribs">Private Attributes</a> </div>
  93. <div class="headertitle">
  94. <div class="title">ModuleManager 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:a01955facbcef5c0159144d7209704be2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a01955facbcef5c0159144d7209704be2">__construct</a> (&amp;$context)</td></tr>
  101. <tr class="separator:a01955facbcef5c0159144d7209704be2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a279ef46fb2e62ce756023d9a443d7953"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a279ef46fb2e62ce756023d9a443d7953">listAvailableModules</a> ()</td></tr>
  103. <tr class="separator:a279ef46fb2e62ce756023d9a443d7953"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ab1dcee2727d5614cb8c028c57d2271e8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#ab1dcee2727d5614cb8c028c57d2271e8">getModuleFromId</a> ($id)</td></tr>
  105. <tr class="separator:ab1dcee2727d5614cb8c028c57d2271e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <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_module_manager.html#a4537dad3b44254124991341cc91b28fb">__get</a> ($key)</td></tr>
  107. <tr class="separator:a4537dad3b44254124991341cc91b28fb"><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="pri-methods"></a>
  110. Private Member Functions</h2></td></tr>
  111. <tr class="memitem:a167a402eddef05c09ce608f803009baa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a167a402eddef05c09ce608f803009baa">loadModule</a> ($path, $module)</td></tr>
  112. <tr class="separator:a167a402eddef05c09ce608f803009baa"><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:a7c294642225a6c91f5d7932dde75c2ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a></td></tr>
  117. <tr class="separator:a7c294642225a6c91f5d7932dde75c2ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a19e625c76c6796e995f33d323ee3aa84"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> = array()</td></tr>
  119. <tr class="separator:a19e625c76c6796e995f33d323ee3aa84"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table>
  121. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  122. <div class="textblock"><p>Container all modules. Allow module managment </p>
  123. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00009">9</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  124. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  125. <a class="anchor" id="a01955facbcef5c0159144d7209704be2"></a>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">__construct </td>
  131. <td>(</td>
  132. <td class="paramtype">&amp;&#160;</td>
  133. <td class="paramname"><em>$context</em></td><td>)</td>
  134. <td></td>
  135. </tr>
  136. </table>
  137. </div><div class="memdoc">
  138. <dl class="params"><dt>Parameters</dt><dd>
  139. <table class="params">
  140. <tr><td class="paramtype">\Tool\Context</td><td class="paramname">$context</td><td>Load all active modules from database. Enable hooks for these modules Disable them if the module cannot be loaded </td></tr>
  141. </table>
  142. </dd>
  143. </dl>
  144. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00038">38</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  145. <div class="fragment"><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; {</div>
  146. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; $this-&gt;context = <a class="code" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>;</div>
  147. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; $modulesRoot = <a class="code" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>-&gt;router-&gt;modulesPath;</div>
  148. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> = <a class="code" href="class_entity_1_1_module.html#a5a5d2fbfed8c77d8760c2d0473e92220">\Entity\Module::getActivated</a>();</div>
  149. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; $ids = array();</div>
  150. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">foreach</span> (<a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> as $i)</div>
  151. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; {</div>
  152. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; $modulePath = <span class="stringliteral">&quot;{$modulesRoot}{$i-&gt;directory}/main.php&quot;</span>;</div>
  153. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">if</span> (file_exists($modulePath) &amp;&amp; $this-&gt;<a class="code" href="class_tools_1_1_module_manager.html#a167a402eddef05c09ce608f803009baa">loadModule</a>($modulePath, $i))</div>
  154. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div>
  155. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; $ids[] = $i-&gt;id;</div>
  156. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
  157. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">else</span></div>
  158. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; {</div>
  159. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; die (<span class="stringliteral">&quot;out&quot;</span>);</div>
  160. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; $i-&gt;active = <span class="keyword">false</span>;</div>
  161. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; $i-&gt;save();</div>
  162. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div>
  163. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div>
  164. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>-&gt;hookManager-&gt;loadHooks(\<a class="code" href="namespace_entity.html">Entity</a>\ModuleHook::getModules($ids));</div>
  165. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; }</div>
  166. <div class="ttc" id="class_tools_1_1_module_manager_html_a7c294642225a6c91f5d7932dde75c2ae"><div class="ttname"><a href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">Tools\ModuleManager\$context</a></div><div class="ttdeci">$context</div><div class="ttdef"><b>Definition:</b> <a href="_module_manager_8php_source.html#l00016">ModuleManager.php:16</a></div></div>
  167. <div class="ttc" id="class_entity_1_1_module_html_a5a5d2fbfed8c77d8760c2d0473e92220"><div class="ttname"><a href="class_entity_1_1_module.html#a5a5d2fbfed8c77d8760c2d0473e92220">Entity\Module\getActivated</a></div><div class="ttdeci">static getActivated()</div><div class="ttdef"><b>Definition:</b> <a href="_module_8php_source.html#l00022">Module.php:22</a></div></div>
  168. <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>
  169. <div class="ttc" id="class_tools_1_1_module_manager_html_a167a402eddef05c09ce608f803009baa"><div class="ttname"><a href="class_tools_1_1_module_manager.html#a167a402eddef05c09ce608f803009baa">Tools\ModuleManager\loadModule</a></div><div class="ttdeci">loadModule($path, $module)</div><div class="ttdef"><b>Definition:</b> <a href="_module_manager_8php_source.html#l00071">ModuleManager.php:71</a></div></div>
  170. <div class="ttc" id="class_tools_1_1_module_manager_html_a19e625c76c6796e995f33d323ee3aa84"><div class="ttname"><a href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">Tools\ModuleManager\$modules</a></div><div class="ttdeci">$modules</div><div class="ttdef"><b>Definition:</b> <a href="_module_manager_8php_source.html#l00024">ModuleManager.php:24</a></div></div>
  171. </div><!-- fragment -->
  172. </div>
  173. </div>
  174. <h2 class="groupheader">Member Function Documentation</h2>
  175. <a class="anchor" id="a4537dad3b44254124991341cc91b28fb"></a>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">__get </td>
  181. <td>(</td>
  182. <td class="paramtype">&#160;</td>
  183. <td class="paramname"><em>$key</em></td><td>)</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>Getter </p>
  189. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00119">119</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  190. <div class="fragment"><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; {</div>
  191. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keywordflow">switch</span> ($key)</div>
  192. <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; {</div>
  193. <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;modules&quot;</span>:</div>
  194. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$this-&gt;modules</a>; <span class="keywordflow">break</span>;</div>
  195. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; }</div>
  196. <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordflow">if</span> (substr($key, 0, 4) == <span class="stringliteral">&quot;_id_&quot;</span>)</div>
  197. <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keywordflow">return</span> $this-&gt;<a class="code" href="class_tools_1_1_module_manager.html#ab1dcee2727d5614cb8c028c57d2271e8">getModuleFromId</a>((<span class="keywordtype">int</span>) substr($key, 4));</div>
  198. <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordflow">throw</span> new \Exception(<span class="stringliteral">&quot;Cannot access attribute {$key}&quot;</span>);</div>
  199. <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; }</div>
  200. <div class="ttc" id="class_tools_1_1_module_manager_html_ab1dcee2727d5614cb8c028c57d2271e8"><div class="ttname"><a href="class_tools_1_1_module_manager.html#ab1dcee2727d5614cb8c028c57d2271e8">Tools\ModuleManager\getModuleFromId</a></div><div class="ttdeci">getModuleFromId($id)</div><div class="ttdef"><b>Definition:</b> <a href="_module_manager_8php_source.html#l00106">ModuleManager.php:106</a></div></div>
  201. <div class="ttc" id="class_tools_1_1_module_manager_html_a19e625c76c6796e995f33d323ee3aa84"><div class="ttname"><a href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">Tools\ModuleManager\$modules</a></div><div class="ttdeci">$modules</div><div class="ttdef"><b>Definition:</b> <a href="_module_manager_8php_source.html#l00024">ModuleManager.php:24</a></div></div>
  202. </div><!-- fragment -->
  203. </div>
  204. </div>
  205. <a class="anchor" id="ab1dcee2727d5614cb8c028c57d2271e8"></a>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">getModuleFromId </td>
  211. <td>(</td>
  212. <td class="paramtype">&#160;</td>
  213. <td class="paramname"><em>$id</em></td><td>)</td>
  214. <td></td>
  215. </tr>
  216. </table>
  217. </div><div class="memdoc">
  218. <dl class="params"><dt>Parameters</dt><dd>
  219. <table class="params">
  220. <tr><td class="paramtype">int</td><td class="paramname">$id</td><td></td></tr>
  221. </table>
  222. </dd>
  223. </dl>
  224. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_tools_1_1_a_module.html">AModule</a> on success, FALSE on failure (no such ID / module not loaded) Get the module identified with id ID </dd></dl>
  225. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00106">106</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  226. <div class="fragment"><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; {</div>
  227. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keywordflow">foreach</span> ($this-&gt;modules as $i)</div>
  228. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; {</div>
  229. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordflow">if</span> ($i-&gt;entity-&gt;id == $id)</div>
  230. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordflow">return</span> $i;</div>
  231. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; }</div>
  232. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordflow">return</span> FALSE;</div>
  233. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; }</div>
  234. </div><!-- fragment -->
  235. </div>
  236. </div>
  237. <a class="anchor" id="a279ef46fb2e62ce756023d9a443d7953"></a>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname">listAvailableModules </td>
  243. <td>(</td>
  244. <td class="paramname"></td><td>)</td>
  245. <td></td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00087">87</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  250. <div class="fragment"><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; {</div>
  251. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; $modulesRoot = <a class="code" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>-&gt;router-&gt;modulesPath;</div>
  252. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; $result = array();</div>
  253. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> = scandir($modulesRoot, SCANDIR_SORT_NONE);</div>
  254. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">foreach</span> (<a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> as $i)</div>
  255. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; {</div>
  256. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; $path = $modulesRoot.$i;</div>
  257. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordflow">if</span> ($i == <span class="charliteral">&#39;.&#39;</span> || $i == <span class="stringliteral">&#39;..&#39;</span> || !is_dir($path))</div>
  258. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordflow">continue</span>;</div>
  259. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; $this-&gt;<a class="code" href="class_tools_1_1_module_manager.html#a167a402eddef05c09ce608f803009baa">loadModule</a>($path);</div>
  260. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; }</div>
  261. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; }</div>
  262. <div class="ttc" id="class_tools_1_1_module_manager_html_a7c294642225a6c91f5d7932dde75c2ae"><div class="ttname"><a href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">Tools\ModuleManager\$context</a></div><div class="ttdeci">$context</div><div class="ttdef"><b>Definition:</b> <a href="_module_manager_8php_source.html#l00016">ModuleManager.php:16</a></div></div>
  263. <div class="ttc" id="class_tools_1_1_module_manager_html_a167a402eddef05c09ce608f803009baa"><div class="ttname"><a href="class_tools_1_1_module_manager.html#a167a402eddef05c09ce608f803009baa">Tools\ModuleManager\loadModule</a></div><div class="ttdeci">loadModule($path, $module)</div><div class="ttdef"><b>Definition:</b> <a href="_module_manager_8php_source.html#l00071">ModuleManager.php:71</a></div></div>
  264. <div class="ttc" id="class_tools_1_1_module_manager_html_a19e625c76c6796e995f33d323ee3aa84"><div class="ttname"><a href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">Tools\ModuleManager\$modules</a></div><div class="ttdeci">$modules</div><div class="ttdef"><b>Definition:</b> <a href="_module_manager_8php_source.html#l00024">ModuleManager.php:24</a></div></div>
  265. </div><!-- fragment -->
  266. </div>
  267. </div>
  268. <a class="anchor" id="a167a402eddef05c09ce608f803009baa"></a>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="mlabels">
  272. <tr>
  273. <td class="mlabels-left">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">loadModule </td>
  277. <td>(</td>
  278. <td class="paramtype">&#160;</td>
  279. <td class="paramname"><em>$path</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype">&#160;</td>
  285. <td class="paramname"><em>$module</em>&#160;</td>
  286. </tr>
  287. <tr>
  288. <td></td>
  289. <td>)</td>
  290. <td></td><td></td>
  291. </tr>
  292. </table>
  293. </td>
  294. <td class="mlabels-right">
  295. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. <dl class="params"><dt>Parameters</dt><dd>
  300. <table class="params">
  301. <tr><td class="paramtype">string</td><td class="paramname">$path</td><td>path to module's main file </td></tr>
  302. <tr><td class="paramtype">\Entity\Module</td><td class="paramname">$module</td><td>module's database object to load /core/models/Module.php </td></tr>
  303. </table>
  304. </dd>
  305. </dl>
  306. <dl class="section return"><dt>Returns</dt><dd>TRUE on success Will try to load module located at $path. This function will include the main.php file located in the module's directory The file MUST return an <a class="el" href="class_tools_1_1_a_module.html">AModule</a> object to be considered as successfull /core/tools/AModule.php </dd></dl>
  307. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00071">71</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  308. <div class="fragment"><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; {</div>
  309. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; $mod = include_once($path);</div>
  310. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">if</span> (!$mod || !($mod instanceof \<a class="code" href="namespace_tools.html">Tools</a>\AModule))</div>
  311. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  312. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; $mod-&gt;setContext($this-&gt;context);</div>
  313. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; $mod-&gt;setEntity($module);</div>
  314. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; $this-&gt;modules[] = $mod;</div>
  315. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
  316. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; }</div>
  317. <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>
  318. </div><!-- fragment -->
  319. </div>
  320. </div>
  321. <h2 class="groupheader">Field Documentation</h2>
  322. <a class="anchor" id="a7c294642225a6c91f5d7932dde75c2ae"></a>
  323. <div class="memitem">
  324. <div class="memproto">
  325. <table class="mlabels">
  326. <tr>
  327. <td class="mlabels-left">
  328. <table class="memname">
  329. <tr>
  330. <td class="memname">Tools <a class="el" href="class_tools_1_1_context.html">Context</a> $context</td>
  331. </tr>
  332. </table>
  333. </td>
  334. <td class="mlabels-right">
  335. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. <p>/core/tools/Context.php Contains website's informations </p>
  340. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00016">16</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  341. </div>
  342. </div>
  343. <a class="anchor" id="a19e625c76c6796e995f33d323ee3aa84"></a>
  344. <div class="memitem">
  345. <div class="memproto">
  346. <table class="mlabels">
  347. <tr>
  348. <td class="mlabels-left">
  349. <table class="memname">
  350. <tr>
  351. <td class="memname">$modules = array()</td>
  352. </tr>
  353. </table>
  354. </td>
  355. <td class="mlabels-right">
  356. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  357. </tr>
  358. </table>
  359. </div><div class="memdoc">
  360. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00024">24</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  361. </div>
  362. </div>
  363. <hr/>The documentation for this class was generated from the following file:<ul>
  364. <li>/home/isundil/Project/ecom/core/tools/<a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a></li>
  365. </ul>
  366. </div><!-- contents -->
  367. <!-- start footer part -->
  368. <hr class="footer"/><address class="footer"><small>
  369. Generated on Tue Aug 4 2015 00:33:19 for ecom by &#160;<a href="http://www.doxygen.org/index.html">
  370. <img class="footer" src="doxygen.png" alt="doxygen"/>
  371. </a> 1.8.8
  372. </small></address>
  373. </body>
  374. </html>