_hooks_8php_source.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182
  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: /home/isundil/Project/ecom/core/tools/Hooks.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="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  43. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  44. <li class="current"><a href="files.html"><span>Files</span></a></li>
  45. <li>
  46. <div id="MSearchBox" class="MSearchBoxInactive">
  47. <span class="left">
  48. <img id="MSearchSelect" src="search/mag_sel.png"
  49. onmouseover="return searchBox.OnSearchSelectShow()"
  50. onmouseout="return searchBox.OnSearchSelectHide()"
  51. alt=""/>
  52. <input type="text" id="MSearchField" value="Search" accesskey="S"
  53. onfocus="searchBox.OnSearchFieldFocus(true)"
  54. onblur="searchBox.OnSearchFieldFocus(false)"
  55. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  56. </span><span class="right">
  57. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  58. </span>
  59. </div>
  60. </li>
  61. </ul>
  62. </div>
  63. <div id="navrow2" class="tabs2">
  64. <ul class="tablist">
  65. <li><a href="files.html"><span>File&#160;List</span></a></li>
  66. <li><a href="globals.html"><span>Globals</span></a></li>
  67. </ul>
  68. </div>
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. <div id="nav-path" class="navpath">
  82. <ul>
  83. <li class="navelem"><a class="el" href="dir_75b82e7e4a5feb05200b9ad7adf06257.html">home</a></li><li class="navelem"><a class="el" href="dir_9db4aabfa12fb2197f4b553e7ea8deed.html">isundil</a></li><li class="navelem"><a class="el" href="dir_1a6cb19e8504dda728b9574aa47fdf34.html">Project</a></li><li class="navelem"><a class="el" href="dir_f8738126562420a628a94e1d7172443f.html">ecom</a></li><li class="navelem"><a class="el" href="dir_fc33a2a7f6da4d78118e1e23a8f17b51.html">core</a></li><li class="navelem"><a class="el" href="dir_c7e9cf21629ccd0940e4dcdbd0bc9b8a.html">tools</a></li> </ul>
  84. </div>
  85. </div><!-- top -->
  86. <div class="header">
  87. <div class="headertitle">
  88. <div class="title">Hooks.php</div> </div>
  89. </div><!--header-->
  90. <div class="contents">
  91. <a href="_hooks_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>
  92. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;</div>
  93. <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>
  94. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div>
  95. <div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html"> 8</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_tools_1_1_hooks.html">Hooks</a></div>
  96. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;{</div>
  97. <div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a7c294642225a6c91f5d7932dde75c2ae"> 15</a></span>&#160; <span class="keyword">private</span> <a class="code" href="class_tools_1_1_hooks.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>;</div>
  98. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
  99. <div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a05aec88c3516c6db5da524fbcc673aff"> 20</a></span>&#160; <span class="keyword">private</span> <a class="code" href="class_tools_1_1_hooks.html#a05aec88c3516c6db5da524fbcc673aff">$hooks</a>;</div>
  100. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
  101. <div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a7e676775f276fe0a207276cdbfb984c8"> 26</a></span>&#160; <span class="keyword">private</span> <a class="code" href="class_tools_1_1_hooks.html#a7e676775f276fe0a207276cdbfb984c8">$currentHook</a>;</div>
  102. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
  103. <div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a01955facbcef5c0159144d7209704be2"> 36</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_hooks.html#a01955facbcef5c0159144d7209704be2">__construct</a>(&amp;$context)</div>
  104. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; {</div>
  105. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; $this-&gt;context = $context;</div>
  106. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; $this-&gt;currentHook = array();</div>
  107. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; }</div>
  108. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
  109. <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a708f58f8e895879111179ae63842d240"> 49</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <span class="keyword">register</span>($module, $hookName)</div>
  110. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; {</div>
  111. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">if</span> (!\<a class="code" href="namespace_tools.html">Tools</a>\ModuleManager::isInstalling())</div>
  112. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">throw</span> <span class="keyword">new</span> \<a class="code" href="namespace_exception.html">Exception</a>(<span class="stringliteral">&quot;You can only register hooks while installing&quot;</span>);</div>
  113. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="comment">//TODO@2</span></div>
  114. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div>
  115. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
  116. <div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a8dc5debf6c33905af409438d26ed3916"> 62</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_hooks.html#a8dc5debf6c33905af409438d26ed3916">trigger</a>($hookName, $params =null)</div>
  117. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; {</div>
  118. <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordflow">if</span> (empty($this-&gt;hooks[$hookName]))</div>
  119. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">return</span> 0;</div>
  120. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; $hookEvent = <span class="keyword">new</span> <a class="code" href="class_tools_1_1_hook_event.html">HookEvent</a>($hookName, $this-&gt;context, $params);</div>
  121. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; array_push($this-&gt;currentHook, $hookEvent);</div>
  122. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; $result = 0;</div>
  123. <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordflow">foreach</span> ($this-&gt;hooks[$hookName] as $module_id)</div>
  124. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; {</div>
  125. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; $module = $this-&gt;context-&gt;moduleManager-&gt;getModuleFromId($module_id);</div>
  126. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordflow">if</span> (!$module)</div>
  127. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordflow">continue</span>;</div>
  128. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; $module-&gt;doAction($hookEvent);</div>
  129. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; $result++;</div>
  130. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div>
  131. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; array_pop($this-&gt;currentHook);</div>
  132. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordflow">return</span> $result;</div>
  133. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; }</div>
  134. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
  135. <div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#aa8a639e43502e64c10e92114c86d0d24"> 86</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_hooks.html#aa8a639e43502e64c10e92114c86d0d24">isInHook</a>($hookName)</div>
  136. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; {</div>
  137. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">foreach</span> ($this-&gt;currentHook as $i)</div>
  138. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordflow">if</span> ($i-&gt;hookName == $hookName)</div>
  139. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
  140. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  141. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; }</div>
  142. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div>
  143. <div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#adc040cf46ed4deda06079b3ad84ee792"> 98</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_hooks.html#adc040cf46ed4deda06079b3ad84ee792">loadHooks</a>($hookEntities)</div>
  144. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; {</div>
  145. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; $this-&gt;hooks = array();</div>
  146. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordflow">foreach</span> ($hookEntities as $i)</div>
  147. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; $this-&gt;hooks[$i-&gt;hookName][] = (int) $i-&gt;module_id;</div>
  148. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; }</div>
  149. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div>
  150. <div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a4537dad3b44254124991341cc91b28fb"> 108</a></span>&#160; <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_hooks.html#a4537dad3b44254124991341cc91b28fb">__get</a>($key)</div>
  151. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; {</div>
  152. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordflow">switch</span> ($key)</div>
  153. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; {</div>
  154. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;currentHook&quot;</span>: <span class="keywordflow">return</span> end($this-&gt;currentHook);</div>
  155. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; }</div>
  156. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordflow">throw</span> new \Exception(<span class="stringliteral">&quot;Cannot access attribute {$key}&quot;</span>);</div>
  157. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; }</div>
  158. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;}</div>
  159. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;</div>
  160. <div class="ttc" id="class_tools_1_1_hooks_html_a7e676775f276fe0a207276cdbfb984c8"><div class="ttname"><a href="class_tools_1_1_hooks.html#a7e676775f276fe0a207276cdbfb984c8">Tools\Hooks\$currentHook</a></div><div class="ttdeci">$currentHook</div><div class="ttdef"><b>Definition:</b> <a href="_hooks_8php_source.html#l00026">Hooks.php:26</a></div></div>
  161. <div class="ttc" id="class_tools_1_1_hooks_html_a01955facbcef5c0159144d7209704be2"><div class="ttname"><a href="class_tools_1_1_hooks.html#a01955facbcef5c0159144d7209704be2">Tools\Hooks\__construct</a></div><div class="ttdeci">__construct(&amp;$context)</div><div class="ttdef"><b>Definition:</b> <a href="_hooks_8php_source.html#l00036">Hooks.php:36</a></div></div>
  162. <div class="ttc" id="class_tools_1_1_hooks_html_a05aec88c3516c6db5da524fbcc673aff"><div class="ttname"><a href="class_tools_1_1_hooks.html#a05aec88c3516c6db5da524fbcc673aff">Tools\Hooks\$hooks</a></div><div class="ttdeci">$hooks</div><div class="ttdef"><b>Definition:</b> <a href="_hooks_8php_source.html#l00020">Hooks.php:20</a></div></div>
  163. <div class="ttc" id="class_tools_1_1_hooks_html_aa8a639e43502e64c10e92114c86d0d24"><div class="ttname"><a href="class_tools_1_1_hooks.html#aa8a639e43502e64c10e92114c86d0d24">Tools\Hooks\isInHook</a></div><div class="ttdeci">isInHook($hookName)</div><div class="ttdef"><b>Definition:</b> <a href="_hooks_8php_source.html#l00086">Hooks.php:86</a></div></div>
  164. <div class="ttc" id="namespace_exception_html"><div class="ttname"><a href="namespace_exception.html">Exception</a></div><div class="ttdef"><b>Definition:</b> <a href="_error404_8php_source.html#l00003">Error404.php:3</a></div></div>
  165. <div class="ttc" id="class_tools_1_1_hooks_html_a7c294642225a6c91f5d7932dde75c2ae"><div class="ttname"><a href="class_tools_1_1_hooks.html#a7c294642225a6c91f5d7932dde75c2ae">Tools\Hooks\$context</a></div><div class="ttdeci">$context</div><div class="ttdef"><b>Definition:</b> <a href="_hooks_8php_source.html#l00015">Hooks.php:15</a></div></div>
  166. <div class="ttc" id="class_tools_1_1_hooks_html_a4537dad3b44254124991341cc91b28fb"><div class="ttname"><a href="class_tools_1_1_hooks.html#a4537dad3b44254124991341cc91b28fb">Tools\Hooks\__get</a></div><div class="ttdeci">__get($key)</div><div class="ttdef"><b>Definition:</b> <a href="_hooks_8php_source.html#l00108">Hooks.php:108</a></div></div>
  167. <div class="ttc" id="class_tools_1_1_hook_event_html"><div class="ttname"><a href="class_tools_1_1_hook_event.html">Tools\HookEvent</a></div><div class="ttdef"><b>Definition:</b> <a href="_hook_event_8php_source.html#l00009">HookEvent.php:9</a></div></div>
  168. <div class="ttc" id="class_tools_1_1_hooks_html"><div class="ttname"><a href="class_tools_1_1_hooks.html">Tools\Hooks</a></div><div class="ttdef"><b>Definition:</b> <a href="_hooks_8php_source.html#l00008">Hooks.php:8</a></div></div>
  169. <div class="ttc" id="class_tools_1_1_hooks_html_adc040cf46ed4deda06079b3ad84ee792"><div class="ttname"><a href="class_tools_1_1_hooks.html#adc040cf46ed4deda06079b3ad84ee792">Tools\Hooks\loadHooks</a></div><div class="ttdeci">loadHooks($hookEntities)</div><div class="ttdef"><b>Definition:</b> <a href="_hooks_8php_source.html#l00098">Hooks.php:98</a></div></div>
  170. <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>
  171. <div class="ttc" id="class_tools_1_1_hooks_html_a8dc5debf6c33905af409438d26ed3916"><div class="ttname"><a href="class_tools_1_1_hooks.html#a8dc5debf6c33905af409438d26ed3916">Tools\Hooks\trigger</a></div><div class="ttdeci">trigger($hookName, $params=null)</div><div class="ttdef"><b>Definition:</b> <a href="_hooks_8php_source.html#l00062">Hooks.php:62</a></div></div>
  172. </div><!-- fragment --></div><!-- contents -->
  173. <!-- start footer part -->
  174. <hr class="footer"/><address class="footer"><small>
  175. Generated on Tue Aug 4 2015 00:33:19 for ecom by &#160;<a href="http://www.doxygen.org/index.html">
  176. <img class="footer" src="doxygen.png" alt="doxygen"/>
  177. </a> 1.8.8
  178. </small></address>
  179. </body>
  180. </html>