Acasă Explorează Ajutor
Înregistrare Autentificare
isundil
/
julia
1
0
Bifurcare 0
Fisiere Probleme 0 Trageți solicitările 0 Wiki
Arbore: ed273d1bab
Ramuri Etichete
julia
/
doc
/
html
/
class_tools_1_1_module_manager.html

class_tools_1_1_module_manager.html 35 KB
Istoric Crud

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

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

  3. <head>
    4. 

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

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

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

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

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

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

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

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

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

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

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

  15. </script>
    16. 

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

  17. </head>
    18. 

  18. <body>
    19. 

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

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

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

  22.  <tbody>
    23. 

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

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

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

  26.    </div>
    27. 

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

  28.   </td>
    29. 

  29.  </tr>
    30. 

  30.  </tbody>
    31. 

  31. </table>
    32. 

  32. </div>
    33. 

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

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

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

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

  37. </script>
    38. 

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

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

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

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

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

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

  44.       <li>
    45. 

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

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

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

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

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

  50.                alt=""/>
    51. 

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

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

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

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

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

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

  57.           </span>
    58. 

  58.         </div>
    59. 

  59.       </li>
    60. 

  60.     </ul>
    61. 

  61.   </div>
    62. 

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

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

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

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

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

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

  68.     </ul>
    69. 

  69.   </div>
    70. 

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

  71. <div id="MSearchSelectWindow"
    72. 

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

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

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

  75. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a></div>
    76. 

  76. 

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

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

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

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

  81. </iframe>
    82. 

  82. </div>
    83. 

  83. 

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

  85.   <ul>
    86. 

  86. <li class="navelem"><a class="el" href="namespace_tools.html">Tools</a></li><li class="navelem"><a class="el" href="class_tools_1_1_module_manager.html">ModuleManager</a></li>  </ul>
    87. 

  87. </div>
    88. 

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

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

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

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

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

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

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

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

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

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

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

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

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

  101. <tr class="memitem: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. 

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

  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. 

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

  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. 

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

  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. 

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

  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. 

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

  111. </table><table class="memberdecls">
    112. 

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

  113. Private Member Functions</h2></td></tr>
    114. 

  114. <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>
    115. 

  115. <tr class="separator:a95b745cacad4b0bb9564b5dbd66828fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
    116. 

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

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

  118. </table><table class="memberdecls">
    119. 

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

  120. Private Attributes</h2></td></tr>
    121. 

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

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

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

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

  125. </table>
    126. 

  126. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    127. 

  127. <div class="textblock"><p>Container all modules. Allow module managment </p>
    128. 

  128. 

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

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

  131. <a class="anchor" id="a01955facbcef5c0159144d7209704be2"></a>
    132. 

  132. <div class="memitem">
    133. 

  133. <div class="memproto">
    134. 

  134.       <table class="memname">
    135. 

  135.         <tr>
    136. 

  136.           <td class="memname">__construct </td>
    137. 

  137.           <td>(</td>
    138. 

  138.           <td class="paramtype">&amp;&#160;</td>
    139. 

  139.           <td class="paramname"><em>$context</em></td><td>)</td>
    140. 

  140.           <td></td>
    141. 

  141.         </tr>
    142. 

  142.       </table>
    143. 

  143. </div><div class="memdoc">
    144. 

  144. <dl class="params"><dt>Parameters</dt><dd>
    145. 

  145.   <table class="params">
    146. 

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

  147.   </table>
    148. 

  148.   </dd>
    149. 

  149. </dl>
    150. 

  150. 

  151. <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>
    152. 

  152. <div class="fragment"><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    {</div>
    153. 

  153. <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>
    154. 

  154. <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>
    155. 

  155. <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>
    156. 

  156. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;        $ids = array();</div>
    157. 

  157. <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>
    158. 

  158. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;        {</div>
    159. 

  159. <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>
    160. 

  160. <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>
    161. 

  161. <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;            {</div>
    162. 

  162. <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;                $ids[] = $i-&gt;id;</div>
    163. 

  163. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;            }</div>
    164. 

  164. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;            <span class="keywordflow">else</span></div>
    165. 

  165. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;            {</div>
    166. 

  166. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;                $i-&gt;active = <span class="keyword">false</span>;</div>
    167. 

  167. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;                $i-&gt;save();</div>
    168. 

  168. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;            }</div>
    169. 

  169. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;        }</div>
    170. 

  170. <div class="line"><a name="l00057"></a><span class="lineno">   57</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>
    171. 

  171. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    }</div>
    172. 

  172. <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>
    173. 

  173. <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>
    174. 

  174. <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>
    175. 

  175. <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#l00083">ModuleManager.php:83</a></div></div>
    176. 

  176. <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>
    177. 

  177. </div><!-- fragment -->
    178. 

  178. </div>
    179. 

  179. </div>
    180. 

  180. <h2 class="groupheader">Member Function Documentation</h2>
    181. 

  181. <a class="anchor" id="a4537dad3b44254124991341cc91b28fb"></a>
    182. 

  182. <div class="memitem">
    183. 

  183. <div class="memproto">
    184. 

  184.       <table class="memname">
    185. 

  185.         <tr>
    186. 

  186.           <td class="memname">__get </td>
    187. 

  187.           <td>(</td>
    188. 

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

  189.           <td class="paramname"><em>$key</em></td><td>)</td>
    190. 

  190.           <td></td>
    191. 

  191.         </tr>
    192. 

  192.       </table>
    193. 

  193. </div><div class="memdoc">
    194. 

  194. <p>Getter </p>
    195. 

  195. 

  196. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00153">153</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
    197. 

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

  198. <div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;        <span class="keywordflow">switch</span> ($key)</div>
    199. 

  199. <div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;        {</div>
    200. 

  200. <div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;            <span class="keywordflow">case</span> <span class="stringliteral">&quot;modules&quot;</span>:</div>
    201. 

  201. <div class="line"><a name="l00158"></a><span class="lineno">  158</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>
    202. 

  202. <div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;        }</div>
    203. 

  203. <div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;        <span class="keywordflow">if</span> (substr($key, 0, 4) == <span class="stringliteral">&quot;_id_&quot;</span>)</div>
    204. 

  204. <div class="line"><a name="l00161"></a><span class="lineno">  161</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>
    205. 

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

  206. <div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;    }</div>
    207. 

  207. <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#l00140">ModuleManager.php:140</a></div></div>
    208. 

  208. <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>
    209. 

  209. </div><!-- fragment -->
    210. 

  210. </div>
    211. 

  211. </div>
    212. 

  212. <a class="anchor" id="ab1dcee2727d5614cb8c028c57d2271e8"></a>
    213. 

  213. <div class="memitem">
    214. 

  214. <div class="memproto">
    215. 

  215.       <table class="memname">
    216. 

  216.         <tr>
    217. 

  217.           <td class="memname">getModuleFromId </td>
    218. 

  218.           <td>(</td>
    219. 

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

  220.           <td class="paramname"><em>$id</em></td><td>)</td>
    221. 

  221.           <td></td>
    222. 

  222.         </tr>
    223. 

  223.       </table>
    224. 

  224. </div><div class="memdoc">
    225. 

  225. <dl class="params"><dt>Parameters</dt><dd>
    226. 

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

  227.     <tr><td class="paramtype">int</td><td class="paramname">$id</td><td></td></tr>
    228. 

  228.   </table>
    229. 

  229.   </dd>
    230. 

  230. </dl>
    231. 

  231. <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>
    232. 

  232. 

  233. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00140">140</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
    234. 

  234. <div class="fragment"><div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    {</div>
    235. 

  235. <div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;        <span class="keywordflow">foreach</span> ($this-&gt;modules as $i)</div>
    236. 

  236. <div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;        {</div>
    237. 

  237. <div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;            <span class="keywordflow">if</span> ($i-&gt;entity-&gt;id == $id)</div>
    238. 

  238. <div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;                <span class="keywordflow">return</span> $i;</div>
    239. 

  239. <div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;        }</div>
    240. 

  240. <div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;        <span class="keywordflow">return</span> FALSE;</div>
    241. 

  241. <div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;    }</div>
    242. 

  242. </div><!-- fragment -->
    243. 

  243. </div>
    244. 

  244. </div>
    245. 

  245. <a class="anchor" id="a3a08c349e26f53ae15f2526ffc70a091"></a>
    246. 

  246. <div class="memitem">
    247. 

  247. <div class="memproto">
    248. 

  248.       <table class="memname">
    249. 

  249.         <tr>
    250. 

  250.           <td class="memname">install </td>
    251. 

  251.           <td>(</td>
    252. 

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

  253.           <td class="paramname"><em>$modulename</em></td><td>)</td>
    254. 

  254.           <td></td>
    255. 

  255.         </tr>
    256. 

  256.       </table>
    257. 

  257. </div><div class="memdoc">
    258. 

  258. <dl class="params"><dt>Parameters</dt><dd>
    259. 

  259.   <table class="params">
    260. 

  260.     <tr><td class="paramtype">string</td><td class="paramname">$modulename</td><td></td></tr>
    261. 

  261.   </table>
    262. 

  262.   </dd>
    263. 

  263. </dl>
    264. 

  264. <dl class="section return"><dt>Returns</dt><dd>|false on failure Install the module located in {modulePath}/modulename/modulename.php </dd></dl>
    265. 

  265. 

  266. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00098">98</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
    267. 

  267. <div class="fragment"><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    {</div>
    268. 

  268. <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;        $entity = new \Entity\Module();</div>
    269. 

  269. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;        $entity-&gt;name = $modulename;</div>
    270. 

  270. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;        $entity-&gt;directory = $modulename;</div>
    271. 

  271. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;        $entity-&gt;active = <span class="keyword">true</span>;</div>
    272. 

  272. <div class="line"><a name="l00104"></a><span class="lineno">  104</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>
    273. 

  273. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;        <span class="keywordflow">if</span> ($module === <span class="keyword">false</span>)</div>
    274. 

  274. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
    275. 

  275. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;        $entity-&gt;name = $module-&gt;getName();</div>
    276. 

  276. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;        $entity-&gt;description = $module-&gt;getDescription();</div>
    277. 

  277. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;        <span class="keywordflow">if</span> ($module-&gt;install() == <span class="keyword">false</span>)</div>
    278. 

  278. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
    279. 

  279. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;        $entity-&gt;save();</div>
    280. 

  280. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;        $module-&gt;setEntity($entity);</div>
    281. 

  281. <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;        <span class="keywordflow">return</span> $module;</div>
    282. 

  282. <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;    }</div>
    283. 

  283. <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#l00064">ModuleManager.php:64</a></div></div>
    284. 

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

  285. </div>
    286. 

  286. </div>
    287. 

  287. <a class="anchor" id="a279ef46fb2e62ce756023d9a443d7953"></a>
    288. 

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

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

  290.       <table class="memname">
    291. 

  291.         <tr>
    292. 

  292.           <td class="memname">listAvailableModules </td>
    293. 

  293.           <td>(</td>
    294. 

  294.           <td class="paramname"></td><td>)</td>
    295. 

  295.           <td></td>
    296. 

  296.         </tr>
    297. 

  297.       </table>
    298. 

  298. </div><div class="memdoc">
    299. 

  299. 

  300. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00121">121</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
    301. 

  301. <div class="fragment"><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    {</div>
    302. 

  302. <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;        $modulesRoot = <a class="code" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>-&gt;router-&gt;modulesPath;</div>
    303. 

  303. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;        $result = array();</div>
    304. 

  304. <div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;        <a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> = scandir($modulesRoot, SCANDIR_SORT_NONE);</div>
    305. 

  305. <div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;        <span class="keywordflow">foreach</span> (<a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> as $i)</div>
    306. 

  306. <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;        {</div>
    307. 

  307. <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;            $path = $modulesRoot.$i;</div>
    308. 

  308. <div class="line"><a name="l00129"></a><span class="lineno">  129</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>
    309. 

  309. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;                <span class="keywordflow">continue</span>;</div>
    310. 

  310. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;            $this-&gt;<a class="code" href="class_tools_1_1_module_manager.html#a167a402eddef05c09ce608f803009baa">loadModule</a>($path);</div>
    311. 

  311. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;        }</div>
    312. 

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

  313. <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>
    314. 

  314. <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#l00083">ModuleManager.php:83</a></div></div>
    315. 

  315. <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>
    316. 

  316. </div><!-- fragment -->
    317. 

  317. </div>
    318. 

  318. </div>
    319. 

  319. <a class="anchor" id="a167a402eddef05c09ce608f803009baa"></a>
    320. 

  320. <div class="memitem">
    321. 

  321. <div class="memproto">
    322. 

  322. <table class="mlabels">
    323. 

  323.   <tr>
    324. 

  324.   <td class="mlabels-left">
    325. 

  325.       <table class="memname">
    326. 

  326.         <tr>
    327. 

  327.           <td class="memname">loadModule </td>
    328. 

  328.           <td>(</td>
    329. 

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

  330.           <td class="paramname"><em>$path</em>, </td>
    331. 

  331.         </tr>
    332. 

  332.         <tr>
    333. 

  333.           <td class="paramkey"></td>
    334. 

  334.           <td></td>
    335. 

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

  336.           <td class="paramname"><em>$module</em>&#160;</td>
    337. 

  337.         </tr>
    338. 

  338.         <tr>
    339. 

  339.           <td></td>
    340. 

  340.           <td>)</td>
    341. 

  341.           <td></td><td></td>
    342. 

  342.         </tr>
    343. 

  343.       </table>
    344. 

  344.   </td>
    345. 

  345.   <td class="mlabels-right">
    346. 

  346. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    347. 

  347.   </tr>
    348. 

  348. </table>
    349. 

  349. </div><div class="memdoc">
    350. 

  350. <dl class="params"><dt>Parameters</dt><dd>
    351. 

  351.   <table class="params">
    352. 

  352.     <tr><td class="paramtype">string</td><td class="paramname">$path</td><td>path to module's main file </td></tr>
    353. 

  353.     <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>
    354. 

  354.   </table>
    355. 

  355.   </dd>
    356. 

  356. </dl>
    357. 

  357. <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>
    358. 

  358. 

  359. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00083">83</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
    360. 

  360. <div class="fragment"><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    {</div>
    361. 

  361. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;        $mod = $this-&gt;<a class="code" href="class_tools_1_1_module_manager.html#a95b745cacad4b0bb9564b5dbd66828fe">loadModuleFile</a>($path);</div>
    362. 

  362. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;        <span class="keywordflow">if</span> ($mod === <span class="keyword">false</span>)</div>
    363. 

  363. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
    364. 

  364. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;        $mod-&gt;setEntity($module);</div>
    365. 

  365. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;        $this-&gt;modules[] = $mod;</div>
    366. 

  366. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
    367. 

  367. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    }</div>
    368. 

  368. <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#l00064">ModuleManager.php:64</a></div></div>
    369. 

  369. </div><!-- fragment -->
    370. 

  370. </div>
    371. 

  371. </div>
    372. 

  372. <a class="anchor" id="a95b745cacad4b0bb9564b5dbd66828fe"></a>
    373. 

  373. <div class="memitem">
    374. 

  374. <div class="memproto">
    375. 

  375. <table class="mlabels">
    376. 

  376.   <tr>
    377. 

  377.   <td class="mlabels-left">
    378. 

  378.       <table class="memname">
    379. 

  379.         <tr>
    380. 

  380.           <td class="memname">loadModuleFile </td>
    381. 

  381.           <td>(</td>
    382. 

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

  383.           <td class="paramname"><em>$path</em></td><td>)</td>
    384. 

  384.           <td></td>
    385. 

  385.         </tr>
    386. 

  386.       </table>
    387. 

  387.   </td>
    388. 

  388.   <td class="mlabels-right">
    389. 

  389. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    390. 

  390.   </tr>
    391. 

  391. </table>
    392. 

  392. </div><div class="memdoc">
    393. 

  393. <dl class="params"><dt>Parameters</dt><dd>
    394. 

  394.   <table class="params">
    395. 

  395.     <tr><td class="paramtype">string</td><td class="paramname">$path</td><td></td></tr>
    396. 

  396.   </table>
    397. 

  397.   </dd>
    398. 

  398. </dl>
    399. 

  399. <dl class="section return"><dt>Returns</dt><dd>loaded module (or false on error) </dd></dl>
    400. 

  400. 

  401. <p>Definition at line <a class="el" href="_module_manager_8php_source.html#l00064">64</a> of file <a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a>.</p>
    402. 

  402. <div class="fragment"><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    {</div>
    403. 

  403. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        $mod = include_once($path);</div>
    404. 

  404. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        <span class="keywordflow">if</span> (!$mod || !($mod instanceof \<a class="code" href="namespace_tools.html">Tools</a>\AModule))</div>
    405. 

  405. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
    406. 

  406. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;        $mod-&gt;setContext($this-&gt;context);</div>
    407. 

  407. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;        <span class="keywordflow">return</span> $mod;</div>
    408. 

  408. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    }</div>
    409. 

  409. <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>
    410. 

  410. </div><!-- fragment -->
    411. 

  411. </div>
    412. 

  412. </div>
    413. 

  413. <h2 class="groupheader">Field Documentation</h2>
    414. 

  414. <a class="anchor" id="a7c294642225a6c91f5d7932dde75c2ae"></a>
    415. 

  415. <div class="memitem">
    416. 

  416. <div class="memproto">
    417. 

  417. <table class="mlabels">
    418. 

  418.   <tr>
    419. 

  419.   <td class="mlabels-left">
    420. 

  420.       <table class="memname">
    421. 

  421.         <tr>
    422. 

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

  423.         </tr>
    424. 

  424.       </table>
    425. 

  425.   </td>
    426. 

  426.   <td class="mlabels-right">
    427. 

  427. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    428. 

  428.   </tr>
    429. 

  429. </table>
    430. 

  430. </div><div class="memdoc">
    431. 

  431. <p>/core/tools/Context.php Contains website's informations </p>
    432. 

  432. 

  433. <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>
    434. 

  434. 

  435. </div>
    436. 

  436. </div>
    437. 

  437. <a class="anchor" id="a19e625c76c6796e995f33d323ee3aa84"></a>
    438. 

  438. <div class="memitem">
    439. 

  439. <div class="memproto">
    440. 

  440. <table class="mlabels">
    441. 

  441.   <tr>
    442. 

  442.   <td class="mlabels-left">
    443. 

  443.       <table class="memname">
    444. 

  444.         <tr>
    445. 

  445.           <td class="memname">$modules = array()</td>
    446. 

  446.         </tr>
    447. 

  447.       </table>
    448. 

  448.   </td>
    449. 

  449.   <td class="mlabels-right">
    450. 

  450. <span class="mlabels"><span class="mlabel">private</span></span>  </td>
    451. 

  451.   </tr>
    452. 

  452. </table>
    453. 

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

  454. 

  455. <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>
    456. 

  456. 

  457. </div>
    458. 

  458. </div>
    459. 

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

  460. <li>core/tools/<a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a></li>
    461. 

  461. </ul>
    462. 

  462. </div><!-- contents -->
    463. 

  463. <!-- start footer part -->
    464. 

  464. <hr class="footer"/><address class="footer"><small>
    465. 

  465. Generated on Tue Aug 11 2015 23:37:35 for ecom by &#160;<a href="http://www.doxygen.org/index.html">
    466. 

  466. <img class="footer" src="doxygen.png" alt="doxygen"/>
    467. 

  467. </a> 1.8.8
    468. 

  468. </small></address>
    469. 

  469. </body>
    470. 

  470. </html>
    471.