| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189 |
- <!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: core/tools/Hooks.php Source File</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><a href="annotated.html"><span>Data Structures</span></a></li>
- <li class="current"><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="files.html"><span>File List</span></a></li>
- <li><a href="globals.html"><span>Globals</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="dir_4270bfced15e0e73154b13468c7c9ad9.html">core</a></li><li class="navelem"><a class="el" href="dir_dff40b844157c216598c968cb799cc0b.html">tools</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="headertitle">
- <div class="title">Hooks.php</div> </div>
- </div><!--header-->
- <div class="contents">
- <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> <?php</div>
- <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div>
- <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="keyword">namespace </span><a class="code" href="namespace_tools.html">Tools</a>;</div>
- <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div>
- <div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html"> 8</a></span> <span class="keyword">class </span><a class="code" href="class_tools_1_1_hooks.html">Hooks</a></div>
- <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> {</div>
- <div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a7c294642225a6c91f5d7932dde75c2ae"> 15</a></span>  <span class="keyword">private</span> <a class="code" href="class_tools_1_1_hooks.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>;</div>
- <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
- <div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a05aec88c3516c6db5da524fbcc673aff"> 20</a></span>  <span class="keyword">private</span> <a class="code" href="class_tools_1_1_hooks.html#a05aec88c3516c6db5da524fbcc673aff">$hooks</a>;</div>
- <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
- <div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a7e676775f276fe0a207276cdbfb984c8"> 26</a></span>  <span class="keyword">private</span> <a class="code" href="class_tools_1_1_hooks.html#a7e676775f276fe0a207276cdbfb984c8">$currentHook</a>;</div>
- <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
- <div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a01955facbcef5c0159144d7209704be2"> 36</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_hooks.html#a01955facbcef5c0159144d7209704be2">__construct</a>(&$context)</div>
- <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {</div>
- <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  $this->context = $context;</div>
- <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  $this->currentHook = array();</div>
- <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  $this->hooks = array();</div>
- <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  }</div>
- <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
- <div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a708f58f8e895879111179ae63842d240"> 50</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <span class="keyword">register</span>($module, $hookName)</div>
- <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div>
- <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">if</span> (!\<a class="code" href="namespace_tools.html">Tools</a>\ModuleManager::isInstalling())</div>
- <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> \<a class="code" href="namespace_exception.html">Exception</a>(<span class="stringliteral">"You can only register hooks while installing"</span>);</div>
- <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">if</span> (!isset($this->hooks[$hookName]))</div>
- <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  $this->hooks[$hookName] = array();</div>
- <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  $this->hooks[$hookName][] = $module->entity->id;</div>
- <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  $moduleHook = new \Entity\ModuleHook();</div>
- <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  $moduleHook->module_id = $module->entity->id;</div>
- <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  $moduleHook->hookName = $hookName;</div>
- <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  $moduleHook->hookPosition = 10;</div>
- <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  $moduleHook->save();</div>
- <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div>
- <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
- <div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a8dc5debf6c33905af409438d26ed3916"> 70</a></span>  <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>
- <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div>
- <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">if</span> (empty($this->hooks[$hookName]))</div>
- <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> 0;</div>
- <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  $hookEvent = <span class="keyword">new</span> <a class="code" href="class_tools_1_1_hook_event.html">HookEvent</a>($hookName, $this->context, $params);</div>
- <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  array_push($this->currentHook, $hookEvent);</div>
- <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  $result = 0;</div>
- <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">foreach</span> ($this->hooks[$hookName] as $module_id)</div>
- <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  {</div>
- <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  $module = $this->context->moduleManager->getModuleFromId($module_id);</div>
- <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">if</span> (!$module)</div>
- <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">continue</span>;</div>
- <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  $module->doAction($hookEvent);</div>
- <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  $result++;</div>
- <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  }</div>
- <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  array_pop($this->currentHook);</div>
- <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> $result;</div>
- <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div>
- <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
- <div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#aa8a639e43502e64c10e92114c86d0d24"> 94</a></span>  <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>
- <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  {</div>
- <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">foreach</span> ($this->currentHook as $i)</div>
- <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">if</span> ($i->hookName == $hookName)</div>
- <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
- <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
- <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  }</div>
- <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
- <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#adc040cf46ed4deda06079b3ad84ee792"> 106</a></span>  <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>
- <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  {</div>
- <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  $this->hooks = array();</div>
- <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">foreach</span> ($hookEntities as $i)</div>
- <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  $this->hooks[$i->hookName][] = (int) $i->module_id;</div>
- <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  }</div>
- <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
- <div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="class_tools_1_1_hooks.html#a4537dad3b44254124991341cc91b28fb"> 116</a></span>  <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>
- <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  {</div>
- <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">switch</span> ($key)</div>
- <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  {</div>
- <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordflow">case</span> <span class="stringliteral">"currentHook"</span>: <span class="keywordflow">return</span> end($this->currentHook);</div>
- <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div>
- <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">throw</span> new \Exception(<span class="stringliteral">"Cannot access attribute {$key}"</span>);</div>
- <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  }</div>
- <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> }</div>
- <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div>
- <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>
- <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(&$context)</div><div class="ttdef"><b>Definition:</b> <a href="_hooks_8php_source.html#l00036">Hooks.php:36</a></div></div>
- <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>
- <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#l00094">Hooks.php:94</a></div></div>
- <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="exceptions_2_error404_8php_source.html#l00003">Error404.php:3</a></div></div>
- <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>
- <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#l00116">Hooks.php:116</a></div></div>
- <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>
- <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>
- <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#l00106">Hooks.php:106</a></div></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 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#l00070">Hooks.php:70</a></div></div>
- </div><!-- fragment --></div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Sun Aug 16 2015 15:52:07 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>
|