class_tools_1_1_module_manager.html 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541
  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="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_module_manager.html">ModuleManager</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-methods">Private Member Functions</a> &#124;
  92. <a href="#pri-attribs">Private Attributes</a> &#124;
  93. <a href="#pri-static-attribs">Static Private Attributes</a> </div>
  94. <div class="headertitle">
  95. <div class="title">ModuleManager Class Reference</div> </div>
  96. </div><!--header-->
  97. <div class="contents">
  98. <table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  100. Public Member Functions</h2></td></tr>
  101. <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>
  102. <tr class="separator:a01955facbcef5c0159144d7209704be2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a3a08c349e26f53ae15f2526ffc70a091"><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#a3a08c349e26f53ae15f2526ffc70a091">install</a> ($modulename)</td></tr>
  104. <tr class="separator:a3a08c349e26f53ae15f2526ffc70a091"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <tr class="separator:a279ef46fb2e62ce756023d9a443d7953"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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>
  108. <tr class="separator:ab1dcee2727d5614cb8c028c57d2271e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <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>
  110. <tr class="separator:a4537dad3b44254124991341cc91b28fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table><table class="memberdecls">
  112. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  113. Static Public Member Functions</h2></td></tr>
  114. <tr class="memitem:ae2f2483f1e0397c7f7a64c64a6a63025"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#ae2f2483f1e0397c7f7a64c64a6a63025">isInstalling</a> ()</td></tr>
  115. <tr class="separator:ae2f2483f1e0397c7f7a64c64a6a63025"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. </table><table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
  118. Private Member Functions</h2></td></tr>
  119. <tr class="memitem:a95b745cacad4b0bb9564b5dbd66828fe"><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#a95b745cacad4b0bb9564b5dbd66828fe">loadModuleFile</a> ($path)</td></tr>
  120. <tr class="separator:a95b745cacad4b0bb9564b5dbd66828fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <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>
  122. <tr class="separator:a167a402eddef05c09ce608f803009baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. </table><table class="memberdecls">
  124. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
  125. Private Attributes</h2></td></tr>
  126. <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>
  127. <tr class="separator:a7c294642225a6c91f5d7932dde75c2ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <tr class="separator:a19e625c76c6796e995f33d323ee3aa84"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. </table><table class="memberdecls">
  131. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
  132. Static Private Attributes</h2></td></tr>
  133. <tr class="memitem:a36cecdf89abd520000db43ccab99da6d"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a36cecdf89abd520000db43ccab99da6d">$installing</a> = false</td></tr>
  134. <tr class="separator:a36cecdf89abd520000db43ccab99da6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table>
  136. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  137. <div class="textblock"><p>Container all modules. Allow module managment </p>
  138. <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>
  139. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  140. <a class="anchor" id="a01955facbcef5c0159144d7209704be2"></a>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">__construct </td>
  146. <td>(</td>
  147. <td class="paramtype">&amp;&#160;</td>
  148. <td class="paramname"><em>$context</em></td><td>)</td>
  149. <td></td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. <dl class="params"><dt>Parameters</dt><dd>
  154. <table class="params">
  155. <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>
  156. </table>
  157. </dd>
  158. </dl>
  159. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00043">43</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  160. <div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; {</div>
  161. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; $this-&gt;context = <a class="code" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>;</div>
  162. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; $modulesRoot = <a class="code" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>-&gt;router-&gt;modulesPath;</div>
  163. <div class="line"><a name="l00047"></a><span class="lineno"> 47</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>
  164. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; $ids = array();</div>
  165. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">foreach</span> (<a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> as $i)</div>
  166. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; {</div>
  167. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; $modulePath = <span class="stringliteral">&quot;{$modulesRoot}{$i-&gt;directory}/main.php&quot;</span>;</div>
  168. <div class="line"><a name="l00052"></a><span class="lineno"> 52</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>
  169. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; {</div>
  170. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; $ids[] = $i-&gt;id;</div>
  171. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; }</div>
  172. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">else</span></div>
  173. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; {</div>
  174. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; $i-&gt;active = <span class="keyword">false</span>;</div>
  175. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; $i-&gt;save();</div>
  176. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div>
  177. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div>
  178. <div class="line"><a name="l00062"></a><span class="lineno"> 62</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>
  179. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; }</div>
  180. <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>
  181. <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>
  182. <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>
  183. <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#l00088">ModuleManager.php:88</a></div></div>
  184. <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>
  185. </div><!-- fragment -->
  186. </div>
  187. </div>
  188. <h2 class="groupheader">Member Function Documentation</h2>
  189. <a class="anchor" id="a4537dad3b44254124991341cc91b28fb"></a>
  190. <div class="memitem">
  191. <div class="memproto">
  192. <table class="memname">
  193. <tr>
  194. <td class="memname">__get </td>
  195. <td>(</td>
  196. <td class="paramtype">&#160;</td>
  197. <td class="paramname"><em>$key</em></td><td>)</td>
  198. <td></td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Getter </p>
  203. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00173">173</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  204. <div class="fragment"><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; {</div>
  205. <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; <span class="keywordflow">switch</span> ($key)</div>
  206. <div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; {</div>
  207. <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;modules&quot;</span>:</div>
  208. <div class="line"><a name="l00178"></a><span class="lineno"> 178</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>
  209. <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; }</div>
  210. <div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keywordflow">if</span> (substr($key, 0, 4) == <span class="stringliteral">&quot;_id_&quot;</span>)</div>
  211. <div class="line"><a name="l00181"></a><span class="lineno"> 181</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>
  212. <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; <span class="keywordflow">throw</span> new \Exception(<span class="stringliteral">&quot;Cannot access attribute {$key}&quot;</span>);</div>
  213. <div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; }</div>
  214. <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#l00154">ModuleManager.php:154</a></div></div>
  215. <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>
  216. </div><!-- fragment -->
  217. </div>
  218. </div>
  219. <a class="anchor" id="ab1dcee2727d5614cb8c028c57d2271e8"></a>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">getModuleFromId </td>
  225. <td>(</td>
  226. <td class="paramtype">&#160;</td>
  227. <td class="paramname"><em>$id</em></td><td>)</td>
  228. <td></td>
  229. </tr>
  230. </table>
  231. </div><div class="memdoc">
  232. <dl class="params"><dt>Parameters</dt><dd>
  233. <table class="params">
  234. <tr><td class="paramtype">int</td><td class="paramname">$id</td><td></td></tr>
  235. </table>
  236. </dd>
  237. </dl>
  238. <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>
  239. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00154">154</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  240. <div class="fragment"><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; {</div>
  241. <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; <span class="keywordflow">foreach</span> ($this-&gt;modules as $i)</div>
  242. <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; {</div>
  243. <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; <span class="keywordflow">if</span> ($i-&gt;entity-&gt;id == $id)</div>
  244. <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; <span class="keywordflow">return</span> $i;</div>
  245. <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; }</div>
  246. <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; <span class="keywordflow">return</span> FALSE;</div>
  247. <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; }</div>
  248. </div><!-- fragment -->
  249. </div>
  250. </div>
  251. <a class="anchor" id="a3a08c349e26f53ae15f2526ffc70a091"></a>
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="memname">
  255. <tr>
  256. <td class="memname">install </td>
  257. <td>(</td>
  258. <td class="paramtype">&#160;</td>
  259. <td class="paramname"><em>$modulename</em></td><td>)</td>
  260. <td></td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <dl class="params"><dt>Parameters</dt><dd>
  265. <table class="params">
  266. <tr><td class="paramtype">string</td><td class="paramname">$modulename</td><td></td></tr>
  267. </table>
  268. </dd>
  269. </dl>
  270. <dl class="section return"><dt>Returns</dt><dd>|false on failure Install the module located in {modulePath}/modulename/modulename.php </dd></dl>
  271. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00103">103</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  272. <div class="fragment"><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; {</div>
  273. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; $entity = new \Entity\Module();</div>
  274. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; $entity-&gt;name = $modulename;</div>
  275. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; $entity-&gt;directory = $modulename;</div>
  276. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; $entity-&gt;active = <span class="keyword">true</span>;</div>
  277. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; $module = $this-&gt;<a class="code" href="class_tools_1_1_module_manager.html#a95b745cacad4b0bb9564b5dbd66828fe">loadModuleFile</a>($this-&gt;context-&gt;router-&gt;modulesPath.$modulename.<span class="stringliteral">&#39;/main.php&#39;</span>);</div>
  278. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordflow">if</span> ($module === <span class="keyword">false</span>)</div>
  279. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  280. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; $module-&gt;setEntity($entity);</div>
  281. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; $entity-&gt;name = $module-&gt;getName();</div>
  282. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; $entity-&gt;description = $module-&gt;getDescription();</div>
  283. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; $entity-&gt;save();</div>
  284. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; self::$installing = <span class="keyword">true</span>;</div>
  285. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordflow">if</span> ($module-&gt;install() == <span class="keyword">false</span>)</div>
  286. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; {</div>
  287. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; self::$installing = <span class="keyword">false</span>;</div>
  288. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; $hooks = <a class="code" href="class_entity_1_1_module_hook.html#a71be00f62d624dea24303dd1cbb3e611">\Entity\ModuleHook::getModules</a>($entity-&gt;id);</div>
  289. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keywordflow">foreach</span> ($hooks as $i)</div>
  290. <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; $i-&gt;delete();</div>
  291. <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; $entity-&gt;delete();</div>
  292. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  293. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; }</div>
  294. <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; self::$installing = <span class="keyword">false</span>;</div>
  295. <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keywordflow">return</span> $module;</div>
  296. <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; }</div>
  297. <div class="ttc" id="class_entity_1_1_module_hook_html_a71be00f62d624dea24303dd1cbb3e611"><div class="ttname"><a href="class_entity_1_1_module_hook.html#a71be00f62d624dea24303dd1cbb3e611">Entity\ModuleHook\getModules</a></div><div class="ttdeci">static getModules($moduleIds)</div><div class="ttdef"><b>Definition:</b> <a href="_module_hook_8php_source.html#l00023">ModuleHook.php:23</a></div></div>
  298. <div class="ttc" id="class_tools_1_1_module_manager_html_a95b745cacad4b0bb9564b5dbd66828fe"><div class="ttname"><a href="class_tools_1_1_module_manager.html#a95b745cacad4b0bb9564b5dbd66828fe">Tools\ModuleManager\loadModuleFile</a></div><div class="ttdeci">loadModuleFile($path)</div><div class="ttdef"><b>Definition:</b> <a href="_module_manager_8php_source.html#l00069">ModuleManager.php:69</a></div></div>
  299. </div><!-- fragment -->
  300. </div>
  301. </div>
  302. <a class="anchor" id="ae2f2483f1e0397c7f7a64c64a6a63025"></a>
  303. <div class="memitem">
  304. <div class="memproto">
  305. <table class="mlabels">
  306. <tr>
  307. <td class="mlabels-left">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">static isInstalling </td>
  311. <td>(</td>
  312. <td class="paramname"></td><td>)</td>
  313. <td></td>
  314. </tr>
  315. </table>
  316. </td>
  317. <td class="mlabels-right">
  318. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  319. </tr>
  320. </table>
  321. </div><div class="memdoc">
  322. <dl class="section return"><dt>Returns</dt><dd>true if a module is currently installing </dd></dl>
  323. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00167">167</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  324. <div class="fragment"><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; { <span class="keywordflow">return</span> self::$installing; }</div>
  325. </div><!-- fragment -->
  326. </div>
  327. </div>
  328. <a class="anchor" id="a279ef46fb2e62ce756023d9a443d7953"></a>
  329. <div class="memitem">
  330. <div class="memproto">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">listAvailableModules </td>
  334. <td>(</td>
  335. <td class="paramname"></td><td>)</td>
  336. <td></td>
  337. </tr>
  338. </table>
  339. </div><div class="memdoc">
  340. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00135">135</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  341. <div class="fragment"><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; {</div>
  342. <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; $modulesRoot = <a class="code" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>-&gt;router-&gt;modulesPath;</div>
  343. <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; $result = array();</div>
  344. <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> = scandir($modulesRoot, SCANDIR_SORT_NONE);</div>
  345. <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keywordflow">foreach</span> (<a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> as $i)</div>
  346. <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; {</div>
  347. <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; $path = $modulesRoot.$i;</div>
  348. <div class="line"><a name="l00143"></a><span class="lineno"> 143</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>
  349. <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="keywordflow">continue</span>;</div>
  350. <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; $this-&gt;<a class="code" href="class_tools_1_1_module_manager.html#a167a402eddef05c09ce608f803009baa">loadModule</a>($path);</div>
  351. <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; }</div>
  352. <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; }</div>
  353. <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>
  354. <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#l00088">ModuleManager.php:88</a></div></div>
  355. <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>
  356. </div><!-- fragment -->
  357. </div>
  358. </div>
  359. <a class="anchor" id="a167a402eddef05c09ce608f803009baa"></a>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <table class="mlabels">
  363. <tr>
  364. <td class="mlabels-left">
  365. <table class="memname">
  366. <tr>
  367. <td class="memname">loadModule </td>
  368. <td>(</td>
  369. <td class="paramtype">&#160;</td>
  370. <td class="paramname"><em>$path</em>, </td>
  371. </tr>
  372. <tr>
  373. <td class="paramkey"></td>
  374. <td></td>
  375. <td class="paramtype">&#160;</td>
  376. <td class="paramname"><em>$module</em>&#160;</td>
  377. </tr>
  378. <tr>
  379. <td></td>
  380. <td>)</td>
  381. <td></td><td></td>
  382. </tr>
  383. </table>
  384. </td>
  385. <td class="mlabels-right">
  386. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. <dl class="params"><dt>Parameters</dt><dd>
  391. <table class="params">
  392. <tr><td class="paramtype">string</td><td class="paramname">$path</td><td>path to module's main file </td></tr>
  393. <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>
  394. </table>
  395. </dd>
  396. </dl>
  397. <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>
  398. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00088">88</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  399. <div class="fragment"><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; {</div>
  400. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; $mod = $this-&gt;<a class="code" href="class_tools_1_1_module_manager.html#a95b745cacad4b0bb9564b5dbd66828fe">loadModuleFile</a>($path);</div>
  401. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordflow">if</span> ($mod === <span class="keyword">false</span>)</div>
  402. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  403. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; $mod-&gt;setEntity($module);</div>
  404. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; $this-&gt;modules[] = $mod;</div>
  405. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
  406. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; }</div>
  407. <div class="ttc" id="class_tools_1_1_module_manager_html_a95b745cacad4b0bb9564b5dbd66828fe"><div class="ttname"><a href="class_tools_1_1_module_manager.html#a95b745cacad4b0bb9564b5dbd66828fe">Tools\ModuleManager\loadModuleFile</a></div><div class="ttdeci">loadModuleFile($path)</div><div class="ttdef"><b>Definition:</b> <a href="_module_manager_8php_source.html#l00069">ModuleManager.php:69</a></div></div>
  408. </div><!-- fragment -->
  409. </div>
  410. </div>
  411. <a class="anchor" id="a95b745cacad4b0bb9564b5dbd66828fe"></a>
  412. <div class="memitem">
  413. <div class="memproto">
  414. <table class="mlabels">
  415. <tr>
  416. <td class="mlabels-left">
  417. <table class="memname">
  418. <tr>
  419. <td class="memname">loadModuleFile </td>
  420. <td>(</td>
  421. <td class="paramtype">&#160;</td>
  422. <td class="paramname"><em>$path</em></td><td>)</td>
  423. <td></td>
  424. </tr>
  425. </table>
  426. </td>
  427. <td class="mlabels-right">
  428. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  429. </tr>
  430. </table>
  431. </div><div class="memdoc">
  432. <dl class="params"><dt>Parameters</dt><dd>
  433. <table class="params">
  434. <tr><td class="paramtype">string</td><td class="paramname">$path</td><td></td></tr>
  435. </table>
  436. </dd>
  437. </dl>
  438. <dl class="section return"><dt>Returns</dt><dd>loaded module (or false on error) </dd></dl>
  439. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00069">69</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  440. <div class="fragment"><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; {</div>
  441. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; $mod = include_once($path);</div>
  442. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordflow">if</span> (!$mod || !($mod instanceof \<a class="code" href="namespace_tools.html">Tools</a>\AModule))</div>
  443. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  444. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; $mod-&gt;setContext($this-&gt;context);</div>
  445. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordflow">return</span> $mod;</div>
  446. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div>
  447. <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>
  448. </div><!-- fragment -->
  449. </div>
  450. </div>
  451. <h2 class="groupheader">Field Documentation</h2>
  452. <a class="anchor" id="a7c294642225a6c91f5d7932dde75c2ae"></a>
  453. <div class="memitem">
  454. <div class="memproto">
  455. <table class="mlabels">
  456. <tr>
  457. <td class="mlabels-left">
  458. <table class="memname">
  459. <tr>
  460. <td class="memname">Tools <a class="el" href="class_tools_1_1_context.html">Context</a> $context</td>
  461. </tr>
  462. </table>
  463. </td>
  464. <td class="mlabels-right">
  465. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  466. </tr>
  467. </table>
  468. </div><div class="memdoc">
  469. <p>/core/tools/Context.php Contains website's informations </p>
  470. <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>
  471. </div>
  472. </div>
  473. <a class="anchor" id="a36cecdf89abd520000db43ccab99da6d"></a>
  474. <div class="memitem">
  475. <div class="memproto">
  476. <table class="mlabels">
  477. <tr>
  478. <td class="mlabels-left">
  479. <table class="memname">
  480. <tr>
  481. <td class="memname">$installing = false</td>
  482. </tr>
  483. </table>
  484. </td>
  485. <td class="mlabels-right">
  486. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
  487. </tr>
  488. </table>
  489. </div><div class="memdoc">
  490. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00029">29</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
  491. </div>
  492. </div>
  493. <a class="anchor" id="a19e625c76c6796e995f33d323ee3aa84"></a>
  494. <div class="memitem">
  495. <div class="memproto">
  496. <table class="mlabels">
  497. <tr>
  498. <td class="mlabels-left">
  499. <table class="memname">
  500. <tr>
  501. <td class="memname">$modules = array()</td>
  502. </tr>
  503. </table>
  504. </td>
  505. <td class="mlabels-right">
  506. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  507. </tr>
  508. </table>
  509. </div><div class="memdoc">
  510. <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>
  511. </div>
  512. </div>
  513. <hr/>The documentation for this class was generated from the following file:<ul>
  514. <li>core/tools/<a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a></li>
  515. </ul>
  516. </div><!-- contents -->
  517. <!-- start footer part -->
  518. <hr class="footer"/><address class="footer"><small>
  519. Generated on Sun Aug 16 2015 21:56:15 for ecom by &#160;<a href="http://www.doxygen.org/index.html">
  520. <img class="footer" src="doxygen.png" alt="doxygen"/>
  521. </a> 1.8.8
  522. </small></address>
  523. </body>
  524. </html>