| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.8"/>
- <title>ecom: ModuleManager Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/javascript">
- $(document).ready(function() { searchBox.OnSelectItem(0); });
- </script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">ecom
- </div>
- <div id="projectbrief">E-commerce cms</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.8 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="namespaces.html"><span>Namespaces</span></a></li>
- <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
- <li><a href="classes.html"><span>Data Structure Index</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Data Fields</span></a></li>
- </ul>
- </div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a></div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <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>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#pri-methods">Private Member Functions</a> |
- <a href="#pri-attribs">Private Attributes</a> |
- <a href="#pri-static-attribs">Static Private Attributes</a> </div>
- <div class="headertitle">
- <div class="title">ModuleManager Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a01955facbcef5c0159144d7209704be2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a01955facbcef5c0159144d7209704be2">__construct</a> (&$context)</td></tr>
- <tr class="separator:a01955facbcef5c0159144d7209704be2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3a08c349e26f53ae15f2526ffc70a091"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a3a08c349e26f53ae15f2526ffc70a091">install</a> ($modulename)</td></tr>
- <tr class="separator:a3a08c349e26f53ae15f2526ffc70a091"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a279ef46fb2e62ce756023d9a443d7953"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a279ef46fb2e62ce756023d9a443d7953">listAvailableModules</a> ()</td></tr>
- <tr class="separator:a279ef46fb2e62ce756023d9a443d7953"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab1dcee2727d5614cb8c028c57d2271e8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#ab1dcee2727d5614cb8c028c57d2271e8">getModuleFromId</a> ($id)</td></tr>
- <tr class="separator:ab1dcee2727d5614cb8c028c57d2271e8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4537dad3b44254124991341cc91b28fb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a4537dad3b44254124991341cc91b28fb">__get</a> ($key)</td></tr>
- <tr class="separator:a4537dad3b44254124991341cc91b28fb"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:ae2f2483f1e0397c7f7a64c64a6a63025"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#ae2f2483f1e0397c7f7a64c64a6a63025">isInstalling</a> ()</td></tr>
- <tr class="separator:ae2f2483f1e0397c7f7a64c64a6a63025"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
- Private Member Functions</h2></td></tr>
- <tr class="memitem:a95b745cacad4b0bb9564b5dbd66828fe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a95b745cacad4b0bb9564b5dbd66828fe">loadModuleFile</a> ($path)</td></tr>
- <tr class="separator:a95b745cacad4b0bb9564b5dbd66828fe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a167a402eddef05c09ce608f803009baa"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a167a402eddef05c09ce608f803009baa">loadModule</a> ($path, $module)</td></tr>
- <tr class="separator:a167a402eddef05c09ce608f803009baa"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
- Private Attributes</h2></td></tr>
- <tr class="memitem:a7c294642225a6c91f5d7932dde75c2ae"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a></td></tr>
- <tr class="separator:a7c294642225a6c91f5d7932dde75c2ae"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a19e625c76c6796e995f33d323ee3aa84"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> = array()</td></tr>
- <tr class="separator:a19e625c76c6796e995f33d323ee3aa84"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
- Static Private Attributes</h2></td></tr>
- <tr class="memitem:a36cecdf89abd520000db43ccab99da6d"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_module_manager.html#a36cecdf89abd520000db43ccab99da6d">$installing</a> = false</td></tr>
- <tr class="separator:a36cecdf89abd520000db43ccab99da6d"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Container all modules. Allow module managment </p>
- <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>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a class="anchor" id="a01955facbcef5c0159144d7209704be2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">__construct </td>
- <td>(</td>
- <td class="paramtype">& </td>
- <td class="paramname"><em>$context</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- </table>
- </dd>
- </dl>
- <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>
- <div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div>
- <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  $this->context = <a class="code" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>;</div>
- <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  $modulesRoot = <a class="code" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>->router->modulesPath;</div>
- <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <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>
- <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  $ids = array();</div>
- <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">foreach</span> (<a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> as $i)</div>
- <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  {</div>
- <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  $modulePath = <span class="stringliteral">"{$modulesRoot}{$i->directory}/main.php"</span>;</div>
- <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">if</span> (file_exists($modulePath) && $this-><a class="code" href="class_tools_1_1_module_manager.html#a167a402eddef05c09ce608f803009baa">loadModule</a>($modulePath, $i))</div>
- <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div>
- <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  $ids[] = $i->id;</div>
- <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div>
- <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">else</span></div>
- <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div>
- <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  $i->active = <span class="keyword">false</span>;</div>
- <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  $i->save();</div>
- <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div>
- <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  }</div>
- <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>->hookManager->loadHooks(\<a class="code" href="namespace_entity.html">Entity</a>\ModuleHook::getModules($ids));</div>
- <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div>
- <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>
- <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>
- <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>
- <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>
- <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>
- </div><!-- fragment -->
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="a4537dad3b44254124991341cc91b28fb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">__get </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$key</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Getter </p>
- <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>
- <div class="fragment"><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  {</div>
- <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordflow">switch</span> ($key)</div>
- <div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  {</div>
- <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="keywordflow">case</span> <span class="stringliteral">"modules"</span>:</div>
- <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$this->modules</a>; <span class="keywordflow">break</span>;</div>
- <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  }</div>
- <div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordflow">if</span> (substr($key, 0, 4) == <span class="stringliteral">"_id_"</span>)</div>
- <div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_tools_1_1_module_manager.html#ab1dcee2727d5614cb8c028c57d2271e8">getModuleFromId</a>((<span class="keywordtype">int</span>) substr($key, 4));</div>
- <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordflow">throw</span> new \Exception(<span class="stringliteral">"Cannot access attribute {$key}"</span>);</div>
- <div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  }</div>
- <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>
- <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>
- </div><!-- fragment -->
- </div>
- </div>
- <a class="anchor" id="ab1dcee2727d5614cb8c028c57d2271e8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">getModuleFromId </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$id</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramtype">int</td><td class="paramname">$id</td><td></td></tr>
- </table>
- </dd>
- </dl>
- <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>
- <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>
- <div class="fragment"><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  {</div>
- <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordflow">foreach</span> ($this->modules as $i)</div>
- <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  {</div>
- <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordflow">if</span> ($i->entity->id == $id)</div>
- <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordflow">return</span> $i;</div>
- <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  }</div>
- <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordflow">return</span> FALSE;</div>
- <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  }</div>
- </div><!-- fragment -->
- </div>
- </div>
- <a class="anchor" id="a3a08c349e26f53ae15f2526ffc70a091"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">install </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$modulename</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramtype">string</td><td class="paramname">$modulename</td><td></td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>|false on failure Install the module located in {modulePath}/modulename/modulename.php </dd></dl>
- <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>
- <div class="fragment"><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  {</div>
- <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  $entity = new \Entity\Module();</div>
- <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  $entity->name = $modulename;</div>
- <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  $entity->directory = $modulename;</div>
- <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  $entity->active = <span class="keyword">true</span>;</div>
- <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  $module = $this-><a class="code" href="class_tools_1_1_module_manager.html#a95b745cacad4b0bb9564b5dbd66828fe">loadModuleFile</a>($this->context->router->modulesPath.$modulename.<span class="stringliteral">'/main.php'</span>);</div>
- <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">if</span> ($module === <span class="keyword">false</span>)</div>
- <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
- <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  $module->setEntity($entity);</div>
- <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  $entity->name = $module->getName();</div>
- <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  $entity->description = $module->getDescription();</div>
- <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  $entity->save();</div>
- <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  self::$installing = <span class="keyword">true</span>;</div>
- <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">if</span> ($module->install() == <span class="keyword">false</span>)</div>
- <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  {</div>
- <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  self::$installing = <span class="keyword">false</span>;</div>
- <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  $hooks = <a class="code" href="class_entity_1_1_module_hook.html#a71be00f62d624dea24303dd1cbb3e611">\Entity\ModuleHook::getModules</a>($entity->id);</div>
- <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordflow">foreach</span> ($hooks as $i)</div>
- <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  $i->delete();</div>
- <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  $entity->delete();</div>
- <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
- <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  }</div>
- <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  self::$installing = <span class="keyword">false</span>;</div>
- <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordflow">return</span> $module;</div>
- <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  }</div>
- <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>
- <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>
- </div><!-- fragment -->
- </div>
- </div>
- <a class="anchor" id="ae2f2483f1e0397c7f7a64c64a6a63025"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static isInstalling </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>true if a module is currently installing </dd></dl>
- <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>
- <div class="fragment"><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  { <span class="keywordflow">return</span> self::$installing; }</div>
- </div><!-- fragment -->
- </div>
- </div>
- <a class="anchor" id="a279ef46fb2e62ce756023d9a443d7953"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">listAvailableModules </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <div class="fragment"><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  {</div>
- <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  $modulesRoot = <a class="code" href="class_tools_1_1_module_manager.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>->router->modulesPath;</div>
- <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  $result = array();</div>
- <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> = scandir($modulesRoot, SCANDIR_SORT_NONE);</div>
- <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordflow">foreach</span> (<a class="code" href="class_tools_1_1_module_manager.html#a19e625c76c6796e995f33d323ee3aa84">$modules</a> as $i)</div>
- <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  {</div>
- <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  $path = $modulesRoot.$i;</div>
- <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordflow">if</span> ($i == <span class="charliteral">'.'</span> || $i == <span class="stringliteral">'..'</span> || !is_dir($path))</div>
- <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordflow">continue</span>;</div>
- <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  $this-><a class="code" href="class_tools_1_1_module_manager.html#a167a402eddef05c09ce608f803009baa">loadModule</a>($path);</div>
- <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  }</div>
- <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  }</div>
- <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>
- <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>
- <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>
- </div><!-- fragment -->
- </div>
- </div>
- <a class="anchor" id="a167a402eddef05c09ce608f803009baa"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">loadModule </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$module</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">private</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramtype">string</td><td class="paramname">$path</td><td>path to module's main file </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- <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>
- <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>
- <div class="fragment"><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  {</div>
- <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  $mod = $this-><a class="code" href="class_tools_1_1_module_manager.html#a95b745cacad4b0bb9564b5dbd66828fe">loadModuleFile</a>($path);</div>
- <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">if</span> ($mod === <span class="keyword">false</span>)</div>
- <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
- <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  $mod->setEntity($module);</div>
- <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  $this->modules[] = $mod;</div>
- <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
- <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div>
- <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>
- </div><!-- fragment -->
- </div>
- </div>
- <a class="anchor" id="a95b745cacad4b0bb9564b5dbd66828fe"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">loadModuleFile </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$path</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">private</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramtype">string</td><td class="paramname">$path</td><td></td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>loaded module (or false on error) </dd></dl>
- <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>
- <div class="fragment"><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  {</div>
- <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  $mod = include_once($path);</div>
- <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">if</span> (!$mod || !($mod instanceof \<a class="code" href="namespace_tools.html">Tools</a>\AModule))</div>
- <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
- <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  $mod->setContext($this->context);</div>
- <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">return</span> $mod;</div>
- <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div>
- <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>
- </div><!-- fragment -->
- </div>
- </div>
- <h2 class="groupheader">Field Documentation</h2>
- <a class="anchor" id="a7c294642225a6c91f5d7932dde75c2ae"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">Tools <a class="el" href="class_tools_1_1_context.html">Context</a> $context</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">private</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>/core/tools/Context.php Contains website's informations </p>
- <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>
- </div>
- </div>
- <a class="anchor" id="a36cecdf89abd520000db43ccab99da6d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">$installing = false</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a19e625c76c6796e995f33d323ee3aa84"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">$modules = array()</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">private</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>core/tools/<a class="el" href="_module_manager_8php_source.html">ModuleManager.php</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Sun Aug 16 2015 21:56:15 for ecom by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.8
- </small></address>
- </body>
- </html>
|