_a_module_8php_source.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  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: core/tools/AModule.php Source File</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><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
  65. <li><a href="globals.html"><span>Globals</span></a></li>
  66. </ul>
  67. </div>
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. <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>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. <div id="nav-path" class="navpath">
  81. <ul>
  82. <li class="navelem"><a class="el" href="dir_4270bfced15e0e73154b13468c7c9ad9.html">core</a></li><li class="navelem"><a class="el" href="dir_dff40b844157c216598c968cb799cc0b.html">tools</a></li> </ul>
  83. </div>
  84. </div><!-- top -->
  85. <div class="header">
  86. <div class="headertitle">
  87. <div class="title">AModule.php</div> </div>
  88. </div><!--header-->
  89. <div class="contents">
  90. <a href="_a_module_8php.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;&lt;?php</div>
  91. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;</div>
  92. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_tools.html">Tools</a>;</div>
  93. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div>
  94. <div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html"> 9</a></span>&#160;<span class="keyword">abstract</span> <span class="keyword">class </span><a class="code" href="class_tools_1_1_a_module.html">AModule</a></div>
  95. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;{</div>
  96. <div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html#a7c294642225a6c91f5d7932dde75c2ae"> 17</a></span>&#160; <span class="keyword">private</span> <a class="code" href="class_tools_1_1_a_module.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>;</div>
  97. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
  98. <div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html#a74ed34e6d7bc9f3f8c4fb58a12247ee2"> 22</a></span>&#160; <span class="keyword">private</span> <a class="code" href="class_tools_1_1_a_module.html#a74ed34e6d7bc9f3f8c4fb58a12247ee2">$entity</a>;</div>
  99. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
  100. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">function</span> install();</div>
  101. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
  102. <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html#a9db6a246faa6b948911078c4be4445c8"> 33</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_a_module.html#a9db6a246faa6b948911078c4be4445c8">uninstall</a>()</div>
  103. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; { }</div>
  104. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
  105. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">function</span> doAction($event);</div>
  106. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
  107. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">function</span> doShortCode($shortCode, $params);</div>
  108. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
  109. <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html#a313783d5477383dd99a2f3785705aaf4"> 56</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_a_module.html#a313783d5477383dd99a2f3785705aaf4">setContext</a>($context)</div>
  110. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; {</div>
  111. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">if</span> ($this-&gt;context === null)</div>
  112. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; $this-&gt;context = $context;</div>
  113. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div>
  114. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
  115. <div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html#ad868339fe7830b388444095288d40e22"> 68</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_a_module.html#ad868339fe7830b388444095288d40e22">setEntity</a>($entity)</div>
  116. <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; {</div>
  117. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">if</span> ($this-&gt;entity === null)</div>
  118. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; $this-&gt;entity = $entity;</div>
  119. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; }</div>
  120. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div>
  121. <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html#a5b0a451462641aed2e7e92324a66bd64"> 78</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_a_module.html#a5b0a451462641aed2e7e92324a66bd64">registerHook</a>($hookName)</div>
  122. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; {</div>
  123. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; $this-&gt;context-&gt;hookManager-&gt;register($this, $hookName);</div>
  124. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; }</div>
  125. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
  126. <div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html#a3d0963e68bb313b163a73f2803c64600"> 86</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_a_module.html#a3d0963e68bb313b163a73f2803c64600">getName</a>()</div>
  127. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; {</div>
  128. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> $this-&gt;entity-&gt;name;</div>
  129. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div>
  130. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div>
  131. <div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html#a2e7bb35c71bf1824456ceb944cb7a845"> 94</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_a_module.html#a2e7bb35c71bf1824456ceb944cb7a845">getDescription</a>()</div>
  132. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; { <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>; }</div>
  133. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;</div>
  134. <div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html#a4537dad3b44254124991341cc91b28fb"> 100</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_a_module.html#a4537dad3b44254124991341cc91b28fb">__get</a>($key)</div>
  135. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; {</div>
  136. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">switch</span> ($key)</div>
  137. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; {</div>
  138. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;context&quot;</span>: <span class="keywordflow">return</span> $this-&gt;context; <span class="keywordflow">break</span>;</div>
  139. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;entity&quot;</span>: <span class="keywordflow">return</span> $this-&gt;entity; <span class="keywordflow">break</span>;</div>
  140. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; }</div>
  141. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordflow">throw</span> new \Exception(<span class="stringliteral">&quot;Cannot access attribute {$key}&quot;</span>);</div>
  142. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; }</div>
  143. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;}</div>
  144. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;</div>
  145. <div class="ttc" id="class_tools_1_1_a_module_html_a4537dad3b44254124991341cc91b28fb"><div class="ttname"><a href="class_tools_1_1_a_module.html#a4537dad3b44254124991341cc91b28fb">Tools\AModule\__get</a></div><div class="ttdeci">__get($key)</div><div class="ttdef"><b>Definition:</b> <a href="_a_module_8php_source.html#l00100">AModule.php:100</a></div></div>
  146. <div class="ttc" id="class_tools_1_1_a_module_html_a7c294642225a6c91f5d7932dde75c2ae"><div class="ttname"><a href="class_tools_1_1_a_module.html#a7c294642225a6c91f5d7932dde75c2ae">Tools\AModule\$context</a></div><div class="ttdeci">$context</div><div class="ttdef"><b>Definition:</b> <a href="_a_module_8php_source.html#l00017">AModule.php:17</a></div></div>
  147. <div class="ttc" id="class_tools_1_1_a_module_html_a2e7bb35c71bf1824456ceb944cb7a845"><div class="ttname"><a href="class_tools_1_1_a_module.html#a2e7bb35c71bf1824456ceb944cb7a845">Tools\AModule\getDescription</a></div><div class="ttdeci">getDescription()</div><div class="ttdef"><b>Definition:</b> <a href="_a_module_8php_source.html#l00094">AModule.php:94</a></div></div>
  148. <div class="ttc" id="class_tools_1_1_a_module_html_a3d0963e68bb313b163a73f2803c64600"><div class="ttname"><a href="class_tools_1_1_a_module.html#a3d0963e68bb313b163a73f2803c64600">Tools\AModule\getName</a></div><div class="ttdeci">getName()</div><div class="ttdef"><b>Definition:</b> <a href="_a_module_8php_source.html#l00086">AModule.php:86</a></div></div>
  149. <div class="ttc" id="class_tools_1_1_a_module_html_a9db6a246faa6b948911078c4be4445c8"><div class="ttname"><a href="class_tools_1_1_a_module.html#a9db6a246faa6b948911078c4be4445c8">Tools\AModule\uninstall</a></div><div class="ttdeci">uninstall()</div><div class="ttdef"><b>Definition:</b> <a href="_a_module_8php_source.html#l00033">AModule.php:33</a></div></div>
  150. <div class="ttc" id="class_tools_1_1_a_module_html"><div class="ttname"><a href="class_tools_1_1_a_module.html">Tools\AModule</a></div><div class="ttdef"><b>Definition:</b> <a href="_a_module_8php_source.html#l00009">AModule.php:9</a></div></div>
  151. <div class="ttc" id="class_tools_1_1_a_module_html_a313783d5477383dd99a2f3785705aaf4"><div class="ttname"><a href="class_tools_1_1_a_module.html#a313783d5477383dd99a2f3785705aaf4">Tools\AModule\setContext</a></div><div class="ttdeci">setContext($context)</div><div class="ttdef"><b>Definition:</b> <a href="_a_module_8php_source.html#l00056">AModule.php:56</a></div></div>
  152. <div class="ttc" id="class_tools_1_1_a_module_html_a5b0a451462641aed2e7e92324a66bd64"><div class="ttname"><a href="class_tools_1_1_a_module.html#a5b0a451462641aed2e7e92324a66bd64">Tools\AModule\registerHook</a></div><div class="ttdeci">registerHook($hookName)</div><div class="ttdef"><b>Definition:</b> <a href="_a_module_8php_source.html#l00078">AModule.php:78</a></div></div>
  153. <div class="ttc" id="class_tools_1_1_a_module_html_a74ed34e6d7bc9f3f8c4fb58a12247ee2"><div class="ttname"><a href="class_tools_1_1_a_module.html#a74ed34e6d7bc9f3f8c4fb58a12247ee2">Tools\AModule\$entity</a></div><div class="ttdeci">$entity</div><div class="ttdef"><b>Definition:</b> <a href="_a_module_8php_source.html#l00022">AModule.php:22</a></div></div>
  154. <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>
  155. <div class="ttc" id="class_tools_1_1_a_module_html_ad868339fe7830b388444095288d40e22"><div class="ttname"><a href="class_tools_1_1_a_module.html#ad868339fe7830b388444095288d40e22">Tools\AModule\setEntity</a></div><div class="ttdeci">setEntity($entity)</div><div class="ttdef"><b>Definition:</b> <a href="_a_module_8php_source.html#l00068">AModule.php:68</a></div></div>
  156. </div><!-- fragment --></div><!-- contents -->
  157. <!-- start footer part -->
  158. <hr class="footer"/><address class="footer"><small>
  159. Generated on Wed Aug 12 2015 21:31:31 for ecom by &#160;<a href="http://www.doxygen.org/index.html">
  160. <img class="footer" src="doxygen.png" alt="doxygen"/>
  161. </a> 1.8.8
  162. </small></address>
  163. </body>
  164. </html>