336 lines
36 KiB
HTML
336 lines
36 KiB
HTML
<!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.4"/>
|
|
<title>TeamSpeak 3 PHP Framework: TeamSpeak3/Helper/Signal.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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</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 id="projectlogo"><img alt="Logo" src="TeamSpeak.png"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">TeamSpeak 3 PHP Framework
|
|
 <span id="projectnumber">1.1.23</span>
|
|
</div>
|
|
<div id="projectbrief">Copyright © Planet TeamSpeak. All rights reserved.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.4 -->
|
|
<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="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</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>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('_signal_8php_source.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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>Classes</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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Pages</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 class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Signal.php</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_signal_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> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * @file</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * TeamSpeak 3 PHP Framework</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * $Id: Signal.php 10/11/2013 11:35:21 scp@orilla $</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * the Free Software Foundation, either version 3 of the License, or</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * (at your option) any later version.</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * This program is distributed in the hope that it will be useful,</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * GNU General Public License for more details.</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * along with this program. If not, see <http://www.gnu.org/licenses/>.</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * @package TeamSpeak3</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * @version 1.1.23</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * @author Sven 'ScP' Paulsen</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * @copyright Copyright (c) 2010 by Planet TeamSpeak. All rights reserved.</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * @class TeamSpeak3_Helper_Signal</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * @brief Helper class for signal slots.</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="class_team_speak3___helper___signal.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="class_team_speak3___helper___signal.html" title="Helper class for signal slots. ">TeamSpeak3_Helper_Signal</a></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {<span class="comment"></span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * Stores the TeamSpeak3_Helper_Signal object.</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * @var TeamSpeak3_Helper_Signal</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">protected</span> <span class="keyword">static</span> $instance = null;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * Stores subscribed signals and their slots.</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * @var array</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">protected</span> $sigslots = array();</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * Emits a signal with a given set of parameters.</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * @param string $signal</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * @param mixed $params</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @return mixed</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="class_team_speak3___helper___signal.html#a26e8fc61637d146b0347b7c9e09587ab"> 55</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___helper___signal.html#a26e8fc61637d146b0347b7c9e09587ab" title="Emits a signal with a given set of parameters. ">emit</a>($signal, $params = null)</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  {</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">if</span>(!$this-><a class="code" href="class_team_speak3___helper___signal.html#a840339183812e5e51d9c3b1beb9d1fd3" title="Returns TRUE there are slots subscribed for a specified signal. ">hasHandlers</a>($signal))</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  {</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">return</span>;</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="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">if</span>(!is_array($params))</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  {</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  $params = func_get_args();</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  $params = array_slice($params, 1);</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">foreach</span>($this->sigslots[$signal] as $slot)</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>  $return = $slot->call($params);</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> </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> $return;</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment"></span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * Generates a MD5 hash based on a given callback.</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * @param mixed $callback</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * @param string</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"><a class="code" href="class_team_speak3___helper___signal.html#ada301980bc0f9b8f310e8656972b6a35"> 83</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___helper___signal.html#ada301980bc0f9b8f310e8656972b6a35" title="Generates a MD5 hash based on a given callback. ">getCallbackHash</a>($callback)</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>  <span class="keywordflow">if</span>(!is_callable($callback, TRUE, $callable_name))</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  {</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___helper___signal___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_Signal objects. ">TeamSpeak3_Helper_Signal_Exception</a>(<span class="stringliteral">"invalid callback specified"</span>);</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  }</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">return</span> md5($callable_name);</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * Subscribes to a signal and returns the signal handler.</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * @param string $signal</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @param mixed $callback</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @return TeamSpeak3_Helper_Signal_Handler</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"><a class="code" href="class_team_speak3___helper___signal.html#a058ad6105e05a7b8c620b9446c545984"> 100</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___helper___signal.html#a058ad6105e05a7b8c620b9446c545984" title="Subscribes to a signal and returns the signal handler. ">subscribe</a>($signal, $callback)</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  {</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">if</span>(empty($this->sigslots[$signal]))</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  {</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  $this->sigslots[$signal] = array();</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  }</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  $index = $this-><a class="code" href="class_team_speak3___helper___signal.html#ada301980bc0f9b8f310e8656972b6a35" title="Generates a MD5 hash based on a given callback. ">getCallbackHash</a>($callback);</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">if</span>(!array_key_exists($index, $this->sigslots[$signal]))</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  {</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  $this->sigslots[$signal][$index] = <span class="keyword">new</span> <a class="code" href="class_team_speak3___helper___signal___handler.html" title="Helper class providing handler functions for signals. ">TeamSpeak3_Helper_Signal_Handler</a>($signal, $callback);</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">return</span> $this->sigslots[$signal][$index];</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  }</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * Unsubscribes from a signal.</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * @param string $signal</span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @param mixed $callback</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"><a class="code" href="class_team_speak3___helper___signal.html#a74e337835a70aa10894202bb43d8c30b"> 124</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___helper___signal.html#a74e337835a70aa10894202bb43d8c30b" title="Unsubscribes from a signal. ">unsubscribe</a>($signal, $callback = null)</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  {</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordflow">if</span>(!$this-><a class="code" href="class_team_speak3___helper___signal.html#a840339183812e5e51d9c3b1beb9d1fd3" title="Returns TRUE there are slots subscribed for a specified signal. ">hasHandlers</a>($signal))</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  {</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  }</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordflow">if</span>($callback !== null)</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  {</div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  $index = $this-><a class="code" href="class_team_speak3___helper___signal.html#ada301980bc0f9b8f310e8656972b6a35" title="Generates a MD5 hash based on a given callback. ">getCallbackHash</a>($callback);</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordflow">if</span>(!array_key_exists($index, $this->sigslots[$signal]))</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  {</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  unset($this->sigslots[$signal][$index]);</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  }</div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  {</div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  unset($this->sigslots[$signal]);</div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  }</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  }</div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * Returns all registered signals.</span></div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"><a class="code" href="class_team_speak3___helper___signal.html#aa690a091efef853c4a47d7b7e7363c03"> 153</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___helper___signal.html#aa690a091efef853c4a47d7b7e7363c03" title="Returns all registered signals. ">getSignals</a>()</div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  {</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordflow">return</span> array_keys($this->sigslots);</div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  }</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * Returns TRUE there are slots subscribed for a specified signal.</span></div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * @param string $signal</span></div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * @return boolean</span></div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"><a class="code" href="class_team_speak3___helper___signal.html#a840339183812e5e51d9c3b1beb9d1fd3"> 164</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___helper___signal.html#a840339183812e5e51d9c3b1beb9d1fd3" title="Returns TRUE there are slots subscribed for a specified signal. ">hasHandlers</a>($signal)</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  {</div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordflow">return</span> empty($this->sigslots[$signal]) ? FALSE : TRUE;</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  }</div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * Returns all slots for a specified signal.</span></div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * @param string $signal</span></div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"><a class="code" href="class_team_speak3___helper___signal.html#af414b1e8d18081c374a852c12c0b5cb6"> 175</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___helper___signal.html#af414b1e8d18081c374a852c12c0b5cb6" title="Returns all slots for a specified signal. ">getHandlers</a>($signal)</div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  {</div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="keywordflow">if</span>(!$this-><a class="code" href="class_team_speak3___helper___signal.html#a840339183812e5e51d9c3b1beb9d1fd3" title="Returns TRUE there are slots subscribed for a specified signal. ">hasHandlers</a>($signal))</div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  {</div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordflow">return</span> $this->sigslots[$signal];</div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  }</div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordflow">return</span> array();</div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  }</div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * Clears all slots for a specified signal.</span></div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * @param string $signal</span></div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"><a class="code" href="class_team_speak3___helper___signal.html#a8610e4f73d3f5b564edd1dfa81f1ac28"> 191</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___helper___signal.html#a8610e4f73d3f5b564edd1dfa81f1ac28" title="Clears all slots for a specified signal. ">clearHandlers</a>($signal)</div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  {</div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="keywordflow">if</span>(!$this-><a class="code" href="class_team_speak3___helper___signal.html#a840339183812e5e51d9c3b1beb9d1fd3" title="Returns TRUE there are slots subscribed for a specified signal. ">hasHandlers</a>($signal))</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  {</div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  unset($this->sigslots[$signal]);</div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  }</div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  }</div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * Returns a singleton instance of TeamSpeak3_Helper_Signal.</span></div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * @return TeamSpeak3_Helper_Signal</span></div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"><a class="code" href="class_team_speak3___helper___signal.html#af156036673730a599c10c8cbfd5e50bf"> 204</a></span>  <span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___helper___signal.html#af156036673730a599c10c8cbfd5e50bf" title="Returns a singleton instance of TeamSpeak3_Helper_Signal. ">getInstance</a>()</div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  {</div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="keywordflow">if</span>(self::$instance === null)</div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  {</div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  self::$instance = <span class="keyword">new</span> <span class="keyword">self</span>();</div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  }</div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> </div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="keywordflow">return</span> self::$instance;</div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  }</div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> }</div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_8c6eb96e4942c21c15d2738fe9c923ec.html">TeamSpeak3</a></li><li class="navelem"><a class="el" href="dir_3e66aa12f34129cf2d52c47a74e0508c.html">Helper</a></li><li class="navelem"><a class="el" href="_signal_8php.html">Signal.php</a></li>
|
|
<li class="footer">Generated on Fri Oct 11 2013 23:35:42 for TeamSpeak 3 PHP Framework by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.4 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|