class_tools_1_1_hook_event.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  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: HookEvent Class Reference</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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
  65. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a></div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><a class="el" href="namespace_tools.html">Tools</a></li><li class="navelem"><a class="el" href="class_tools_1_1_hook_event.html">HookEvent</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#pub-methods">Public Member Functions</a> &#124;
  90. <a href="#pri-attribs">Private Attributes</a> </div>
  91. <div class="headertitle">
  92. <div class="title">HookEvent Class Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  97. Public Member Functions</h2></td></tr>
  98. <tr class="memitem:a5c11c5afa79de475e4b3760fcdbe82e3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_hook_event.html#a5c11c5afa79de475e4b3760fcdbe82e3">__construct</a> ($hookName, $context, $params)</td></tr>
  99. <tr class="separator:a5c11c5afa79de475e4b3760fcdbe82e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a4537dad3b44254124991341cc91b28fb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_hook_event.html#a4537dad3b44254124991341cc91b28fb">__get</a> ($key)</td></tr>
  101. <tr class="separator:a4537dad3b44254124991341cc91b28fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table><table class="memberdecls">
  103. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
  104. Private Attributes</h2></td></tr>
  105. <tr class="memitem:a7c294642225a6c91f5d7932dde75c2ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_hook_event.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a></td></tr>
  106. <tr class="separator:a7c294642225a6c91f5d7932dde75c2ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:aea63c2ead484f541380a4be3a3de7da2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_hook_event.html#aea63c2ead484f541380a4be3a3de7da2">$hookName</a></td></tr>
  108. <tr class="separator:aea63c2ead484f541380a4be3a3de7da2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:afe68e6fbe7acfbffc0af0c84a1996466"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tools_1_1_hook_event.html#afe68e6fbe7acfbffc0af0c84a1996466">$params</a></td></tr>
  110. <tr class="separator:afe68e6fbe7acfbffc0af0c84a1996466"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table>
  112. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  113. <div class="textblock"><p>Event's parameters This classe is attached to a hook when fired </p>
  114. <p>Definition at line <a class="el" href="_hook_event_8php_source.html#l00009">9</a> of file <a class="el" href="_hook_event_8php_source.html">HookEvent.php</a>.</p>
  115. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  116. <a class="anchor" id="a5c11c5afa79de475e4b3760fcdbe82e3"></a>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">__construct </td>
  122. <td>(</td>
  123. <td class="paramtype">&#160;</td>
  124. <td class="paramname"><em>$hookName</em>, </td>
  125. </tr>
  126. <tr>
  127. <td class="paramkey"></td>
  128. <td></td>
  129. <td class="paramtype">&#160;</td>
  130. <td class="paramname"><em>$context</em>, </td>
  131. </tr>
  132. <tr>
  133. <td class="paramkey"></td>
  134. <td></td>
  135. <td class="paramtype">&#160;</td>
  136. <td class="paramname"><em>$params</em>&#160;</td>
  137. </tr>
  138. <tr>
  139. <td></td>
  140. <td>)</td>
  141. <td></td><td></td>
  142. </tr>
  143. </table>
  144. </div><div class="memdoc">
  145. <p>Constructor </p>
  146. <p>Definition at line <a class="el" href="_hook_event_8php_source.html#l00035">35</a> of file <a class="el" href="_hook_event_8php_source.html">HookEvent.php</a>.</p>
  147. <div class="fragment"><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; {</div>
  148. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; $this-&gt;context = <a class="code" href="class_tools_1_1_hook_event.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>;</div>
  149. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; $this-&gt;hookName = <a class="code" href="class_tools_1_1_hook_event.html#aea63c2ead484f541380a4be3a3de7da2">$hookName</a>;</div>
  150. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; $this-&gt;params = <a class="code" href="class_tools_1_1_hook_event.html#afe68e6fbe7acfbffc0af0c84a1996466">$params</a>;</div>
  151. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; }</div>
  152. <div class="ttc" id="class_tools_1_1_hook_event_html_aea63c2ead484f541380a4be3a3de7da2"><div class="ttname"><a href="class_tools_1_1_hook_event.html#aea63c2ead484f541380a4be3a3de7da2">Tools\HookEvent\$hookName</a></div><div class="ttdeci">$hookName</div><div class="ttdef"><b>Definition:</b> <a href="_hook_event_8php_source.html#l00023">HookEvent.php:23</a></div></div>
  153. <div class="ttc" id="class_tools_1_1_hook_event_html_a7c294642225a6c91f5d7932dde75c2ae"><div class="ttname"><a href="class_tools_1_1_hook_event.html#a7c294642225a6c91f5d7932dde75c2ae">Tools\HookEvent\$context</a></div><div class="ttdeci">$context</div><div class="ttdef"><b>Definition:</b> <a href="_hook_event_8php_source.html#l00016">HookEvent.php:16</a></div></div>
  154. <div class="ttc" id="class_tools_1_1_hook_event_html_afe68e6fbe7acfbffc0af0c84a1996466"><div class="ttname"><a href="class_tools_1_1_hook_event.html#afe68e6fbe7acfbffc0af0c84a1996466">Tools\HookEvent\$params</a></div><div class="ttdeci">$params</div><div class="ttdef"><b>Definition:</b> <a href="_hook_event_8php_source.html#l00030">HookEvent.php:30</a></div></div>
  155. </div><!-- fragment -->
  156. </div>
  157. </div>
  158. <h2 class="groupheader">Member Function Documentation</h2>
  159. <a class="anchor" id="a4537dad3b44254124991341cc91b28fb"></a>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <table class="memname">
  163. <tr>
  164. <td class="memname">__get </td>
  165. <td>(</td>
  166. <td class="paramtype">&#160;</td>
  167. <td class="paramname"><em>$key</em></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </div><div class="memdoc">
  172. <p>Getter </p>
  173. <p>Definition at line <a class="el" href="_hook_event_8php_source.html#l00045">45</a> of file <a class="el" href="_hook_event_8php_source.html">HookEvent.php</a>.</p>
  174. <div class="fragment"><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; {</div>
  175. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">switch</span> ($key)</div>
  176. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div>
  177. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;hookName&quot;</span>: <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_hook_event.html#aea63c2ead484f541380a4be3a3de7da2">$this-&gt;hookName</a>; <span class="keywordflow">break</span>;</div>
  178. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordflow">case</span> <span class="stringliteral">&quot;params&quot;</span>: <span class="keywordflow">return</span> <a class="code" href="class_tools_1_1_hook_event.html#afe68e6fbe7acfbffc0af0c84a1996466">$this-&gt;params</a>; <span class="keywordflow">break</span>;</div>
  179. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; }</div>
  180. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">throw</span> new \Exception(<span class="stringliteral">&quot;Cannot access attribute {$key}&quot;</span>);</div>
  181. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; }</div>
  182. <div class="ttc" id="class_tools_1_1_hook_event_html_aea63c2ead484f541380a4be3a3de7da2"><div class="ttname"><a href="class_tools_1_1_hook_event.html#aea63c2ead484f541380a4be3a3de7da2">Tools\HookEvent\$hookName</a></div><div class="ttdeci">$hookName</div><div class="ttdef"><b>Definition:</b> <a href="_hook_event_8php_source.html#l00023">HookEvent.php:23</a></div></div>
  183. <div class="ttc" id="class_tools_1_1_hook_event_html_afe68e6fbe7acfbffc0af0c84a1996466"><div class="ttname"><a href="class_tools_1_1_hook_event.html#afe68e6fbe7acfbffc0af0c84a1996466">Tools\HookEvent\$params</a></div><div class="ttdeci">$params</div><div class="ttdef"><b>Definition:</b> <a href="_hook_event_8php_source.html#l00030">HookEvent.php:30</a></div></div>
  184. </div><!-- fragment -->
  185. </div>
  186. </div>
  187. <h2 class="groupheader">Field Documentation</h2>
  188. <a class="anchor" id="a7c294642225a6c91f5d7932dde75c2ae"></a>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="mlabels">
  192. <tr>
  193. <td class="mlabels-left">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">Tools <a class="el" href="class_tools_1_1_context.html">Context</a> $context</td>
  197. </tr>
  198. </table>
  199. </td>
  200. <td class="mlabels-right">
  201. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <p>/core/tools/Context.php Contains website's informations </p>
  206. <p>Definition at line <a class="el" href="_hook_event_8php_source.html#l00016">16</a> of file <a class="el" href="_hook_event_8php_source.html">HookEvent.php</a>.</p>
  207. </div>
  208. </div>
  209. <a class="anchor" id="aea63c2ead484f541380a4be3a3de7da2"></a>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="mlabels">
  213. <tr>
  214. <td class="mlabels-left">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">string $hookName</td>
  218. </tr>
  219. </table>
  220. </td>
  221. <td class="mlabels-right">
  222. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Contains hook name Can be accessed read-only </p>
  227. <p>Definition at line <a class="el" href="_hook_event_8php_source.html#l00023">23</a> of file <a class="el" href="_hook_event_8php_source.html">HookEvent.php</a>.</p>
  228. </div>
  229. </div>
  230. <a class="anchor" id="afe68e6fbe7acfbffc0af0c84a1996466"></a>
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="mlabels">
  234. <tr>
  235. <td class="mlabels-left">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">$params</td>
  239. </tr>
  240. </table>
  241. </td>
  242. <td class="mlabels-right">
  243. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. <p>Definition at line <a class="el" href="_hook_event_8php_source.html#l00030">30</a> of file <a class="el" href="_hook_event_8php_source.html">HookEvent.php</a>.</p>
  248. </div>
  249. </div>
  250. <hr/>The documentation for this class was generated from the following file:<ul>
  251. <li>core/tools/<a class="el" href="_hook_event_8php_source.html">HookEvent.php</a></li>
  252. </ul>
  253. </div><!-- contents -->
  254. <!-- start footer part -->
  255. <hr class="footer"/><address class="footer"><small>
  256. Generated on Sun Aug 16 2015 21:56:15 for ecom by &#160;<a href="http://www.doxygen.org/index.html">
  257. <img class="footer" src="doxygen.png" alt="doxygen"/>
  258. </a> 1.8.8
  259. </small></address>
  260. </body>
  261. </html>