| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156 |
- <!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/AModule.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">AModule.php</div> </div>
- </div><!--header-->
- <div class="contents">
- <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> <?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="l00009"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html"> 9</a></span> <span class="keyword">abstract</span> <span class="keyword">class </span><a class="code" href="class_tools_1_1_a_module.html">AModule</a></div>
- <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> {</div>
- <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>  <span class="keyword">private</span> <a class="code" href="class_tools_1_1_a_module.html#a7c294642225a6c91f5d7932dde75c2ae">$context</a>;</div>
- <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
- <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>  <span class="keyword">private</span> <a class="code" href="class_tools_1_1_a_module.html#a74ed34e6d7bc9f3f8c4fb58a12247ee2">$entity</a>;</div>
- <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
- <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">function</span> install();</div>
- <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
- <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>  <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>
- <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  { }</div>
- <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
- <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">function</span> doAction($event);</div>
- <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
- <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">function</span> doShortCode($shortCode, $params);</div>
- <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
- <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>  <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>
- <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>  <span class="keywordflow">if</span> ($this->context === null)</div>
- <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  $this->context = $context;</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="l00068"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html#ad868339fe7830b388444095288d40e22"> 68</a></span>  <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>
- <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div>
- <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">if</span> ($this->entity === null)</div>
- <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  $this->entity = $entity;</div>
- <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div>
- <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
- <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html#ab4218414b61680c0b9dee10c7f57e0a8"> 78</a></span>  <span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_tools_1_1_a_module.html#ab4218414b61680c0b9dee10c7f57e0a8">registerHook</a>($hookName)</div>
- <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  {</div>
- <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  $this->context->hooks->register($this, $hookname);</div>
- <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div>
- <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
- <div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="class_tools_1_1_a_module.html#a4537dad3b44254124991341cc91b28fb"> 86</a></span>  <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>
- <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>  <span class="keywordflow">switch</span> ($key)</div>
- <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>  <span class="keywordflow">case</span> <span class="stringliteral">"context"</span>: <span class="keywordflow">return</span> $this->context; <span class="keywordflow">break</span>;</div>
- <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">case</span> <span class="stringliteral">"entity"</span>: <span class="keywordflow">return</span> $this->entity; <span class="keywordflow">break</span>;</div>
- <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  }</div>
- <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">throw</span> new \Exception(<span class="stringliteral">"Cannot access attribute {$key}"</span>);</div>
- <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</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> </div>
- <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#l00086">AModule.php:86</a></div></div>
- <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>
- <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>
- <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>
- <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>
- <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>
- <div class="ttc" id="class_tools_1_1_a_module_html_ab4218414b61680c0b9dee10c7f57e0a8"><div class="ttname"><a href="class_tools_1_1_a_module.html#ab4218414b61680c0b9dee10c7f57e0a8">Tools\AModule\registerHook</a></div><div class="ttdeci">static registerHook($hookName)</div><div class="ttdef"><b>Definition:</b> <a href="_a_module_8php_source.html#l00078">AModule.php:78</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_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>
- </div><!-- fragment --></div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Aug 5 2015 00:58:13 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>
|