2659 lines
453 KiB
HTML
2659 lines
453 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/Node/Server.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('_server_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">Server.php</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_server_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: Server.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_Node_Server</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * @brief Class describing a TeamSpeak 3 virtual server and all it's parameters.</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___node___server.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="class_team_speak3___node___server.html" title="Class describing a TeamSpeak 3 virtual server and all it's parameters. ">TeamSpeak3_Node_Server</a> <span class="keyword">extends</span> <a class="code" href="class_team_speak3___node___abstract.html" title="Abstract class describing a TeamSpeak 3 node and all it's parameters. ">TeamSpeak3_Node_Abstract</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"> * @ignore</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"><a class="code" href="class_team_speak3___node___server.html#aec962cb88b2aff33e055e9d62992bbd8"> 37</a></span>  <span class="keyword">protected</span> <a class="code" href="class_team_speak3___node___server.html#aec962cb88b2aff33e055e9d62992bbd8">$channelList</a> = null;</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="comment"> /**</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @ignore</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"><a class="code" href="class_team_speak3___node___server.html#a3f25f20028741a14cc652779159707cb"> 42</a></span>  <span class="keyword">protected</span> <a class="code" href="class_team_speak3___node___server.html#a3f25f20028741a14cc652779159707cb">$clientList</a> = null;</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"> /**</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * @ignore</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a9c4ce4a5649ba8aa595a7f2fdafdf951"> 47</a></span>  <span class="keyword">protected</span> <a class="code" href="class_team_speak3___node___server.html#a9c4ce4a5649ba8aa595a7f2fdafdf951">$sgroupList</a> = null;</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"> /**</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @ignore</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ae5a5b2061a93f754afbb410f28e09415"> 52</a></span>  <span class="keyword">protected</span> <a class="code" href="class_team_speak3___node___server.html#ae5a5b2061a93f754afbb410f28e09415">$cgroupList</a> = null;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></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"> 55</span> <span class="comment"> * The TeamSpeak3_Node_Server constructor.</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @param TeamSpeak3_Node_Host $host</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @param array $info</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * @param string $index</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @return TeamSpeak3_Node_Server</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a5daf725f479aa4f401739c6af5b86ea2"> 63</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a5daf725f479aa4f401739c6af5b86ea2" title="The TeamSpeak3_Node_Server constructor. ">__construct</a>(<a class="code" href="class_team_speak3___node___host.html" title="Class describing a TeamSpeak 3 server instance and all it's parameters. ">TeamSpeak3_Node_Host</a> $host, array $info, $index = <span class="stringliteral">"virtualserver_id"</span>)</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  {</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  $this->parent = $host;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  $this->nodeInfo = $info;</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">if</span>(!array_key_exists($index, $this->nodeInfo))</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">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid serverID"</span>, 0x400);</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>  $this->nodeId = $this->nodeInfo[$index];</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"> * Sends a prepared command to the server and returns the result.</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 string $cmd</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * @param boolean $throw</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * @return TeamSpeak3_Adapter_ServerQuery_Reply</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___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6"> 83</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>($cmd, $throw = TRUE)</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>($this-><a class="code" href="class_team_speak3___node___abstract.html#a4a0a5545abc2460d1d9b3d6b52d07cbe" title="Returns the primary ID of the current node. ">getId</a>() != $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->serverSelectedId())</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>  $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->serverSelect($this-><a class="code" href="class_team_speak3___node___abstract.html#a4a0a5545abc2460d1d9b3d6b52d07cbe" title="Returns the primary ID of the current node. ">getId</a>());</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> $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->request($cmd, $throw);</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"> * Returns an array filled with TeamSpeak3_Node_Channel objects.</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 array $filter</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#af89e63cf4213e41524cfcf522f46493d"> 99</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#af89e63cf4213e41524cfcf522f46493d" title="Returns an array filled with TeamSpeak3_Node_Channel objects. ">channelList</a>(array $filter = array())</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>  <span class="keywordflow">if</span>($this-><a class="code" href="class_team_speak3___node___server.html#af89e63cf4213e41524cfcf522f46493d" title="Returns an array filled with TeamSpeak3_Node_Channel objects. ">channelList</a> === null)</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  {</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  $channels = $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"channellist -topic -flags -voice -limits -icon"</span>)->toAssocArray(<span class="stringliteral">"cid"</span>);</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  $this-><a class="code" href="class_team_speak3___node___server.html#af89e63cf4213e41524cfcf522f46493d" title="Returns an array filled with TeamSpeak3_Node_Channel objects. ">channelList</a> = array();</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>  <span class="keywordflow">foreach</span>($channels as $cid => $channel)</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>  $this-><a class="code" href="class_team_speak3___node___server.html#af89e63cf4213e41524cfcf522f46493d" title="Returns an array filled with TeamSpeak3_Node_Channel objects. ">channelList</a>[$cid] = <span class="keyword">new</span> <a class="code" href="class_team_speak3___node___channel.html" title="Class describing a TeamSpeak 3 channel and all it's parameters. ">TeamSpeak3_Node_Channel</a>($this, $channel);</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> </div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#a9ead519e8396990ba30d79d6bed9d286">resetNodeList</a>();</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> </div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#ad826df3c71029ca48839dbe9aa3559b8" title="Filters given node list array using specified filter rules. ">filterList</a>($this-><a class="code" href="class_team_speak3___node___server.html#af89e63cf4213e41524cfcf522f46493d" title="Returns an array filled with TeamSpeak3_Node_Channel objects. ">channelList</a>, $filter);</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</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"> /**</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * Resets the list of channels online.</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aa6e9bfacd257844a49eb0e2444f468bb"> 123</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aa6e9bfacd257844a49eb0e2444f468bb" title="Resets the list of channels online. ">channelListReset</a>()</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>  $this-><a class="code" href="class_team_speak3___node___abstract.html#a9ead519e8396990ba30d79d6bed9d286">resetNodeList</a>();</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  $this-><a class="code" href="class_team_speak3___node___server.html#af89e63cf4213e41524cfcf522f46493d" title="Returns an array filled with TeamSpeak3_Node_Channel objects. ">channelList</a> = null;</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="comment"></span></div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * Creates a new channel using given properties and returns the new ID.</span></div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * @param array $properties</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ad99b7e328bc70ad4fdbf623d4bc0ec08"> 135</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ad99b7e328bc70ad4fdbf623d4bc0ec08" title="Creates a new channel using given properties and returns the new ID. ">channelCreate</a>(array $properties)</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>  $cid = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelcreate"</span>, $properties)->toList();</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  $this-><a class="code" href="class_team_speak3___node___server.html#aa6e9bfacd257844a49eb0e2444f468bb" title="Resets the list of channels online. ">channelListReset</a>();</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>  <span class="keywordflow">if</span>(!isset($properties[<span class="stringliteral">"client_flag_permanent"</span>]) && !isset($properties[<span class="stringliteral">"client_flag_semi_permanent"</span>]))</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>  $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->whoamiSet(<span class="stringliteral">"client_channel_id"</span>, $cid[<span class="stringliteral">"cid"</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> </div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordflow">return</span> $cid[<span class="stringliteral">"cid"</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"> * Deletes the channel specified by $cid.</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"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * @param boolean $force</span></div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a2fda0933d13a8ffad575bf5c33be6aaa"> 155</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a2fda0933d13a8ffad575bf5c33be6aaa" title="Deletes the channel specified by $cid. ">channelDelete</a>($cid, $force = FALSE)</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>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channeldelete"</span>, array(<span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"force"</span> => $force));</div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  $this-><a class="code" href="class_team_speak3___node___server.html#aa6e9bfacd257844a49eb0e2444f468bb" title="Resets the list of channels online. ">channelListReset</a>();</div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordflow">if</span>(($cid instanceof <a class="code" href="class_team_speak3___node___abstract.html" title="Abstract class describing a TeamSpeak 3 node and all it's parameters. ">TeamSpeak3_Node_Abstract</a> ? $cid-><a class="code" href="class_team_speak3___node___abstract.html#a4a0a5545abc2460d1d9b3d6b52d07cbe" title="Returns the primary ID of the current node. ">getId</a>() : $cid) == $this->whoamiGet(<span class="stringliteral">"client_channel_id"</span>))</div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  {</div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->whoamiReset();</div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  }</div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  }</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * Moves the channel specified by $cid to the parent channel specified with $pid.</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"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * @param integer $pid</span></div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * @param integer $order</span></div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a318977af4cbbe51289e68bdbd57a9342"> 174</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a318977af4cbbe51289e68bdbd57a9342" title="Moves the channel specified by $cid to the parent channel specified with $pid. ">channelMove</a>($cid, $pid, $order = null)</div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  {</div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelmove"</span>, array(<span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"cpid"</span> => $pid, <span class="stringliteral">"order"</span> => $order));</div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  $this-><a class="code" href="class_team_speak3___node___server.html#aa6e9bfacd257844a49eb0e2444f468bb" title="Resets the list of channels online. ">channelListReset</a>();</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="comment"></span></div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * Returns TRUE if the given TeamSpeak3_Node_Channel object is a spacer.</span></div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * @param TeamSpeak3_Node_Channel $channel</span></div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * @return boolean</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"><a class="code" href="class_team_speak3___node___server.html#af1ace8782c92dabd6bf1d5fc2476295a"> 186</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#af1ace8782c92dabd6bf1d5fc2476295a" title="Returns TRUE if the given TeamSpeak3_Node_Channel object is a spacer. ">channelIsSpacer</a>(<a class="code" href="class_team_speak3___node___channel.html" title="Class describing a TeamSpeak 3 channel and all it's parameters. ">TeamSpeak3_Node_Channel</a> $channel)</div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  {</div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordflow">return</span> (preg_match(<span class="stringliteral">"/\[[^\]]*spacer[^\]]*\]/"</span>, $channel) && $channel[<span class="stringliteral">"channel_flag_permanent"</span>] && !$channel[<span class="stringliteral">"pid"</span>]) ? TRUE : FALSE;</div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</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"> 191</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * Creates a new channel spacer and returns the new ID. The first parameter $ident is used to create a</span></div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> * unique spacer name on the virtual server.</span></div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * @param string $ident</span></div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * @param mixed $type</span></div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * @param integer $align</span></div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * @param integer $order</span></div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * @param integer $maxclients</span></div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aba6de5270fed2d117ad5cdb3f5503b43"> 203</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aba6de5270fed2d117ad5cdb3f5503b43" title="Creates a new channel spacer and returns the new ID. ">channelSpacerCreate</a>($ident, $type = <a class="code" href="class_team_speak3.html#abe21c7855096b6b8d86613897ed1a4bd" title="0: solid line ">TeamSpeak3::SPACER_SOLIDLINE</a>, $align = <a class="code" href="class_team_speak3.html#a7aa076becfafe9cfb5a6b9eae4c72831" title="3: repeat until the whole line is filled ">TeamSpeak3::SPACER_ALIGN_REPEAT</a>, $order = null, $maxclients = 0)</div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  {</div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  $properties = array(</div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="stringliteral">"channel_name_phonetic"</span> => <span class="stringliteral">"channel spacer"</span>,</div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="stringliteral">"channel_codec"</span> => <a class="code" href="class_team_speak3.html#ac8a12a60994f2949c63e21d8915c8afa" title="3: opus voice (interactive) ">TeamSpeak3::CODEC_OPUS_VOICE</a>,</div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <span class="stringliteral">"channel_codec_quality"</span> => 0x00,</div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="stringliteral">"channel_flag_permanent"</span> => TRUE,</div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <span class="stringliteral">"channel_flag_maxclients_unlimited"</span> => FALSE,</div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="stringliteral">"channel_flag_maxfamilyclients_unlimited"</span> => FALSE,</div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="stringliteral">"channel_flag_maxfamilyclients_inherited"</span> => FALSE,</div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <span class="stringliteral">"channel_maxclients"</span> => $maxclients,</div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="stringliteral">"channel_order"</span> => $order,</div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  );</div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keywordflow">switch</span>($align)</div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  {</div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#a7aa076becfafe9cfb5a6b9eae4c72831" title="3: repeat until the whole line is filled ">TeamSpeak3::SPACER_ALIGN_REPEAT</a>:</div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  $properties[<span class="stringliteral">"channel_name"</span>] = <span class="stringliteral">"[*spacer"</span> . strval($ident) . <span class="stringliteral">"]"</span>;</div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> </div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#ad7a9fe53817b1d8441eafe1cfed2570e" title="0: alignment left ">TeamSpeak3::SPACER_ALIGN_LEFT</a>:</div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  $properties[<span class="stringliteral">"channel_name"</span>] = <span class="stringliteral">"[lspacer"</span> . strval($ident) . <span class="stringliteral">"]"</span>;</div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> </div>
|
|
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#ace570a7b5abdbfd89f20145f2757bbcd" title="1: alignment right ">TeamSpeak3::SPACER_ALIGN_RIGHT</a>:</div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  $properties[<span class="stringliteral">"channel_name"</span>] = <span class="stringliteral">"[rspacer"</span> . strval($ident) . <span class="stringliteral">"]"</span>;</div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> </div>
|
|
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#aaffe4f52d9d9009a8fd90fb2683e18ce" title="2: alignment center ">TeamSpeak3::SPACER_ALIGN_CENTER</a>:</div>
|
|
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  $properties[<span class="stringliteral">"channel_name"</span>] = <span class="stringliteral">"[cspacer"</span> . strval($ident) . <span class="stringliteral">"]"</span>;</div>
|
|
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <span class="keywordflow">default</span>:</div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"missing required parameter"</span>, 0x606);</div>
|
|
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  }</div>
|
|
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> </div>
|
|
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keywordflow">switch</span>($type)</div>
|
|
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  {</div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="keywordflow">case</span> (<span class="keywordtype">string</span>) <a class="code" href="class_team_speak3.html#abe21c7855096b6b8d86613897ed1a4bd" title="0: solid line ">TeamSpeak3::SPACER_SOLIDLINE</a>:</div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  $properties[<span class="stringliteral">"channel_name"</span>] .= <span class="stringliteral">"___"</span>;</div>
|
|
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> </div>
|
|
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  <span class="keywordflow">case</span> (<span class="keywordtype">string</span>) <a class="code" href="class_team_speak3.html#ae0f64ba57dfa729092ae07f0508ad20c" title="1: dash line ">TeamSpeak3::SPACER_DASHLINE</a>:</div>
|
|
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  $properties[<span class="stringliteral">"channel_name"</span>] .= <span class="stringliteral">"---"</span>;</div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> </div>
|
|
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <span class="keywordflow">case</span> (<span class="keywordtype">string</span>) <a class="code" href="class_team_speak3.html#a1b97ddf3ea3bfb3bac4167cc9853bcf5" title="2: dot line ">TeamSpeak3::SPACER_DOTLINE</a>:</div>
|
|
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  $properties[<span class="stringliteral">"channel_name"</span>] .= <span class="stringliteral">"..."</span>;</div>
|
|
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div>
|
|
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  <span class="keywordflow">case</span> (<span class="keywordtype">string</span>) <a class="code" href="class_team_speak3.html#ab5f7f692edb611a09be65dbe1cc22fd3" title="3: dash dot line ">TeamSpeak3::SPACER_DASHDOTLINE</a>:</div>
|
|
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  $properties[<span class="stringliteral">"channel_name"</span>] .= <span class="stringliteral">"-.-"</span>;</div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> </div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  <span class="keywordflow">case</span> (<span class="keywordtype">string</span>) <a class="code" href="class_team_speak3.html#a8a46203c06bf7b769b1245eee8c71eca" title="4: dash dot dot line ">TeamSpeak3::SPACER_DASHDOTDOTLINE</a>:</div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  $properties[<span class="stringliteral">"channel_name"</span>] .= <span class="stringliteral">"-.."</span>;</div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> </div>
|
|
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="keywordflow">default</span>:</div>
|
|
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  $properties[<span class="stringliteral">"channel_name"</span>] .= strval($type);</div>
|
|
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  }</div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> </div>
|
|
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___server.html#ad99b7e328bc70ad4fdbf623d4bc0ec08" title="Creates a new channel using given properties and returns the new ID. ">channelCreate</a>($properties);</div>
|
|
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  }</div>
|
|
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> * Returns the possible type of a channel spacer.</span></div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00277"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a4b65797b14ce1dbc5ab123840216d8d5"> 277</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a4b65797b14ce1dbc5ab123840216d8d5" title="Returns the possible type of a channel spacer. ">channelSpacerGetType</a>($cid)</div>
|
|
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  {</div>
|
|
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  $channel = $this-><a class="code" href="class_team_speak3___node___server.html#ab384bb6d76c0dfb582c877852ddba1dc" title="Returns the TeamSpeak3_Node_Channel object matching the given ID. ">channelGetById</a>($cid);</div>
|
|
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> </div>
|
|
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  <span class="keywordflow">if</span>(!$this-><a class="code" href="class_team_speak3___node___server.html#af1ace8782c92dabd6bf1d5fc2476295a" title="Returns TRUE if the given TeamSpeak3_Node_Channel object is a spacer. ">channelIsSpacer</a>($channel))</div>
|
|
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  {</div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid channel flags"</span>, 0x307);</div>
|
|
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  }</div>
|
|
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> </div>
|
|
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  <span class="keywordflow">switch</span>($channel[<span class="stringliteral">"channel_name"</span>]->section(<span class="stringliteral">"]"</span>, 1))</div>
|
|
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  {</div>
|
|
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  <span class="keywordflow">case</span> <span class="stringliteral">"___"</span>:</div>
|
|
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3.html#abe21c7855096b6b8d86613897ed1a4bd" title="0: solid line ">TeamSpeak3::SPACER_SOLIDLINE</a>;</div>
|
|
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> </div>
|
|
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  <span class="keywordflow">case</span> <span class="stringliteral">"---"</span>:</div>
|
|
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3.html#ae0f64ba57dfa729092ae07f0508ad20c" title="1: dash line ">TeamSpeak3::SPACER_DASHLINE</a>;</div>
|
|
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> </div>
|
|
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  <span class="keywordflow">case</span> <span class="stringliteral">"..."</span>:</div>
|
|
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3.html#a1b97ddf3ea3bfb3bac4167cc9853bcf5" title="2: dot line ">TeamSpeak3::SPACER_DOTLINE</a>;</div>
|
|
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> </div>
|
|
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  <span class="keywordflow">case</span> <span class="stringliteral">"-.-"</span>:</div>
|
|
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3.html#ab5f7f692edb611a09be65dbe1cc22fd3" title="3: dash dot line ">TeamSpeak3::SPACER_DASHDOTLINE</a>;</div>
|
|
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> </div>
|
|
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  <span class="keywordflow">case</span> <span class="stringliteral">"-.."</span>:</div>
|
|
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3.html#a8a46203c06bf7b769b1245eee8c71eca" title="4: dash dot dot line ">TeamSpeak3::SPACER_DASHDOTDOTLINE</a>;</div>
|
|
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> </div>
|
|
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <span class="keywordflow">default</span>:</div>
|
|
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3.html#a12e9d78448fe9a2fc19f71a19db33b24" title="5: custom format ">TeamSpeak3::SPACER_CUSTOM</a>;</div>
|
|
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  }</div>
|
|
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  }</div>
|
|
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> * Returns the possible alignment of a channel spacer.</span></div>
|
|
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00315"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a34911a30ab894a628124c6e8ec3131f1"> 315</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a34911a30ab894a628124c6e8ec3131f1" title="Returns the possible alignment of a channel spacer. ">channelSpacerGetAlign</a>($cid)</div>
|
|
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  {</div>
|
|
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  $channel = $this-><a class="code" href="class_team_speak3___node___server.html#ab384bb6d76c0dfb582c877852ddba1dc" title="Returns the TeamSpeak3_Node_Channel object matching the given ID. ">channelGetById</a>($cid);</div>
|
|
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> </div>
|
|
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <span class="keywordflow">if</span>(!$this-><a class="code" href="class_team_speak3___node___server.html#af1ace8782c92dabd6bf1d5fc2476295a" title="Returns TRUE if the given TeamSpeak3_Node_Channel object is a spacer. ">channelIsSpacer</a>($channel) || !preg_match(<span class="stringliteral">"/\[(.*)spacer.*\]/"</span>, $channel, $matches) || !isset($matches[1]))</div>
|
|
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  {</div>
|
|
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid channel flags"</span>, 0x307);</div>
|
|
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  }</div>
|
|
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> </div>
|
|
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  <span class="keywordflow">switch</span>($matches[1])</div>
|
|
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  {</div>
|
|
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  <span class="keywordflow">case</span> <span class="stringliteral">"*"</span>:</div>
|
|
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3.html#a7aa076becfafe9cfb5a6b9eae4c72831" title="3: repeat until the whole line is filled ">TeamSpeak3::SPACER_ALIGN_REPEAT</a>;</div>
|
|
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> </div>
|
|
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  <span class="keywordflow">case</span> <span class="stringliteral">"c"</span>:</div>
|
|
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3.html#aaffe4f52d9d9009a8fd90fb2683e18ce" title="2: alignment center ">TeamSpeak3::SPACER_ALIGN_CENTER</a>;</div>
|
|
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> </div>
|
|
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  <span class="keywordflow">case</span> <span class="stringliteral">"r"</span>:</div>
|
|
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3.html#ace570a7b5abdbfd89f20145f2757bbcd" title="1: alignment right ">TeamSpeak3::SPACER_ALIGN_RIGHT</a>;</div>
|
|
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> </div>
|
|
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  <span class="keywordflow">default</span>:</div>
|
|
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3.html#ad7a9fe53817b1d8441eafe1cfed2570e" title="0: alignment left ">TeamSpeak3::SPACER_ALIGN_LEFT</a>;</div>
|
|
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  }</div>
|
|
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span>  }</div>
|
|
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> * Returns a list of permissions defined for a specific channel.</span></div>
|
|
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * @param boolean $permsid</span></div>
|
|
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00347"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#abf2cdfe68a150d47712165b91db12bbc"> 347</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#abf2cdfe68a150d47712165b91db12bbc" title="Returns a list of permissions defined for a specific channel. ">channelPermList</a>($cid, $permsid = FALSE)</div>
|
|
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>  {</div>
|
|
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelpermlist"</span>, array(<span class="stringliteral">"cid"</span> => $cid, $permsid ? <span class="stringliteral">"-permsid"</span> : null))->toAssocArray($permsid ? <span class="stringliteral">"permsid"</span> : <span class="stringliteral">"permid"</span>);</div>
|
|
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  }</div>
|
|
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> * Adds a set of specified permissions to a channel. Multiple permissions can be added by</span></div>
|
|
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> * providing the two parameters of each permission.</span></div>
|
|
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> * @param integer $permid</span></div>
|
|
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> * @param integer $permvalue</span></div>
|
|
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00361"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a912200d0dad1ac57581786d8f09948e4"> 361</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a912200d0dad1ac57581786d8f09948e4" title="Adds a set of specified permissions to a channel. ">channelPermAssign</a>($cid, $permid, $permvalue)</div>
|
|
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  {</div>
|
|
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  <span class="keywordflow">if</span>(!is_array($permid))</div>
|
|
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  {</div>
|
|
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  $permident = (is_numeric($permid)) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  }</div>
|
|
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  {</div>
|
|
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  $permident = (is_numeric(<a class="code" href="class_team_speak3___node___abstract.html#a1c78dbb54df73f8c5dabe41ebd476207">current</a>($permid))) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  }</div>
|
|
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span> </div>
|
|
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channeladdperm"</span>, array(<span class="stringliteral">"cid"</span> => $cid, $permident => $permid, <span class="stringliteral">"permvalue"</span> => $permvalue));</div>
|
|
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  }</div>
|
|
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> * Removes a set of specified permissions from a channel. Multiple permissions can be removed at once.</span></div>
|
|
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> * @param integer $permid</span></div>
|
|
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00382"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a7d88676f4ef80466b1a24945c49a006b"> 382</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a7d88676f4ef80466b1a24945c49a006b" title="Removes a set of specified permissions from a channel. ">channelPermRemove</a>($cid, $permid)</div>
|
|
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>  {</div>
|
|
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  <span class="keywordflow">if</span>(!is_array($permid))</div>
|
|
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  {</div>
|
|
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>  $permident = (is_numeric($permid)) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>  }</div>
|
|
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  {</div>
|
|
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  $permident = (is_numeric(<a class="code" href="class_team_speak3___node___abstract.html#a1c78dbb54df73f8c5dabe41ebd476207">current</a>($permid))) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span>  }</div>
|
|
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span> </div>
|
|
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channeldelperm"</span>, array(<span class="stringliteral">"cid"</span> => $cid, $permident => $permid));</div>
|
|
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>  }</div>
|
|
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment"> * Returns a list of permissions defined for a client in a specific channel.</span></div>
|
|
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment"> * @param integer $cldbid</span></div>
|
|
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment"> * @param boolean $permsid</span></div>
|
|
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00404"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a3bfc6b821cabd6b26dfdc32f70111161"> 404</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a3bfc6b821cabd6b26dfdc32f70111161" title="Returns a list of permissions defined for a client in a specific channel. ">channelClientPermList</a>($cid, $cldbid, $permsid = FALSE)</div>
|
|
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span>  {</div>
|
|
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelclientpermlist"</span>, array(<span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"cldbid"</span> => $cldbid, $permsid ? <span class="stringliteral">"-permsid"</span> : null))->toAssocArray($permsid ? <span class="stringliteral">"permsid"</span> : <span class="stringliteral">"permid"</span>);</div>
|
|
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span>  }</div>
|
|
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="comment"> * Adds a set of specified permissions to a client in a specific channel. Multiple permissions can be added by</span></div>
|
|
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="comment"> * providing the two parameters of each permission.</span></div>
|
|
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"> * @param integer $cldbid</span></div>
|
|
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment"> * @param integer $permid</span></div>
|
|
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment"> * @param integer $permvalue</span></div>
|
|
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00419"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a4a88f38a81880b5c6a33cb5d084eb56a"> 419</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a4a88f38a81880b5c6a33cb5d084eb56a" title="Adds a set of specified permissions to a client in a specific channel. ">channelClientPermAssign</a>($cid, $cldbid, $permid, $permvalue)</div>
|
|
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>  {</div>
|
|
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>  <span class="keywordflow">if</span>(!is_array($permid))</div>
|
|
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>  {</div>
|
|
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>  $permident = (is_numeric($permid)) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>  }</div>
|
|
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>  {</div>
|
|
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  $permident = (is_numeric(<a class="code" href="class_team_speak3___node___abstract.html#a1c78dbb54df73f8c5dabe41ebd476207">current</a>($permid))) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>  }</div>
|
|
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span> </div>
|
|
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelclientaddperm"</span>, array(<span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"cldbid"</span> => $cldbid, $permident => $permid, <span class="stringliteral">"permvalue"</span> => $permvalue));</div>
|
|
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span>  }</div>
|
|
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment"> * Removes a set of specified permissions from a client in a specific channel. Multiple permissions can be removed at once.</span></div>
|
|
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="comment"> * @param integer $cldbid</span></div>
|
|
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment"> * @param integer $permid</span></div>
|
|
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00441"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a16866a89acc0ebab56ac281fd481fa5c"> 441</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a16866a89acc0ebab56ac281fd481fa5c" title="Removes a set of specified permissions from a client in a specific channel. ">channelClientPermRemove</a>($cid, $cldbid, $permid)</div>
|
|
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  {</div>
|
|
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span>  <span class="keywordflow">if</span>(!is_array($permid))</div>
|
|
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>  {</div>
|
|
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  $permident = (is_numeric($permid)) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>  }</div>
|
|
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  {</div>
|
|
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  $permident = (is_numeric(<a class="code" href="class_team_speak3___node___abstract.html#a1c78dbb54df73f8c5dabe41ebd476207">current</a>($permid))) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  }</div>
|
|
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span> </div>
|
|
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelclientdelperm"</span>, array(<span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"cldbid"</span> => $cldbid, $permident => $permid));</div>
|
|
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span>  }</div>
|
|
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment"> * Returns a list of files and directories stored in the specified channels file repository.</span></div>
|
|
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment"> * @param string $cpw</span></div>
|
|
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment"> * @param string $path</span></div>
|
|
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment"> * @param boolean $recursive</span></div>
|
|
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00464"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ade91ccd595c575785b73e6676195375d"> 464</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ade91ccd595c575785b73e6676195375d" title="Returns a list of files and directories stored in the specified channels file repository. ">channelFileList</a>($cid, $cpw = <span class="stringliteral">""</span>, $path = <span class="stringliteral">"/"</span>, $recursive = FALSE)</div>
|
|
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span>  {</div>
|
|
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>  $files = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"ftgetfilelist"</span>, array(<span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"cpw"</span> => $cpw, <span class="stringliteral">"path"</span> => $path))->toArray();</div>
|
|
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  $count = <a class="code" href="class_team_speak3___node___abstract.html#ad22d04a2800ae672f6117de3afb0e9c4">count</a>($files);</div>
|
|
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span> </div>
|
|
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span>  <span class="keywordflow">for</span>($i = 0; $i < $count; $i++)</div>
|
|
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span>  {</div>
|
|
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  $files[$i][<span class="stringliteral">"sid"</span>] = $this-><a class="code" href="class_team_speak3___node___abstract.html#a4a0a5545abc2460d1d9b3d6b52d07cbe" title="Returns the primary ID of the current node. ">getId</a>();</div>
|
|
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>  $files[$i][<span class="stringliteral">"cid"</span>] = $files[0][<span class="stringliteral">"cid"</span>];</div>
|
|
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span>  $files[$i][<span class="stringliteral">"path"</span>] = $files[0][<span class="stringliteral">"path"</span>];</div>
|
|
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>  $files[$i][<span class="stringliteral">"src"</span>] = <span class="keyword">new</span> <a class="code" href="class_team_speak3___helper___string.html" title="Helper class for string handling. ">TeamSpeak3_Helper_String</a>($cid ? $files[$i][<span class="stringliteral">"path"</span>] : <span class="stringliteral">"/"</span>);</div>
|
|
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span> </div>
|
|
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  <span class="keywordflow">if</span>(!$files[$i][<span class="stringliteral">"src"</span>]->endsWith(<span class="stringliteral">"/"</span>))</div>
|
|
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  {</div>
|
|
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  $files[$i][<span class="stringliteral">"src"</span>]->append(<span class="stringliteral">"/"</span>);</div>
|
|
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  }</div>
|
|
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span> </div>
|
|
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span>  $files[$i][<span class="stringliteral">"src"</span>]->append($files[$i][<span class="stringliteral">"name"</span>]);</div>
|
|
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span> </div>
|
|
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  <span class="keywordflow">if</span>($recursive && $files[$i][<span class="stringliteral">"type"</span>] == <a class="code" href="class_team_speak3.html#a0dfea6a5fe76141895e0f2900e8e4e52" title="0: file is directory ">TeamSpeak3::FILE_TYPE_DIRECTORY</a>)</div>
|
|
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  {</div>
|
|
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  $files = array_merge($files, $this-><a class="code" href="class_team_speak3___node___server.html#ade91ccd595c575785b73e6676195375d" title="Returns a list of files and directories stored in the specified channels file repository. ">channelFileList</a>($cid, $cpw, $path . $files[$i][<span class="stringliteral">"name"</span>], $recursive));</div>
|
|
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  }</div>
|
|
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  }</div>
|
|
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span> </div>
|
|
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  uasort($files, array(__CLASS__, <span class="stringliteral">"sortFileList"</span>));</div>
|
|
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span> </div>
|
|
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  <span class="keywordflow">return</span> $files;</div>
|
|
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span>  }</div>
|
|
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment"> * Returns detailed information about the specified file stored in a channels file repository.</span></div>
|
|
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment"> * @param string $cpw</span></div>
|
|
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00502"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a42480bcff5af21ef8cc4af469636eadd"> 502</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a42480bcff5af21ef8cc4af469636eadd" title="Returns detailed information about the specified file stored in a channels file repository. ">channelFileInfo</a>($cid, $cpw = <span class="stringliteral">""</span>, $name = <span class="stringliteral">"/"</span>)</div>
|
|
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  {</div>
|
|
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span>  <span class="keywordflow">return</span> array_pop($this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"ftgetfileinfo"</span>, array(<span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"cpw"</span> => $cpw, <span class="stringliteral">"name"</span> => $name))-><a class="code" href="class_team_speak3___node___abstract.html#acf3c56763859b8adb21379f0cc6394ad" title="Returns an assoc array filled with current node info properties. ">toArray</a>());</div>
|
|
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>  }</div>
|
|
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="comment"> * Renames a file in a channels file repository. If the two parameters $tcid and $tcpw are specified, the file</span></div>
|
|
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment"> * will be moved into another channels file repository.</span></div>
|
|
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"> * @param string $cpw</span></div>
|
|
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"> * @param string $oldname</span></div>
|
|
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="comment"> * @param string $newname</span></div>
|
|
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <span class="comment"> * @param integer $tcid</span></div>
|
|
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="comment"> * @param string $tcpw</span></div>
|
|
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00519"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a2005bdcfe3f564880c3be8d9249f9419"> 519</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a2005bdcfe3f564880c3be8d9249f9419" title="Renames a file in a channels file repository. ">channelFileRename</a>($cid, $cpw = <span class="stringliteral">""</span>, $oldname = <span class="stringliteral">"/"</span>, $newname = <span class="stringliteral">"/"</span>, $tcid = null, $tcpw = null)</div>
|
|
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span>  {</div>
|
|
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"ftrenamefile"</span>, array(<span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"cpw"</span> => $cpw, <span class="stringliteral">"oldname"</span> => $oldname, <span class="stringliteral">"newname"</span> => $newname, <span class="stringliteral">"tcid"</span> => $tcid, <span class="stringliteral">"tcpw"</span> => $tcpw));</div>
|
|
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span>  }</div>
|
|
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="comment"> * Deletes one or more files stored in a channels file repository.</span></div>
|
|
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment"> * @param string $cpw</span></div>
|
|
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00532"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#adf66cf57917238b350e42f121bed7b12"> 532</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#adf66cf57917238b350e42f121bed7b12" title="Deletes one or more files stored in a channels file repository. ">channelFileDelete</a>($cid, $cpw = <span class="stringliteral">""</span>, $name = <span class="stringliteral">"/"</span>)</div>
|
|
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span>  {</div>
|
|
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"ftdeletefile"</span>, array(<span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"cpw"</span> => $cpw, <span class="stringliteral">"name"</span> => $name));</div>
|
|
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span>  }</div>
|
|
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span> <span class="comment"> * Creates new directory in a channels file repository.</span></div>
|
|
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="comment"> * @param string $cpw</span></div>
|
|
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="comment"> * @param string $dirname</span></div>
|
|
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00545"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a8ec028d2a9dbd36794015e8614831c8d"> 545</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a8ec028d2a9dbd36794015e8614831c8d" title="Creates new directory in a channels file repository. ">channelDirCreate</a>($cid, $cpw = <span class="stringliteral">""</span>, $dirname = <span class="stringliteral">"/"</span>)</div>
|
|
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span>  {</div>
|
|
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"ftcreatedir"</span>, array(<span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"cpw"</span> => $cpw, <span class="stringliteral">"dirname"</span> => $dirname));</div>
|
|
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span>  }</div>
|
|
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span> <span class="comment"> * Returns the level of a channel.</span></div>
|
|
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00556"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aac1d19d84aba2017c807ab3ccabe9d6b"> 556</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aac1d19d84aba2017c807ab3ccabe9d6b" title="Returns the level of a channel. ">channelGetLevel</a>($cid)</div>
|
|
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span>  {</div>
|
|
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span>  $channel = $this-><a class="code" href="class_team_speak3___node___server.html#ab384bb6d76c0dfb582c877852ddba1dc" title="Returns the TeamSpeak3_Node_Channel object matching the given ID. ">channelGetById</a>($cid);</div>
|
|
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span>  $levelno = 0;</div>
|
|
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span> </div>
|
|
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span>  <span class="keywordflow">if</span>($channel[<span class="stringliteral">"pid"</span>])</div>
|
|
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span>  {</div>
|
|
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span>  $levelno = $this-><a class="code" href="class_team_speak3___node___server.html#aac1d19d84aba2017c807ab3ccabe9d6b" title="Returns the level of a channel. ">channelGetLevel</a>($channel[<span class="stringliteral">"pid"</span>])+1;</div>
|
|
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span>  }</div>
|
|
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span> </div>
|
|
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span>  <span class="keywordflow">return</span> $levelno;</div>
|
|
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>  }</div>
|
|
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="comment"> * Returns the pathway of a channel which can be used as a clients default channel.</span></div>
|
|
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span> <span class="comment"> * @return string</span></div>
|
|
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00575"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a9f0d8234a8274bef62c40954c4dab731"> 575</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a9f0d8234a8274bef62c40954c4dab731" title="Returns the pathway of a channel which can be used as a clients default channel. ">channelGetPathway</a>($cid)</div>
|
|
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span>  {</div>
|
|
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span>  $channel = $this-><a class="code" href="class_team_speak3___node___server.html#ab384bb6d76c0dfb582c877852ddba1dc" title="Returns the TeamSpeak3_Node_Channel object matching the given ID. ">channelGetById</a>($cid);</div>
|
|
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span>  $pathway = $channel[<span class="stringliteral">"channel_name"</span>];</div>
|
|
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span> </div>
|
|
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span>  <span class="keywordflow">if</span>($channel[<span class="stringliteral">"pid"</span>])</div>
|
|
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span>  {</div>
|
|
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span>  $pathway = $this-><a class="code" href="class_team_speak3___node___server.html#a9f0d8234a8274bef62c40954c4dab731" title="Returns the pathway of a channel which can be used as a clients default channel. ">channelGetPathway</a>($channel[<span class="stringliteral">"pid"</span>]) . <span class="stringliteral">"/"</span> . $channel[<span class="stringliteral">"channel_name"</span>];</div>
|
|
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span>  }</div>
|
|
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span> </div>
|
|
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span>  <span class="keywordflow">return</span> $pathway;</div>
|
|
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span>  }</div>
|
|
<div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span> <span class="comment"> * Returns the TeamSpeak3_Node_Channel object matching the given ID.</span></div>
|
|
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment"> * @return TeamSpeak3_Node_Channel</span></div>
|
|
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00595"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ab384bb6d76c0dfb582c877852ddba1dc"> 595</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ab384bb6d76c0dfb582c877852ddba1dc" title="Returns the TeamSpeak3_Node_Channel object matching the given ID. ">channelGetById</a>($cid)</div>
|
|
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span>  {</div>
|
|
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span>  <span class="keywordflow">if</span>(!array_key_exists((<span class="keywordtype">string</span>) $cid, $this-><a class="code" href="class_team_speak3___node___server.html#af89e63cf4213e41524cfcf522f46493d" title="Returns an array filled with TeamSpeak3_Node_Channel objects. ">channelList</a>()))</div>
|
|
<div class="line"><a name="l00598"></a><span class="lineno"> 598</span>  {</div>
|
|
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid channelID"</span>, 0x300);</div>
|
|
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span>  }</div>
|
|
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span> </div>
|
|
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___server.html#af89e63cf4213e41524cfcf522f46493d" title="Returns an array filled with TeamSpeak3_Node_Channel objects. ">channelList</a>[intval((<span class="keywordtype">string</span>) $cid)];</div>
|
|
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span>  }</div>
|
|
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment"> * Returns the TeamSpeak3_Node_Channel object matching the given name.</span></div>
|
|
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="comment"> * @return TeamSpeak3_Node_Channel</span></div>
|
|
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00612"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a93c751a3d29014c0c7c6ec67ad4ae15a"> 612</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a93c751a3d29014c0c7c6ec67ad4ae15a" title="Returns the TeamSpeak3_Node_Channel object matching the given name. ">channelGetByName</a>($name)</div>
|
|
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span>  {</div>
|
|
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span>  <span class="keywordflow">foreach</span>($this-><a class="code" href="class_team_speak3___node___server.html#af89e63cf4213e41524cfcf522f46493d" title="Returns an array filled with TeamSpeak3_Node_Channel objects. ">channelList</a>() as $channel)</div>
|
|
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span>  {</div>
|
|
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span>  <span class="keywordflow">if</span>($channel[<span class="stringliteral">"channel_name"</span>] == $name) <span class="keywordflow">return</span> $channel;</div>
|
|
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span>  }</div>
|
|
<div class="line"><a name="l00618"></a><span class="lineno"> 618</span> </div>
|
|
<div class="line"><a name="l00619"></a><span class="lineno"> 619</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid channelID"</span>, 0x300);</div>
|
|
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span>  }</div>
|
|
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span> <span class="comment"> * Returns an array filled with TeamSpeak3_Node_Client objects.</span></div>
|
|
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="comment"> * @param array $filter</span></div>
|
|
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00628"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279"> 628</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279" title="Returns an array filled with TeamSpeak3_Node_Client objects. ">clientList</a>(array $filter = array())</div>
|
|
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span>  {</div>
|
|
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span>  <span class="keywordflow">if</span>($this-><a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279" title="Returns an array filled with TeamSpeak3_Node_Client objects. ">clientList</a> === null)</div>
|
|
<div class="line"><a name="l00631"></a><span class="lineno"> 631</span>  {</div>
|
|
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span>  $clients = $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"clientlist -uid -away -badges -voice -info -times -groups -icon -country -ip"</span>)->toAssocArray(<span class="stringliteral">"clid"</span>);</div>
|
|
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span> </div>
|
|
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279" title="Returns an array filled with TeamSpeak3_Node_Client objects. ">clientList</a> = array();</div>
|
|
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span> </div>
|
|
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span>  <span class="keywordflow">foreach</span>($clients as $clid => $client)</div>
|
|
<div class="line"><a name="l00637"></a><span class="lineno"> 637</span>  {</div>
|
|
<div class="line"><a name="l00638"></a><span class="lineno"> 638</span>  <span class="keywordflow">if</span>($this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->getExcludeQueryClients() && $client[<span class="stringliteral">"client_type"</span>]) <span class="keywordflow">continue</span>;</div>
|
|
<div class="line"><a name="l00639"></a><span class="lineno"> 639</span> </div>
|
|
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279" title="Returns an array filled with TeamSpeak3_Node_Client objects. ">clientList</a>[$clid] = <span class="keyword">new</span> <a class="code" href="class_team_speak3___node___client.html" title="Class describing a TeamSpeak 3 client and all it's parameters. ">TeamSpeak3_Node_Client</a>($this, $client);</div>
|
|
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span>  }</div>
|
|
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span> </div>
|
|
<div class="line"><a name="l00643"></a><span class="lineno"> 643</span>  uasort($this-><a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279" title="Returns an array filled with TeamSpeak3_Node_Client objects. ">clientList</a>, array(__CLASS__, <span class="stringliteral">"sortClientList"</span>));</div>
|
|
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span> </div>
|
|
<div class="line"><a name="l00645"></a><span class="lineno"> 645</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#a9ead519e8396990ba30d79d6bed9d286">resetNodeList</a>();</div>
|
|
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span>  }</div>
|
|
<div class="line"><a name="l00647"></a><span class="lineno"> 647</span> </div>
|
|
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#ad826df3c71029ca48839dbe9aa3559b8" title="Filters given node list array using specified filter rules. ">filterList</a>($this-><a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279" title="Returns an array filled with TeamSpeak3_Node_Client objects. ">clientList</a>, $filter);</div>
|
|
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span>  }</div>
|
|
<div class="line"><a name="l00650"></a><span class="lineno"> 650</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00651"></a><span class="lineno"> 651</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00652"></a><span class="lineno"> 652</span> <span class="comment"> * Resets the list of clients online.</span></div>
|
|
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00656"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#acc00747588b6b1320c7f08f872f65fcf"> 656</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#acc00747588b6b1320c7f08f872f65fcf" title="Resets the list of clients online. ">clientListReset</a>()</div>
|
|
<div class="line"><a name="l00657"></a><span class="lineno"> 657</span>  {</div>
|
|
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#a9ead519e8396990ba30d79d6bed9d286">resetNodeList</a>();</div>
|
|
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279" title="Returns an array filled with TeamSpeak3_Node_Client objects. ">clientList</a> = null;</div>
|
|
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span>  }</div>
|
|
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00663"></a><span class="lineno"> 663</span> <span class="comment"> * Returns a list of clients matching a given name pattern.</span></div>
|
|
<div class="line"><a name="l00664"></a><span class="lineno"> 664</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00665"></a><span class="lineno"> 665</span> <span class="comment"> * @param string $pattern</span></div>
|
|
<div class="line"><a name="l00666"></a><span class="lineno"> 666</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00667"></a><span class="lineno"> 667</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00668"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ac42ed34f0e7faeea2f5c8a56196f2eef"> 668</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ac42ed34f0e7faeea2f5c8a56196f2eef" title="Returns a list of clients matching a given name pattern. ">clientFind</a>($pattern)</div>
|
|
<div class="line"><a name="l00669"></a><span class="lineno"> 669</span>  {</div>
|
|
<div class="line"><a name="l00670"></a><span class="lineno"> 670</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientfind"</span>, array(<span class="stringliteral">"pattern"</span> => $pattern))->toAssocArray(<span class="stringliteral">"clid"</span>);</div>
|
|
<div class="line"><a name="l00671"></a><span class="lineno"> 671</span>  }</div>
|
|
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span> <span class="comment"> * Returns a list of client identities known by the virtual server. By default, the server spits out 25 entries</span></div>
|
|
<div class="line"><a name="l00675"></a><span class="lineno"> 675</span> <span class="comment"> * at once.</span></div>
|
|
<div class="line"><a name="l00676"></a><span class="lineno"> 676</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00677"></a><span class="lineno"> 677</span> <span class="comment"> * @param integer $offset</span></div>
|
|
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span> <span class="comment"> * @param integer $limit</span></div>
|
|
<div class="line"><a name="l00679"></a><span class="lineno"> 679</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00681"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ab2f0462d9820e266e91bccb67529311d"> 681</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ab2f0462d9820e266e91bccb67529311d" title="Returns a list of client identities known by the virtual server. ">clientListDb</a>($offset = null, $limit = null)</div>
|
|
<div class="line"><a name="l00682"></a><span class="lineno"> 682</span>  {</div>
|
|
<div class="line"><a name="l00683"></a><span class="lineno"> 683</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientdblist -count"</span>, array(<span class="stringliteral">"start"</span> => $offset, <span class="stringliteral">"duration"</span> => $limit))->toAssocArray(<span class="stringliteral">"cldbid"</span>);</div>
|
|
<div class="line"><a name="l00684"></a><span class="lineno"> 684</span>  }</div>
|
|
<div class="line"><a name="l00685"></a><span class="lineno"> 685</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00686"></a><span class="lineno"> 686</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00687"></a><span class="lineno"> 687</span> <span class="comment"> * Returns the number of client identities known by the virtual server.</span></div>
|
|
<div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l00690"></a><span class="lineno"> 690</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00691"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a899389702e061146235d7204bc56a332"> 691</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a899389702e061146235d7204bc56a332" title="Returns the number of client identities known by the virtual server. ">clientCountDb</a>()</div>
|
|
<div class="line"><a name="l00692"></a><span class="lineno"> 692</span>  {</div>
|
|
<div class="line"><a name="l00693"></a><span class="lineno"> 693</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3___node___abstract.html#a1c78dbb54df73f8c5dabe41ebd476207">current</a>($this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientdblist -count"</span>, array(<span class="stringliteral">"duration"</span> => 1))->toList(<span class="stringliteral">"count"</span>));</div>
|
|
<div class="line"><a name="l00694"></a><span class="lineno"> 694</span>  }</div>
|
|
<div class="line"><a name="l00695"></a><span class="lineno"> 695</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00696"></a><span class="lineno"> 696</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00697"></a><span class="lineno"> 697</span> <span class="comment"> * Returns a list of properties from the database for the client specified by $cldbid.</span></div>
|
|
<div class="line"><a name="l00698"></a><span class="lineno"> 698</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00699"></a><span class="lineno"> 699</span> <span class="comment"> * @param integer $cldbid</span></div>
|
|
<div class="line"><a name="l00700"></a><span class="lineno"> 700</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00701"></a><span class="lineno"> 701</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00702"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a3938d6ae2889a541277558b87d21991f"> 702</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a3938d6ae2889a541277558b87d21991f" title="Returns a list of properties from the database for the client specified by $cldbid. ">clientInfoDb</a>($cldbid)</div>
|
|
<div class="line"><a name="l00703"></a><span class="lineno"> 703</span>  {</div>
|
|
<div class="line"><a name="l00704"></a><span class="lineno"> 704</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientdbinfo"</span>, array(<span class="stringliteral">"cldbid"</span> => $cldbid))->toList();</div>
|
|
<div class="line"><a name="l00705"></a><span class="lineno"> 705</span>  }</div>
|
|
<div class="line"><a name="l00706"></a><span class="lineno"> 706</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00707"></a><span class="lineno"> 707</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00708"></a><span class="lineno"> 708</span> <span class="comment"> * Returns a list of client database IDs matching a given pattern. You can either search for a clients</span></div>
|
|
<div class="line"><a name="l00709"></a><span class="lineno"> 709</span> <span class="comment"> * last known nickname or his unique identity by using the $uid option.</span></div>
|
|
<div class="line"><a name="l00710"></a><span class="lineno"> 710</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00711"></a><span class="lineno"> 711</span> <span class="comment"> * @param string $pattern</span></div>
|
|
<div class="line"><a name="l00712"></a><span class="lineno"> 712</span> <span class="comment"> * @param boolean $uid</span></div>
|
|
<div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00714"></a><span class="lineno"> 714</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00715"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ae8648992f4e8d470f474b280870243a8"> 715</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ae8648992f4e8d470f474b280870243a8" title="Returns a list of client database IDs matching a given pattern. ">clientFindDb</a>($pattern, $uid = FALSE)</div>
|
|
<div class="line"><a name="l00716"></a><span class="lineno"> 716</span>  {</div>
|
|
<div class="line"><a name="l00717"></a><span class="lineno"> 717</span>  <span class="keywordflow">return</span> array_keys($this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientdbfind"</span>, array(<span class="stringliteral">"pattern"</span> => $pattern, ($uid) ? <span class="stringliteral">"-uid"</span> : null))->toAssocArray(<span class="stringliteral">"cldbid"</span>));</div>
|
|
<div class="line"><a name="l00718"></a><span class="lineno"> 718</span>  }</div>
|
|
<div class="line"><a name="l00719"></a><span class="lineno"> 719</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00720"></a><span class="lineno"> 720</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00721"></a><span class="lineno"> 721</span> <span class="comment"> * Returns the number of regular clients online.</span></div>
|
|
<div class="line"><a name="l00722"></a><span class="lineno"> 722</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00723"></a><span class="lineno"> 723</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l00724"></a><span class="lineno"> 724</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00725"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ae23d433b89992fa85371562db35763c1"> 725</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ae23d433b89992fa85371562db35763c1" title="Returns the number of regular clients online. ">clientCount</a>()</div>
|
|
<div class="line"><a name="l00726"></a><span class="lineno"> 726</span>  {</div>
|
|
<div class="line"><a name="l00727"></a><span class="lineno"> 727</span>  <span class="keywordflow">if</span>($this-><a class="code" href="class_team_speak3___node___server.html#a55f06b4b0c636dcc41a877edc5a3a7d7" title="Returns TRUE if the virtual server is offline. ">isOffline</a>()) <span class="keywordflow">return</span> 0;</div>
|
|
<div class="line"><a name="l00728"></a><span class="lineno"> 728</span> </div>
|
|
<div class="line"><a name="l00729"></a><span class="lineno"> 729</span>  <span class="keywordflow">return</span> $this[<span class="stringliteral">"virtualserver_clientsonline"</span>]-$this[<span class="stringliteral">"virtualserver_queryclientsonline"</span>];</div>
|
|
<div class="line"><a name="l00730"></a><span class="lineno"> 730</span>  }</div>
|
|
<div class="line"><a name="l00731"></a><span class="lineno"> 731</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00732"></a><span class="lineno"> 732</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00733"></a><span class="lineno"> 733</span> <span class="comment"> * Returns the TeamSpeak3_Node_Client object matching the given ID.</span></div>
|
|
<div class="line"><a name="l00734"></a><span class="lineno"> 734</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00735"></a><span class="lineno"> 735</span> <span class="comment"> * @param integer $clid</span></div>
|
|
<div class="line"><a name="l00736"></a><span class="lineno"> 736</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l00737"></a><span class="lineno"> 737</span> <span class="comment"> * @return TeamSpeak3_Node_Client</span></div>
|
|
<div class="line"><a name="l00738"></a><span class="lineno"> 738</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00739"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ad7c9c04b99162b40afe39178a0d39632"> 739</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ad7c9c04b99162b40afe39178a0d39632" title="Returns the TeamSpeak3_Node_Client object matching the given ID. ">clientGetById</a>($clid)</div>
|
|
<div class="line"><a name="l00740"></a><span class="lineno"> 740</span>  {</div>
|
|
<div class="line"><a name="l00741"></a><span class="lineno"> 741</span>  <span class="keywordflow">if</span>(!array_key_exists((<span class="keywordtype">string</span>) $clid, $this-><a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279" title="Returns an array filled with TeamSpeak3_Node_Client objects. ">clientList</a>()))</div>
|
|
<div class="line"><a name="l00742"></a><span class="lineno"> 742</span>  {</div>
|
|
<div class="line"><a name="l00743"></a><span class="lineno"> 743</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid clientID"</span>, 0x200);</div>
|
|
<div class="line"><a name="l00744"></a><span class="lineno"> 744</span>  }</div>
|
|
<div class="line"><a name="l00745"></a><span class="lineno"> 745</span> </div>
|
|
<div class="line"><a name="l00746"></a><span class="lineno"> 746</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279" title="Returns an array filled with TeamSpeak3_Node_Client objects. ">clientList</a>[intval((<span class="keywordtype">string</span>) $clid)];</div>
|
|
<div class="line"><a name="l00747"></a><span class="lineno"> 747</span>  }</div>
|
|
<div class="line"><a name="l00748"></a><span class="lineno"> 748</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00749"></a><span class="lineno"> 749</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00750"></a><span class="lineno"> 750</span> <span class="comment"> * Returns the TeamSpeak3_Node_Client object matching the given name.</span></div>
|
|
<div class="line"><a name="l00751"></a><span class="lineno"> 751</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00752"></a><span class="lineno"> 752</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l00753"></a><span class="lineno"> 753</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l00754"></a><span class="lineno"> 754</span> <span class="comment"> * @return TeamSpeak3_Node_Client</span></div>
|
|
<div class="line"><a name="l00755"></a><span class="lineno"> 755</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00756"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a3bd7e2be71de3187099ef1446f1a186b"> 756</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a3bd7e2be71de3187099ef1446f1a186b" title="Returns the TeamSpeak3_Node_Client object matching the given name. ">clientGetByName</a>($name)</div>
|
|
<div class="line"><a name="l00757"></a><span class="lineno"> 757</span>  {</div>
|
|
<div class="line"><a name="l00758"></a><span class="lineno"> 758</span>  <span class="keywordflow">foreach</span>($this-><a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279" title="Returns an array filled with TeamSpeak3_Node_Client objects. ">clientList</a>() as $client)</div>
|
|
<div class="line"><a name="l00759"></a><span class="lineno"> 759</span>  {</div>
|
|
<div class="line"><a name="l00760"></a><span class="lineno"> 760</span>  <span class="keywordflow">if</span>($client[<span class="stringliteral">"client_nickname"</span>] == $name) <span class="keywordflow">return</span> $client;</div>
|
|
<div class="line"><a name="l00761"></a><span class="lineno"> 761</span>  }</div>
|
|
<div class="line"><a name="l00762"></a><span class="lineno"> 762</span> </div>
|
|
<div class="line"><a name="l00763"></a><span class="lineno"> 763</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid clientID"</span>, 0x200);</div>
|
|
<div class="line"><a name="l00764"></a><span class="lineno"> 764</span>  }</div>
|
|
<div class="line"><a name="l00765"></a><span class="lineno"> 765</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00766"></a><span class="lineno"> 766</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00767"></a><span class="lineno"> 767</span> <span class="comment"> * Returns the TeamSpeak3_Node_Client object matching the given unique identifier.</span></div>
|
|
<div class="line"><a name="l00768"></a><span class="lineno"> 768</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00769"></a><span class="lineno"> 769</span> <span class="comment"> * @param string $uid</span></div>
|
|
<div class="line"><a name="l00770"></a><span class="lineno"> 770</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l00771"></a><span class="lineno"> 771</span> <span class="comment"> * @return TeamSpeak3_Node_Client</span></div>
|
|
<div class="line"><a name="l00772"></a><span class="lineno"> 772</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00773"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ad6e7bf183d0e904b1507c375e3aabde8"> 773</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ad6e7bf183d0e904b1507c375e3aabde8" title="Returns the TeamSpeak3_Node_Client object matching the given unique identifier. ">clientGetByUid</a>($uid)</div>
|
|
<div class="line"><a name="l00774"></a><span class="lineno"> 774</span>  {</div>
|
|
<div class="line"><a name="l00775"></a><span class="lineno"> 775</span>  <span class="keywordflow">foreach</span>($this-><a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279" title="Returns an array filled with TeamSpeak3_Node_Client objects. ">clientList</a>() as $client)</div>
|
|
<div class="line"><a name="l00776"></a><span class="lineno"> 776</span>  {</div>
|
|
<div class="line"><a name="l00777"></a><span class="lineno"> 777</span>  <span class="keywordflow">if</span>($client[<span class="stringliteral">"client_unique_identifier"</span>] == $uid) <span class="keywordflow">return</span> $client;</div>
|
|
<div class="line"><a name="l00778"></a><span class="lineno"> 778</span>  }</div>
|
|
<div class="line"><a name="l00779"></a><span class="lineno"> 779</span> </div>
|
|
<div class="line"><a name="l00780"></a><span class="lineno"> 780</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid clientID"</span>, 0x200);</div>
|
|
<div class="line"><a name="l00781"></a><span class="lineno"> 781</span>  }</div>
|
|
<div class="line"><a name="l00782"></a><span class="lineno"> 782</span>  <span class="comment"></span></div>
|
|
<div class="line"><a name="l00783"></a><span class="lineno"> 783</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00784"></a><span class="lineno"> 784</span> <span class="comment"> * Returns the TeamSpeak3_Node_Client object matching the given database ID.</span></div>
|
|
<div class="line"><a name="l00785"></a><span class="lineno"> 785</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00786"></a><span class="lineno"> 786</span> <span class="comment"> * @param integer $dbid</span></div>
|
|
<div class="line"><a name="l00787"></a><span class="lineno"> 787</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l00788"></a><span class="lineno"> 788</span> <span class="comment"> * @return TeamSpeak3_Node_Client</span></div>
|
|
<div class="line"><a name="l00789"></a><span class="lineno"> 789</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00790"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#acdaab3b579e68badc7849f615cf1f1c2"> 790</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#acdaab3b579e68badc7849f615cf1f1c2" title="Returns the TeamSpeak3_Node_Client object matching the given database ID. ">clientGetByDbid</a>($dbid)</div>
|
|
<div class="line"><a name="l00791"></a><span class="lineno"> 791</span>  {</div>
|
|
<div class="line"><a name="l00792"></a><span class="lineno"> 792</span>  <span class="keywordflow">foreach</span>($this-><a class="code" href="class_team_speak3___node___server.html#a194c9f52336862f3168c408c413d4279" title="Returns an array filled with TeamSpeak3_Node_Client objects. ">clientList</a>() as $client)</div>
|
|
<div class="line"><a name="l00793"></a><span class="lineno"> 793</span>  {</div>
|
|
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span>  <span class="keywordflow">if</span>($client[<span class="stringliteral">"client_database_id"</span>] == $dbid) <span class="keywordflow">return</span> $client;</div>
|
|
<div class="line"><a name="l00795"></a><span class="lineno"> 795</span>  }</div>
|
|
<div class="line"><a name="l00796"></a><span class="lineno"> 796</span> </div>
|
|
<div class="line"><a name="l00797"></a><span class="lineno"> 797</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid clientID"</span>, 0x200);</div>
|
|
<div class="line"><a name="l00798"></a><span class="lineno"> 798</span>  }</div>
|
|
<div class="line"><a name="l00799"></a><span class="lineno"> 799</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00800"></a><span class="lineno"> 800</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00801"></a><span class="lineno"> 801</span> <span class="comment"> * Returns an array containing the last known nickname and the database ID of the client matching</span></div>
|
|
<div class="line"><a name="l00802"></a><span class="lineno"> 802</span> <span class="comment"> * the unique identifier specified with $cluid.</span></div>
|
|
<div class="line"><a name="l00803"></a><span class="lineno"> 803</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00804"></a><span class="lineno"> 804</span> <span class="comment"> * @param string $cluid</span></div>
|
|
<div class="line"><a name="l00805"></a><span class="lineno"> 805</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00806"></a><span class="lineno"> 806</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00807"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a0a49ab51e9518d50606299944c143a9b"> 807</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a0a49ab51e9518d50606299944c143a9b" title="Returns an array containing the last known nickname and the database ID of the client matching the un...">clientGetNameByUid</a>($cluid)</div>
|
|
<div class="line"><a name="l00808"></a><span class="lineno"> 808</span>  {</div>
|
|
<div class="line"><a name="l00809"></a><span class="lineno"> 809</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientgetnamefromuid"</span>, array(<span class="stringliteral">"cluid"</span> => $cluid))->toList();</div>
|
|
<div class="line"><a name="l00810"></a><span class="lineno"> 810</span>  }</div>
|
|
<div class="line"><a name="l00811"></a><span class="lineno"> 811</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00812"></a><span class="lineno"> 812</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00813"></a><span class="lineno"> 813</span> <span class="comment"> * Returns an array containing a list of active client connections using the unique identifier</span></div>
|
|
<div class="line"><a name="l00814"></a><span class="lineno"> 814</span> <span class="comment"> * specified with $cluid.</span></div>
|
|
<div class="line"><a name="l00815"></a><span class="lineno"> 815</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00816"></a><span class="lineno"> 816</span> <span class="comment"> * @param string $cluid</span></div>
|
|
<div class="line"><a name="l00817"></a><span class="lineno"> 817</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00818"></a><span class="lineno"> 818</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00819"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a8aaa42f632bbf8760d1666756cd4b744"> 819</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a8aaa42f632bbf8760d1666756cd4b744" title="Returns an array containing a list of active client connections using the unique identifier specified...">clientGetIdsByUid</a>($cluid)</div>
|
|
<div class="line"><a name="l00820"></a><span class="lineno"> 820</span>  {</div>
|
|
<div class="line"><a name="l00821"></a><span class="lineno"> 821</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientgetids"</span>, array(<span class="stringliteral">"cluid"</span> => $cluid))->toAssocArray(<span class="stringliteral">"clid"</span>);</div>
|
|
<div class="line"><a name="l00822"></a><span class="lineno"> 822</span>  }</div>
|
|
<div class="line"><a name="l00823"></a><span class="lineno"> 823</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00824"></a><span class="lineno"> 824</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00825"></a><span class="lineno"> 825</span> <span class="comment"> * Returns an array containing the last known nickname and the unique identifier of the client</span></div>
|
|
<div class="line"><a name="l00826"></a><span class="lineno"> 826</span> <span class="comment"> * matching the database ID specified with $cldbid.</span></div>
|
|
<div class="line"><a name="l00827"></a><span class="lineno"> 827</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00828"></a><span class="lineno"> 828</span> <span class="comment"> * @param string $cldbid</span></div>
|
|
<div class="line"><a name="l00829"></a><span class="lineno"> 829</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00830"></a><span class="lineno"> 830</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00831"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a149e1b1857e51c8b9ebfb0818b5bc2f7"> 831</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a149e1b1857e51c8b9ebfb0818b5bc2f7" title="Returns an array containing the last known nickname and the unique identifier of the client matching ...">clientGetNameByDbid</a>($cldbid)</div>
|
|
<div class="line"><a name="l00832"></a><span class="lineno"> 832</span>  {</div>
|
|
<div class="line"><a name="l00833"></a><span class="lineno"> 833</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientgetnamefromdbid"</span>, array(<span class="stringliteral">"cldbid"</span> => $cldbid))->toList();</div>
|
|
<div class="line"><a name="l00834"></a><span class="lineno"> 834</span>  }</div>
|
|
<div class="line"><a name="l00835"></a><span class="lineno"> 835</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00836"></a><span class="lineno"> 836</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00837"></a><span class="lineno"> 837</span> <span class="comment"> * Returns an array containing the names and IDs of all server groups the client specified with</span></div>
|
|
<div class="line"><a name="l00838"></a><span class="lineno"> 838</span> <span class="comment"> * $cldbid is is currently residing in.</span></div>
|
|
<div class="line"><a name="l00839"></a><span class="lineno"> 839</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00840"></a><span class="lineno"> 840</span> <span class="comment"> * @param string $cldbid</span></div>
|
|
<div class="line"><a name="l00841"></a><span class="lineno"> 841</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00842"></a><span class="lineno"> 842</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00843"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a454f7bcafaf0bf2aa4c073d5267eb2c3"> 843</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a454f7bcafaf0bf2aa4c073d5267eb2c3" title="Returns an array containing the names and IDs of all server groups the client specified with $cldbid ...">clientGetServerGroupsByDbid</a>($cldbid)</div>
|
|
<div class="line"><a name="l00844"></a><span class="lineno"> 844</span>  {</div>
|
|
<div class="line"><a name="l00845"></a><span class="lineno"> 845</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servergroupsbyclientid"</span>, array(<span class="stringliteral">"cldbid"</span> => $cldbid))->toAssocArray(<span class="stringliteral">"sgid"</span>);</div>
|
|
<div class="line"><a name="l00846"></a><span class="lineno"> 846</span>  }</div>
|
|
<div class="line"><a name="l00847"></a><span class="lineno"> 847</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00848"></a><span class="lineno"> 848</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00849"></a><span class="lineno"> 849</span> <span class="comment"> * Moves a client to another channel.</span></div>
|
|
<div class="line"><a name="l00850"></a><span class="lineno"> 850</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00851"></a><span class="lineno"> 851</span> <span class="comment"> * @param integer $clid</span></div>
|
|
<div class="line"><a name="l00852"></a><span class="lineno"> 852</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00853"></a><span class="lineno"> 853</span> <span class="comment"> * @param string $cpw</span></div>
|
|
<div class="line"><a name="l00854"></a><span class="lineno"> 854</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00855"></a><span class="lineno"> 855</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00856"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a35aee62e8ba86d0ea80ea5cafd9c5801"> 856</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a35aee62e8ba86d0ea80ea5cafd9c5801" title="Moves a client to another channel. ">clientMove</a>($clid, $cid, $cpw = null)</div>
|
|
<div class="line"><a name="l00857"></a><span class="lineno"> 857</span>  {</div>
|
|
<div class="line"><a name="l00858"></a><span class="lineno"> 858</span>  $this-><a class="code" href="class_team_speak3___node___server.html#acc00747588b6b1320c7f08f872f65fcf" title="Resets the list of clients online. ">clientListReset</a>();</div>
|
|
<div class="line"><a name="l00859"></a><span class="lineno"> 859</span> </div>
|
|
<div class="line"><a name="l00860"></a><span class="lineno"> 860</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientmove"</span>, array(<span class="stringliteral">"clid"</span> => $clid, <span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"cpw"</span> => $cpw));</div>
|
|
<div class="line"><a name="l00861"></a><span class="lineno"> 861</span> </div>
|
|
<div class="line"><a name="l00862"></a><span class="lineno"> 862</span>  <span class="keywordflow">if</span>($clid instanceof <a class="code" href="class_team_speak3___node___abstract.html" title="Abstract class describing a TeamSpeak 3 node and all it's parameters. ">TeamSpeak3_Node_Abstract</a>)</div>
|
|
<div class="line"><a name="l00863"></a><span class="lineno"> 863</span>  {</div>
|
|
<div class="line"><a name="l00864"></a><span class="lineno"> 864</span>  $clid = $clid->getId();</div>
|
|
<div class="line"><a name="l00865"></a><span class="lineno"> 865</span>  }</div>
|
|
<div class="line"><a name="l00866"></a><span class="lineno"> 866</span> </div>
|
|
<div class="line"><a name="l00867"></a><span class="lineno"> 867</span>  <span class="keywordflow">if</span>($cid instanceof TeamSpeak3_Node_Abstract)</div>
|
|
<div class="line"><a name="l00868"></a><span class="lineno"> 868</span>  {</div>
|
|
<div class="line"><a name="l00869"></a><span class="lineno"> 869</span>  $cid = $cid->getId();</div>
|
|
<div class="line"><a name="l00870"></a><span class="lineno"> 870</span>  }</div>
|
|
<div class="line"><a name="l00871"></a><span class="lineno"> 871</span> </div>
|
|
<div class="line"><a name="l00872"></a><span class="lineno"> 872</span>  <span class="keywordflow">if</span>(!is_array($clid) && $clid == $this->whoamiGet(<span class="stringliteral">"client_id"</span>))</div>
|
|
<div class="line"><a name="l00873"></a><span class="lineno"> 873</span>  {</div>
|
|
<div class="line"><a name="l00874"></a><span class="lineno"> 874</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->whoamiSet(<span class="stringliteral">"client_channel_id"</span>, $cid);</div>
|
|
<div class="line"><a name="l00875"></a><span class="lineno"> 875</span>  }</div>
|
|
<div class="line"><a name="l00876"></a><span class="lineno"> 876</span>  }</div>
|
|
<div class="line"><a name="l00877"></a><span class="lineno"> 877</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00878"></a><span class="lineno"> 878</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00879"></a><span class="lineno"> 879</span> <span class="comment"> * Kicks one or more clients from their currently joined channel or from the server.</span></div>
|
|
<div class="line"><a name="l00880"></a><span class="lineno"> 880</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00881"></a><span class="lineno"> 881</span> <span class="comment"> * @param integer $clid</span></div>
|
|
<div class="line"><a name="l00882"></a><span class="lineno"> 882</span> <span class="comment"> * @param integer $reasonid</span></div>
|
|
<div class="line"><a name="l00883"></a><span class="lineno"> 883</span> <span class="comment"> * @param string $reasonmsg</span></div>
|
|
<div class="line"><a name="l00884"></a><span class="lineno"> 884</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00885"></a><span class="lineno"> 885</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00886"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a8ddb527606200718f41d0ef06beb40b8"> 886</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a8ddb527606200718f41d0ef06beb40b8" title="Kicks one or more clients from their currently joined channel or from the server. ...">clientKick</a>($clid, $reasonid = <a class="code" href="class_team_speak3.html#ab6a4d55688e33c16004508fff14c81da" title="4: kick client from channel ">TeamSpeak3::KICK_CHANNEL</a>, $reasonmsg = null)</div>
|
|
<div class="line"><a name="l00887"></a><span class="lineno"> 887</span>  {</div>
|
|
<div class="line"><a name="l00888"></a><span class="lineno"> 888</span>  $this-><a class="code" href="class_team_speak3___node___server.html#acc00747588b6b1320c7f08f872f65fcf" title="Resets the list of clients online. ">clientListReset</a>();</div>
|
|
<div class="line"><a name="l00889"></a><span class="lineno"> 889</span> </div>
|
|
<div class="line"><a name="l00890"></a><span class="lineno"> 890</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientkick"</span>, array(<span class="stringliteral">"clid"</span> => $clid, <span class="stringliteral">"reasonid"</span> => $reasonid, <span class="stringliteral">"reasonmsg"</span> => $reasonmsg));</div>
|
|
<div class="line"><a name="l00891"></a><span class="lineno"> 891</span>  }</div>
|
|
<div class="line"><a name="l00892"></a><span class="lineno"> 892</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00893"></a><span class="lineno"> 893</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00894"></a><span class="lineno"> 894</span> <span class="comment"> * Sends a poke message to a client.</span></div>
|
|
<div class="line"><a name="l00895"></a><span class="lineno"> 895</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00896"></a><span class="lineno"> 896</span> <span class="comment"> * @param integer $clid</span></div>
|
|
<div class="line"><a name="l00897"></a><span class="lineno"> 897</span> <span class="comment"> * @param string $msg</span></div>
|
|
<div class="line"><a name="l00898"></a><span class="lineno"> 898</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00899"></a><span class="lineno"> 899</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00900"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a2bd6ce432c9dd08e550289b1cc0a16bd"> 900</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a2bd6ce432c9dd08e550289b1cc0a16bd" title="Sends a poke message to a client. ">clientPoke</a>($clid, $msg)</div>
|
|
<div class="line"><a name="l00901"></a><span class="lineno"> 901</span>  {</div>
|
|
<div class="line"><a name="l00902"></a><span class="lineno"> 902</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientpoke"</span>, array(<span class="stringliteral">"clid"</span> => $clid, <span class="stringliteral">"msg"</span> => $msg));</div>
|
|
<div class="line"><a name="l00903"></a><span class="lineno"> 903</span>  }</div>
|
|
<div class="line"><a name="l00904"></a><span class="lineno"> 904</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00905"></a><span class="lineno"> 905</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00906"></a><span class="lineno"> 906</span> <span class="comment"> * Bans the client specified with ID $clid from the server. Please note that this will create two separate</span></div>
|
|
<div class="line"><a name="l00907"></a><span class="lineno"> 907</span> <span class="comment"> * ban rules for the targeted clients IP address and his unique identifier.</span></div>
|
|
<div class="line"><a name="l00908"></a><span class="lineno"> 908</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00909"></a><span class="lineno"> 909</span> <span class="comment"> * @param integer $clid</span></div>
|
|
<div class="line"><a name="l00910"></a><span class="lineno"> 910</span> <span class="comment"> * @param integer $timeseconds</span></div>
|
|
<div class="line"><a name="l00911"></a><span class="lineno"> 911</span> <span class="comment"> * @param string $reason</span></div>
|
|
<div class="line"><a name="l00912"></a><span class="lineno"> 912</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00913"></a><span class="lineno"> 913</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00914"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aec861d4290728b6048fea64db528fc7a"> 914</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aec861d4290728b6048fea64db528fc7a" title="Bans the client specified with ID $clid from the server. ">clientBan</a>($clid, $timeseconds = null, $reason = null)</div>
|
|
<div class="line"><a name="l00915"></a><span class="lineno"> 915</span>  {</div>
|
|
<div class="line"><a name="l00916"></a><span class="lineno"> 916</span>  $this-><a class="code" href="class_team_speak3___node___server.html#acc00747588b6b1320c7f08f872f65fcf" title="Resets the list of clients online. ">clientListReset</a>();</div>
|
|
<div class="line"><a name="l00917"></a><span class="lineno"> 917</span> </div>
|
|
<div class="line"><a name="l00918"></a><span class="lineno"> 918</span>  $bans = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"banclient"</span>, array(<span class="stringliteral">"clid"</span> => $clid, <span class="stringliteral">"time"</span> => $timeseconds, <span class="stringliteral">"banreason"</span> => $reason))->toAssocArray(<span class="stringliteral">"banid"</span>);</div>
|
|
<div class="line"><a name="l00919"></a><span class="lineno"> 919</span> </div>
|
|
<div class="line"><a name="l00920"></a><span class="lineno"> 920</span>  <span class="keywordflow">return</span> array_keys($bans);</div>
|
|
<div class="line"><a name="l00921"></a><span class="lineno"> 921</span>  }</div>
|
|
<div class="line"><a name="l00922"></a><span class="lineno"> 922</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00923"></a><span class="lineno"> 923</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00924"></a><span class="lineno"> 924</span> <span class="comment"> * Changes the clients properties using given properties.</span></div>
|
|
<div class="line"><a name="l00925"></a><span class="lineno"> 925</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00926"></a><span class="lineno"> 926</span> <span class="comment"> * @param string $cldbid</span></div>
|
|
<div class="line"><a name="l00927"></a><span class="lineno"> 927</span> <span class="comment"> * @param array $properties</span></div>
|
|
<div class="line"><a name="l00928"></a><span class="lineno"> 928</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00929"></a><span class="lineno"> 929</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00930"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#acb9a0d106c96e3367b3c7484519b5cbb"> 930</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#acb9a0d106c96e3367b3c7484519b5cbb" title="Changes the clients properties using given properties. ">clientModifyDb</a>($cldbid, array $properties)</div>
|
|
<div class="line"><a name="l00931"></a><span class="lineno"> 931</span>  {</div>
|
|
<div class="line"><a name="l00932"></a><span class="lineno"> 932</span>  $properties[<span class="stringliteral">"cldbid"</span>] = $cldbid;</div>
|
|
<div class="line"><a name="l00933"></a><span class="lineno"> 933</span> </div>
|
|
<div class="line"><a name="l00934"></a><span class="lineno"> 934</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientdbedit"</span>, $properties);</div>
|
|
<div class="line"><a name="l00935"></a><span class="lineno"> 935</span>  }</div>
|
|
<div class="line"><a name="l00936"></a><span class="lineno"> 936</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00937"></a><span class="lineno"> 937</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00938"></a><span class="lineno"> 938</span> <span class="comment"> * Deletes a clients properties from the database.</span></div>
|
|
<div class="line"><a name="l00939"></a><span class="lineno"> 939</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00940"></a><span class="lineno"> 940</span> <span class="comment"> * @param string $cldbid</span></div>
|
|
<div class="line"><a name="l00941"></a><span class="lineno"> 941</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00942"></a><span class="lineno"> 942</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00943"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a5ca709d4b3a73686459ef0b09bd7d71a"> 943</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a5ca709d4b3a73686459ef0b09bd7d71a" title="Deletes a clients properties from the database. ">clientDeleteDb</a>($cldbid)</div>
|
|
<div class="line"><a name="l00944"></a><span class="lineno"> 944</span>  {</div>
|
|
<div class="line"><a name="l00945"></a><span class="lineno"> 945</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientdbdelete"</span>, array(<span class="stringliteral">"cldbid"</span> => $cldbid));</div>
|
|
<div class="line"><a name="l00946"></a><span class="lineno"> 946</span>  }</div>
|
|
<div class="line"><a name="l00947"></a><span class="lineno"> 947</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00948"></a><span class="lineno"> 948</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00949"></a><span class="lineno"> 949</span> <span class="comment"> * Sets the channel group of a client to the ID specified.</span></div>
|
|
<div class="line"><a name="l00950"></a><span class="lineno"> 950</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00951"></a><span class="lineno"> 951</span> <span class="comment"> * @param integer $cldbid</span></div>
|
|
<div class="line"><a name="l00952"></a><span class="lineno"> 952</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l00953"></a><span class="lineno"> 953</span> <span class="comment"> * @param integer $cgid</span></div>
|
|
<div class="line"><a name="l00954"></a><span class="lineno"> 954</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00955"></a><span class="lineno"> 955</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00956"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a101d9234082d47f359ea39ca7bc1c0bf"> 956</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a101d9234082d47f359ea39ca7bc1c0bf" title="Sets the channel group of a client to the ID specified. ">clientSetChannelGroup</a>($cldbid, $cid, $cgid)</div>
|
|
<div class="line"><a name="l00957"></a><span class="lineno"> 957</span>  {</div>
|
|
<div class="line"><a name="l00958"></a><span class="lineno"> 958</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"setclientchannelgroup"</span>, array(<span class="stringliteral">"cldbid"</span> => $cldbid, <span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"cgid"</span> => $cgid));</div>
|
|
<div class="line"><a name="l00959"></a><span class="lineno"> 959</span>  }</div>
|
|
<div class="line"><a name="l00960"></a><span class="lineno"> 960</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00961"></a><span class="lineno"> 961</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00962"></a><span class="lineno"> 962</span> <span class="comment"> * Returns a list of permissions defined for a client.</span></div>
|
|
<div class="line"><a name="l00963"></a><span class="lineno"> 963</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00964"></a><span class="lineno"> 964</span> <span class="comment"> * @param integer $cldbid</span></div>
|
|
<div class="line"><a name="l00965"></a><span class="lineno"> 965</span> <span class="comment"> * @param boolean $permsid</span></div>
|
|
<div class="line"><a name="l00966"></a><span class="lineno"> 966</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l00967"></a><span class="lineno"> 967</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00968"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aa2f308ca18a93f602af0e38155c48deb"> 968</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aa2f308ca18a93f602af0e38155c48deb" title="Returns a list of permissions defined for a client. ">clientPermList</a>($cldbid, $permsid = FALSE)</div>
|
|
<div class="line"><a name="l00969"></a><span class="lineno"> 969</span>  {</div>
|
|
<div class="line"><a name="l00970"></a><span class="lineno"> 970</span>  $this-><a class="code" href="class_team_speak3___node___server.html#acc00747588b6b1320c7f08f872f65fcf" title="Resets the list of clients online. ">clientListReset</a>();</div>
|
|
<div class="line"><a name="l00971"></a><span class="lineno"> 971</span> </div>
|
|
<div class="line"><a name="l00972"></a><span class="lineno"> 972</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientpermlist"</span>, array(<span class="stringliteral">"cldbid"</span> => $cldbid, $permsid ? <span class="stringliteral">"-permsid"</span> : null))->toAssocArray($permsid ? <span class="stringliteral">"permsid"</span> : <span class="stringliteral">"permid"</span>);</div>
|
|
<div class="line"><a name="l00973"></a><span class="lineno"> 973</span>  }</div>
|
|
<div class="line"><a name="l00974"></a><span class="lineno"> 974</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00975"></a><span class="lineno"> 975</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00976"></a><span class="lineno"> 976</span> <span class="comment"> * Adds a set of specified permissions to a client. Multiple permissions can be added by providing</span></div>
|
|
<div class="line"><a name="l00977"></a><span class="lineno"> 977</span> <span class="comment"> * the three parameters of each permission.</span></div>
|
|
<div class="line"><a name="l00978"></a><span class="lineno"> 978</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00979"></a><span class="lineno"> 979</span> <span class="comment"> * @param integer $cldbid</span></div>
|
|
<div class="line"><a name="l00980"></a><span class="lineno"> 980</span> <span class="comment"> * @param integer $permid</span></div>
|
|
<div class="line"><a name="l00981"></a><span class="lineno"> 981</span> <span class="comment"> * @param integer $permvalue</span></div>
|
|
<div class="line"><a name="l00982"></a><span class="lineno"> 982</span> <span class="comment"> * @param integer $permskip</span></div>
|
|
<div class="line"><a name="l00983"></a><span class="lineno"> 983</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l00984"></a><span class="lineno"> 984</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00985"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a387de111424128521346a04cd7be8710"> 985</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a387de111424128521346a04cd7be8710" title="Adds a set of specified permissions to a client. ">clientPermAssign</a>($cldbid, $permid, $permvalue, $permskip = FALSE)</div>
|
|
<div class="line"><a name="l00986"></a><span class="lineno"> 986</span>  {</div>
|
|
<div class="line"><a name="l00987"></a><span class="lineno"> 987</span>  <span class="keywordflow">if</span>(!is_array($permid))</div>
|
|
<div class="line"><a name="l00988"></a><span class="lineno"> 988</span>  {</div>
|
|
<div class="line"><a name="l00989"></a><span class="lineno"> 989</span>  $permident = (is_numeric($permid)) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l00990"></a><span class="lineno"> 990</span>  }</div>
|
|
<div class="line"><a name="l00991"></a><span class="lineno"> 991</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l00992"></a><span class="lineno"> 992</span>  {</div>
|
|
<div class="line"><a name="l00993"></a><span class="lineno"> 993</span>  $permident = (is_numeric(<a class="code" href="class_team_speak3___node___abstract.html#a1c78dbb54df73f8c5dabe41ebd476207">current</a>($permid))) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l00994"></a><span class="lineno"> 994</span>  }</div>
|
|
<div class="line"><a name="l00995"></a><span class="lineno"> 995</span> </div>
|
|
<div class="line"><a name="l00996"></a><span class="lineno"> 996</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientaddperm"</span>, array(<span class="stringliteral">"cldbid"</span> => $cldbid, $permident => $permid, <span class="stringliteral">"permvalue"</span> => $permvalue, <span class="stringliteral">"permskip"</span> => $permskip));</div>
|
|
<div class="line"><a name="l00997"></a><span class="lineno"> 997</span>  }</div>
|
|
<div class="line"><a name="l00998"></a><span class="lineno"> 998</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00999"></a><span class="lineno"> 999</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01000"></a><span class="lineno"> 1000</span> <span class="comment"> * Removes a set of specified permissions from a client. Multiple permissions can be removed at once.</span></div>
|
|
<div class="line"><a name="l01001"></a><span class="lineno"> 1001</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01002"></a><span class="lineno"> 1002</span> <span class="comment"> * @param integer $cldbid</span></div>
|
|
<div class="line"><a name="l01003"></a><span class="lineno"> 1003</span> <span class="comment"> * @param integer $permid</span></div>
|
|
<div class="line"><a name="l01004"></a><span class="lineno"> 1004</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01005"></a><span class="lineno"> 1005</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01006"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a7ff9f7bff622429c810933b53454adb3"> 1006</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a7ff9f7bff622429c810933b53454adb3" title="Removes a set of specified permissions from a client. ">clientPermRemove</a>($cldbid, $permid)</div>
|
|
<div class="line"><a name="l01007"></a><span class="lineno"> 1007</span>  {</div>
|
|
<div class="line"><a name="l01008"></a><span class="lineno"> 1008</span>  <span class="keywordflow">if</span>(!is_array($permid))</div>
|
|
<div class="line"><a name="l01009"></a><span class="lineno"> 1009</span>  {</div>
|
|
<div class="line"><a name="l01010"></a><span class="lineno"> 1010</span>  $permident = (is_numeric($permid)) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l01011"></a><span class="lineno"> 1011</span>  }</div>
|
|
<div class="line"><a name="l01012"></a><span class="lineno"> 1012</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l01013"></a><span class="lineno"> 1013</span>  {</div>
|
|
<div class="line"><a name="l01014"></a><span class="lineno"> 1014</span>  $permident = (is_numeric(<a class="code" href="class_team_speak3___node___abstract.html#a1c78dbb54df73f8c5dabe41ebd476207">current</a>($permid))) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l01015"></a><span class="lineno"> 1015</span>  }</div>
|
|
<div class="line"><a name="l01016"></a><span class="lineno"> 1016</span> </div>
|
|
<div class="line"><a name="l01017"></a><span class="lineno"> 1017</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientdelperm"</span>, array(<span class="stringliteral">"cldbid"</span> => $cldbid, $permident => $permid));</div>
|
|
<div class="line"><a name="l01018"></a><span class="lineno"> 1018</span>  }</div>
|
|
<div class="line"><a name="l01019"></a><span class="lineno"> 1019</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01020"></a><span class="lineno"> 1020</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01021"></a><span class="lineno"> 1021</span> <span class="comment"> * Returns a list of server groups available.</span></div>
|
|
<div class="line"><a name="l01022"></a><span class="lineno"> 1022</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01023"></a><span class="lineno"> 1023</span> <span class="comment"> * @param filter $filter</span></div>
|
|
<div class="line"><a name="l01024"></a><span class="lineno"> 1024</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01025"></a><span class="lineno"> 1025</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01026"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a0d3b40b9337ff37e5b2164d60ddd4e28"> 1026</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a0d3b40b9337ff37e5b2164d60ddd4e28" title="Returns a list of server groups available. ">serverGroupList</a>(array $filter = array())</div>
|
|
<div class="line"><a name="l01027"></a><span class="lineno"> 1027</span>  {</div>
|
|
<div class="line"><a name="l01028"></a><span class="lineno"> 1028</span>  <span class="keywordflow">if</span>($this->sgroupList === null)</div>
|
|
<div class="line"><a name="l01029"></a><span class="lineno"> 1029</span>  {</div>
|
|
<div class="line"><a name="l01030"></a><span class="lineno"> 1030</span>  $this->sgroupList = $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"servergrouplist"</span>)->toAssocArray(<span class="stringliteral">"sgid"</span>);</div>
|
|
<div class="line"><a name="l01031"></a><span class="lineno"> 1031</span> </div>
|
|
<div class="line"><a name="l01032"></a><span class="lineno"> 1032</span>  <span class="keywordflow">foreach</span>($this->sgroupList as $sgid => $group)</div>
|
|
<div class="line"><a name="l01033"></a><span class="lineno"> 1033</span>  {</div>
|
|
<div class="line"><a name="l01034"></a><span class="lineno"> 1034</span>  $this->sgroupList[$sgid] = <span class="keyword">new</span> <a class="code" href="class_team_speak3___node___servergroup.html" title="Class describing a TeamSpeak 3 server group and all it's parameters. ">TeamSpeak3_Node_Servergroup</a>($this, $group);</div>
|
|
<div class="line"><a name="l01035"></a><span class="lineno"> 1035</span>  }</div>
|
|
<div class="line"><a name="l01036"></a><span class="lineno"> 1036</span> </div>
|
|
<div class="line"><a name="l01037"></a><span class="lineno"> 1037</span>  uasort($this->sgroupList, array(__CLASS__, <span class="stringliteral">"sortGroupList"</span>));</div>
|
|
<div class="line"><a name="l01038"></a><span class="lineno"> 1038</span>  }</div>
|
|
<div class="line"><a name="l01039"></a><span class="lineno"> 1039</span> </div>
|
|
<div class="line"><a name="l01040"></a><span class="lineno"> 1040</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#ad826df3c71029ca48839dbe9aa3559b8" title="Filters given node list array using specified filter rules. ">filterList</a>($this->sgroupList, $filter);</div>
|
|
<div class="line"><a name="l01041"></a><span class="lineno"> 1041</span>  }</div>
|
|
<div class="line"><a name="l01042"></a><span class="lineno"> 1042</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01043"></a><span class="lineno"> 1043</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01044"></a><span class="lineno"> 1044</span> <span class="comment"> * Resets the list of server groups.</span></div>
|
|
<div class="line"><a name="l01045"></a><span class="lineno"> 1045</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01046"></a><span class="lineno"> 1046</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01047"></a><span class="lineno"> 1047</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01048"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aec6950365d137da98fb2acd94102f231"> 1048</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aec6950365d137da98fb2acd94102f231" title="Resets the list of server groups. ">serverGroupListReset</a>()</div>
|
|
<div class="line"><a name="l01049"></a><span class="lineno"> 1049</span>  {</div>
|
|
<div class="line"><a name="l01050"></a><span class="lineno"> 1050</span>  $this->sgroupList = null;</div>
|
|
<div class="line"><a name="l01051"></a><span class="lineno"> 1051</span>  }</div>
|
|
<div class="line"><a name="l01052"></a><span class="lineno"> 1052</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01053"></a><span class="lineno"> 1053</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01054"></a><span class="lineno"> 1054</span> <span class="comment"> * Creates a new server group using the name specified with $name and returns its ID.</span></div>
|
|
<div class="line"><a name="l01055"></a><span class="lineno"> 1055</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01056"></a><span class="lineno"> 1056</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l01057"></a><span class="lineno"> 1057</span> <span class="comment"> * @param integer $type</span></div>
|
|
<div class="line"><a name="l01058"></a><span class="lineno"> 1058</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l01059"></a><span class="lineno"> 1059</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01060"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a086d6141683f7aa0a6addbe13ae6da58"> 1060</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a086d6141683f7aa0a6addbe13ae6da58" title="Creates a new server group using the name specified with $name and returns its ID. ">serverGroupCreate</a>($name, $type = <a class="code" href="class_team_speak3.html#a6e018ed33e01f80861a9649f5fbdcb05" title="1: regular group (used for regular clients) ">TeamSpeak3::GROUP_DBTYPE_REGULAR</a>)</div>
|
|
<div class="line"><a name="l01061"></a><span class="lineno"> 1061</span>  {</div>
|
|
<div class="line"><a name="l01062"></a><span class="lineno"> 1062</span>  $this-><a class="code" href="class_team_speak3___node___server.html#aec6950365d137da98fb2acd94102f231" title="Resets the list of server groups. ">serverGroupListReset</a>();</div>
|
|
<div class="line"><a name="l01063"></a><span class="lineno"> 1063</span> </div>
|
|
<div class="line"><a name="l01064"></a><span class="lineno"> 1064</span>  $sgid = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servergroupadd"</span>, array(<span class="stringliteral">"name"</span> => $name, <span class="stringliteral">"type"</span> => $type))->toList();</div>
|
|
<div class="line"><a name="l01065"></a><span class="lineno"> 1065</span> </div>
|
|
<div class="line"><a name="l01066"></a><span class="lineno"> 1066</span>  <span class="keywordflow">return</span> $sgid[<span class="stringliteral">"sgid"</span>];</div>
|
|
<div class="line"><a name="l01067"></a><span class="lineno"> 1067</span>  }</div>
|
|
<div class="line"><a name="l01068"></a><span class="lineno"> 1068</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01069"></a><span class="lineno"> 1069</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01070"></a><span class="lineno"> 1070</span> <span class="comment"> * Creates a copy of an existing server group specified by $ssgid and returns the new groups ID.</span></div>
|
|
<div class="line"><a name="l01071"></a><span class="lineno"> 1071</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01072"></a><span class="lineno"> 1072</span> <span class="comment"> * @param integer $ssgid</span></div>
|
|
<div class="line"><a name="l01073"></a><span class="lineno"> 1073</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l01074"></a><span class="lineno"> 1074</span> <span class="comment"> * @param integer $tsgid</span></div>
|
|
<div class="line"><a name="l01075"></a><span class="lineno"> 1075</span> <span class="comment"> * @param integer $type</span></div>
|
|
<div class="line"><a name="l01076"></a><span class="lineno"> 1076</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l01077"></a><span class="lineno"> 1077</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01078"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aadd60ec1808c607b6ad6a62d95f8bacf"> 1078</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aadd60ec1808c607b6ad6a62d95f8bacf" title="Creates a copy of an existing server group specified by $ssgid and returns the new groups ID...">serverGroupCopy</a>($ssgid, $name = null, $tsgid = 0, $type = <a class="code" href="class_team_speak3.html#a6e018ed33e01f80861a9649f5fbdcb05" title="1: regular group (used for regular clients) ">TeamSpeak3::GROUP_DBTYPE_REGULAR</a>)</div>
|
|
<div class="line"><a name="l01079"></a><span class="lineno"> 1079</span>  {</div>
|
|
<div class="line"><a name="l01080"></a><span class="lineno"> 1080</span>  $this-><a class="code" href="class_team_speak3___node___server.html#aec6950365d137da98fb2acd94102f231" title="Resets the list of server groups. ">serverGroupListReset</a>();</div>
|
|
<div class="line"><a name="l01081"></a><span class="lineno"> 1081</span> </div>
|
|
<div class="line"><a name="l01082"></a><span class="lineno"> 1082</span>  $sgid = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servergroupcopy"</span>, array(<span class="stringliteral">"ssgid"</span> => $ssgid, <span class="stringliteral">"tsgid"</span> => $tsgid, <span class="stringliteral">"name"</span> => $name, <span class="stringliteral">"type"</span> => $type))->toList();</div>
|
|
<div class="line"><a name="l01083"></a><span class="lineno"> 1083</span> </div>
|
|
<div class="line"><a name="l01084"></a><span class="lineno"> 1084</span>  <span class="keywordflow">if</span>($tsgid && $name)</div>
|
|
<div class="line"><a name="l01085"></a><span class="lineno"> 1085</span>  {</div>
|
|
<div class="line"><a name="l01086"></a><span class="lineno"> 1086</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a593ea60776cecfce292855f8fdce050d" title="Renames the server group specified with $sgid. ">serverGroupRename</a>($tsgid, $name);</div>
|
|
<div class="line"><a name="l01087"></a><span class="lineno"> 1087</span>  }</div>
|
|
<div class="line"><a name="l01088"></a><span class="lineno"> 1088</span> </div>
|
|
<div class="line"><a name="l01089"></a><span class="lineno"> 1089</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3___node___abstract.html#ad22d04a2800ae672f6117de3afb0e9c4">count</a>($sgid) ? $sgid[<span class="stringliteral">"sgid"</span>] : intval($tsgid);</div>
|
|
<div class="line"><a name="l01090"></a><span class="lineno"> 1090</span>  }</div>
|
|
<div class="line"><a name="l01091"></a><span class="lineno"> 1091</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01092"></a><span class="lineno"> 1092</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01093"></a><span class="lineno"> 1093</span> <span class="comment"> * Renames the server group specified with $sgid.</span></div>
|
|
<div class="line"><a name="l01094"></a><span class="lineno"> 1094</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01095"></a><span class="lineno"> 1095</span> <span class="comment"> * @param integer $sgid</span></div>
|
|
<div class="line"><a name="l01096"></a><span class="lineno"> 1096</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l01097"></a><span class="lineno"> 1097</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01098"></a><span class="lineno"> 1098</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01099"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a593ea60776cecfce292855f8fdce050d"> 1099</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a593ea60776cecfce292855f8fdce050d" title="Renames the server group specified with $sgid. ">serverGroupRename</a>($sgid, $name)</div>
|
|
<div class="line"><a name="l01100"></a><span class="lineno"> 1100</span>  {</div>
|
|
<div class="line"><a name="l01101"></a><span class="lineno"> 1101</span>  $this-><a class="code" href="class_team_speak3___node___server.html#aec6950365d137da98fb2acd94102f231" title="Resets the list of server groups. ">serverGroupListReset</a>();</div>
|
|
<div class="line"><a name="l01102"></a><span class="lineno"> 1102</span> </div>
|
|
<div class="line"><a name="l01103"></a><span class="lineno"> 1103</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servergrouprename"</span>, array(<span class="stringliteral">"sgid"</span> => $sgid, <span class="stringliteral">"name"</span> => $name));</div>
|
|
<div class="line"><a name="l01104"></a><span class="lineno"> 1104</span>  }</div>
|
|
<div class="line"><a name="l01105"></a><span class="lineno"> 1105</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01106"></a><span class="lineno"> 1106</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01107"></a><span class="lineno"> 1107</span> <span class="comment"> * Deletes the server group specified with $sgid. If $force is set to 1, the server group</span></div>
|
|
<div class="line"><a name="l01108"></a><span class="lineno"> 1108</span> <span class="comment"> * will be deleted even if there are clients within.</span></div>
|
|
<div class="line"><a name="l01109"></a><span class="lineno"> 1109</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01110"></a><span class="lineno"> 1110</span> <span class="comment"> * @param integer $sgid</span></div>
|
|
<div class="line"><a name="l01111"></a><span class="lineno"> 1111</span> <span class="comment"> * @param boolean $force</span></div>
|
|
<div class="line"><a name="l01112"></a><span class="lineno"> 1112</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01113"></a><span class="lineno"> 1113</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01114"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a347baec8fce678ab8a8f464f0398ebed"> 1114</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a347baec8fce678ab8a8f464f0398ebed" title="Deletes the server group specified with $sgid. ">serverGroupDelete</a>($sgid, $force = FALSE)</div>
|
|
<div class="line"><a name="l01115"></a><span class="lineno"> 1115</span>  {</div>
|
|
<div class="line"><a name="l01116"></a><span class="lineno"> 1116</span>  $this-><a class="code" href="class_team_speak3___node___server.html#aec6950365d137da98fb2acd94102f231" title="Resets the list of server groups. ">serverGroupListReset</a>();</div>
|
|
<div class="line"><a name="l01117"></a><span class="lineno"> 1117</span> </div>
|
|
<div class="line"><a name="l01118"></a><span class="lineno"> 1118</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servergroupdel"</span>, array(<span class="stringliteral">"sgid"</span> => $sgid, <span class="stringliteral">"force"</span> => $force));</div>
|
|
<div class="line"><a name="l01119"></a><span class="lineno"> 1119</span>  }</div>
|
|
<div class="line"><a name="l01120"></a><span class="lineno"> 1120</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01121"></a><span class="lineno"> 1121</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01122"></a><span class="lineno"> 1122</span> <span class="comment"> * Returns the TeamSpeak3_Node_Servergroup object matching the given ID.</span></div>
|
|
<div class="line"><a name="l01123"></a><span class="lineno"> 1123</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01124"></a><span class="lineno"> 1124</span> <span class="comment"> * @param integer $sgid</span></div>
|
|
<div class="line"><a name="l01125"></a><span class="lineno"> 1125</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l01126"></a><span class="lineno"> 1126</span> <span class="comment"> * @return TeamSpeak3_Node_Servergroup</span></div>
|
|
<div class="line"><a name="l01127"></a><span class="lineno"> 1127</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01128"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a8c8a3d44efa6582d80da3e647d934429"> 1128</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a8c8a3d44efa6582d80da3e647d934429" title="Returns the TeamSpeak3_Node_Servergroup object matching the given ID. ">serverGroupGetById</a>($sgid)</div>
|
|
<div class="line"><a name="l01129"></a><span class="lineno"> 1129</span>  {</div>
|
|
<div class="line"><a name="l01130"></a><span class="lineno"> 1130</span>  <span class="keywordflow">if</span>(!array_key_exists((<span class="keywordtype">string</span>) $sgid, $this-><a class="code" href="class_team_speak3___node___server.html#a0d3b40b9337ff37e5b2164d60ddd4e28" title="Returns a list of server groups available. ">serverGroupList</a>()))</div>
|
|
<div class="line"><a name="l01131"></a><span class="lineno"> 1131</span>  {</div>
|
|
<div class="line"><a name="l01132"></a><span class="lineno"> 1132</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid groupID"</span>, 0xA00);</div>
|
|
<div class="line"><a name="l01133"></a><span class="lineno"> 1133</span>  }</div>
|
|
<div class="line"><a name="l01134"></a><span class="lineno"> 1134</span> </div>
|
|
<div class="line"><a name="l01135"></a><span class="lineno"> 1135</span>  <span class="keywordflow">return</span> $this->sgroupList[intval((<span class="keywordtype">string</span>) $sgid)];</div>
|
|
<div class="line"><a name="l01136"></a><span class="lineno"> 1136</span>  }</div>
|
|
<div class="line"><a name="l01137"></a><span class="lineno"> 1137</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01138"></a><span class="lineno"> 1138</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01139"></a><span class="lineno"> 1139</span> <span class="comment"> * Returns the TeamSpeak3_Node_Servergroup object matching the given name.</span></div>
|
|
<div class="line"><a name="l01140"></a><span class="lineno"> 1140</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01141"></a><span class="lineno"> 1141</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l01142"></a><span class="lineno"> 1142</span> <span class="comment"> * @param integer $type</span></div>
|
|
<div class="line"><a name="l01143"></a><span class="lineno"> 1143</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l01144"></a><span class="lineno"> 1144</span> <span class="comment"> * @return TeamSpeak3_Node_Servergroup</span></div>
|
|
<div class="line"><a name="l01145"></a><span class="lineno"> 1145</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01146"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#af44dad10a4123fa928deda53a1452df2"> 1146</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#af44dad10a4123fa928deda53a1452df2" title="Returns the TeamSpeak3_Node_Servergroup object matching the given name. ">serverGroupGetByName</a>($name, $type = <a class="code" href="class_team_speak3.html#a6e018ed33e01f80861a9649f5fbdcb05" title="1: regular group (used for regular clients) ">TeamSpeak3::GROUP_DBTYPE_REGULAR</a>)</div>
|
|
<div class="line"><a name="l01147"></a><span class="lineno"> 1147</span>  {</div>
|
|
<div class="line"><a name="l01148"></a><span class="lineno"> 1148</span>  <span class="keywordflow">foreach</span>($this-><a class="code" href="class_team_speak3___node___server.html#a0d3b40b9337ff37e5b2164d60ddd4e28" title="Returns a list of server groups available. ">serverGroupList</a>() as $group)</div>
|
|
<div class="line"><a name="l01149"></a><span class="lineno"> 1149</span>  {</div>
|
|
<div class="line"><a name="l01150"></a><span class="lineno"> 1150</span>  <span class="keywordflow">if</span>($group[<span class="stringliteral">"name"</span>] == $name && $group[<span class="stringliteral">"type"</span>] == $type) <span class="keywordflow">return</span> $group;</div>
|
|
<div class="line"><a name="l01151"></a><span class="lineno"> 1151</span>  }</div>
|
|
<div class="line"><a name="l01152"></a><span class="lineno"> 1152</span> </div>
|
|
<div class="line"><a name="l01153"></a><span class="lineno"> 1153</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid groupID"</span>, 0xA00);</div>
|
|
<div class="line"><a name="l01154"></a><span class="lineno"> 1154</span>  }</div>
|
|
<div class="line"><a name="l01155"></a><span class="lineno"> 1155</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01156"></a><span class="lineno"> 1156</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01157"></a><span class="lineno"> 1157</span> <span class="comment"> * Returns a list of permissions assigned to the server group specified.</span></div>
|
|
<div class="line"><a name="l01158"></a><span class="lineno"> 1158</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01159"></a><span class="lineno"> 1159</span> <span class="comment"> * @param integer $sgid</span></div>
|
|
<div class="line"><a name="l01160"></a><span class="lineno"> 1160</span> <span class="comment"> * @param boolean $permsid</span></div>
|
|
<div class="line"><a name="l01161"></a><span class="lineno"> 1161</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01162"></a><span class="lineno"> 1162</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01163"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a2406d3d74974d39b296ec5af4b7643c4"> 1163</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a2406d3d74974d39b296ec5af4b7643c4" title="Returns a list of permissions assigned to the server group specified. ">serverGroupPermList</a>($sgid, $permsid = FALSE)</div>
|
|
<div class="line"><a name="l01164"></a><span class="lineno"> 1164</span>  {</div>
|
|
<div class="line"><a name="l01165"></a><span class="lineno"> 1165</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servergrouppermlist"</span>, array(<span class="stringliteral">"sgid"</span> => $sgid, $permsid ? <span class="stringliteral">"-permsid"</span> : null))->toAssocArray($permsid ? <span class="stringliteral">"permsid"</span> : <span class="stringliteral">"permid"</span>);</div>
|
|
<div class="line"><a name="l01166"></a><span class="lineno"> 1166</span>  }</div>
|
|
<div class="line"><a name="l01167"></a><span class="lineno"> 1167</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01168"></a><span class="lineno"> 1168</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01169"></a><span class="lineno"> 1169</span> <span class="comment"> * Adds a set of specified permissions to the server group specified. Multiple permissions</span></div>
|
|
<div class="line"><a name="l01170"></a><span class="lineno"> 1170</span> <span class="comment"> * can be added by providing the four parameters of each permission in separate arrays.</span></div>
|
|
<div class="line"><a name="l01171"></a><span class="lineno"> 1171</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01172"></a><span class="lineno"> 1172</span> <span class="comment"> * @param integer $sgid</span></div>
|
|
<div class="line"><a name="l01173"></a><span class="lineno"> 1173</span> <span class="comment"> * @param integer $permid</span></div>
|
|
<div class="line"><a name="l01174"></a><span class="lineno"> 1174</span> <span class="comment"> * @param integer $permvalue</span></div>
|
|
<div class="line"><a name="l01175"></a><span class="lineno"> 1175</span> <span class="comment"> * @param integer $permnegated</span></div>
|
|
<div class="line"><a name="l01176"></a><span class="lineno"> 1176</span> <span class="comment"> * @param integer $permskip</span></div>
|
|
<div class="line"><a name="l01177"></a><span class="lineno"> 1177</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01178"></a><span class="lineno"> 1178</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01179"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a1625df1060f7b19b5e607174df29406b"> 1179</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a1625df1060f7b19b5e607174df29406b" title="Adds a set of specified permissions to the server group specified. ">serverGroupPermAssign</a>($sgid, $permid, $permvalue, $permnegated = FALSE, $permskip = FALSE)</div>
|
|
<div class="line"><a name="l01180"></a><span class="lineno"> 1180</span>  {</div>
|
|
<div class="line"><a name="l01181"></a><span class="lineno"> 1181</span>  <span class="keywordflow">if</span>(!is_array($permid))</div>
|
|
<div class="line"><a name="l01182"></a><span class="lineno"> 1182</span>  {</div>
|
|
<div class="line"><a name="l01183"></a><span class="lineno"> 1183</span>  $permident = (is_numeric($permid)) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l01184"></a><span class="lineno"> 1184</span>  }</div>
|
|
<div class="line"><a name="l01185"></a><span class="lineno"> 1185</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l01186"></a><span class="lineno"> 1186</span>  {</div>
|
|
<div class="line"><a name="l01187"></a><span class="lineno"> 1187</span>  $permident = (is_numeric(<a class="code" href="class_team_speak3___node___abstract.html#a1c78dbb54df73f8c5dabe41ebd476207">current</a>($permid))) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l01188"></a><span class="lineno"> 1188</span>  }</div>
|
|
<div class="line"><a name="l01189"></a><span class="lineno"> 1189</span> </div>
|
|
<div class="line"><a name="l01190"></a><span class="lineno"> 1190</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servergroupaddperm"</span>, array(<span class="stringliteral">"sgid"</span> => $sgid, $permident => $permid, <span class="stringliteral">"permvalue"</span> => $permvalue, <span class="stringliteral">"permnegated"</span> => $permnegated, <span class="stringliteral">"permskip"</span> => $permskip));</div>
|
|
<div class="line"><a name="l01191"></a><span class="lineno"> 1191</span>  }</div>
|
|
<div class="line"><a name="l01192"></a><span class="lineno"> 1192</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01193"></a><span class="lineno"> 1193</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01194"></a><span class="lineno"> 1194</span> <span class="comment"> * Removes a set of specified permissions from the server group specified with $sgid. Multiple</span></div>
|
|
<div class="line"><a name="l01195"></a><span class="lineno"> 1195</span> <span class="comment"> * permissions can be removed at once.</span></div>
|
|
<div class="line"><a name="l01196"></a><span class="lineno"> 1196</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01197"></a><span class="lineno"> 1197</span> <span class="comment"> * @param integer $sgid</span></div>
|
|
<div class="line"><a name="l01198"></a><span class="lineno"> 1198</span> <span class="comment"> * @param integer $permid</span></div>
|
|
<div class="line"><a name="l01199"></a><span class="lineno"> 1199</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01200"></a><span class="lineno"> 1200</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01201"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a3b7ead504bbc7f2070f46d19e072afd9"> 1201</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a3b7ead504bbc7f2070f46d19e072afd9" title="Removes a set of specified permissions from the server group specified with $sgid. ">serverGroupPermRemove</a>($sgid, $permid)</div>
|
|
<div class="line"><a name="l01202"></a><span class="lineno"> 1202</span>  {</div>
|
|
<div class="line"><a name="l01203"></a><span class="lineno"> 1203</span>  <span class="keywordflow">if</span>(!is_array($permid))</div>
|
|
<div class="line"><a name="l01204"></a><span class="lineno"> 1204</span>  {</div>
|
|
<div class="line"><a name="l01205"></a><span class="lineno"> 1205</span>  $permident = (is_numeric($permid)) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l01206"></a><span class="lineno"> 1206</span>  }</div>
|
|
<div class="line"><a name="l01207"></a><span class="lineno"> 1207</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l01208"></a><span class="lineno"> 1208</span>  {</div>
|
|
<div class="line"><a name="l01209"></a><span class="lineno"> 1209</span>  $permident = (is_numeric(<a class="code" href="class_team_speak3___node___abstract.html#a1c78dbb54df73f8c5dabe41ebd476207">current</a>($permid))) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l01210"></a><span class="lineno"> 1210</span>  }</div>
|
|
<div class="line"><a name="l01211"></a><span class="lineno"> 1211</span> </div>
|
|
<div class="line"><a name="l01212"></a><span class="lineno"> 1212</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servergroupdelperm"</span>, array(<span class="stringliteral">"sgid"</span> => $sgid, $permident => $permid));</div>
|
|
<div class="line"><a name="l01213"></a><span class="lineno"> 1213</span>  }</div>
|
|
<div class="line"><a name="l01214"></a><span class="lineno"> 1214</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01215"></a><span class="lineno"> 1215</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01216"></a><span class="lineno"> 1216</span> <span class="comment"> * Returns a list of clients assigned to the server group specified.</span></div>
|
|
<div class="line"><a name="l01217"></a><span class="lineno"> 1217</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01218"></a><span class="lineno"> 1218</span> <span class="comment"> * @param integer $sgid</span></div>
|
|
<div class="line"><a name="l01219"></a><span class="lineno"> 1219</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01220"></a><span class="lineno"> 1220</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01221"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a69f43173d45cc599b05a4e6f9bef5baa"> 1221</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a69f43173d45cc599b05a4e6f9bef5baa" title="Returns a list of clients assigned to the server group specified. ">serverGroupClientList</a>($sgid)</div>
|
|
<div class="line"><a name="l01222"></a><span class="lineno"> 1222</span>  {</div>
|
|
<div class="line"><a name="l01223"></a><span class="lineno"> 1223</span>  <span class="keywordflow">if</span>($this[<span class="stringliteral">"virtualserver_default_server_group"</span>] == $sgid)</div>
|
|
<div class="line"><a name="l01224"></a><span class="lineno"> 1224</span>  {</div>
|
|
<div class="line"><a name="l01225"></a><span class="lineno"> 1225</span>  <span class="keywordflow">return</span> array();</div>
|
|
<div class="line"><a name="l01226"></a><span class="lineno"> 1226</span>  }</div>
|
|
<div class="line"><a name="l01227"></a><span class="lineno"> 1227</span> </div>
|
|
<div class="line"><a name="l01228"></a><span class="lineno"> 1228</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servergroupclientlist"</span>, array(<span class="stringliteral">"sgid"</span> => $sgid, <span class="stringliteral">"-names"</span>))->toAssocArray(<span class="stringliteral">"cldbid"</span>);</div>
|
|
<div class="line"><a name="l01229"></a><span class="lineno"> 1229</span>  }</div>
|
|
<div class="line"><a name="l01230"></a><span class="lineno"> 1230</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01231"></a><span class="lineno"> 1231</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01232"></a><span class="lineno"> 1232</span> <span class="comment"> * Adds a client to the server group specified. Please note that a client cannot be</span></div>
|
|
<div class="line"><a name="l01233"></a><span class="lineno"> 1233</span> <span class="comment"> * added to default groups or template groups.</span></div>
|
|
<div class="line"><a name="l01234"></a><span class="lineno"> 1234</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01235"></a><span class="lineno"> 1235</span> <span class="comment"> * @param integer $sgid</span></div>
|
|
<div class="line"><a name="l01236"></a><span class="lineno"> 1236</span> <span class="comment"> * @param integer $cldbid</span></div>
|
|
<div class="line"><a name="l01237"></a><span class="lineno"> 1237</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01238"></a><span class="lineno"> 1238</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01239"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a8d2a092fb314a86b304ad3eb7d0d295b"> 1239</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a8d2a092fb314a86b304ad3eb7d0d295b" title="Adds a client to the server group specified. ">serverGroupClientAdd</a>($sgid, $cldbid)</div>
|
|
<div class="line"><a name="l01240"></a><span class="lineno"> 1240</span>  {</div>
|
|
<div class="line"><a name="l01241"></a><span class="lineno"> 1241</span>  $this-><a class="code" href="class_team_speak3___node___server.html#acc00747588b6b1320c7f08f872f65fcf" title="Resets the list of clients online. ">clientListReset</a>();</div>
|
|
<div class="line"><a name="l01242"></a><span class="lineno"> 1242</span> </div>
|
|
<div class="line"><a name="l01243"></a><span class="lineno"> 1243</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servergroupaddclient"</span>, array(<span class="stringliteral">"sgid"</span> => $sgid, <span class="stringliteral">"cldbid"</span> => $cldbid));</div>
|
|
<div class="line"><a name="l01244"></a><span class="lineno"> 1244</span>  }</div>
|
|
<div class="line"><a name="l01245"></a><span class="lineno"> 1245</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01246"></a><span class="lineno"> 1246</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01247"></a><span class="lineno"> 1247</span> <span class="comment"> * Removes a client from the server group specified.</span></div>
|
|
<div class="line"><a name="l01248"></a><span class="lineno"> 1248</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01249"></a><span class="lineno"> 1249</span> <span class="comment"> * @param integer $sgid</span></div>
|
|
<div class="line"><a name="l01250"></a><span class="lineno"> 1250</span> <span class="comment"> * @param integer $cldbid</span></div>
|
|
<div class="line"><a name="l01251"></a><span class="lineno"> 1251</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01252"></a><span class="lineno"> 1252</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01253"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#acbd1a4c797a041242eeb5f0ead1e7667"> 1253</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#acbd1a4c797a041242eeb5f0ead1e7667" title="Removes a client from the server group specified. ">serverGroupClientDel</a>($sgid, $cldbid)</div>
|
|
<div class="line"><a name="l01254"></a><span class="lineno"> 1254</span>  {</div>
|
|
<div class="line"><a name="l01255"></a><span class="lineno"> 1255</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servergroupdelclient"</span>, array(<span class="stringliteral">"sgid"</span> => $sgid, <span class="stringliteral">"cldbid"</span> => $cldbid));</div>
|
|
<div class="line"><a name="l01256"></a><span class="lineno"> 1256</span>  }</div>
|
|
<div class="line"><a name="l01257"></a><span class="lineno"> 1257</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01258"></a><span class="lineno"> 1258</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01259"></a><span class="lineno"> 1259</span> <span class="comment"> * Returns an ordered array of regular server groups available based on a pre-defined</span></div>
|
|
<div class="line"><a name="l01260"></a><span class="lineno"> 1260</span> <span class="comment"> * set of rules.</span></div>
|
|
<div class="line"><a name="l01261"></a><span class="lineno"> 1261</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01262"></a><span class="lineno"> 1262</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01263"></a><span class="lineno"> 1263</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01264"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a78d5842c3b8e9248f8a46df03d041d77"> 1264</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a78d5842c3b8e9248f8a46df03d041d77" title="Returns an ordered array of regular server groups available based on a pre-defined set of rules...">serverGroupGetProfiles</a>()</div>
|
|
<div class="line"><a name="l01265"></a><span class="lineno"> 1265</span>  {</div>
|
|
<div class="line"><a name="l01266"></a><span class="lineno"> 1266</span>  $profiles = array();</div>
|
|
<div class="line"><a name="l01267"></a><span class="lineno"> 1267</span> </div>
|
|
<div class="line"><a name="l01268"></a><span class="lineno"> 1268</span>  <span class="keywordflow">foreach</span>($this-><a class="code" href="class_team_speak3___node___server.html#a0d3b40b9337ff37e5b2164d60ddd4e28" title="Returns a list of server groups available. ">serverGroupList</a>() as $sgid => $sgroup)</div>
|
|
<div class="line"><a name="l01269"></a><span class="lineno"> 1269</span>  {</div>
|
|
<div class="line"><a name="l01270"></a><span class="lineno"> 1270</span>  <span class="keywordflow">if</span>($sgroup[<span class="stringliteral">"type"</span>] != <a class="code" href="class_team_speak3.html#a6e018ed33e01f80861a9649f5fbdcb05" title="1: regular group (used for regular clients) ">TeamSpeak3::GROUP_DBTYPE_REGULAR</a>) <span class="keywordflow">continue</span>;</div>
|
|
<div class="line"><a name="l01271"></a><span class="lineno"> 1271</span> </div>
|
|
<div class="line"><a name="l01272"></a><span class="lineno"> 1272</span>  $profiles[$sgid] = array(</div>
|
|
<div class="line"><a name="l01273"></a><span class="lineno"> 1273</span>  <span class="stringliteral">"b_permission_modify_power_ignore"</span> => 0,</div>
|
|
<div class="line"><a name="l01274"></a><span class="lineno"> 1274</span>  <span class="stringliteral">"i_group_needed_member_add_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01275"></a><span class="lineno"> 1275</span>  <span class="stringliteral">"i_group_member_add_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01276"></a><span class="lineno"> 1276</span>  <span class="stringliteral">"i_group_needed_member_remove_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01277"></a><span class="lineno"> 1277</span>  <span class="stringliteral">"i_group_member_remove_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01278"></a><span class="lineno"> 1278</span>  <span class="stringliteral">"i_needed_modify_power_count"</span> => 0,</div>
|
|
<div class="line"><a name="l01279"></a><span class="lineno"> 1279</span>  <span class="stringliteral">"i_needed_modify_power_total"</span> => 0,</div>
|
|
<div class="line"><a name="l01280"></a><span class="lineno"> 1280</span>  <span class="stringliteral">"i_permission_modify_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01281"></a><span class="lineno"> 1281</span>  <span class="stringliteral">"i_group_needed_modify_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01282"></a><span class="lineno"> 1282</span>  <span class="stringliteral">"i_group_modify_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01283"></a><span class="lineno"> 1283</span>  <span class="stringliteral">"i_client_needed_modify_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01284"></a><span class="lineno"> 1284</span>  <span class="stringliteral">"i_client_modify_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01285"></a><span class="lineno"> 1285</span>  <span class="stringliteral">"b_virtualserver_servergroup_create"</span> => 0,</div>
|
|
<div class="line"><a name="l01286"></a><span class="lineno"> 1286</span>  <span class="stringliteral">"b_virtualserver_servergroup_delete"</span> => 0,</div>
|
|
<div class="line"><a name="l01287"></a><span class="lineno"> 1287</span>  <span class="stringliteral">"b_client_ignore_bans"</span> => 0,</div>
|
|
<div class="line"><a name="l01288"></a><span class="lineno"> 1288</span>  <span class="stringliteral">"b_client_ignore_antiflood"</span> => 0,</div>
|
|
<div class="line"><a name="l01289"></a><span class="lineno"> 1289</span>  <span class="stringliteral">"b_group_is_permanent"</span> => 0,</div>
|
|
<div class="line"><a name="l01290"></a><span class="lineno"> 1290</span>  <span class="stringliteral">"i_client_needed_ban_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01291"></a><span class="lineno"> 1291</span>  <span class="stringliteral">"i_client_needed_kick_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01292"></a><span class="lineno"> 1292</span>  <span class="stringliteral">"i_client_needed_move_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01293"></a><span class="lineno"> 1293</span>  <span class="stringliteral">"i_client_talk_power"</span> => 0,</div>
|
|
<div class="line"><a name="l01294"></a><span class="lineno"> 1294</span>  <span class="stringliteral">"__sgid"</span> => $sgid,</div>
|
|
<div class="line"><a name="l01295"></a><span class="lineno"> 1295</span>  <span class="stringliteral">"__name"</span> => $sgroup->toString(),</div>
|
|
<div class="line"><a name="l01296"></a><span class="lineno"> 1296</span>  <span class="stringliteral">"__node"</span> => $sgroup,</div>
|
|
<div class="line"><a name="l01297"></a><span class="lineno"> 1297</span>  );</div>
|
|
<div class="line"><a name="l01298"></a><span class="lineno"> 1298</span> </div>
|
|
<div class="line"><a name="l01299"></a><span class="lineno"> 1299</span>  <span class="keywordflow">try</span></div>
|
|
<div class="line"><a name="l01300"></a><span class="lineno"> 1300</span>  {</div>
|
|
<div class="line"><a name="l01301"></a><span class="lineno"> 1301</span>  $perms = $this-><a class="code" href="class_team_speak3___node___server.html#a2406d3d74974d39b296ec5af4b7643c4" title="Returns a list of permissions assigned to the server group specified. ">serverGroupPermList</a>($sgid, TRUE);</div>
|
|
<div class="line"><a name="l01302"></a><span class="lineno"> 1302</span>  $grant = isset($perms[<span class="stringliteral">"i_permission_modify_power"</span>]) ? $perms[<span class="stringliteral">"i_permission_modify_power"</span>][<span class="stringliteral">"permvalue"</span>] : null;</div>
|
|
<div class="line"><a name="l01303"></a><span class="lineno"> 1303</span>  }</div>
|
|
<div class="line"><a name="l01304"></a><span class="lineno"> 1304</span>  <span class="keywordflow">catch</span>(<a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a> $e)</div>
|
|
<div class="line"><a name="l01305"></a><span class="lineno"> 1305</span>  {</div>
|
|
<div class="line"><a name="l01306"></a><span class="lineno"> 1306</span>  <span class="comment">/* ERROR_database_empty_result */</span></div>
|
|
<div class="line"><a name="l01307"></a><span class="lineno"> 1307</span>  <span class="keywordflow">if</span>($e->getCode() != 0x501) <span class="keywordflow">throw</span> $e;</div>
|
|
<div class="line"><a name="l01308"></a><span class="lineno"> 1308</span> </div>
|
|
<div class="line"><a name="l01309"></a><span class="lineno"> 1309</span>  $perms = array();</div>
|
|
<div class="line"><a name="l01310"></a><span class="lineno"> 1310</span>  $grant = null;</div>
|
|
<div class="line"><a name="l01311"></a><span class="lineno"> 1311</span>  }</div>
|
|
<div class="line"><a name="l01312"></a><span class="lineno"> 1312</span> </div>
|
|
<div class="line"><a name="l01313"></a><span class="lineno"> 1313</span>  <span class="keywordflow">foreach</span>($perms as $permsid => $perm)</div>
|
|
<div class="line"><a name="l01314"></a><span class="lineno"> 1314</span>  {</div>
|
|
<div class="line"><a name="l01315"></a><span class="lineno"> 1315</span>  <span class="keywordflow">if</span>(in_array($permsid, array_keys($profiles[$sgid])))</div>
|
|
<div class="line"><a name="l01316"></a><span class="lineno"> 1316</span>  {</div>
|
|
<div class="line"><a name="l01317"></a><span class="lineno"> 1317</span>  $profiles[$sgid][$permsid] = $perm[<span class="stringliteral">"permvalue"</span>];</div>
|
|
<div class="line"><a name="l01318"></a><span class="lineno"> 1318</span>  }</div>
|
|
<div class="line"><a name="l01319"></a><span class="lineno"> 1319</span>  elseif(<a class="code" href="class_team_speak3___helper___string.html#a475f5a602d67dd0568fb8c86352c88a0" title="Returns a TeamSpeak3_Helper_String object for thegiven string. ">TeamSpeak3_Helper_String::factory</a>($permsid)->startsWith(<span class="stringliteral">"i_needed_modify_power_"</span>))</div>
|
|
<div class="line"><a name="l01320"></a><span class="lineno"> 1320</span>  {</div>
|
|
<div class="line"><a name="l01321"></a><span class="lineno"> 1321</span>  <span class="keywordflow">if</span>(!$grant || $perm[<span class="stringliteral">"permvalue"</span>] > $grant) <span class="keywordflow">continue</span>;</div>
|
|
<div class="line"><a name="l01322"></a><span class="lineno"> 1322</span> </div>
|
|
<div class="line"><a name="l01323"></a><span class="lineno"> 1323</span>  $profiles[$sgid][<span class="stringliteral">"i_needed_modify_power_total"</span>] = $profiles[$sgid][<span class="stringliteral">"i_needed_modify_power_total"</span>]+$perm[<span class="stringliteral">"permvalue"</span>];</div>
|
|
<div class="line"><a name="l01324"></a><span class="lineno"> 1324</span>  $profiles[$sgid][<span class="stringliteral">"i_needed_modify_power_count"</span>]++;</div>
|
|
<div class="line"><a name="l01325"></a><span class="lineno"> 1325</span>  }</div>
|
|
<div class="line"><a name="l01326"></a><span class="lineno"> 1326</span>  }</div>
|
|
<div class="line"><a name="l01327"></a><span class="lineno"> 1327</span>  }</div>
|
|
<div class="line"><a name="l01328"></a><span class="lineno"> 1328</span> </div>
|
|
<div class="line"><a name="l01329"></a><span class="lineno"> 1329</span>  array_multisort($profiles, SORT_DESC);</div>
|
|
<div class="line"><a name="l01330"></a><span class="lineno"> 1330</span> </div>
|
|
<div class="line"><a name="l01331"></a><span class="lineno"> 1331</span>  <span class="keywordflow">return</span> $profiles;</div>
|
|
<div class="line"><a name="l01332"></a><span class="lineno"> 1332</span>  }</div>
|
|
<div class="line"><a name="l01333"></a><span class="lineno"> 1333</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01334"></a><span class="lineno"> 1334</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01335"></a><span class="lineno"> 1335</span> <span class="comment"> * Tries to identify the post powerful/weakest server group on the virtual server and returns</span></div>
|
|
<div class="line"><a name="l01336"></a><span class="lineno"> 1336</span> <span class="comment"> * the ID.</span></div>
|
|
<div class="line"><a name="l01337"></a><span class="lineno"> 1337</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01338"></a><span class="lineno"> 1338</span> <span class="comment"> * @param integer $mode</span></div>
|
|
<div class="line"><a name="l01339"></a><span class="lineno"> 1339</span> <span class="comment"> * @return TeamSpeak3_Node_Servergroup</span></div>
|
|
<div class="line"><a name="l01340"></a><span class="lineno"> 1340</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01341"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aee3bf51303b69cbf9d50202a4864a38b"> 1341</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aee3bf51303b69cbf9d50202a4864a38b" title="Tries to identify the post powerful/weakest server group on the virtual server and returns the ID...">serverGroupIdentify</a>($mode = <a class="code" href="class_team_speak3.html#ac8dbaaf31bc8b339287692ae80abae94" title="1: identify most powerful group ">TeamSpeak3::GROUP_IDENTIFIY_STRONGEST</a>)</div>
|
|
<div class="line"><a name="l01342"></a><span class="lineno"> 1342</span>  {</div>
|
|
<div class="line"><a name="l01343"></a><span class="lineno"> 1343</span>  $profiles = $this-><a class="code" href="class_team_speak3___node___server.html#a78d5842c3b8e9248f8a46df03d041d77" title="Returns an ordered array of regular server groups available based on a pre-defined set of rules...">serverGroupGetProfiles</a>();</div>
|
|
<div class="line"><a name="l01344"></a><span class="lineno"> 1344</span> </div>
|
|
<div class="line"><a name="l01345"></a><span class="lineno"> 1345</span>  $best_guess_profile = ($mode == <a class="code" href="class_team_speak3.html#ac8dbaaf31bc8b339287692ae80abae94" title="1: identify most powerful group ">TeamSpeak3::GROUP_IDENTIFIY_STRONGEST</a>) ? array_shift($profiles) : array_pop($profiles);</div>
|
|
<div class="line"><a name="l01346"></a><span class="lineno"> 1346</span> </div>
|
|
<div class="line"><a name="l01347"></a><span class="lineno"> 1347</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___server.html#a8c8a3d44efa6582d80da3e647d934429" title="Returns the TeamSpeak3_Node_Servergroup object matching the given ID. ">serverGroupGetById</a>($best_guess_profile[<span class="stringliteral">"__sgid"</span>]);</div>
|
|
<div class="line"><a name="l01348"></a><span class="lineno"> 1348</span>  }</div>
|
|
<div class="line"><a name="l01349"></a><span class="lineno"> 1349</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01350"></a><span class="lineno"> 1350</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01351"></a><span class="lineno"> 1351</span> <span class="comment"> * Returns a list of channel groups available.</span></div>
|
|
<div class="line"><a name="l01352"></a><span class="lineno"> 1352</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01353"></a><span class="lineno"> 1353</span> <span class="comment"> * @param array $filter</span></div>
|
|
<div class="line"><a name="l01354"></a><span class="lineno"> 1354</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01355"></a><span class="lineno"> 1355</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01356"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a442c9127e61b6e1d31e368af71443b1a"> 1356</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a442c9127e61b6e1d31e368af71443b1a" title="Returns a list of channel groups available. ">channelGroupList</a>(array $filter = array())</div>
|
|
<div class="line"><a name="l01357"></a><span class="lineno"> 1357</span>  {</div>
|
|
<div class="line"><a name="l01358"></a><span class="lineno"> 1358</span>  <span class="keywordflow">if</span>($this->cgroupList === null)</div>
|
|
<div class="line"><a name="l01359"></a><span class="lineno"> 1359</span>  {</div>
|
|
<div class="line"><a name="l01360"></a><span class="lineno"> 1360</span>  $this->cgroupList = $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"channelgrouplist"</span>)->toAssocArray(<span class="stringliteral">"cgid"</span>);</div>
|
|
<div class="line"><a name="l01361"></a><span class="lineno"> 1361</span> </div>
|
|
<div class="line"><a name="l01362"></a><span class="lineno"> 1362</span>  <span class="keywordflow">foreach</span>($this->cgroupList as $cgid => $group)</div>
|
|
<div class="line"><a name="l01363"></a><span class="lineno"> 1363</span>  {</div>
|
|
<div class="line"><a name="l01364"></a><span class="lineno"> 1364</span>  $this->cgroupList[$cgid] = <span class="keyword">new</span> <a class="code" href="class_team_speak3___node___channelgroup.html" title="Class describing a TeamSpeak 3 channel group and all it's parameters. ">TeamSpeak3_Node_Channelgroup</a>($this, $group);</div>
|
|
<div class="line"><a name="l01365"></a><span class="lineno"> 1365</span>  }</div>
|
|
<div class="line"><a name="l01366"></a><span class="lineno"> 1366</span> </div>
|
|
<div class="line"><a name="l01367"></a><span class="lineno"> 1367</span>  uasort($this->cgroupList, array(__CLASS__, <span class="stringliteral">"sortGroupList"</span>));</div>
|
|
<div class="line"><a name="l01368"></a><span class="lineno"> 1368</span>  }</div>
|
|
<div class="line"><a name="l01369"></a><span class="lineno"> 1369</span> </div>
|
|
<div class="line"><a name="l01370"></a><span class="lineno"> 1370</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#ad826df3c71029ca48839dbe9aa3559b8" title="Filters given node list array using specified filter rules. ">filterList</a>($this->cgroupList, $filter);</div>
|
|
<div class="line"><a name="l01371"></a><span class="lineno"> 1371</span>  }</div>
|
|
<div class="line"><a name="l01372"></a><span class="lineno"> 1372</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01373"></a><span class="lineno"> 1373</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01374"></a><span class="lineno"> 1374</span> <span class="comment"> * Resets the list of channel groups.</span></div>
|
|
<div class="line"><a name="l01375"></a><span class="lineno"> 1375</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01376"></a><span class="lineno"> 1376</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01377"></a><span class="lineno"> 1377</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01378"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a529b1954afa6d9c93eb1c75e4b529a2d"> 1378</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a529b1954afa6d9c93eb1c75e4b529a2d" title="Resets the list of channel groups. ">channelGroupListReset</a>()</div>
|
|
<div class="line"><a name="l01379"></a><span class="lineno"> 1379</span>  {</div>
|
|
<div class="line"><a name="l01380"></a><span class="lineno"> 1380</span>  $this->cgroupList = null;</div>
|
|
<div class="line"><a name="l01381"></a><span class="lineno"> 1381</span>  }</div>
|
|
<div class="line"><a name="l01382"></a><span class="lineno"> 1382</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01383"></a><span class="lineno"> 1383</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01384"></a><span class="lineno"> 1384</span> <span class="comment"> * Creates a new channel group using the name specified with $name and returns its ID.</span></div>
|
|
<div class="line"><a name="l01385"></a><span class="lineno"> 1385</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01386"></a><span class="lineno"> 1386</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l01387"></a><span class="lineno"> 1387</span> <span class="comment"> * @param integer $type</span></div>
|
|
<div class="line"><a name="l01388"></a><span class="lineno"> 1388</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l01389"></a><span class="lineno"> 1389</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01390"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a9cbda0c1f2afcd8fdcf8b558b7d03e56"> 1390</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a9cbda0c1f2afcd8fdcf8b558b7d03e56" title="Creates a new channel group using the name specified with $name and returns its ID. ">channelGroupCreate</a>($name, $type = <a class="code" href="class_team_speak3.html#a6e018ed33e01f80861a9649f5fbdcb05" title="1: regular group (used for regular clients) ">TeamSpeak3::GROUP_DBTYPE_REGULAR</a>)</div>
|
|
<div class="line"><a name="l01391"></a><span class="lineno"> 1391</span>  {</div>
|
|
<div class="line"><a name="l01392"></a><span class="lineno"> 1392</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a529b1954afa6d9c93eb1c75e4b529a2d" title="Resets the list of channel groups. ">channelGroupListReset</a>();</div>
|
|
<div class="line"><a name="l01393"></a><span class="lineno"> 1393</span> </div>
|
|
<div class="line"><a name="l01394"></a><span class="lineno"> 1394</span>  $cgid = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelgroupadd"</span>, array(<span class="stringliteral">"name"</span> => $name, <span class="stringliteral">"type"</span> => $type))->toList();</div>
|
|
<div class="line"><a name="l01395"></a><span class="lineno"> 1395</span> </div>
|
|
<div class="line"><a name="l01396"></a><span class="lineno"> 1396</span>  <span class="keywordflow">return</span> $cgid[<span class="stringliteral">"cgid"</span>];</div>
|
|
<div class="line"><a name="l01397"></a><span class="lineno"> 1397</span>  }</div>
|
|
<div class="line"><a name="l01398"></a><span class="lineno"> 1398</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01399"></a><span class="lineno"> 1399</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01400"></a><span class="lineno"> 1400</span> <span class="comment"> * Creates a copy of an existing channel group specified by $scgid and returns the new groups ID.</span></div>
|
|
<div class="line"><a name="l01401"></a><span class="lineno"> 1401</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01402"></a><span class="lineno"> 1402</span> <span class="comment"> * @param integer $scgid</span></div>
|
|
<div class="line"><a name="l01403"></a><span class="lineno"> 1403</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l01404"></a><span class="lineno"> 1404</span> <span class="comment"> * @param integer $tcgid</span></div>
|
|
<div class="line"><a name="l01405"></a><span class="lineno"> 1405</span> <span class="comment"> * @param integer $type</span></div>
|
|
<div class="line"><a name="l01406"></a><span class="lineno"> 1406</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l01407"></a><span class="lineno"> 1407</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01408"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ae4ec84a2bad70c6bc88b13656d2bbea6"> 1408</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ae4ec84a2bad70c6bc88b13656d2bbea6" title="Creates a copy of an existing channel group specified by $scgid and returns the new groups ID...">channelGroupCopy</a>($scgid, $name = null, $tcgid = 0, $type = <a class="code" href="class_team_speak3.html#a6e018ed33e01f80861a9649f5fbdcb05" title="1: regular group (used for regular clients) ">TeamSpeak3::GROUP_DBTYPE_REGULAR</a>)</div>
|
|
<div class="line"><a name="l01409"></a><span class="lineno"> 1409</span>  {</div>
|
|
<div class="line"><a name="l01410"></a><span class="lineno"> 1410</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a529b1954afa6d9c93eb1c75e4b529a2d" title="Resets the list of channel groups. ">channelGroupListReset</a>();</div>
|
|
<div class="line"><a name="l01411"></a><span class="lineno"> 1411</span> </div>
|
|
<div class="line"><a name="l01412"></a><span class="lineno"> 1412</span>  $cgid = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelgroupcopy"</span>, array(<span class="stringliteral">"scgid"</span> => $scgid, <span class="stringliteral">"tcgid"</span> => $tcgid, <span class="stringliteral">"name"</span> => $name, <span class="stringliteral">"type"</span> => $type))->toList();</div>
|
|
<div class="line"><a name="l01413"></a><span class="lineno"> 1413</span> </div>
|
|
<div class="line"><a name="l01414"></a><span class="lineno"> 1414</span>  <span class="keywordflow">if</span>($tcgid && $name)</div>
|
|
<div class="line"><a name="l01415"></a><span class="lineno"> 1415</span>  {</div>
|
|
<div class="line"><a name="l01416"></a><span class="lineno"> 1416</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a87eed3ba8fc9c48f40b84fb54fbf3584" title="Renames the channel group specified with $cgid. ">channelGroupRename</a>($tcgid, $name);</div>
|
|
<div class="line"><a name="l01417"></a><span class="lineno"> 1417</span>  }</div>
|
|
<div class="line"><a name="l01418"></a><span class="lineno"> 1418</span> </div>
|
|
<div class="line"><a name="l01419"></a><span class="lineno"> 1419</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3___node___abstract.html#ad22d04a2800ae672f6117de3afb0e9c4">count</a>($cgid) ? $cgid[<span class="stringliteral">"cgid"</span>] : intval($tcgid);</div>
|
|
<div class="line"><a name="l01420"></a><span class="lineno"> 1420</span>  }</div>
|
|
<div class="line"><a name="l01421"></a><span class="lineno"> 1421</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01422"></a><span class="lineno"> 1422</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01423"></a><span class="lineno"> 1423</span> <span class="comment"> * Renames the channel group specified with $cgid.</span></div>
|
|
<div class="line"><a name="l01424"></a><span class="lineno"> 1424</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01425"></a><span class="lineno"> 1425</span> <span class="comment"> * @param integer $cgid</span></div>
|
|
<div class="line"><a name="l01426"></a><span class="lineno"> 1426</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l01427"></a><span class="lineno"> 1427</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01428"></a><span class="lineno"> 1428</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01429"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a87eed3ba8fc9c48f40b84fb54fbf3584"> 1429</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a87eed3ba8fc9c48f40b84fb54fbf3584" title="Renames the channel group specified with $cgid. ">channelGroupRename</a>($cgid, $name)</div>
|
|
<div class="line"><a name="l01430"></a><span class="lineno"> 1430</span>  {</div>
|
|
<div class="line"><a name="l01431"></a><span class="lineno"> 1431</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a529b1954afa6d9c93eb1c75e4b529a2d" title="Resets the list of channel groups. ">channelGroupListReset</a>();</div>
|
|
<div class="line"><a name="l01432"></a><span class="lineno"> 1432</span> </div>
|
|
<div class="line"><a name="l01433"></a><span class="lineno"> 1433</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelgrouprename"</span>, array(<span class="stringliteral">"cgid"</span> => $cgid, <span class="stringliteral">"name"</span> => $name));</div>
|
|
<div class="line"><a name="l01434"></a><span class="lineno"> 1434</span>  }</div>
|
|
<div class="line"><a name="l01435"></a><span class="lineno"> 1435</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01436"></a><span class="lineno"> 1436</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01437"></a><span class="lineno"> 1437</span> <span class="comment"> * Deletes the channel group specified with $cgid. If $force is set to 1, the channel group</span></div>
|
|
<div class="line"><a name="l01438"></a><span class="lineno"> 1438</span> <span class="comment"> * will be deleted even if there are clients within.</span></div>
|
|
<div class="line"><a name="l01439"></a><span class="lineno"> 1439</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01440"></a><span class="lineno"> 1440</span> <span class="comment"> * @param integer $sgid</span></div>
|
|
<div class="line"><a name="l01441"></a><span class="lineno"> 1441</span> <span class="comment"> * @param boolean $force</span></div>
|
|
<div class="line"><a name="l01442"></a><span class="lineno"> 1442</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01443"></a><span class="lineno"> 1443</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01444"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aab0725d35c8c4f8c075e85418b9b5955"> 1444</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aab0725d35c8c4f8c075e85418b9b5955" title="Deletes the channel group specified with $cgid. ">channelGroupDelete</a>($cgid, $force = FALSE)</div>
|
|
<div class="line"><a name="l01445"></a><span class="lineno"> 1445</span>  {</div>
|
|
<div class="line"><a name="l01446"></a><span class="lineno"> 1446</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a529b1954afa6d9c93eb1c75e4b529a2d" title="Resets the list of channel groups. ">channelGroupListReset</a>();</div>
|
|
<div class="line"><a name="l01447"></a><span class="lineno"> 1447</span> </div>
|
|
<div class="line"><a name="l01448"></a><span class="lineno"> 1448</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelgroupdel"</span>, array(<span class="stringliteral">"cgid"</span> => $cgid, <span class="stringliteral">"force"</span> => $force));</div>
|
|
<div class="line"><a name="l01449"></a><span class="lineno"> 1449</span>  }</div>
|
|
<div class="line"><a name="l01450"></a><span class="lineno"> 1450</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01451"></a><span class="lineno"> 1451</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01452"></a><span class="lineno"> 1452</span> <span class="comment"> * Returns the TeamSpeak3_Node_Channelgroup object matching the given ID.</span></div>
|
|
<div class="line"><a name="l01453"></a><span class="lineno"> 1453</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01454"></a><span class="lineno"> 1454</span> <span class="comment"> * @param integer $cgid</span></div>
|
|
<div class="line"><a name="l01455"></a><span class="lineno"> 1455</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l01456"></a><span class="lineno"> 1456</span> <span class="comment"> * @return TeamSpeak3_Node_Channelgroup</span></div>
|
|
<div class="line"><a name="l01457"></a><span class="lineno"> 1457</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01458"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a7ddb6b6324cf20c1ec0166d98914670e"> 1458</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a7ddb6b6324cf20c1ec0166d98914670e" title="Returns the TeamSpeak3_Node_Channelgroup object matching the given ID. ">channelGroupGetById</a>($cgid)</div>
|
|
<div class="line"><a name="l01459"></a><span class="lineno"> 1459</span>  {</div>
|
|
<div class="line"><a name="l01460"></a><span class="lineno"> 1460</span>  <span class="keywordflow">if</span>(!array_key_exists((<span class="keywordtype">string</span>) $cgid, $this-><a class="code" href="class_team_speak3___node___server.html#a442c9127e61b6e1d31e368af71443b1a" title="Returns a list of channel groups available. ">channelGroupList</a>()))</div>
|
|
<div class="line"><a name="l01461"></a><span class="lineno"> 1461</span>  {</div>
|
|
<div class="line"><a name="l01462"></a><span class="lineno"> 1462</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid groupID"</span>, 0xA00);</div>
|
|
<div class="line"><a name="l01463"></a><span class="lineno"> 1463</span>  }</div>
|
|
<div class="line"><a name="l01464"></a><span class="lineno"> 1464</span> </div>
|
|
<div class="line"><a name="l01465"></a><span class="lineno"> 1465</span>  <span class="keywordflow">return</span> $this->cgroupList[intval((<span class="keywordtype">string</span>) $cgid)];</div>
|
|
<div class="line"><a name="l01466"></a><span class="lineno"> 1466</span>  }</div>
|
|
<div class="line"><a name="l01467"></a><span class="lineno"> 1467</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01468"></a><span class="lineno"> 1468</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01469"></a><span class="lineno"> 1469</span> <span class="comment"> * Returns the TeamSpeak3_Node_Channelgroup object matching the given name.</span></div>
|
|
<div class="line"><a name="l01470"></a><span class="lineno"> 1470</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01471"></a><span class="lineno"> 1471</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l01472"></a><span class="lineno"> 1472</span> <span class="comment"> * @param integer $type</span></div>
|
|
<div class="line"><a name="l01473"></a><span class="lineno"> 1473</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l01474"></a><span class="lineno"> 1474</span> <span class="comment"> * @return TeamSpeak3_Node_Channelgroup</span></div>
|
|
<div class="line"><a name="l01475"></a><span class="lineno"> 1475</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01476"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a12649be6d62d7aa194323bdd144a42c7"> 1476</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a12649be6d62d7aa194323bdd144a42c7" title="Returns the TeamSpeak3_Node_Channelgroup object matching the given name. ">channelGroupGetByName</a>($name, $type = <a class="code" href="class_team_speak3.html#a6e018ed33e01f80861a9649f5fbdcb05" title="1: regular group (used for regular clients) ">TeamSpeak3::GROUP_DBTYPE_REGULAR</a>)</div>
|
|
<div class="line"><a name="l01477"></a><span class="lineno"> 1477</span>  {</div>
|
|
<div class="line"><a name="l01478"></a><span class="lineno"> 1478</span>  <span class="keywordflow">foreach</span>($this-><a class="code" href="class_team_speak3___node___server.html#a442c9127e61b6e1d31e368af71443b1a" title="Returns a list of channel groups available. ">channelGroupList</a>() as $group)</div>
|
|
<div class="line"><a name="l01479"></a><span class="lineno"> 1479</span>  {</div>
|
|
<div class="line"><a name="l01480"></a><span class="lineno"> 1480</span>  <span class="keywordflow">if</span>($group[<span class="stringliteral">"name"</span>] == $name && $group[<span class="stringliteral">"type"</span>] == $type) <span class="keywordflow">return</span> $group;</div>
|
|
<div class="line"><a name="l01481"></a><span class="lineno"> 1481</span>  }</div>
|
|
<div class="line"><a name="l01482"></a><span class="lineno"> 1482</span> </div>
|
|
<div class="line"><a name="l01483"></a><span class="lineno"> 1483</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid groupID"</span>, 0xA00);</div>
|
|
<div class="line"><a name="l01484"></a><span class="lineno"> 1484</span>  }</div>
|
|
<div class="line"><a name="l01485"></a><span class="lineno"> 1485</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01486"></a><span class="lineno"> 1486</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01487"></a><span class="lineno"> 1487</span> <span class="comment"> * Returns a list of permissions assigned to the channel group specified.</span></div>
|
|
<div class="line"><a name="l01488"></a><span class="lineno"> 1488</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01489"></a><span class="lineno"> 1489</span> <span class="comment"> * @param integer $cgid</span></div>
|
|
<div class="line"><a name="l01490"></a><span class="lineno"> 1490</span> <span class="comment"> * @param boolean $permsid</span></div>
|
|
<div class="line"><a name="l01491"></a><span class="lineno"> 1491</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01492"></a><span class="lineno"> 1492</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01493"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a6866211126530af14d9c60976960b39f"> 1493</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a6866211126530af14d9c60976960b39f" title="Returns a list of permissions assigned to the channel group specified. ">channelGroupPermList</a>($cgid, $permsid = FALSE)</div>
|
|
<div class="line"><a name="l01494"></a><span class="lineno"> 1494</span>  {</div>
|
|
<div class="line"><a name="l01495"></a><span class="lineno"> 1495</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelgrouppermlist"</span>, array(<span class="stringliteral">"cgid"</span> => $cgid, $permsid ? <span class="stringliteral">"-permsid"</span> : null))->toAssocArray($permsid ? <span class="stringliteral">"permsid"</span> : <span class="stringliteral">"permid"</span>);</div>
|
|
<div class="line"><a name="l01496"></a><span class="lineno"> 1496</span>  }</div>
|
|
<div class="line"><a name="l01497"></a><span class="lineno"> 1497</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01498"></a><span class="lineno"> 1498</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01499"></a><span class="lineno"> 1499</span> <span class="comment"> * Adds a set of specified permissions to the channel group specified. Multiple permissions</span></div>
|
|
<div class="line"><a name="l01500"></a><span class="lineno"> 1500</span> <span class="comment"> * can be added by providing the two parameters of each permission in separate arrays.</span></div>
|
|
<div class="line"><a name="l01501"></a><span class="lineno"> 1501</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01502"></a><span class="lineno"> 1502</span> <span class="comment"> * @param integer $cgid</span></div>
|
|
<div class="line"><a name="l01503"></a><span class="lineno"> 1503</span> <span class="comment"> * @param integer $permid</span></div>
|
|
<div class="line"><a name="l01504"></a><span class="lineno"> 1504</span> <span class="comment"> * @param integer $permvalue</span></div>
|
|
<div class="line"><a name="l01505"></a><span class="lineno"> 1505</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01506"></a><span class="lineno"> 1506</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01507"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a96f49940c54b63c3611702d701f4d32f"> 1507</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a96f49940c54b63c3611702d701f4d32f" title="Adds a set of specified permissions to the channel group specified. ">channelGroupPermAssign</a>($cgid, $permid, $permvalue)</div>
|
|
<div class="line"><a name="l01508"></a><span class="lineno"> 1508</span>  {</div>
|
|
<div class="line"><a name="l01509"></a><span class="lineno"> 1509</span>  <span class="keywordflow">if</span>(!is_array($permid))</div>
|
|
<div class="line"><a name="l01510"></a><span class="lineno"> 1510</span>  {</div>
|
|
<div class="line"><a name="l01511"></a><span class="lineno"> 1511</span>  $permident = (is_numeric($permid)) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l01512"></a><span class="lineno"> 1512</span>  }</div>
|
|
<div class="line"><a name="l01513"></a><span class="lineno"> 1513</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l01514"></a><span class="lineno"> 1514</span>  {</div>
|
|
<div class="line"><a name="l01515"></a><span class="lineno"> 1515</span>  $permident = (is_numeric(<a class="code" href="class_team_speak3___node___abstract.html#a1c78dbb54df73f8c5dabe41ebd476207">current</a>($permid))) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l01516"></a><span class="lineno"> 1516</span>  }</div>
|
|
<div class="line"><a name="l01517"></a><span class="lineno"> 1517</span> </div>
|
|
<div class="line"><a name="l01518"></a><span class="lineno"> 1518</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelgroupaddperm"</span>, array(<span class="stringliteral">"cgid"</span> => $cgid, $permident => $permid, <span class="stringliteral">"permvalue"</span> => $permvalue));</div>
|
|
<div class="line"><a name="l01519"></a><span class="lineno"> 1519</span>  }</div>
|
|
<div class="line"><a name="l01520"></a><span class="lineno"> 1520</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01521"></a><span class="lineno"> 1521</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01522"></a><span class="lineno"> 1522</span> <span class="comment"> * Removes a set of specified permissions from the channel group specified with $cgid. Multiple</span></div>
|
|
<div class="line"><a name="l01523"></a><span class="lineno"> 1523</span> <span class="comment"> * permissions can be removed at once.</span></div>
|
|
<div class="line"><a name="l01524"></a><span class="lineno"> 1524</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01525"></a><span class="lineno"> 1525</span> <span class="comment"> * @param integer $cgid</span></div>
|
|
<div class="line"><a name="l01526"></a><span class="lineno"> 1526</span> <span class="comment"> * @param integer $permid</span></div>
|
|
<div class="line"><a name="l01527"></a><span class="lineno"> 1527</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01528"></a><span class="lineno"> 1528</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01529"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aa16f874d9d2403b4d4182bfb39729ced"> 1529</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aa16f874d9d2403b4d4182bfb39729ced" title="Removes a set of specified permissions from the channel group specified with $cgid. ">channelGroupPermRemove</a>($cgid, $permid)</div>
|
|
<div class="line"><a name="l01530"></a><span class="lineno"> 1530</span>  {</div>
|
|
<div class="line"><a name="l01531"></a><span class="lineno"> 1531</span>  <span class="keywordflow">if</span>(!is_array($permid))</div>
|
|
<div class="line"><a name="l01532"></a><span class="lineno"> 1532</span>  {</div>
|
|
<div class="line"><a name="l01533"></a><span class="lineno"> 1533</span>  $permident = (is_numeric($permid)) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l01534"></a><span class="lineno"> 1534</span>  }</div>
|
|
<div class="line"><a name="l01535"></a><span class="lineno"> 1535</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l01536"></a><span class="lineno"> 1536</span>  {</div>
|
|
<div class="line"><a name="l01537"></a><span class="lineno"> 1537</span>  $permident = (is_numeric(<a class="code" href="class_team_speak3___node___abstract.html#a1c78dbb54df73f8c5dabe41ebd476207">current</a>($permid))) ? <span class="stringliteral">"permid"</span> : <span class="stringliteral">"permsid"</span>;</div>
|
|
<div class="line"><a name="l01538"></a><span class="lineno"> 1538</span>  }</div>
|
|
<div class="line"><a name="l01539"></a><span class="lineno"> 1539</span> </div>
|
|
<div class="line"><a name="l01540"></a><span class="lineno"> 1540</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelgroupdelperm"</span>, array(<span class="stringliteral">"cgid"</span> => $cgid, $permident => $permid));</div>
|
|
<div class="line"><a name="l01541"></a><span class="lineno"> 1541</span>  }</div>
|
|
<div class="line"><a name="l01542"></a><span class="lineno"> 1542</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01543"></a><span class="lineno"> 1543</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01544"></a><span class="lineno"> 1544</span> <span class="comment"> * Returns all the client and/or channel IDs currently assigned to channel groups. All three</span></div>
|
|
<div class="line"><a name="l01545"></a><span class="lineno"> 1545</span> <span class="comment"> * parameters are optional so you're free to choose the most suitable combination for your</span></div>
|
|
<div class="line"><a name="l01546"></a><span class="lineno"> 1546</span> <span class="comment"> * requirements.</span></div>
|
|
<div class="line"><a name="l01547"></a><span class="lineno"> 1547</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01548"></a><span class="lineno"> 1548</span> <span class="comment"> * @param integer $cgid</span></div>
|
|
<div class="line"><a name="l01549"></a><span class="lineno"> 1549</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l01550"></a><span class="lineno"> 1550</span> <span class="comment"> * @param integer $cldbid</span></div>
|
|
<div class="line"><a name="l01551"></a><span class="lineno"> 1551</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01552"></a><span class="lineno"> 1552</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01553"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a6a560f0bf64a8c22c1b2542874093ba0"> 1553</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a6a560f0bf64a8c22c1b2542874093ba0" title="Returns all the client and/or channel IDs currently assigned to channel groups. ">channelGroupClientList</a>($cgid = null, $cid = null, $cldbid = null)</div>
|
|
<div class="line"><a name="l01554"></a><span class="lineno"> 1554</span>  {</div>
|
|
<div class="line"><a name="l01555"></a><span class="lineno"> 1555</span>  <span class="keywordflow">if</span>($this[<span class="stringliteral">"virtualserver_default_channel_group"</span>] == $cgid)</div>
|
|
<div class="line"><a name="l01556"></a><span class="lineno"> 1556</span>  {</div>
|
|
<div class="line"><a name="l01557"></a><span class="lineno"> 1557</span>  <span class="keywordflow">return</span> array();</div>
|
|
<div class="line"><a name="l01558"></a><span class="lineno"> 1558</span>  }</div>
|
|
<div class="line"><a name="l01559"></a><span class="lineno"> 1559</span> </div>
|
|
<div class="line"><a name="l01560"></a><span class="lineno"> 1560</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"channelgroupclientlist"</span>, array(<span class="stringliteral">"cgid"</span> => $cgid, <span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"cldbid"</span> => $cldbid))->toArray();</div>
|
|
<div class="line"><a name="l01561"></a><span class="lineno"> 1561</span>  }</div>
|
|
<div class="line"><a name="l01562"></a><span class="lineno"> 1562</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01563"></a><span class="lineno"> 1563</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01564"></a><span class="lineno"> 1564</span> <span class="comment"> * Restores the default permission settings on the virtual server and returns a new initial</span></div>
|
|
<div class="line"><a name="l01565"></a><span class="lineno"> 1565</span> <span class="comment"> * administrator privilege key.</span></div>
|
|
<div class="line"><a name="l01566"></a><span class="lineno"> 1566</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01567"></a><span class="lineno"> 1567</span> <span class="comment"> * @return TeamSpeak3_Helper_String</span></div>
|
|
<div class="line"><a name="l01568"></a><span class="lineno"> 1568</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01569"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a6ee64afd6c312ff8644725823ab0b078"> 1569</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a6ee64afd6c312ff8644725823ab0b078" title="Restores the default permission settings on the virtual server and returns a new initial administrato...">permReset</a>()</div>
|
|
<div class="line"><a name="l01570"></a><span class="lineno"> 1570</span>  {</div>
|
|
<div class="line"><a name="l01571"></a><span class="lineno"> 1571</span>  $token = $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"permreset"</span>)->toList();</div>
|
|
<div class="line"><a name="l01572"></a><span class="lineno"> 1572</span> </div>
|
|
<div class="line"><a name="l01573"></a><span class="lineno"> 1573</span>  <a class="code" href="class_team_speak3___helper___signal.html#af156036673730a599c10c8cbfd5e50bf" title="Returns a singleton instance of TeamSpeak3_Helper_Signal. ">TeamSpeak3_Helper_Signal::getInstance</a>()->emit(<span class="stringliteral">"notifyTokencreated"</span>, $this, $token[<span class="stringliteral">"token"</span>]);</div>
|
|
<div class="line"><a name="l01574"></a><span class="lineno"> 1574</span> </div>
|
|
<div class="line"><a name="l01575"></a><span class="lineno"> 1575</span>  <span class="keywordflow">return</span> $token[<span class="stringliteral">"token"</span>];</div>
|
|
<div class="line"><a name="l01576"></a><span class="lineno"> 1576</span>  }</div>
|
|
<div class="line"><a name="l01577"></a><span class="lineno"> 1577</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01578"></a><span class="lineno"> 1578</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01579"></a><span class="lineno"> 1579</span> <span class="comment"> * Removes any assignment of the permission specified with $permid on the selected virtual server</span></div>
|
|
<div class="line"><a name="l01580"></a><span class="lineno"> 1580</span> <span class="comment"> * and returns the number of removed assignments on success.</span></div>
|
|
<div class="line"><a name="l01581"></a><span class="lineno"> 1581</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01582"></a><span class="lineno"> 1582</span> <span class="comment"> * @param integer $permid</span></div>
|
|
<div class="line"><a name="l01583"></a><span class="lineno"> 1583</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l01584"></a><span class="lineno"> 1584</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01585"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a4064b80b0f7796367e61438ae9a0cd5a"> 1585</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a4064b80b0f7796367e61438ae9a0cd5a" title="Removes any assignment of the permission specified with $permid on the selected virtual server and re...">permRemoveAny</a>($permid)</div>
|
|
<div class="line"><a name="l01586"></a><span class="lineno"> 1586</span>  {</div>
|
|
<div class="line"><a name="l01587"></a><span class="lineno"> 1587</span>  $assignments = $this->permissionFind($permid);</div>
|
|
<div class="line"><a name="l01588"></a><span class="lineno"> 1588</span> </div>
|
|
<div class="line"><a name="l01589"></a><span class="lineno"> 1589</span>  <span class="keywordflow">foreach</span>($assignments as $assignment)</div>
|
|
<div class="line"><a name="l01590"></a><span class="lineno"> 1590</span>  {</div>
|
|
<div class="line"><a name="l01591"></a><span class="lineno"> 1591</span>  <span class="keywordflow">switch</span>($assignment[<span class="stringliteral">"t"</span>])</div>
|
|
<div class="line"><a name="l01592"></a><span class="lineno"> 1592</span>  {</div>
|
|
<div class="line"><a name="l01593"></a><span class="lineno"> 1593</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#a0772e3a79ac03d3acb657e07dad63a0e" title="0: server group permission ">TeamSpeak3::PERM_TYPE_SERVERGROUP</a>:</div>
|
|
<div class="line"><a name="l01594"></a><span class="lineno"> 1594</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a3b7ead504bbc7f2070f46d19e072afd9" title="Removes a set of specified permissions from the server group specified with $sgid. ">serverGroupPermRemove</a>($assignment[<span class="stringliteral">"id1"</span>], $assignment[<span class="stringliteral">"p"</span>]);</div>
|
|
<div class="line"><a name="l01595"></a><span class="lineno"> 1595</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l01596"></a><span class="lineno"> 1596</span> </div>
|
|
<div class="line"><a name="l01597"></a><span class="lineno"> 1597</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#a9ea90147fb0486786931015e4d64abba" title="1: client specific permission ">TeamSpeak3::PERM_TYPE_CLIENT</a>:</div>
|
|
<div class="line"><a name="l01598"></a><span class="lineno"> 1598</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a7ff9f7bff622429c810933b53454adb3" title="Removes a set of specified permissions from a client. ">clientPermRemove</a>($assignment[<span class="stringliteral">"id2"</span>], $assignment[<span class="stringliteral">"p"</span>]);</div>
|
|
<div class="line"><a name="l01599"></a><span class="lineno"> 1599</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l01600"></a><span class="lineno"> 1600</span> </div>
|
|
<div class="line"><a name="l01601"></a><span class="lineno"> 1601</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#a57fa7853513872a96f0adf9d3329c59b" title="2: channel specific permission ">TeamSpeak3::PERM_TYPE_CHANNEL</a>:</div>
|
|
<div class="line"><a name="l01602"></a><span class="lineno"> 1602</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a7d88676f4ef80466b1a24945c49a006b" title="Removes a set of specified permissions from a channel. ">channelPermRemove</a>($assignment[<span class="stringliteral">"id2"</span>], $assignment[<span class="stringliteral">"p"</span>]);</div>
|
|
<div class="line"><a name="l01603"></a><span class="lineno"> 1603</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l01604"></a><span class="lineno"> 1604</span> </div>
|
|
<div class="line"><a name="l01605"></a><span class="lineno"> 1605</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#a2a930337bd67c2c2893b3afad902b440" title="3: channel group permission ">TeamSpeak3::PERM_TYPE_CHANNELGROUP</a>:</div>
|
|
<div class="line"><a name="l01606"></a><span class="lineno"> 1606</span>  $this-><a class="code" href="class_team_speak3___node___server.html#aa16f874d9d2403b4d4182bfb39729ced" title="Removes a set of specified permissions from the channel group specified with $cgid. ">channelGroupPermRemove</a>($assignment[<span class="stringliteral">"id1"</span>], $assignment[<span class="stringliteral">"p"</span>]);</div>
|
|
<div class="line"><a name="l01607"></a><span class="lineno"> 1607</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l01608"></a><span class="lineno"> 1608</span> </div>
|
|
<div class="line"><a name="l01609"></a><span class="lineno"> 1609</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#a5324e065c2ed9c98c0931654d388610f" title="4: channel-client specific permission ">TeamSpeak3::PERM_TYPE_CHANNELCLIENT</a>:</div>
|
|
<div class="line"><a name="l01610"></a><span class="lineno"> 1610</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a16866a89acc0ebab56ac281fd481fa5c" title="Removes a set of specified permissions from a client in a specific channel. ">channelClientPermRemove</a>($assignment[<span class="stringliteral">"id2"</span>], $assignment[<span class="stringliteral">"id1"</span>], $assignment[<span class="stringliteral">"p"</span>]);</div>
|
|
<div class="line"><a name="l01611"></a><span class="lineno"> 1611</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l01612"></a><span class="lineno"> 1612</span> </div>
|
|
<div class="line"><a name="l01613"></a><span class="lineno"> 1613</span>  <span class="keywordflow">default</span>:</div>
|
|
<div class="line"><a name="l01614"></a><span class="lineno"> 1614</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"convert error"</span>, 0x604);</div>
|
|
<div class="line"><a name="l01615"></a><span class="lineno"> 1615</span>  }</div>
|
|
<div class="line"><a name="l01616"></a><span class="lineno"> 1616</span>  }</div>
|
|
<div class="line"><a name="l01617"></a><span class="lineno"> 1617</span> </div>
|
|
<div class="line"><a name="l01618"></a><span class="lineno"> 1618</span>  <span class="keywordflow">return</span> <a class="code" href="class_team_speak3___node___abstract.html#ad22d04a2800ae672f6117de3afb0e9c4">count</a>($assignments);</div>
|
|
<div class="line"><a name="l01619"></a><span class="lineno"> 1619</span>  }</div>
|
|
<div class="line"><a name="l01620"></a><span class="lineno"> 1620</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01621"></a><span class="lineno"> 1621</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01622"></a><span class="lineno"> 1622</span> <span class="comment"> * Initializes a file transfer upload. $clientftfid is an arbitrary ID to identify the file transfer on client-side.</span></div>
|
|
<div class="line"><a name="l01623"></a><span class="lineno"> 1623</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01624"></a><span class="lineno"> 1624</span> <span class="comment"> * @param integer $clientftfid</span></div>
|
|
<div class="line"><a name="l01625"></a><span class="lineno"> 1625</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l01626"></a><span class="lineno"> 1626</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l01627"></a><span class="lineno"> 1627</span> <span class="comment"> * @param integer $size</span></div>
|
|
<div class="line"><a name="l01628"></a><span class="lineno"> 1628</span> <span class="comment"> * @param string $cpw</span></div>
|
|
<div class="line"><a name="l01629"></a><span class="lineno"> 1629</span> <span class="comment"> * @param boolean $overwrite</span></div>
|
|
<div class="line"><a name="l01630"></a><span class="lineno"> 1630</span> <span class="comment"> * @param boolean $resume</span></div>
|
|
<div class="line"><a name="l01631"></a><span class="lineno"> 1631</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l01632"></a><span class="lineno"> 1632</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01633"></a><span class="lineno"> 1633</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01634"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a276cde0701f7051fd3cc33e8f1d304c2"> 1634</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a276cde0701f7051fd3cc33e8f1d304c2" title="Initializes a file transfer upload. ">transferInitUpload</a>($clientftfid, $cid, $name, $size, $cpw = <span class="stringliteral">""</span>, $overwrite = FALSE, $resume = FALSE)</div>
|
|
<div class="line"><a name="l01635"></a><span class="lineno"> 1635</span>  {</div>
|
|
<div class="line"><a name="l01636"></a><span class="lineno"> 1636</span>  $upload = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"ftinitupload"</span>, array(<span class="stringliteral">"clientftfid"</span> => $clientftfid, <span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"name"</span> => $name, <span class="stringliteral">"cpw"</span> => $cpw, <span class="stringliteral">"size"</span> => $size, <span class="stringliteral">"overwrite"</span> => $overwrite, <span class="stringliteral">"resume"</span> => $resume))->toList();</div>
|
|
<div class="line"><a name="l01637"></a><span class="lineno"> 1637</span> </div>
|
|
<div class="line"><a name="l01638"></a><span class="lineno"> 1638</span>  <span class="keywordflow">if</span>(array_key_exists(<span class="stringliteral">"status"</span>, $upload) && $upload[<span class="stringliteral">"status"</span>] != 0x00)</div>
|
|
<div class="line"><a name="l01639"></a><span class="lineno"> 1639</span>  {</div>
|
|
<div class="line"><a name="l01640"></a><span class="lineno"> 1640</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>($upload[<span class="stringliteral">"msg"</span>], $upload[<span class="stringliteral">"status"</span>]);</div>
|
|
<div class="line"><a name="l01641"></a><span class="lineno"> 1641</span>  }</div>
|
|
<div class="line"><a name="l01642"></a><span class="lineno"> 1642</span> </div>
|
|
<div class="line"><a name="l01643"></a><span class="lineno"> 1643</span>  $upload[<span class="stringliteral">"cid"</span>] = $cid;</div>
|
|
<div class="line"><a name="l01644"></a><span class="lineno"> 1644</span>  $upload[<span class="stringliteral">"file"</span>] = $name;</div>
|
|
<div class="line"><a name="l01645"></a><span class="lineno"> 1645</span> </div>
|
|
<div class="line"><a name="l01646"></a><span class="lineno"> 1646</span>  <span class="keywordflow">if</span>(!array_key_exists(<span class="stringliteral">"ip"</span>, $upload) || $upload[<span class="stringliteral">"ip"</span>]->startsWith(<span class="stringliteral">"0.0.0.0"</span>))</div>
|
|
<div class="line"><a name="l01647"></a><span class="lineno"> 1647</span>  {</div>
|
|
<div class="line"><a name="l01648"></a><span class="lineno"> 1648</span>  $upload[<span class="stringliteral">"ip"</span>] = $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->getAdapterHost();</div>
|
|
<div class="line"><a name="l01649"></a><span class="lineno"> 1649</span>  $upload[<span class="stringliteral">"host"</span>] = $upload[<span class="stringliteral">"ip"</span>];</div>
|
|
<div class="line"><a name="l01650"></a><span class="lineno"> 1650</span>  }</div>
|
|
<div class="line"><a name="l01651"></a><span class="lineno"> 1651</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l01652"></a><span class="lineno"> 1652</span>  {</div>
|
|
<div class="line"><a name="l01653"></a><span class="lineno"> 1653</span>  $upload[<span class="stringliteral">"ip"</span>] = $upload[<span class="stringliteral">"ip"</span>]->section(<span class="stringliteral">","</span>);</div>
|
|
<div class="line"><a name="l01654"></a><span class="lineno"> 1654</span>  $upload[<span class="stringliteral">"host"</span>] = $upload[<span class="stringliteral">"ip"</span>];</div>
|
|
<div class="line"><a name="l01655"></a><span class="lineno"> 1655</span>  }</div>
|
|
<div class="line"><a name="l01656"></a><span class="lineno"> 1656</span> </div>
|
|
<div class="line"><a name="l01657"></a><span class="lineno"> 1657</span>  <a class="code" href="class_team_speak3___helper___signal.html#af156036673730a599c10c8cbfd5e50bf" title="Returns a singleton instance of TeamSpeak3_Helper_Signal. ">TeamSpeak3_Helper_Signal::getInstance</a>()->emit(<span class="stringliteral">"filetransferUploadInit"</span>, $upload[<span class="stringliteral">"ftkey"</span>], $upload);</div>
|
|
<div class="line"><a name="l01658"></a><span class="lineno"> 1658</span> </div>
|
|
<div class="line"><a name="l01659"></a><span class="lineno"> 1659</span>  <span class="keywordflow">return</span> $upload;</div>
|
|
<div class="line"><a name="l01660"></a><span class="lineno"> 1660</span>  }</div>
|
|
<div class="line"><a name="l01661"></a><span class="lineno"> 1661</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01662"></a><span class="lineno"> 1662</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01663"></a><span class="lineno"> 1663</span> <span class="comment"> * Initializes a file transfer download. $clientftfid is an arbitrary ID to identify the file transfer on client-side.</span></div>
|
|
<div class="line"><a name="l01664"></a><span class="lineno"> 1664</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01665"></a><span class="lineno"> 1665</span> <span class="comment"> * @param integer $clientftfid</span></div>
|
|
<div class="line"><a name="l01666"></a><span class="lineno"> 1666</span> <span class="comment"> * @param integer $cid</span></div>
|
|
<div class="line"><a name="l01667"></a><span class="lineno"> 1667</span> <span class="comment"> * @param string $name</span></div>
|
|
<div class="line"><a name="l01668"></a><span class="lineno"> 1668</span> <span class="comment"> * @param string $cpw</span></div>
|
|
<div class="line"><a name="l01669"></a><span class="lineno"> 1669</span> <span class="comment"> * @param integer $seekpos</span></div>
|
|
<div class="line"><a name="l01670"></a><span class="lineno"> 1670</span> <span class="comment"> * @throws TeamSpeak3_Adapter_ServerQuery_Exception</span></div>
|
|
<div class="line"><a name="l01671"></a><span class="lineno"> 1671</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01672"></a><span class="lineno"> 1672</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01673"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a4e8e46758ad2c7a502c04f22af3e47ca"> 1673</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a4e8e46758ad2c7a502c04f22af3e47ca" title="Initializes a file transfer download. ">transferInitDownload</a>($clientftfid, $cid, $name, $cpw = <span class="stringliteral">""</span>, $seekpos = 0)</div>
|
|
<div class="line"><a name="l01674"></a><span class="lineno"> 1674</span>  {</div>
|
|
<div class="line"><a name="l01675"></a><span class="lineno"> 1675</span>  $download = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"ftinitdownload"</span>, array(<span class="stringliteral">"clientftfid"</span> => $clientftfid, <span class="stringliteral">"cid"</span> => $cid, <span class="stringliteral">"name"</span> => $name, <span class="stringliteral">"cpw"</span> => $cpw, <span class="stringliteral">"seekpos"</span> => $seekpos))->toList();</div>
|
|
<div class="line"><a name="l01676"></a><span class="lineno"> 1676</span> </div>
|
|
<div class="line"><a name="l01677"></a><span class="lineno"> 1677</span>  <span class="keywordflow">if</span>(array_key_exists(<span class="stringliteral">"status"</span>, $download) && $download[<span class="stringliteral">"status"</span>] != 0x00)</div>
|
|
<div class="line"><a name="l01678"></a><span class="lineno"> 1678</span>  {</div>
|
|
<div class="line"><a name="l01679"></a><span class="lineno"> 1679</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>($download[<span class="stringliteral">"msg"</span>], $download[<span class="stringliteral">"status"</span>]);</div>
|
|
<div class="line"><a name="l01680"></a><span class="lineno"> 1680</span>  }</div>
|
|
<div class="line"><a name="l01681"></a><span class="lineno"> 1681</span> </div>
|
|
<div class="line"><a name="l01682"></a><span class="lineno"> 1682</span>  $download[<span class="stringliteral">"cid"</span>] = $cid;</div>
|
|
<div class="line"><a name="l01683"></a><span class="lineno"> 1683</span>  $download[<span class="stringliteral">"file"</span>] = $name;</div>
|
|
<div class="line"><a name="l01684"></a><span class="lineno"> 1684</span> </div>
|
|
<div class="line"><a name="l01685"></a><span class="lineno"> 1685</span>  <span class="keywordflow">if</span>(!array_key_exists(<span class="stringliteral">"ip"</span>, $download) || $download[<span class="stringliteral">"ip"</span>]->startsWith(<span class="stringliteral">"0.0.0.0"</span>))</div>
|
|
<div class="line"><a name="l01686"></a><span class="lineno"> 1686</span>  {</div>
|
|
<div class="line"><a name="l01687"></a><span class="lineno"> 1687</span>  $download[<span class="stringliteral">"ip"</span>] = $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->getAdapterHost();</div>
|
|
<div class="line"><a name="l01688"></a><span class="lineno"> 1688</span>  $download[<span class="stringliteral">"host"</span>] = $download[<span class="stringliteral">"ip"</span>];</div>
|
|
<div class="line"><a name="l01689"></a><span class="lineno"> 1689</span>  }</div>
|
|
<div class="line"><a name="l01690"></a><span class="lineno"> 1690</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l01691"></a><span class="lineno"> 1691</span>  {</div>
|
|
<div class="line"><a name="l01692"></a><span class="lineno"> 1692</span>  $download[<span class="stringliteral">"ip"</span>] = $download[<span class="stringliteral">"ip"</span>]->section(<span class="stringliteral">","</span>);</div>
|
|
<div class="line"><a name="l01693"></a><span class="lineno"> 1693</span>  $download[<span class="stringliteral">"host"</span>] = $download[<span class="stringliteral">"ip"</span>];</div>
|
|
<div class="line"><a name="l01694"></a><span class="lineno"> 1694</span>  }</div>
|
|
<div class="line"><a name="l01695"></a><span class="lineno"> 1695</span> </div>
|
|
<div class="line"><a name="l01696"></a><span class="lineno"> 1696</span>  <a class="code" href="class_team_speak3___helper___signal.html#af156036673730a599c10c8cbfd5e50bf" title="Returns a singleton instance of TeamSpeak3_Helper_Signal. ">TeamSpeak3_Helper_Signal::getInstance</a>()->emit(<span class="stringliteral">"filetransferDownloadInit"</span>, $download[<span class="stringliteral">"ftkey"</span>], $download);</div>
|
|
<div class="line"><a name="l01697"></a><span class="lineno"> 1697</span> </div>
|
|
<div class="line"><a name="l01698"></a><span class="lineno"> 1698</span>  <span class="keywordflow">return</span> $download;</div>
|
|
<div class="line"><a name="l01699"></a><span class="lineno"> 1699</span>  }</div>
|
|
<div class="line"><a name="l01700"></a><span class="lineno"> 1700</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01701"></a><span class="lineno"> 1701</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01702"></a><span class="lineno"> 1702</span> <span class="comment"> * Displays a list of running file transfers on the selected virtual server. The output contains the path to</span></div>
|
|
<div class="line"><a name="l01703"></a><span class="lineno"> 1703</span> <span class="comment"> * which a file is uploaded to, the current transfer rate in bytes per second, etc.</span></div>
|
|
<div class="line"><a name="l01704"></a><span class="lineno"> 1704</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01705"></a><span class="lineno"> 1705</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01706"></a><span class="lineno"> 1706</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01707"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a54a998325257872475957ca2ba62faea"> 1707</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a54a998325257872475957ca2ba62faea" title="Displays a list of running file transfers on the selected virtual server. ">transferList</a>()</div>
|
|
<div class="line"><a name="l01708"></a><span class="lineno"> 1708</span>  {</div>
|
|
<div class="line"><a name="l01709"></a><span class="lineno"> 1709</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"ftlist"</span>)->toAssocArray(<span class="stringliteral">"serverftfid"</span>);</div>
|
|
<div class="line"><a name="l01710"></a><span class="lineno"> 1710</span>  }</div>
|
|
<div class="line"><a name="l01711"></a><span class="lineno"> 1711</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01712"></a><span class="lineno"> 1712</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01713"></a><span class="lineno"> 1713</span> <span class="comment"> * Stops the running file transfer with server-side ID $serverftfid.</span></div>
|
|
<div class="line"><a name="l01714"></a><span class="lineno"> 1714</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01715"></a><span class="lineno"> 1715</span> <span class="comment"> * @param integer $serverftfid</span></div>
|
|
<div class="line"><a name="l01716"></a><span class="lineno"> 1716</span> <span class="comment"> * @param boolean $delete</span></div>
|
|
<div class="line"><a name="l01717"></a><span class="lineno"> 1717</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01718"></a><span class="lineno"> 1718</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01719"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a6c7e742fb77bb0affe7d25dbc5aa1561"> 1719</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a6c7e742fb77bb0affe7d25dbc5aa1561" title="Stops the running file transfer with server-side ID $serverftfid. ">transferStop</a>($serverftfid, $delete = FALSE)</div>
|
|
<div class="line"><a name="l01720"></a><span class="lineno"> 1720</span>  {</div>
|
|
<div class="line"><a name="l01721"></a><span class="lineno"> 1721</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"ftstop"</span>, array(<span class="stringliteral">"serverftfid"</span> => $serverftfid, <span class="stringliteral">"delete"</span> => $delete));</div>
|
|
<div class="line"><a name="l01722"></a><span class="lineno"> 1722</span>  }</div>
|
|
<div class="line"><a name="l01723"></a><span class="lineno"> 1723</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01724"></a><span class="lineno"> 1724</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01725"></a><span class="lineno"> 1725</span> <span class="comment"> * Downloads and returns the servers icon file content.</span></div>
|
|
<div class="line"><a name="l01726"></a><span class="lineno"> 1726</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01727"></a><span class="lineno"> 1727</span> <span class="comment"> * @return TeamSpeak3_Helper_String</span></div>
|
|
<div class="line"><a name="l01728"></a><span class="lineno"> 1728</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01729"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aaeffd8b897c67a8b483eba32d2c63c9c"> 1729</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aaeffd8b897c67a8b483eba32d2c63c9c" title="Downloads and returns the servers icon file content. ">iconDownload</a>()</div>
|
|
<div class="line"><a name="l01730"></a><span class="lineno"> 1730</span>  {</div>
|
|
<div class="line"><a name="l01731"></a><span class="lineno"> 1731</span>  <span class="keywordflow">if</span>($this-><a class="code" href="class_team_speak3___node___abstract.html#aa78cba098574598dd9c0331cac1f39a1" title="Returns TRUE if the node icon has a local source. ">iconIsLocal</a>(<span class="stringliteral">"virtualserver_icon_id"</span>) || $this[<span class="stringliteral">"virtualserver_icon_id"</span>] == 0) <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l01732"></a><span class="lineno"> 1732</span> </div>
|
|
<div class="line"><a name="l01733"></a><span class="lineno"> 1733</span>  $download = $this-><a class="code" href="class_team_speak3___node___server.html#a4e8e46758ad2c7a502c04f22af3e47ca" title="Initializes a file transfer download. ">transferInitDownload</a>(rand(0x0000, 0xFFFF), 0, $this-><a class="code" href="class_team_speak3___node___abstract.html#a02ce34dce8fbf7881ce2323f7af0dca3" title="Returns the internal path of the node icon. ">iconGetName</a>(<span class="stringliteral">"virtualserver_icon_id"</span>));</div>
|
|
<div class="line"><a name="l01734"></a><span class="lineno"> 1734</span>  $transfer = <a class="code" href="class_team_speak3.html#aed403cdb559cae556a94a0d9823bcaf4" title="Factory for TeamSpeak3_Adapter_Abstract classes. ">TeamSpeak3::factory</a>(<span class="stringliteral">"filetransfer://"</span> . $download[<span class="stringliteral">"host"</span>] . <span class="stringliteral">":"</span> . $download[<span class="stringliteral">"port"</span>]);</div>
|
|
<div class="line"><a name="l01735"></a><span class="lineno"> 1735</span> </div>
|
|
<div class="line"><a name="l01736"></a><span class="lineno"> 1736</span>  <span class="keywordflow">return</span> $transfer->download($download[<span class="stringliteral">"ftkey"</span>], $download[<span class="stringliteral">"size"</span>]);</div>
|
|
<div class="line"><a name="l01737"></a><span class="lineno"> 1737</span>  }</div>
|
|
<div class="line"><a name="l01738"></a><span class="lineno"> 1738</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01739"></a><span class="lineno"> 1739</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01740"></a><span class="lineno"> 1740</span> <span class="comment"> * Uploads a given icon file content to the server and returns the ID of the icon.</span></div>
|
|
<div class="line"><a name="l01741"></a><span class="lineno"> 1741</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01742"></a><span class="lineno"> 1742</span> <span class="comment"> * @param string $data</span></div>
|
|
<div class="line"><a name="l01743"></a><span class="lineno"> 1743</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l01744"></a><span class="lineno"> 1744</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01745"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aa09963df399797506a9f5107541f826d"> 1745</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aa09963df399797506a9f5107541f826d" title="Uploads a given icon file content to the server and returns the ID of the icon. ">iconUpload</a>($data)</div>
|
|
<div class="line"><a name="l01746"></a><span class="lineno"> 1746</span>  {</div>
|
|
<div class="line"><a name="l01747"></a><span class="lineno"> 1747</span>  $crc = crc32($data);</div>
|
|
<div class="line"><a name="l01748"></a><span class="lineno"> 1748</span>  $size = strlen($data);</div>
|
|
<div class="line"><a name="l01749"></a><span class="lineno"> 1749</span> </div>
|
|
<div class="line"><a name="l01750"></a><span class="lineno"> 1750</span>  $upload = $this-><a class="code" href="class_team_speak3___node___server.html#a276cde0701f7051fd3cc33e8f1d304c2" title="Initializes a file transfer upload. ">transferInitUpload</a>(rand(0x0000, 0xFFFF), 0, <span class="stringliteral">"/icon_"</span> . $crc, $size);</div>
|
|
<div class="line"><a name="l01751"></a><span class="lineno"> 1751</span>  $transfer = <a class="code" href="class_team_speak3.html#aed403cdb559cae556a94a0d9823bcaf4" title="Factory for TeamSpeak3_Adapter_Abstract classes. ">TeamSpeak3::factory</a>(<span class="stringliteral">"filetransfer://"</span> . $upload[<span class="stringliteral">"host"</span>] . <span class="stringliteral">":"</span> . $upload[<span class="stringliteral">"port"</span>]);</div>
|
|
<div class="line"><a name="l01752"></a><span class="lineno"> 1752</span> </div>
|
|
<div class="line"><a name="l01753"></a><span class="lineno"> 1753</span>  $transfer->upload($upload[<span class="stringliteral">"ftkey"</span>], $upload[<span class="stringliteral">"seekpos"</span>], $data);</div>
|
|
<div class="line"><a name="l01754"></a><span class="lineno"> 1754</span> </div>
|
|
<div class="line"><a name="l01755"></a><span class="lineno"> 1755</span>  <span class="keywordflow">return</span> $crc;</div>
|
|
<div class="line"><a name="l01756"></a><span class="lineno"> 1756</span>  }</div>
|
|
<div class="line"><a name="l01757"></a><span class="lineno"> 1757</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01758"></a><span class="lineno"> 1758</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01759"></a><span class="lineno"> 1759</span> <span class="comment"> * Changes the virtual server configuration using given properties.</span></div>
|
|
<div class="line"><a name="l01760"></a><span class="lineno"> 1760</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01761"></a><span class="lineno"> 1761</span> <span class="comment"> * @param array $properties</span></div>
|
|
<div class="line"><a name="l01762"></a><span class="lineno"> 1762</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01763"></a><span class="lineno"> 1763</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01764"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a4829c324cac2866b7748b9ba48ee17e1"> 1764</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a4829c324cac2866b7748b9ba48ee17e1" title="Changes the virtual server configuration using given properties. ">modify</a>(array $properties)</div>
|
|
<div class="line"><a name="l01765"></a><span class="lineno"> 1765</span>  {</div>
|
|
<div class="line"><a name="l01766"></a><span class="lineno"> 1766</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"serveredit"</span>, $properties);</div>
|
|
<div class="line"><a name="l01767"></a><span class="lineno"> 1767</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#a266578bece0506453e1f1bfba1f08966">resetNodeInfo</a>();</div>
|
|
<div class="line"><a name="l01768"></a><span class="lineno"> 1768</span>  }</div>
|
|
<div class="line"><a name="l01769"></a><span class="lineno"> 1769</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01770"></a><span class="lineno"> 1770</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01771"></a><span class="lineno"> 1771</span> <span class="comment"> * Sends a text message to all clients on the virtual server.</span></div>
|
|
<div class="line"><a name="l01772"></a><span class="lineno"> 1772</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01773"></a><span class="lineno"> 1773</span> <span class="comment"> * @param string $msg</span></div>
|
|
<div class="line"><a name="l01774"></a><span class="lineno"> 1774</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01775"></a><span class="lineno"> 1775</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01776"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a0bbeea2377896171ec7d971de382528f"> 1776</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a0bbeea2377896171ec7d971de382528f" title="Sends a text message to all clients on the virtual server. ">message</a>($msg)</div>
|
|
<div class="line"><a name="l01777"></a><span class="lineno"> 1777</span>  {</div>
|
|
<div class="line"><a name="l01778"></a><span class="lineno"> 1778</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"sendtextmessage"</span>, array(<span class="stringliteral">"msg"</span> => $msg, <span class="stringliteral">"target"</span> => $this-><a class="code" href="class_team_speak3___node___abstract.html#a4a0a5545abc2460d1d9b3d6b52d07cbe" title="Returns the primary ID of the current node. ">getId</a>(), <span class="stringliteral">"targetmode"</span> => <a class="code" href="class_team_speak3.html#a9f1020035b40674a589647e5dc90c95b" title="3: target is a virtual server ">TeamSpeak3::TEXTMSG_SERVER</a>));</div>
|
|
<div class="line"><a name="l01779"></a><span class="lineno"> 1779</span>  }</div>
|
|
<div class="line"><a name="l01780"></a><span class="lineno"> 1780</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01781"></a><span class="lineno"> 1781</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01782"></a><span class="lineno"> 1782</span> <span class="comment"> * Returns a list of offline messages you've received. The output contains the senders unique identifier,</span></div>
|
|
<div class="line"><a name="l01783"></a><span class="lineno"> 1783</span> <span class="comment"> * the messages subject, etc.</span></div>
|
|
<div class="line"><a name="l01784"></a><span class="lineno"> 1784</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01785"></a><span class="lineno"> 1785</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01786"></a><span class="lineno"> 1786</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01787"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a094080732e7f39c9ac07fbefdcbf5d6e"> 1787</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a094080732e7f39c9ac07fbefdcbf5d6e" title="Returns a list of offline messages you've received. ">messageList</a>()</div>
|
|
<div class="line"><a name="l01788"></a><span class="lineno"> 1788</span>  {</div>
|
|
<div class="line"><a name="l01789"></a><span class="lineno"> 1789</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"messagelist"</span>)->toAssocArray(<span class="stringliteral">"msgid"</span>);</div>
|
|
<div class="line"><a name="l01790"></a><span class="lineno"> 1790</span>  }</div>
|
|
<div class="line"><a name="l01791"></a><span class="lineno"> 1791</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01792"></a><span class="lineno"> 1792</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01793"></a><span class="lineno"> 1793</span> <span class="comment"> * Sends an offline message to the client specified by $cluid.</span></div>
|
|
<div class="line"><a name="l01794"></a><span class="lineno"> 1794</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01795"></a><span class="lineno"> 1795</span> <span class="comment"> * @param string $cluid</span></div>
|
|
<div class="line"><a name="l01796"></a><span class="lineno"> 1796</span> <span class="comment"> * @param string $subject</span></div>
|
|
<div class="line"><a name="l01797"></a><span class="lineno"> 1797</span> <span class="comment"> * @param string $message</span></div>
|
|
<div class="line"><a name="l01798"></a><span class="lineno"> 1798</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01799"></a><span class="lineno"> 1799</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01800"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#af229175f84fc35b20a7e74542b4f48c0"> 1800</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#af229175f84fc35b20a7e74542b4f48c0" title="Sends an offline message to the client specified by $cluid. ">messageCreate</a>($cluid, $subject, $message)</div>
|
|
<div class="line"><a name="l01801"></a><span class="lineno"> 1801</span>  {</div>
|
|
<div class="line"><a name="l01802"></a><span class="lineno"> 1802</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"messageadd"</span>, array(<span class="stringliteral">"cluid"</span> => $cluid, <span class="stringliteral">"subject"</span> => $subject, <span class="stringliteral">"message"</span> => $message));</div>
|
|
<div class="line"><a name="l01803"></a><span class="lineno"> 1803</span>  }</div>
|
|
<div class="line"><a name="l01804"></a><span class="lineno"> 1804</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01805"></a><span class="lineno"> 1805</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01806"></a><span class="lineno"> 1806</span> <span class="comment"> * Deletes an existing offline message with ID $msgid from your inbox.</span></div>
|
|
<div class="line"><a name="l01807"></a><span class="lineno"> 1807</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01808"></a><span class="lineno"> 1808</span> <span class="comment"> * @param integer $msgid</span></div>
|
|
<div class="line"><a name="l01809"></a><span class="lineno"> 1809</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01810"></a><span class="lineno"> 1810</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01811"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#af5f666e5496fed200ffe2ab4c7da2e70"> 1811</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#af5f666e5496fed200ffe2ab4c7da2e70" title="Deletes an existing offline message with ID $msgid from your inbox. ">messageDelete</a>($msgid)</div>
|
|
<div class="line"><a name="l01812"></a><span class="lineno"> 1812</span>  {</div>
|
|
<div class="line"><a name="l01813"></a><span class="lineno"> 1813</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"messagedel"</span>, array(<span class="stringliteral">"msgid"</span> => $msgid));</div>
|
|
<div class="line"><a name="l01814"></a><span class="lineno"> 1814</span>  }</div>
|
|
<div class="line"><a name="l01815"></a><span class="lineno"> 1815</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01816"></a><span class="lineno"> 1816</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01817"></a><span class="lineno"> 1817</span> <span class="comment"> * Returns an existing offline message with ID $msgid from your inbox.</span></div>
|
|
<div class="line"><a name="l01818"></a><span class="lineno"> 1818</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01819"></a><span class="lineno"> 1819</span> <span class="comment"> * @param integer $msgid</span></div>
|
|
<div class="line"><a name="l01820"></a><span class="lineno"> 1820</span> <span class="comment"> * @param boolean $flag_read</span></div>
|
|
<div class="line"><a name="l01821"></a><span class="lineno"> 1821</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01822"></a><span class="lineno"> 1822</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01823"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aba2804d7bb9a1b9994af24c35fcc9484"> 1823</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aba2804d7bb9a1b9994af24c35fcc9484" title="Returns an existing offline message with ID $msgid from your inbox. ">messageRead</a>($msgid, $flag_read = TRUE)</div>
|
|
<div class="line"><a name="l01824"></a><span class="lineno"> 1824</span>  {</div>
|
|
<div class="line"><a name="l01825"></a><span class="lineno"> 1825</span>  $msg = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"messageget"</span>, array(<span class="stringliteral">"msgid"</span> => $msgid))->toList();</div>
|
|
<div class="line"><a name="l01826"></a><span class="lineno"> 1826</span> </div>
|
|
<div class="line"><a name="l01827"></a><span class="lineno"> 1827</span>  <span class="keywordflow">if</span>($flag_read)</div>
|
|
<div class="line"><a name="l01828"></a><span class="lineno"> 1828</span>  {</div>
|
|
<div class="line"><a name="l01829"></a><span class="lineno"> 1829</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"messageget"</span>, array(<span class="stringliteral">"msgid"</span> => $msgid, <span class="stringliteral">"flag"</span> => $flag_read));</div>
|
|
<div class="line"><a name="l01830"></a><span class="lineno"> 1830</span>  }</div>
|
|
<div class="line"><a name="l01831"></a><span class="lineno"> 1831</span> </div>
|
|
<div class="line"><a name="l01832"></a><span class="lineno"> 1832</span>  <span class="keywordflow">return</span> $msg;</div>
|
|
<div class="line"><a name="l01833"></a><span class="lineno"> 1833</span>  }</div>
|
|
<div class="line"><a name="l01834"></a><span class="lineno"> 1834</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01835"></a><span class="lineno"> 1835</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01836"></a><span class="lineno"> 1836</span> <span class="comment"> * Creates and returns snapshot data for the selected virtual server.</span></div>
|
|
<div class="line"><a name="l01837"></a><span class="lineno"> 1837</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01838"></a><span class="lineno"> 1838</span> <span class="comment"> * @param string $mode</span></div>
|
|
<div class="line"><a name="l01839"></a><span class="lineno"> 1839</span> <span class="comment"> * @return string</span></div>
|
|
<div class="line"><a name="l01840"></a><span class="lineno"> 1840</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01841"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a2f9a35ca93ed9d7341e131142779acbe"> 1841</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a2f9a35ca93ed9d7341e131142779acbe" title="Creates and returns snapshot data for the selected virtual server. ">snapshotCreate</a>($mode = <a class="code" href="class_team_speak3.html#af9a20a17b3aaaf60621e4f471f7e300a" title="0: default string ">TeamSpeak3::SNAPSHOT_STRING</a>)</div>
|
|
<div class="line"><a name="l01842"></a><span class="lineno"> 1842</span>  {</div>
|
|
<div class="line"><a name="l01843"></a><span class="lineno"> 1843</span>  $snapshot = $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"serversnapshotcreate"</span>)->toString(FALSE);</div>
|
|
<div class="line"><a name="l01844"></a><span class="lineno"> 1844</span> </div>
|
|
<div class="line"><a name="l01845"></a><span class="lineno"> 1845</span>  <span class="keywordflow">switch</span>($mode)</div>
|
|
<div class="line"><a name="l01846"></a><span class="lineno"> 1846</span>  {</div>
|
|
<div class="line"><a name="l01847"></a><span class="lineno"> 1847</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#ac9535ce5e98c480aea71d0f149a7c2cb" title="1: base64 string ">TeamSpeak3::SNAPSHOT_BASE64</a>:</div>
|
|
<div class="line"><a name="l01848"></a><span class="lineno"> 1848</span>  <span class="keywordflow">return</span> $snapshot->toBase64();</div>
|
|
<div class="line"><a name="l01849"></a><span class="lineno"> 1849</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l01850"></a><span class="lineno"> 1850</span> </div>
|
|
<div class="line"><a name="l01851"></a><span class="lineno"> 1851</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#a7dfffb36f25a89a472b60275fc3fc4e7" title="2: hexadecimal string ">TeamSpeak3::SNAPSHOT_HEXDEC</a>:</div>
|
|
<div class="line"><a name="l01852"></a><span class="lineno"> 1852</span>  <span class="keywordflow">return</span> $snapshot->toHex();</div>
|
|
<div class="line"><a name="l01853"></a><span class="lineno"> 1853</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l01854"></a><span class="lineno"> 1854</span> </div>
|
|
<div class="line"><a name="l01855"></a><span class="lineno"> 1855</span>  <span class="keywordflow">default</span>:</div>
|
|
<div class="line"><a name="l01856"></a><span class="lineno"> 1856</span>  <span class="keywordflow">return</span> (<span class="keywordtype">string</span>) $snapshot;</div>
|
|
<div class="line"><a name="l01857"></a><span class="lineno"> 1857</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l01858"></a><span class="lineno"> 1858</span>  }</div>
|
|
<div class="line"><a name="l01859"></a><span class="lineno"> 1859</span>  }</div>
|
|
<div class="line"><a name="l01860"></a><span class="lineno"> 1860</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01861"></a><span class="lineno"> 1861</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01862"></a><span class="lineno"> 1862</span> <span class="comment"> * Deploys snapshot data on the selected virtual server. If no virtual server is selected (ID 0),</span></div>
|
|
<div class="line"><a name="l01863"></a><span class="lineno"> 1863</span> <span class="comment"> * the data will be used to create a new virtual server from scratch.</span></div>
|
|
<div class="line"><a name="l01864"></a><span class="lineno"> 1864</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01865"></a><span class="lineno"> 1865</span> <span class="comment"> * @param string $data</span></div>
|
|
<div class="line"><a name="l01866"></a><span class="lineno"> 1866</span> <span class="comment"> * @param string $mode</span></div>
|
|
<div class="line"><a name="l01867"></a><span class="lineno"> 1867</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01868"></a><span class="lineno"> 1868</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01869"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a30215b7852290912517096a1555ba7ee"> 1869</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a30215b7852290912517096a1555ba7ee" title="Deploys snapshot data on the selected virtual server. ">snapshotDeploy</a>($data, $mode = <a class="code" href="class_team_speak3.html#af9a20a17b3aaaf60621e4f471f7e300a" title="0: default string ">TeamSpeak3::SNAPSHOT_STRING</a>)</div>
|
|
<div class="line"><a name="l01870"></a><span class="lineno"> 1870</span>  {</div>
|
|
<div class="line"><a name="l01871"></a><span class="lineno"> 1871</span>  <span class="keywordflow">switch</span>($mode)</div>
|
|
<div class="line"><a name="l01872"></a><span class="lineno"> 1872</span>  {</div>
|
|
<div class="line"><a name="l01873"></a><span class="lineno"> 1873</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#ac9535ce5e98c480aea71d0f149a7c2cb" title="1: base64 string ">TeamSpeak3::SNAPSHOT_BASE64</a>:</div>
|
|
<div class="line"><a name="l01874"></a><span class="lineno"> 1874</span>  $data = <a class="code" href="class_team_speak3___helper___string.html#ae48a7462ffd80cca1487685e4042c4c3" title="Decodes the string with MIME base64 and returns the result as an TeamSpeak3_Helper_String. ">TeamSpeak3_Helper_String::fromBase64</a>($data);</div>
|
|
<div class="line"><a name="l01875"></a><span class="lineno"> 1875</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l01876"></a><span class="lineno"> 1876</span> </div>
|
|
<div class="line"><a name="l01877"></a><span class="lineno"> 1877</span>  <span class="keywordflow">case</span> <a class="code" href="class_team_speak3.html#a7dfffb36f25a89a472b60275fc3fc4e7" title="2: hexadecimal string ">TeamSpeak3::SNAPSHOT_HEXDEC</a>:</div>
|
|
<div class="line"><a name="l01878"></a><span class="lineno"> 1878</span>  $data = <a class="code" href="class_team_speak3___helper___string.html#a74f8c216773fe9876fbf60ee02e643ca" title="Returns the TeamSpeak3_Helper_String based on a given hex value. ">TeamSpeak3_Helper_String::fromHex</a>($data);</div>
|
|
<div class="line"><a name="l01879"></a><span class="lineno"> 1879</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l01880"></a><span class="lineno"> 1880</span> </div>
|
|
<div class="line"><a name="l01881"></a><span class="lineno"> 1881</span>  <span class="keywordflow">default</span>:</div>
|
|
<div class="line"><a name="l01882"></a><span class="lineno"> 1882</span>  $data = <a class="code" href="class_team_speak3___helper___string.html#a475f5a602d67dd0568fb8c86352c88a0" title="Returns a TeamSpeak3_Helper_String object for thegiven string. ">TeamSpeak3_Helper_String::factory</a>($data);</div>
|
|
<div class="line"><a name="l01883"></a><span class="lineno"> 1883</span>  <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a name="l01884"></a><span class="lineno"> 1884</span>  }</div>
|
|
<div class="line"><a name="l01885"></a><span class="lineno"> 1885</span> </div>
|
|
<div class="line"><a name="l01886"></a><span class="lineno"> 1886</span>  $detail = $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"serversnapshotdeploy "</span> . $data)->toList();</div>
|
|
<div class="line"><a name="l01887"></a><span class="lineno"> 1887</span> </div>
|
|
<div class="line"><a name="l01888"></a><span class="lineno"> 1888</span>  <span class="keywordflow">if</span>(array_key_exists(<span class="stringliteral">"sid"</span>, $detail))</div>
|
|
<div class="line"><a name="l01889"></a><span class="lineno"> 1889</span>  {</div>
|
|
<div class="line"><a name="l01890"></a><span class="lineno"> 1890</span>  <a class="code" href="class_team_speak3___helper___signal.html#af156036673730a599c10c8cbfd5e50bf" title="Returns a singleton instance of TeamSpeak3_Helper_Signal. ">TeamSpeak3_Helper_Signal::getInstance</a>()->emit(<span class="stringliteral">"notifyServercreated"</span>, $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>(), $detail[<span class="stringliteral">"sid"</span>]);</div>
|
|
<div class="line"><a name="l01891"></a><span class="lineno"> 1891</span>  }</div>
|
|
<div class="line"><a name="l01892"></a><span class="lineno"> 1892</span> </div>
|
|
<div class="line"><a name="l01893"></a><span class="lineno"> 1893</span>  <span class="keywordflow">return</span> $detail;</div>
|
|
<div class="line"><a name="l01894"></a><span class="lineno"> 1894</span>  }</div>
|
|
<div class="line"><a name="l01895"></a><span class="lineno"> 1895</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01896"></a><span class="lineno"> 1896</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01897"></a><span class="lineno"> 1897</span> <span class="comment"> * Registers for a specified category of events on a virtual server to receive notification</span></div>
|
|
<div class="line"><a name="l01898"></a><span class="lineno"> 1898</span> <span class="comment"> * messages. Depending on the notifications you've registered for, the server will send you</span></div>
|
|
<div class="line"><a name="l01899"></a><span class="lineno"> 1899</span> <span class="comment"> * a message on every event.</span></div>
|
|
<div class="line"><a name="l01900"></a><span class="lineno"> 1900</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01901"></a><span class="lineno"> 1901</span> <span class="comment"> * @param string $event</span></div>
|
|
<div class="line"><a name="l01902"></a><span class="lineno"> 1902</span> <span class="comment"> * @param integer $id</span></div>
|
|
<div class="line"><a name="l01903"></a><span class="lineno"> 1903</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01904"></a><span class="lineno"> 1904</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01905"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ab6042c937b2e0b7eccd7dca9c98fe8b6"> 1905</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ab6042c937b2e0b7eccd7dca9c98fe8b6" title="Registers for a specified category of events on a virtual server to receive notification messages...">notifyRegister</a>($event, $id = 0)</div>
|
|
<div class="line"><a name="l01906"></a><span class="lineno"> 1906</span>  {</div>
|
|
<div class="line"><a name="l01907"></a><span class="lineno"> 1907</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servernotifyregister"</span>, array(<span class="stringliteral">"event"</span> => $event, <span class="stringliteral">"id"</span> => $id));</div>
|
|
<div class="line"><a name="l01908"></a><span class="lineno"> 1908</span>  }</div>
|
|
<div class="line"><a name="l01909"></a><span class="lineno"> 1909</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01910"></a><span class="lineno"> 1910</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01911"></a><span class="lineno"> 1911</span> <span class="comment"> * Unregisters all events previously registered with servernotifyregister so you will no</span></div>
|
|
<div class="line"><a name="l01912"></a><span class="lineno"> 1912</span> <span class="comment"> * longer receive notification messages.</span></div>
|
|
<div class="line"><a name="l01913"></a><span class="lineno"> 1913</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01914"></a><span class="lineno"> 1914</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l01915"></a><span class="lineno"> 1915</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01916"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a46509385b685f0154e04c2774d74652a"> 1916</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a46509385b685f0154e04c2774d74652a" title="Unregisters all events previously registered with servernotifyregister so you will no longer receive ...">notifyUnregister</a>()</div>
|
|
<div class="line"><a name="l01917"></a><span class="lineno"> 1917</span>  {</div>
|
|
<div class="line"><a name="l01918"></a><span class="lineno"> 1918</span>  $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"servernotifyunregister"</span>);</div>
|
|
<div class="line"><a name="l01919"></a><span class="lineno"> 1919</span>  }</div>
|
|
<div class="line"><a name="l01920"></a><span class="lineno"> 1920</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01921"></a><span class="lineno"> 1921</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01922"></a><span class="lineno"> 1922</span> <span class="comment"> * Alias for privilegeKeyList().</span></div>
|
|
<div class="line"><a name="l01923"></a><span class="lineno"> 1923</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01924"></a><span class="lineno"> 1924</span> <span class="comment"> * @deprecated</span></div>
|
|
<div class="line"><a name="l01925"></a><span class="lineno"> 1925</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01926"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a6e9970aec423b74cf392c7259853557b"> 1926</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a6e9970aec423b74cf392c7259853557b" title="Alias for privilegeKeyList(). ">tokenList</a>($translate = FALSE)</div>
|
|
<div class="line"><a name="l01927"></a><span class="lineno"> 1927</span>  {</div>
|
|
<div class="line"><a name="l01928"></a><span class="lineno"> 1928</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___server.html#ae79c8994a9fa524016a141aad5b14e31" title="Returns a list of privilege keys (tokens) available. ">privilegeKeyList</a>();</div>
|
|
<div class="line"><a name="l01929"></a><span class="lineno"> 1929</span>  }</div>
|
|
<div class="line"><a name="l01930"></a><span class="lineno"> 1930</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01931"></a><span class="lineno"> 1931</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01932"></a><span class="lineno"> 1932</span> <span class="comment"> * Returns a list of privilege keys (tokens) available. If $resolve is set to TRUE the values</span></div>
|
|
<div class="line"><a name="l01933"></a><span class="lineno"> 1933</span> <span class="comment"> * of token_id1 and token_id2 will be translated into the appropriate group and/or channel</span></div>
|
|
<div class="line"><a name="l01934"></a><span class="lineno"> 1934</span> <span class="comment"> * names.</span></div>
|
|
<div class="line"><a name="l01935"></a><span class="lineno"> 1935</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01936"></a><span class="lineno"> 1936</span> <span class="comment"> * @param boolean $resolve</span></div>
|
|
<div class="line"><a name="l01937"></a><span class="lineno"> 1937</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l01938"></a><span class="lineno"> 1938</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01939"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ae79c8994a9fa524016a141aad5b14e31"> 1939</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ae79c8994a9fa524016a141aad5b14e31" title="Returns a list of privilege keys (tokens) available. ">privilegeKeyList</a>($resolve = FALSE)</div>
|
|
<div class="line"><a name="l01940"></a><span class="lineno"> 1940</span>  {</div>
|
|
<div class="line"><a name="l01941"></a><span class="lineno"> 1941</span>  $tokens = $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"privilegekeylist"</span>)->toAssocArray(<span class="stringliteral">"token"</span>);</div>
|
|
<div class="line"><a name="l01942"></a><span class="lineno"> 1942</span> </div>
|
|
<div class="line"><a name="l01943"></a><span class="lineno"> 1943</span>  <span class="keywordflow">if</span>($resolve)</div>
|
|
<div class="line"><a name="l01944"></a><span class="lineno"> 1944</span>  {</div>
|
|
<div class="line"><a name="l01945"></a><span class="lineno"> 1945</span>  <span class="keywordflow">foreach</span>($tokens as $token => $array)</div>
|
|
<div class="line"><a name="l01946"></a><span class="lineno"> 1946</span>  {</div>
|
|
<div class="line"><a name="l01947"></a><span class="lineno"> 1947</span>  $func = $array[<span class="stringliteral">"token_type"</span>] ? <span class="stringliteral">"channelGroupGetById"</span> : <span class="stringliteral">"serverGroupGetById"</span>;</div>
|
|
<div class="line"><a name="l01948"></a><span class="lineno"> 1948</span> </div>
|
|
<div class="line"><a name="l01949"></a><span class="lineno"> 1949</span>  <span class="keywordflow">try</span></div>
|
|
<div class="line"><a name="l01950"></a><span class="lineno"> 1950</span>  {</div>
|
|
<div class="line"><a name="l01951"></a><span class="lineno"> 1951</span>  $tokens[$token][<span class="stringliteral">"token_id1"</span>] = $this->$func($array[<span class="stringliteral">"token_id1"</span>])->name;</div>
|
|
<div class="line"><a name="l01952"></a><span class="lineno"> 1952</span>  }</div>
|
|
<div class="line"><a name="l01953"></a><span class="lineno"> 1953</span>  <span class="keywordflow">catch</span>(Exception $e)</div>
|
|
<div class="line"><a name="l01954"></a><span class="lineno"> 1954</span>  {</div>
|
|
<div class="line"><a name="l01955"></a><span class="lineno"> 1955</span>  <span class="comment">/* ERROR_channel_invalid_id */</span></div>
|
|
<div class="line"><a name="l01956"></a><span class="lineno"> 1956</span>  <span class="keywordflow">if</span>($e->getCode() != 0xA00) <span class="keywordflow">throw</span> $e;</div>
|
|
<div class="line"><a name="l01957"></a><span class="lineno"> 1957</span>  }</div>
|
|
<div class="line"><a name="l01958"></a><span class="lineno"> 1958</span> </div>
|
|
<div class="line"><a name="l01959"></a><span class="lineno"> 1959</span>  <span class="keywordflow">try</span></div>
|
|
<div class="line"><a name="l01960"></a><span class="lineno"> 1960</span>  {</div>
|
|
<div class="line"><a name="l01961"></a><span class="lineno"> 1961</span>  <span class="keywordflow">if</span>($array[<span class="stringliteral">"token_type"</span>]) $tokens[$token][<span class="stringliteral">"token_id2"</span>] = $this-><a class="code" href="class_team_speak3___node___server.html#ab384bb6d76c0dfb582c877852ddba1dc" title="Returns the TeamSpeak3_Node_Channel object matching the given ID. ">channelGetById</a>($array[<span class="stringliteral">"token_id2"</span>])->getPathway();</div>
|
|
<div class="line"><a name="l01962"></a><span class="lineno"> 1962</span>  }</div>
|
|
<div class="line"><a name="l01963"></a><span class="lineno"> 1963</span>  <span class="keywordflow">catch</span>(Exception $e)</div>
|
|
<div class="line"><a name="l01964"></a><span class="lineno"> 1964</span>  {</div>
|
|
<div class="line"><a name="l01965"></a><span class="lineno"> 1965</span>  <span class="comment">/* ERROR_permission_invalid_group_id */</span></div>
|
|
<div class="line"><a name="l01966"></a><span class="lineno"> 1966</span>  <span class="keywordflow">if</span>($e->getCode() != 0x300) <span class="keywordflow">throw</span> $e;</div>
|
|
<div class="line"><a name="l01967"></a><span class="lineno"> 1967</span>  }</div>
|
|
<div class="line"><a name="l01968"></a><span class="lineno"> 1968</span>  }</div>
|
|
<div class="line"><a name="l01969"></a><span class="lineno"> 1969</span>  }</div>
|
|
<div class="line"><a name="l01970"></a><span class="lineno"> 1970</span> </div>
|
|
<div class="line"><a name="l01971"></a><span class="lineno"> 1971</span>  <span class="keywordflow">return</span> $tokens;</div>
|
|
<div class="line"><a name="l01972"></a><span class="lineno"> 1972</span>  }</div>
|
|
<div class="line"><a name="l01973"></a><span class="lineno"> 1973</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01974"></a><span class="lineno"> 1974</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01975"></a><span class="lineno"> 1975</span> <span class="comment"> * Alias for privilegeKeyCreate().</span></div>
|
|
<div class="line"><a name="l01976"></a><span class="lineno"> 1976</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01977"></a><span class="lineno"> 1977</span> <span class="comment"> * @deprecated</span></div>
|
|
<div class="line"><a name="l01978"></a><span class="lineno"> 1978</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01979"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a9a0e159ffbacd9bf36a791862732f525"> 1979</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a9a0e159ffbacd9bf36a791862732f525" title="Alias for privilegeKeyCreate(). ">tokenCreate</a>($type = <a class="code" href="class_team_speak3.html#add756e636bc8ea39128fdf8361ffd54c" title="0: server group token (id1={groupID} id2=0) ">TeamSpeak3::TOKEN_SERVERGROUP</a>, $id1, $id2 = 0, $description = null, $customset = null)</div>
|
|
<div class="line"><a name="l01980"></a><span class="lineno"> 1980</span>  {</div>
|
|
<div class="line"><a name="l01981"></a><span class="lineno"> 1981</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___server.html#a65f5b13eca06755b6ef96e6bbe80947b" title="Creates a new privilege key (token) and returns the key. ">privilegeKeyCreate</a>($type, $id1, $id2, $description, $customset);</div>
|
|
<div class="line"><a name="l01982"></a><span class="lineno"> 1982</span>  }</div>
|
|
<div class="line"><a name="l01983"></a><span class="lineno"> 1983</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01984"></a><span class="lineno"> 1984</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l01985"></a><span class="lineno"> 1985</span> <span class="comment"> * Creates a new privilege key (token) and returns the key.</span></div>
|
|
<div class="line"><a name="l01986"></a><span class="lineno"> 1986</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l01987"></a><span class="lineno"> 1987</span> <span class="comment"> * @param integer $type</span></div>
|
|
<div class="line"><a name="l01988"></a><span class="lineno"> 1988</span> <span class="comment"> * @param integer $id1</span></div>
|
|
<div class="line"><a name="l01989"></a><span class="lineno"> 1989</span> <span class="comment"> * @param integer $id2</span></div>
|
|
<div class="line"><a name="l01990"></a><span class="lineno"> 1990</span> <span class="comment"> * @param string $description</span></div>
|
|
<div class="line"><a name="l01991"></a><span class="lineno"> 1991</span> <span class="comment"> * @param string $customset</span></div>
|
|
<div class="line"><a name="l01992"></a><span class="lineno"> 1992</span> <span class="comment"> * @return TeamSpeak3_Helper_String</span></div>
|
|
<div class="line"><a name="l01993"></a><span class="lineno"> 1993</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l01994"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a65f5b13eca06755b6ef96e6bbe80947b"> 1994</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a65f5b13eca06755b6ef96e6bbe80947b" title="Creates a new privilege key (token) and returns the key. ">privilegeKeyCreate</a>($type = <a class="code" href="class_team_speak3.html#add756e636bc8ea39128fdf8361ffd54c" title="0: server group token (id1={groupID} id2=0) ">TeamSpeak3::TOKEN_SERVERGROUP</a>, $id1, $id2 = 0, $description = null, $customset = null)</div>
|
|
<div class="line"><a name="l01995"></a><span class="lineno"> 1995</span>  {</div>
|
|
<div class="line"><a name="l01996"></a><span class="lineno"> 1996</span>  $token = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"privilegekeyadd"</span>, array(<span class="stringliteral">"tokentype"</span> => $type, <span class="stringliteral">"tokenid1"</span> => $id1, <span class="stringliteral">"tokenid2"</span> => $id2, <span class="stringliteral">"tokendescription"</span> => $description, <span class="stringliteral">"tokencustomset"</span> => $customset))->toList();</div>
|
|
<div class="line"><a name="l01997"></a><span class="lineno"> 1997</span> </div>
|
|
<div class="line"><a name="l01998"></a><span class="lineno"> 1998</span>  <a class="code" href="class_team_speak3___helper___signal.html#af156036673730a599c10c8cbfd5e50bf" title="Returns a singleton instance of TeamSpeak3_Helper_Signal. ">TeamSpeak3_Helper_Signal::getInstance</a>()->emit(<span class="stringliteral">"notifyTokencreated"</span>, $this, $token[<span class="stringliteral">"token"</span>]);</div>
|
|
<div class="line"><a name="l01999"></a><span class="lineno"> 1999</span> </div>
|
|
<div class="line"><a name="l02000"></a><span class="lineno"> 2000</span>  <span class="keywordflow">return</span> $token[<span class="stringliteral">"token"</span>];</div>
|
|
<div class="line"><a name="l02001"></a><span class="lineno"> 2001</span>  }</div>
|
|
<div class="line"><a name="l02002"></a><span class="lineno"> 2002</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02003"></a><span class="lineno"> 2003</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02004"></a><span class="lineno"> 2004</span> <span class="comment"> * Alias for privilegeKeyDelete().</span></div>
|
|
<div class="line"><a name="l02005"></a><span class="lineno"> 2005</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02006"></a><span class="lineno"> 2006</span> <span class="comment"> * @deprecated</span></div>
|
|
<div class="line"><a name="l02007"></a><span class="lineno"> 2007</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02008"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a46e722bae91524ef2d2b80a9f4b02cd8"> 2008</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a46e722bae91524ef2d2b80a9f4b02cd8" title="Alias for privilegeKeyDelete(). ">tokenDelete</a>($token)</div>
|
|
<div class="line"><a name="l02009"></a><span class="lineno"> 2009</span>  {</div>
|
|
<div class="line"><a name="l02010"></a><span class="lineno"> 2010</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a06d451d9f1f484da9e902eadb52739e4" title="Deletes a token specified by key $token. ">privilegeKeyDelete</a>($token);</div>
|
|
<div class="line"><a name="l02011"></a><span class="lineno"> 2011</span>  }</div>
|
|
<div class="line"><a name="l02012"></a><span class="lineno"> 2012</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02013"></a><span class="lineno"> 2013</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02014"></a><span class="lineno"> 2014</span> <span class="comment"> * Deletes a token specified by key $token.</span></div>
|
|
<div class="line"><a name="l02015"></a><span class="lineno"> 2015</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02016"></a><span class="lineno"> 2016</span> <span class="comment"> * @param string $token</span></div>
|
|
<div class="line"><a name="l02017"></a><span class="lineno"> 2017</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02018"></a><span class="lineno"> 2018</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02019"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a06d451d9f1f484da9e902eadb52739e4"> 2019</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a06d451d9f1f484da9e902eadb52739e4" title="Deletes a token specified by key $token. ">privilegeKeyDelete</a>($token)</div>
|
|
<div class="line"><a name="l02020"></a><span class="lineno"> 2020</span>  {</div>
|
|
<div class="line"><a name="l02021"></a><span class="lineno"> 2021</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"privilegekeydelete"</span>, array(<span class="stringliteral">"token"</span> => $token));</div>
|
|
<div class="line"><a name="l02022"></a><span class="lineno"> 2022</span>  }</div>
|
|
<div class="line"><a name="l02023"></a><span class="lineno"> 2023</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02024"></a><span class="lineno"> 2024</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02025"></a><span class="lineno"> 2025</span> <span class="comment"> * Alias for privilegeKeyUse().</span></div>
|
|
<div class="line"><a name="l02026"></a><span class="lineno"> 2026</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02027"></a><span class="lineno"> 2027</span> <span class="comment"> * @deprecated</span></div>
|
|
<div class="line"><a name="l02028"></a><span class="lineno"> 2028</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02029"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a96197181eefbe0489b88294fe46ef715"> 2029</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a96197181eefbe0489b88294fe46ef715" title="Alias for privilegeKeyUse(). ">tokenUse</a>($token)</div>
|
|
<div class="line"><a name="l02030"></a><span class="lineno"> 2030</span>  {</div>
|
|
<div class="line"><a name="l02031"></a><span class="lineno"> 2031</span>  $this-><a class="code" href="class_team_speak3___node___server.html#a6cdf7f6012d20caf6b2be3b42ffb5c21" title="Use a token key gain access to a server or channel group. ">privilegeKeyUse</a>($token);</div>
|
|
<div class="line"><a name="l02032"></a><span class="lineno"> 2032</span>  }</div>
|
|
<div class="line"><a name="l02033"></a><span class="lineno"> 2033</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02034"></a><span class="lineno"> 2034</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02035"></a><span class="lineno"> 2035</span> <span class="comment"> * Use a token key gain access to a server or channel group. Please note that the server will</span></div>
|
|
<div class="line"><a name="l02036"></a><span class="lineno"> 2036</span> <span class="comment"> * automatically delete the token after it has been used.</span></div>
|
|
<div class="line"><a name="l02037"></a><span class="lineno"> 2037</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02038"></a><span class="lineno"> 2038</span> <span class="comment"> * @param string $token</span></div>
|
|
<div class="line"><a name="l02039"></a><span class="lineno"> 2039</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02040"></a><span class="lineno"> 2040</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02041"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a6cdf7f6012d20caf6b2be3b42ffb5c21"> 2041</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a6cdf7f6012d20caf6b2be3b42ffb5c21" title="Use a token key gain access to a server or channel group. ">privilegeKeyUse</a>($token)</div>
|
|
<div class="line"><a name="l02042"></a><span class="lineno"> 2042</span>  {</div>
|
|
<div class="line"><a name="l02043"></a><span class="lineno"> 2043</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"privilegekeyuse"</span>, array(<span class="stringliteral">"token"</span> => $token));</div>
|
|
<div class="line"><a name="l02044"></a><span class="lineno"> 2044</span>  }</div>
|
|
<div class="line"><a name="l02045"></a><span class="lineno"> 2045</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02046"></a><span class="lineno"> 2046</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02047"></a><span class="lineno"> 2047</span> <span class="comment"> * Returns a list of custom client properties specified by $ident.</span></div>
|
|
<div class="line"><a name="l02048"></a><span class="lineno"> 2048</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02049"></a><span class="lineno"> 2049</span> <span class="comment"> * @param string $ident</span></div>
|
|
<div class="line"><a name="l02050"></a><span class="lineno"> 2050</span> <span class="comment"> * @param string $pattern</span></div>
|
|
<div class="line"><a name="l02051"></a><span class="lineno"> 2051</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l02052"></a><span class="lineno"> 2052</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02053"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ac81f6d268d0bd65d62adf54fdfb6f74c"> 2053</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ac81f6d268d0bd65d62adf54fdfb6f74c" title="Returns a list of custom client properties specified by $ident. ">customSearch</a>($ident, $pattern = <span class="stringliteral">"%"</span>)</div>
|
|
<div class="line"><a name="l02054"></a><span class="lineno"> 2054</span>  {</div>
|
|
<div class="line"><a name="l02055"></a><span class="lineno"> 2055</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"customsearch"</span>, array(<span class="stringliteral">"ident"</span> => $ident, <span class="stringliteral">"pattern"</span> => $pattern))->toArray();</div>
|
|
<div class="line"><a name="l02056"></a><span class="lineno"> 2056</span>  }</div>
|
|
<div class="line"><a name="l02057"></a><span class="lineno"> 2057</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02058"></a><span class="lineno"> 2058</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02059"></a><span class="lineno"> 2059</span> <span class="comment"> * Returns a list of custom properties for the client specified by $cldbid.</span></div>
|
|
<div class="line"><a name="l02060"></a><span class="lineno"> 2060</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02061"></a><span class="lineno"> 2061</span> <span class="comment"> * @param integer $cldbid</span></div>
|
|
<div class="line"><a name="l02062"></a><span class="lineno"> 2062</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l02063"></a><span class="lineno"> 2063</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02064"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ab607dab98be8ad823c6ea639045ceadd"> 2064</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ab607dab98be8ad823c6ea639045ceadd" title="Returns a list of custom properties for the client specified by $cldbid. ">customInfo</a>($cldbid)</div>
|
|
<div class="line"><a name="l02065"></a><span class="lineno"> 2065</span>  {</div>
|
|
<div class="line"><a name="l02066"></a><span class="lineno"> 2066</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"custominfo"</span>, array(<span class="stringliteral">"cldbid"</span> => $cldbid))->toArray();</div>
|
|
<div class="line"><a name="l02067"></a><span class="lineno"> 2067</span>  }</div>
|
|
<div class="line"><a name="l02068"></a><span class="lineno"> 2068</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02069"></a><span class="lineno"> 2069</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02070"></a><span class="lineno"> 2070</span> <span class="comment"> * Returns a list of active bans on the selected virtual server.</span></div>
|
|
<div class="line"><a name="l02071"></a><span class="lineno"> 2071</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02072"></a><span class="lineno"> 2072</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l02073"></a><span class="lineno"> 2073</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02074"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a6d0211802f5d1248bc69c4fdefa3d417"> 2074</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a6d0211802f5d1248bc69c4fdefa3d417" title="Returns a list of active bans on the selected virtual server. ">banList</a>()</div>
|
|
<div class="line"><a name="l02075"></a><span class="lineno"> 2075</span>  {</div>
|
|
<div class="line"><a name="l02076"></a><span class="lineno"> 2076</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"banlist"</span>)->toAssocArray(<span class="stringliteral">"banid"</span>);</div>
|
|
<div class="line"><a name="l02077"></a><span class="lineno"> 2077</span>  }</div>
|
|
<div class="line"><a name="l02078"></a><span class="lineno"> 2078</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02079"></a><span class="lineno"> 2079</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02080"></a><span class="lineno"> 2080</span> <span class="comment"> * Deletes all active ban rules from the server.</span></div>
|
|
<div class="line"><a name="l02081"></a><span class="lineno"> 2081</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02082"></a><span class="lineno"> 2082</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02083"></a><span class="lineno"> 2083</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02084"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ad61bc446498a29aeb0f035c8316ee743"> 2084</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#ad61bc446498a29aeb0f035c8316ee743" title="Deletes all active ban rules from the server. ">banListClear</a>()</div>
|
|
<div class="line"><a name="l02085"></a><span class="lineno"> 2085</span>  {</div>
|
|
<div class="line"><a name="l02086"></a><span class="lineno"> 2086</span>  $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"bandelall"</span>);</div>
|
|
<div class="line"><a name="l02087"></a><span class="lineno"> 2087</span>  }</div>
|
|
<div class="line"><a name="l02088"></a><span class="lineno"> 2088</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02089"></a><span class="lineno"> 2089</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02090"></a><span class="lineno"> 2090</span> <span class="comment"> * Adds a new ban rule on the selected virtual server. All parameters are optional but at least one</span></div>
|
|
<div class="line"><a name="l02091"></a><span class="lineno"> 2091</span> <span class="comment"> * of the following rules must be set: ip, name, or uid.</span></div>
|
|
<div class="line"><a name="l02092"></a><span class="lineno"> 2092</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02093"></a><span class="lineno"> 2093</span> <span class="comment"> * @param array $rules</span></div>
|
|
<div class="line"><a name="l02094"></a><span class="lineno"> 2094</span> <span class="comment"> * @param integer $timeseconds</span></div>
|
|
<div class="line"><a name="l02095"></a><span class="lineno"> 2095</span> <span class="comment"> * @param string $reason</span></div>
|
|
<div class="line"><a name="l02096"></a><span class="lineno"> 2096</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l02097"></a><span class="lineno"> 2097</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02098"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a0a2c9e20c88b81275222acdd61a5f8c4"> 2098</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a0a2c9e20c88b81275222acdd61a5f8c4" title="Adds a new ban rule on the selected virtual server. ">banCreate</a>(array $rules, $timeseconds = null, $reason = null)</div>
|
|
<div class="line"><a name="l02099"></a><span class="lineno"> 2099</span>  {</div>
|
|
<div class="line"><a name="l02100"></a><span class="lineno"> 2100</span>  $rules[<span class="stringliteral">"time"</span>] = $timeseconds;</div>
|
|
<div class="line"><a name="l02101"></a><span class="lineno"> 2101</span>  $rules[<span class="stringliteral">"banreason"</span>] = $reason;</div>
|
|
<div class="line"><a name="l02102"></a><span class="lineno"> 2102</span> </div>
|
|
<div class="line"><a name="l02103"></a><span class="lineno"> 2103</span>  $banid = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"banadd"</span>, $rules)->toList();</div>
|
|
<div class="line"><a name="l02104"></a><span class="lineno"> 2104</span> </div>
|
|
<div class="line"><a name="l02105"></a><span class="lineno"> 2105</span>  <span class="keywordflow">return</span> $banid[<span class="stringliteral">"banid"</span>];</div>
|
|
<div class="line"><a name="l02106"></a><span class="lineno"> 2106</span>  }</div>
|
|
<div class="line"><a name="l02107"></a><span class="lineno"> 2107</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02108"></a><span class="lineno"> 2108</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02109"></a><span class="lineno"> 2109</span> <span class="comment"> * Deletes the specified ban rule from the server.</span></div>
|
|
<div class="line"><a name="l02110"></a><span class="lineno"> 2110</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02111"></a><span class="lineno"> 2111</span> <span class="comment"> * @param integer $banid</span></div>
|
|
<div class="line"><a name="l02112"></a><span class="lineno"> 2112</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02113"></a><span class="lineno"> 2113</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02114"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a953aaca1b1d5e024b37221146d04b296"> 2114</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a953aaca1b1d5e024b37221146d04b296" title="Deletes the specified ban rule from the server. ">banDelete</a>($banid)</div>
|
|
<div class="line"><a name="l02115"></a><span class="lineno"> 2115</span>  {</div>
|
|
<div class="line"><a name="l02116"></a><span class="lineno"> 2116</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"bandel"</span>, array(<span class="stringliteral">"banid"</span> => $banid));</div>
|
|
<div class="line"><a name="l02117"></a><span class="lineno"> 2117</span>  }</div>
|
|
<div class="line"><a name="l02118"></a><span class="lineno"> 2118</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02119"></a><span class="lineno"> 2119</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02120"></a><span class="lineno"> 2120</span> <span class="comment"> * Returns a list of complaints on the selected virtual server. If $tcldbid is specified, only</span></div>
|
|
<div class="line"><a name="l02121"></a><span class="lineno"> 2121</span> <span class="comment"> * complaints about the targeted client will be shown.</span></div>
|
|
<div class="line"><a name="l02122"></a><span class="lineno"> 2122</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02123"></a><span class="lineno"> 2123</span> <span class="comment"> * @param integer $tcldbid</span></div>
|
|
<div class="line"><a name="l02124"></a><span class="lineno"> 2124</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l02125"></a><span class="lineno"> 2125</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02126"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#af44418304dbbe76dca50be38e7e394de"> 2126</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#af44418304dbbe76dca50be38e7e394de" title="Returns a list of complaints on the selected virtual server. ">complaintList</a>($tcldbid = null)</div>
|
|
<div class="line"><a name="l02127"></a><span class="lineno"> 2127</span>  {</div>
|
|
<div class="line"><a name="l02128"></a><span class="lineno"> 2128</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"complainlist"</span>, array(<span class="stringliteral">"tcldbid"</span> => $tcldbid))->toArray();</div>
|
|
<div class="line"><a name="l02129"></a><span class="lineno"> 2129</span>  }</div>
|
|
<div class="line"><a name="l02130"></a><span class="lineno"> 2130</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02131"></a><span class="lineno"> 2131</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02132"></a><span class="lineno"> 2132</span> <span class="comment"> * Deletes all active complaints about the client with database ID $tcldbid from the server.</span></div>
|
|
<div class="line"><a name="l02133"></a><span class="lineno"> 2133</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02134"></a><span class="lineno"> 2134</span> <span class="comment"> * @param integer $tcldbid</span></div>
|
|
<div class="line"><a name="l02135"></a><span class="lineno"> 2135</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02136"></a><span class="lineno"> 2136</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02137"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a2a6d384cf01078cb72cd9f9670cebb57"> 2137</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a2a6d384cf01078cb72cd9f9670cebb57" title="Deletes all active complaints about the client with database ID $tcldbid from the server...">complaintListClear</a>($tcldbid)</div>
|
|
<div class="line"><a name="l02138"></a><span class="lineno"> 2138</span>  {</div>
|
|
<div class="line"><a name="l02139"></a><span class="lineno"> 2139</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"complaindelall"</span>, array(<span class="stringliteral">"tcldbid"</span> => $tcldbid));</div>
|
|
<div class="line"><a name="l02140"></a><span class="lineno"> 2140</span>  }</div>
|
|
<div class="line"><a name="l02141"></a><span class="lineno"> 2141</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02142"></a><span class="lineno"> 2142</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02143"></a><span class="lineno"> 2143</span> <span class="comment"> * Submits a complaint about the client with database ID $tcldbid to the server.</span></div>
|
|
<div class="line"><a name="l02144"></a><span class="lineno"> 2144</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02145"></a><span class="lineno"> 2145</span> <span class="comment"> * @param integer $tcldbid</span></div>
|
|
<div class="line"><a name="l02146"></a><span class="lineno"> 2146</span> <span class="comment"> * @param string $message</span></div>
|
|
<div class="line"><a name="l02147"></a><span class="lineno"> 2147</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02148"></a><span class="lineno"> 2148</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02149"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a7d683c16389f1b1d72e38b783638c3c4"> 2149</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a7d683c16389f1b1d72e38b783638c3c4" title="Submits a complaint about the client with database ID $tcldbid to the server. ">complaintCreate</a>($tcldbid, $message)</div>
|
|
<div class="line"><a name="l02150"></a><span class="lineno"> 2150</span>  {</div>
|
|
<div class="line"><a name="l02151"></a><span class="lineno"> 2151</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"complainadd"</span>, array(<span class="stringliteral">"tcldbid"</span> => $tcldbid, <span class="stringliteral">"message"</span> => $message));</div>
|
|
<div class="line"><a name="l02152"></a><span class="lineno"> 2152</span>  }</div>
|
|
<div class="line"><a name="l02153"></a><span class="lineno"> 2153</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02154"></a><span class="lineno"> 2154</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02155"></a><span class="lineno"> 2155</span> <span class="comment"> * Deletes the complaint about the client with ID $tcldbid submitted by the client with ID $fcldbid from the server.</span></div>
|
|
<div class="line"><a name="l02156"></a><span class="lineno"> 2156</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02157"></a><span class="lineno"> 2157</span> <span class="comment"> * @param integer $tcldbid</span></div>
|
|
<div class="line"><a name="l02158"></a><span class="lineno"> 2158</span> <span class="comment"> * @param integer $fcldbid</span></div>
|
|
<div class="line"><a name="l02159"></a><span class="lineno"> 2159</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02160"></a><span class="lineno"> 2160</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02161"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a72cfe9527297ec1e6536b9c073c0858b"> 2161</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a72cfe9527297ec1e6536b9c073c0858b" title="Deletes the complaint about the client with ID $tcldbid submitted by the client with ID $fcldbid from...">complaintDelete</a>($tcldbid, $fcldbid)</div>
|
|
<div class="line"><a name="l02162"></a><span class="lineno"> 2162</span>  {</div>
|
|
<div class="line"><a name="l02163"></a><span class="lineno"> 2163</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"complaindel"</span>, array(<span class="stringliteral">"tcldbid"</span> => $tcldbid, <span class="stringliteral">"fcldbid"</span> => $fcldbid));</div>
|
|
<div class="line"><a name="l02164"></a><span class="lineno"> 2164</span>  }</div>
|
|
<div class="line"><a name="l02165"></a><span class="lineno"> 2165</span>  <span class="comment"></span></div>
|
|
<div class="line"><a name="l02166"></a><span class="lineno"> 2166</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02167"></a><span class="lineno"> 2167</span> <span class="comment"> * Returns a list of temporary server passwords.</span></div>
|
|
<div class="line"><a name="l02168"></a><span class="lineno"> 2168</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02169"></a><span class="lineno"> 2169</span> <span class="comment"> * @param boolean $resolve</span></div>
|
|
<div class="line"><a name="l02170"></a><span class="lineno"> 2170</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l02171"></a><span class="lineno"> 2171</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02172"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a162441d331999a7fdfc7d8fcd2d8978b"> 2172</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a162441d331999a7fdfc7d8fcd2d8978b" title="Returns a list of temporary server passwords. ">tempPasswordList</a>($resolve = FALSE)</div>
|
|
<div class="line"><a name="l02173"></a><span class="lineno"> 2173</span>  {</div>
|
|
<div class="line"><a name="l02174"></a><span class="lineno"> 2174</span>  $passwords = $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"servertemppasswordlist"</span>)->toAssocArray(<span class="stringliteral">"pw_clear"</span>);</div>
|
|
<div class="line"><a name="l02175"></a><span class="lineno"> 2175</span>  </div>
|
|
<div class="line"><a name="l02176"></a><span class="lineno"> 2176</span>  <span class="keywordflow">if</span>($resolve)</div>
|
|
<div class="line"><a name="l02177"></a><span class="lineno"> 2177</span>  {</div>
|
|
<div class="line"><a name="l02178"></a><span class="lineno"> 2178</span>  <span class="keywordflow">foreach</span>($passwords as $password => $array)</div>
|
|
<div class="line"><a name="l02179"></a><span class="lineno"> 2179</span>  {</div>
|
|
<div class="line"><a name="l02180"></a><span class="lineno"> 2180</span>  <span class="keywordflow">try</span></div>
|
|
<div class="line"><a name="l02181"></a><span class="lineno"> 2181</span>  {</div>
|
|
<div class="line"><a name="l02182"></a><span class="lineno"> 2182</span>  $channel = $this-><a class="code" href="class_team_speak3___node___server.html#ab384bb6d76c0dfb582c877852ddba1dc" title="Returns the TeamSpeak3_Node_Channel object matching the given ID. ">channelGetById</a>($array[<span class="stringliteral">"tcid"</span>]);</div>
|
|
<div class="line"><a name="l02183"></a><span class="lineno"> 2183</span>  </div>
|
|
<div class="line"><a name="l02184"></a><span class="lineno"> 2184</span>  $passwords[$password][<span class="stringliteral">"tcname"</span>] = $channel->toString();</div>
|
|
<div class="line"><a name="l02185"></a><span class="lineno"> 2185</span>  $passwords[$password][<span class="stringliteral">"tcpath"</span>] = $channel->getPathway();</div>
|
|
<div class="line"><a name="l02186"></a><span class="lineno"> 2186</span>  }</div>
|
|
<div class="line"><a name="l02187"></a><span class="lineno"> 2187</span>  <span class="keywordflow">catch</span>(Exception $e)</div>
|
|
<div class="line"><a name="l02188"></a><span class="lineno"> 2188</span>  {</div>
|
|
<div class="line"><a name="l02189"></a><span class="lineno"> 2189</span>  <span class="comment">/* ERROR_channel_invalid_id */</span></div>
|
|
<div class="line"><a name="l02190"></a><span class="lineno"> 2190</span>  <span class="keywordflow">if</span>($e->getCode() != 0xA00) <span class="keywordflow">throw</span> $e;</div>
|
|
<div class="line"><a name="l02191"></a><span class="lineno"> 2191</span>  }</div>
|
|
<div class="line"><a name="l02192"></a><span class="lineno"> 2192</span>  }</div>
|
|
<div class="line"><a name="l02193"></a><span class="lineno"> 2193</span>  }</div>
|
|
<div class="line"><a name="l02194"></a><span class="lineno"> 2194</span>  </div>
|
|
<div class="line"><a name="l02195"></a><span class="lineno"> 2195</span>  <span class="keywordflow">return</span> $passwords;</div>
|
|
<div class="line"><a name="l02196"></a><span class="lineno"> 2196</span>  }</div>
|
|
<div class="line"><a name="l02197"></a><span class="lineno"> 2197</span>  <span class="comment"></span></div>
|
|
<div class="line"><a name="l02198"></a><span class="lineno"> 2198</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02199"></a><span class="lineno"> 2199</span> <span class="comment"> * Sets a new temporary server password specified with $pw. The temporary password will be </span></div>
|
|
<div class="line"><a name="l02200"></a><span class="lineno"> 2200</span> <span class="comment"> * valid for the number of seconds specified with $duration. The client connecting with this </span></div>
|
|
<div class="line"><a name="l02201"></a><span class="lineno"> 2201</span> <span class="comment"> * password will automatically join the channel specified with $tcid. If tcid is set to 0, </span></div>
|
|
<div class="line"><a name="l02202"></a><span class="lineno"> 2202</span> <span class="comment"> * the client will join the default channel.</span></div>
|
|
<div class="line"><a name="l02203"></a><span class="lineno"> 2203</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02204"></a><span class="lineno"> 2204</span> <span class="comment"> * @param string $pw</span></div>
|
|
<div class="line"><a name="l02205"></a><span class="lineno"> 2205</span> <span class="comment"> * @param integer $duration</span></div>
|
|
<div class="line"><a name="l02206"></a><span class="lineno"> 2206</span> <span class="comment"> * @param integer $tcid</span></div>
|
|
<div class="line"><a name="l02207"></a><span class="lineno"> 2207</span> <span class="comment"> * @param string $tcpw</span></div>
|
|
<div class="line"><a name="l02208"></a><span class="lineno"> 2208</span> <span class="comment"> * @param string $desc</span></div>
|
|
<div class="line"><a name="l02209"></a><span class="lineno"> 2209</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02210"></a><span class="lineno"> 2210</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02211"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a6498965a34fe39e72abc006cfdcf04b8"> 2211</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a6498965a34fe39e72abc006cfdcf04b8" title="Sets a new temporary server password specified with $pw. ">tempPasswordCreate</a>($pw, $duration, $tcid = 0, $tcpw = <span class="stringliteral">""</span>, $desc = <span class="stringliteral">""</span>)</div>
|
|
<div class="line"><a name="l02212"></a><span class="lineno"> 2212</span>  {</div>
|
|
<div class="line"><a name="l02213"></a><span class="lineno"> 2213</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servertemppasswordadd"</span>, array(<span class="stringliteral">"pw"</span> => $pw, <span class="stringliteral">"duration"</span> => $duration, <span class="stringliteral">"tcid"</span> => $tcid, <span class="stringliteral">"tcpw"</span> => $tcpw, <span class="stringliteral">"desc"</span> => $desc));</div>
|
|
<div class="line"><a name="l02214"></a><span class="lineno"> 2214</span>  }</div>
|
|
<div class="line"><a name="l02215"></a><span class="lineno"> 2215</span>  <span class="comment"></span></div>
|
|
<div class="line"><a name="l02216"></a><span class="lineno"> 2216</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02217"></a><span class="lineno"> 2217</span> <span class="comment"> * Deletes the temporary server password specified with $pw.</span></div>
|
|
<div class="line"><a name="l02218"></a><span class="lineno"> 2218</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02219"></a><span class="lineno"> 2219</span> <span class="comment"> * @param string $pw</span></div>
|
|
<div class="line"><a name="l02220"></a><span class="lineno"> 2220</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02221"></a><span class="lineno"> 2221</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02222"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a176d8a85e03314cbe7422749006122b9"> 2222</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a176d8a85e03314cbe7422749006122b9" title="Deletes the temporary server password specified with $pw. ">tempPasswordDelete</a>($pw)</div>
|
|
<div class="line"><a name="l02223"></a><span class="lineno"> 2223</span>  {</div>
|
|
<div class="line"><a name="l02224"></a><span class="lineno"> 2224</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"servertemppassworddel"</span>, array(<span class="stringliteral">"pw"</span> => $pw));</div>
|
|
<div class="line"><a name="l02225"></a><span class="lineno"> 2225</span>  }</div>
|
|
<div class="line"><a name="l02226"></a><span class="lineno"> 2226</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02227"></a><span class="lineno"> 2227</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02228"></a><span class="lineno"> 2228</span> <span class="comment"> * Displays a specified number of entries (1-100) from the servers log.</span></div>
|
|
<div class="line"><a name="l02229"></a><span class="lineno"> 2229</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02230"></a><span class="lineno"> 2230</span> <span class="comment"> * @param integer $lines</span></div>
|
|
<div class="line"><a name="l02231"></a><span class="lineno"> 2231</span> <span class="comment"> * @param integer $begin_pos</span></div>
|
|
<div class="line"><a name="l02232"></a><span class="lineno"> 2232</span> <span class="comment"> * @param boolean $reverse</span></div>
|
|
<div class="line"><a name="l02233"></a><span class="lineno"> 2233</span> <span class="comment"> * @param boolean $instance</span></div>
|
|
<div class="line"><a name="l02234"></a><span class="lineno"> 2234</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l02235"></a><span class="lineno"> 2235</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02236"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a5a61fde00711fbde340c0917c738d19d"> 2236</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a5a61fde00711fbde340c0917c738d19d" title="Displays a specified number of entries (1-100) from the servers log. ">logView</a>($lines = 30, $begin_pos = null, $reverse = null, $instance = null)</div>
|
|
<div class="line"><a name="l02237"></a><span class="lineno"> 2237</span>  {</div>
|
|
<div class="line"><a name="l02238"></a><span class="lineno"> 2238</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"logview"</span>, array(<span class="stringliteral">"lines"</span> => $lines, <span class="stringliteral">"begin_pos"</span> => $begin_pos, <span class="stringliteral">"instance"</span> => $instance, <span class="stringliteral">"reverse"</span> => $reverse))->toArray();</div>
|
|
<div class="line"><a name="l02239"></a><span class="lineno"> 2239</span>  }</div>
|
|
<div class="line"><a name="l02240"></a><span class="lineno"> 2240</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02241"></a><span class="lineno"> 2241</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02242"></a><span class="lineno"> 2242</span> <span class="comment"> * Writes a custom entry into the virtual server log.</span></div>
|
|
<div class="line"><a name="l02243"></a><span class="lineno"> 2243</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02244"></a><span class="lineno"> 2244</span> <span class="comment"> * @param string $logmsg</span></div>
|
|
<div class="line"><a name="l02245"></a><span class="lineno"> 2245</span> <span class="comment"> * @param integer $loglevel</span></div>
|
|
<div class="line"><a name="l02246"></a><span class="lineno"> 2246</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02247"></a><span class="lineno"> 2247</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02248"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a5a35cfb06bb9e8fbf8d8716a8de1c047"> 2248</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a5a35cfb06bb9e8fbf8d8716a8de1c047" title="Writes a custom entry into the virtual server log. ">logAdd</a>($logmsg, $loglevel = <a class="code" href="class_team_speak3.html#a4b19b7a03ed2787450ea21229854ced8" title="4: informational output ">TeamSpeak3::LOGLEVEL_INFO</a>)</div>
|
|
<div class="line"><a name="l02249"></a><span class="lineno"> 2249</span>  {</div>
|
|
<div class="line"><a name="l02250"></a><span class="lineno"> 2250</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"logadd"</span>, array(<span class="stringliteral">"logmsg"</span> => $logmsg, <span class="stringliteral">"loglevel"</span> => $loglevel));</div>
|
|
<div class="line"><a name="l02251"></a><span class="lineno"> 2251</span>  }</div>
|
|
<div class="line"><a name="l02252"></a><span class="lineno"> 2252</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02253"></a><span class="lineno"> 2253</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02254"></a><span class="lineno"> 2254</span> <span class="comment"> * Returns detailed connection information of the virtual server.</span></div>
|
|
<div class="line"><a name="l02255"></a><span class="lineno"> 2255</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02256"></a><span class="lineno"> 2256</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l02257"></a><span class="lineno"> 2257</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02258"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a4c13644c69f768e0a449d5d0b7bcd1a9"> 2258</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a4c13644c69f768e0a449d5d0b7bcd1a9" title="Returns detailed connection information of the virtual server. ">connectionInfo</a>()</div>
|
|
<div class="line"><a name="l02259"></a><span class="lineno"> 2259</span>  {</div>
|
|
<div class="line"><a name="l02260"></a><span class="lineno"> 2260</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"serverrequestconnectioninfo"</span>)->toList();</div>
|
|
<div class="line"><a name="l02261"></a><span class="lineno"> 2261</span>  }</div>
|
|
<div class="line"><a name="l02262"></a><span class="lineno"> 2262</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02263"></a><span class="lineno"> 2263</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02264"></a><span class="lineno"> 2264</span> <span class="comment"> * Deletes the virtual server.</span></div>
|
|
<div class="line"><a name="l02265"></a><span class="lineno"> 2265</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02266"></a><span class="lineno"> 2266</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02267"></a><span class="lineno"> 2267</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02268"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#ac159e3dff47e2dca9b7baabcd75265a7"> 2268</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <span class="keyword">delete</span>()</div>
|
|
<div class="line"><a name="l02269"></a><span class="lineno"> 2269</span>  {</div>
|
|
<div class="line"><a name="l02270"></a><span class="lineno"> 2270</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->serverDelete($this-><a class="code" href="class_team_speak3___node___abstract.html#a4a0a5545abc2460d1d9b3d6b52d07cbe" title="Returns the primary ID of the current node. ">getId</a>());</div>
|
|
<div class="line"><a name="l02271"></a><span class="lineno"> 2271</span> </div>
|
|
<div class="line"><a name="l02272"></a><span class="lineno"> 2272</span>  unset($this);</div>
|
|
<div class="line"><a name="l02273"></a><span class="lineno"> 2273</span>  }</div>
|
|
<div class="line"><a name="l02274"></a><span class="lineno"> 2274</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02275"></a><span class="lineno"> 2275</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02276"></a><span class="lineno"> 2276</span> <span class="comment"> * Starts the virtual server.</span></div>
|
|
<div class="line"><a name="l02277"></a><span class="lineno"> 2277</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02278"></a><span class="lineno"> 2278</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02279"></a><span class="lineno"> 2279</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02280"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a21ce82924bf869c8033ef3fcde598795"> 2280</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a21ce82924bf869c8033ef3fcde598795" title="Starts the virtual server. ">start</a>()</div>
|
|
<div class="line"><a name="l02281"></a><span class="lineno"> 2281</span>  {</div>
|
|
<div class="line"><a name="l02282"></a><span class="lineno"> 2282</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->serverStart($this-><a class="code" href="class_team_speak3___node___abstract.html#a4a0a5545abc2460d1d9b3d6b52d07cbe" title="Returns the primary ID of the current node. ">getId</a>());</div>
|
|
<div class="line"><a name="l02283"></a><span class="lineno"> 2283</span>  }</div>
|
|
<div class="line"><a name="l02284"></a><span class="lineno"> 2284</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02285"></a><span class="lineno"> 2285</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02286"></a><span class="lineno"> 2286</span> <span class="comment"> * Stops the virtual server.</span></div>
|
|
<div class="line"><a name="l02287"></a><span class="lineno"> 2287</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02288"></a><span class="lineno"> 2288</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02289"></a><span class="lineno"> 2289</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02290"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a63a380c17cc49c30093672163b164502"> 2290</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a63a380c17cc49c30093672163b164502" title="Stops the virtual server. ">stop</a>()</div>
|
|
<div class="line"><a name="l02291"></a><span class="lineno"> 2291</span>  {</div>
|
|
<div class="line"><a name="l02292"></a><span class="lineno"> 2292</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->serverStop($this-><a class="code" href="class_team_speak3___node___abstract.html#a4a0a5545abc2460d1d9b3d6b52d07cbe" title="Returns the primary ID of the current node. ">getId</a>());</div>
|
|
<div class="line"><a name="l02293"></a><span class="lineno"> 2293</span>  }</div>
|
|
<div class="line"><a name="l02294"></a><span class="lineno"> 2294</span>  <span class="comment"></span></div>
|
|
<div class="line"><a name="l02295"></a><span class="lineno"> 2295</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02296"></a><span class="lineno"> 2296</span> <span class="comment"> * Sends a plugin command to all clients connected to the server.</span></div>
|
|
<div class="line"><a name="l02297"></a><span class="lineno"> 2297</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02298"></a><span class="lineno"> 2298</span> <span class="comment"> * @param string $plugin</span></div>
|
|
<div class="line"><a name="l02299"></a><span class="lineno"> 2299</span> <span class="comment"> * @param string $data</span></div>
|
|
<div class="line"><a name="l02300"></a><span class="lineno"> 2300</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02301"></a><span class="lineno"> 2301</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02302"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a7ad80214abca716151ed418dd0a65129"> 2302</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a7ad80214abca716151ed418dd0a65129" title="Sends a plugin command to all clients connected to the server. ">sendPluginCmd</a>($plugin, $data)</div>
|
|
<div class="line"><a name="l02303"></a><span class="lineno"> 2303</span>  {</div>
|
|
<div class="line"><a name="l02304"></a><span class="lineno"> 2304</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"plugincmd"</span>, array(<span class="stringliteral">"name"</span> => $plugin, <span class="stringliteral">"data"</span> => $data, <span class="stringliteral">"targetmode"</span> => <a class="code" href="class_team_speak3.html#a908573c6bc67e85396a4af21972bfeae" title="2: send plugincmd to all clients on server ">TeamSpeak3::PLUGINCMD_SERVER</a>));</div>
|
|
<div class="line"><a name="l02305"></a><span class="lineno"> 2305</span>  }</div>
|
|
<div class="line"><a name="l02306"></a><span class="lineno"> 2306</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02307"></a><span class="lineno"> 2307</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02308"></a><span class="lineno"> 2308</span> <span class="comment"> * Changes the properties of your own client connection.</span></div>
|
|
<div class="line"><a name="l02309"></a><span class="lineno"> 2309</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02310"></a><span class="lineno"> 2310</span> <span class="comment"> * @param array $properties</span></div>
|
|
<div class="line"><a name="l02311"></a><span class="lineno"> 2311</span> <span class="comment"> * @return void</span></div>
|
|
<div class="line"><a name="l02312"></a><span class="lineno"> 2312</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02313"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a5c94f444f21e92a1a8045256dbe8eda6"> 2313</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a5c94f444f21e92a1a8045256dbe8eda6" title="Changes the properties of your own client connection. ">selfUpdate</a>(array $properties)</div>
|
|
<div class="line"><a name="l02314"></a><span class="lineno"> 2314</span>  {</div>
|
|
<div class="line"><a name="l02315"></a><span class="lineno"> 2315</span>  $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientupdate"</span>, $properties);</div>
|
|
<div class="line"><a name="l02316"></a><span class="lineno"> 2316</span> </div>
|
|
<div class="line"><a name="l02317"></a><span class="lineno"> 2317</span>  <span class="keywordflow">foreach</span>($properties as $ident => $value)</div>
|
|
<div class="line"><a name="l02318"></a><span class="lineno"> 2318</span>  {</div>
|
|
<div class="line"><a name="l02319"></a><span class="lineno"> 2319</span>  $this->whoamiSet($ident, $value);</div>
|
|
<div class="line"><a name="l02320"></a><span class="lineno"> 2320</span>  }</div>
|
|
<div class="line"><a name="l02321"></a><span class="lineno"> 2321</span>  }</div>
|
|
<div class="line"><a name="l02322"></a><span class="lineno"> 2322</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02323"></a><span class="lineno"> 2323</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02324"></a><span class="lineno"> 2324</span> <span class="comment"> * Updates your own ServerQuery login credentials using a specified username. The password</span></div>
|
|
<div class="line"><a name="l02325"></a><span class="lineno"> 2325</span> <span class="comment"> * will be auto-generated.</span></div>
|
|
<div class="line"><a name="l02326"></a><span class="lineno"> 2326</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02327"></a><span class="lineno"> 2327</span> <span class="comment"> * @param string $username</span></div>
|
|
<div class="line"><a name="l02328"></a><span class="lineno"> 2328</span> <span class="comment"> * @return TeamSpeak3_Helper_String</span></div>
|
|
<div class="line"><a name="l02329"></a><span class="lineno"> 2329</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02330"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a3bf58118ecbc54cde9cd4a652d139352"> 2330</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a3bf58118ecbc54cde9cd4a652d139352" title="Updates your own ServerQuery login credentials using a specified username. ">selfUpdateLogin</a>($username)</div>
|
|
<div class="line"><a name="l02331"></a><span class="lineno"> 2331</span>  {</div>
|
|
<div class="line"><a name="l02332"></a><span class="lineno"> 2332</span>  $password = $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"clientsetserverquerylogin"</span>, array(<span class="stringliteral">"client_login_name"</span> => $username))->toList();</div>
|
|
<div class="line"><a name="l02333"></a><span class="lineno"> 2333</span> </div>
|
|
<div class="line"><a name="l02334"></a><span class="lineno"> 2334</span>  <span class="keywordflow">return</span> $password[<span class="stringliteral">"client_login_password"</span>];</div>
|
|
<div class="line"><a name="l02335"></a><span class="lineno"> 2335</span>  }</div>
|
|
<div class="line"><a name="l02336"></a><span class="lineno"> 2336</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02337"></a><span class="lineno"> 2337</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02338"></a><span class="lineno"> 2338</span> <span class="comment"> * Returns an array containing the permission overview of your own client.</span></div>
|
|
<div class="line"><a name="l02339"></a><span class="lineno"> 2339</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02340"></a><span class="lineno"> 2340</span> <span class="comment"> * @return array</span></div>
|
|
<div class="line"><a name="l02341"></a><span class="lineno"> 2341</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02342"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a766abde5e479d793ba266dd680b5ca7b"> 2342</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a766abde5e479d793ba266dd680b5ca7b" title="Returns an array containing the permission overview of your own client. ">selfPermOverview</a>()</div>
|
|
<div class="line"><a name="l02343"></a><span class="lineno"> 2343</span>  {</div>
|
|
<div class="line"><a name="l02344"></a><span class="lineno"> 2344</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#af6811efc5065b8aadfd6792334ea6977" title="Prepares and executes a ServerQuery command and returns the result. ">execute</a>(<span class="stringliteral">"permoverview"</span>, array(<span class="stringliteral">"cldbid"</span> => $this->whoamiGet(<span class="stringliteral">"client_database_id"</span>), <span class="stringliteral">"cid"</span> => $this->whoamiGet(<span class="stringliteral">"client_channel_id"</span>), <span class="stringliteral">"permid"</span> => 0))->toArray();</div>
|
|
<div class="line"><a name="l02345"></a><span class="lineno"> 2345</span>  }</div>
|
|
<div class="line"><a name="l02346"></a><span class="lineno"> 2346</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02347"></a><span class="lineno"> 2347</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02348"></a><span class="lineno"> 2348</span> <span class="comment"> * @ignore</span></div>
|
|
<div class="line"><a name="l02349"></a><span class="lineno"> 2349</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02350"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a3ef412bad6efe2bde9d5ebcf17a7e113"> 2350</a></span>  <span class="keyword">protected</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a3ef412bad6efe2bde9d5ebcf17a7e113">fetchNodeList</a>()</div>
|
|
<div class="line"><a name="l02351"></a><span class="lineno"> 2351</span>  {</div>
|
|
<div class="line"><a name="l02352"></a><span class="lineno"> 2352</span>  $this->nodeList = array();</div>
|
|
<div class="line"><a name="l02353"></a><span class="lineno"> 2353</span> </div>
|
|
<div class="line"><a name="l02354"></a><span class="lineno"> 2354</span>  <span class="keywordflow">foreach</span>($this-><a class="code" href="class_team_speak3___node___server.html#af89e63cf4213e41524cfcf522f46493d" title="Returns an array filled with TeamSpeak3_Node_Channel objects. ">channelList</a>() as $channel)</div>
|
|
<div class="line"><a name="l02355"></a><span class="lineno"> 2355</span>  {</div>
|
|
<div class="line"><a name="l02356"></a><span class="lineno"> 2356</span>  <span class="keywordflow">if</span>($channel[<span class="stringliteral">"pid"</span>] == 0)</div>
|
|
<div class="line"><a name="l02357"></a><span class="lineno"> 2357</span>  {</div>
|
|
<div class="line"><a name="l02358"></a><span class="lineno"> 2358</span>  $this->nodeList[] = $channel;</div>
|
|
<div class="line"><a name="l02359"></a><span class="lineno"> 2359</span>  }</div>
|
|
<div class="line"><a name="l02360"></a><span class="lineno"> 2360</span>  }</div>
|
|
<div class="line"><a name="l02361"></a><span class="lineno"> 2361</span>  }</div>
|
|
<div class="line"><a name="l02362"></a><span class="lineno"> 2362</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02363"></a><span class="lineno"> 2363</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02364"></a><span class="lineno"> 2364</span> <span class="comment"> * @ignore</span></div>
|
|
<div class="line"><a name="l02365"></a><span class="lineno"> 2365</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02366"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a1cf6d79bee67d387752af85f28901dac"> 2366</a></span>  <span class="keyword">protected</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a1cf6d79bee67d387752af85f28901dac">fetchNodeInfo</a>()</div>
|
|
<div class="line"><a name="l02367"></a><span class="lineno"> 2367</span>  {</div>
|
|
<div class="line"><a name="l02368"></a><span class="lineno"> 2368</span>  $this->nodeInfo = array_merge($this->nodeInfo, $this-><a class="code" href="class_team_speak3___node___server.html#ad690f9ace5a0cb9f3789158b77c8d1f6" title="Sends a prepared command to the server and returns the result. ">request</a>(<span class="stringliteral">"serverinfo"</span>)->toList());</div>
|
|
<div class="line"><a name="l02369"></a><span class="lineno"> 2369</span>  }</div>
|
|
<div class="line"><a name="l02370"></a><span class="lineno"> 2370</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02371"></a><span class="lineno"> 2371</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02372"></a><span class="lineno"> 2372</span> <span class="comment"> * Internal callback funtion for sorting of client objects.</span></div>
|
|
<div class="line"><a name="l02373"></a><span class="lineno"> 2373</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02374"></a><span class="lineno"> 2374</span> <span class="comment"> * @param TeamSpeak3_Node_Client $a</span></div>
|
|
<div class="line"><a name="l02375"></a><span class="lineno"> 2375</span> <span class="comment"> * @param TeamSpeak3_Node_Client $b</span></div>
|
|
<div class="line"><a name="l02376"></a><span class="lineno"> 2376</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l02377"></a><span class="lineno"> 2377</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02378"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a011ab27a8853db6f1197eda9bf873de3"> 2378</a></span>  <span class="keyword">protected</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a011ab27a8853db6f1197eda9bf873de3" title="Internal callback funtion for sorting of client objects. ">sortClientList</a>(<a class="code" href="class_team_speak3___node___client.html" title="Class describing a TeamSpeak 3 client and all it's parameters. ">TeamSpeak3_Node_Client</a> $a, <a class="code" href="class_team_speak3___node___client.html" title="Class describing a TeamSpeak 3 client and all it's parameters. ">TeamSpeak3_Node_Client</a> $b)</div>
|
|
<div class="line"><a name="l02379"></a><span class="lineno"> 2379</span>  {</div>
|
|
<div class="line"><a name="l02380"></a><span class="lineno"> 2380</span>  <span class="keywordflow">if</span>(get_class($a) != get_class($b))</div>
|
|
<div class="line"><a name="l02381"></a><span class="lineno"> 2381</span>  {</div>
|
|
<div class="line"><a name="l02382"></a><span class="lineno"> 2382</span>  <span class="keywordflow">return</span> 0;</div>
|
|
<div class="line"><a name="l02383"></a><span class="lineno"> 2383</span> </div>
|
|
<div class="line"><a name="l02384"></a><span class="lineno"> 2384</span>  <span class="comment">/* workaround for PHP bug #50688 */</span></div>
|
|
<div class="line"><a name="l02385"></a><span class="lineno"> 2385</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid parameter"</span>, 0x602);</div>
|
|
<div class="line"><a name="l02386"></a><span class="lineno"> 2386</span>  }</div>
|
|
<div class="line"><a name="l02387"></a><span class="lineno"> 2387</span> </div>
|
|
<div class="line"><a name="l02388"></a><span class="lineno"> 2388</span>  <span class="keywordflow">if</span>(!$a instanceof <a class="code" href="class_team_speak3___node___client.html" title="Class describing a TeamSpeak 3 client and all it's parameters. ">TeamSpeak3_Node_Client</a>)</div>
|
|
<div class="line"><a name="l02389"></a><span class="lineno"> 2389</span>  {</div>
|
|
<div class="line"><a name="l02390"></a><span class="lineno"> 2390</span>  <span class="keywordflow">return</span> 0;</div>
|
|
<div class="line"><a name="l02391"></a><span class="lineno"> 2391</span> </div>
|
|
<div class="line"><a name="l02392"></a><span class="lineno"> 2392</span>  <span class="comment">/* workaround for PHP bug #50688 */</span></div>
|
|
<div class="line"><a name="l02393"></a><span class="lineno"> 2393</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"convert error"</span>, 0x604);</div>
|
|
<div class="line"><a name="l02394"></a><span class="lineno"> 2394</span>  }</div>
|
|
<div class="line"><a name="l02395"></a><span class="lineno"> 2395</span> </div>
|
|
<div class="line"><a name="l02396"></a><span class="lineno"> 2396</span>  <span class="keywordflow">if</span>($a-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"client_talk_power"</span>, 0) != $b-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"client_talk_power"</span>, 0))</div>
|
|
<div class="line"><a name="l02397"></a><span class="lineno"> 2397</span>  {</div>
|
|
<div class="line"><a name="l02398"></a><span class="lineno"> 2398</span>  <span class="keywordflow">return</span> ($a-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"client_talk_power"</span>, 0) > $b-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"client_talk_power"</span>, 0)) ? -1 : 1;</div>
|
|
<div class="line"><a name="l02399"></a><span class="lineno"> 2399</span>  }</div>
|
|
<div class="line"><a name="l02400"></a><span class="lineno"> 2400</span> </div>
|
|
<div class="line"><a name="l02401"></a><span class="lineno"> 2401</span>  <span class="keywordflow">if</span>($a-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"client_is_talker"</span>, 0) != $b-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"client_is_talker"</span>, 0))</div>
|
|
<div class="line"><a name="l02402"></a><span class="lineno"> 2402</span>  {</div>
|
|
<div class="line"><a name="l02403"></a><span class="lineno"> 2403</span>  <span class="keywordflow">return</span> ($a-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"client_is_talker"</span>, 0) > $b-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"client_is_talker"</span>, 0)) ? -1 : 1;</div>
|
|
<div class="line"><a name="l02404"></a><span class="lineno"> 2404</span>  }</div>
|
|
<div class="line"><a name="l02405"></a><span class="lineno"> 2405</span> </div>
|
|
<div class="line"><a name="l02406"></a><span class="lineno"> 2406</span>  <span class="keywordflow">return</span> strcmp(strtolower($a[<span class="stringliteral">"client_nickname"</span>]), strtolower($b[<span class="stringliteral">"client_nickname"</span>]));</div>
|
|
<div class="line"><a name="l02407"></a><span class="lineno"> 2407</span>  }</div>
|
|
<div class="line"><a name="l02408"></a><span class="lineno"> 2408</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02409"></a><span class="lineno"> 2409</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02410"></a><span class="lineno"> 2410</span> <span class="comment"> * Internal callback funtion for sorting of group objects.</span></div>
|
|
<div class="line"><a name="l02411"></a><span class="lineno"> 2411</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02412"></a><span class="lineno"> 2412</span> <span class="comment"> * @param TeamSpeak3_Node_Abstract $a</span></div>
|
|
<div class="line"><a name="l02413"></a><span class="lineno"> 2413</span> <span class="comment"> * @param TeamSpeak3_Node_Abstract $b</span></div>
|
|
<div class="line"><a name="l02414"></a><span class="lineno"> 2414</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l02415"></a><span class="lineno"> 2415</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02416"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a30149e018f59e136e8d8d2e32c03c30f"> 2416</a></span>  <span class="keyword">protected</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a30149e018f59e136e8d8d2e32c03c30f" title="Internal callback funtion for sorting of group objects. ">sortGroupList</a>(<a class="code" href="class_team_speak3___node___abstract.html" title="Abstract class describing a TeamSpeak 3 node and all it's parameters. ">TeamSpeak3_Node_Abstract</a> $a, <a class="code" href="class_team_speak3___node___abstract.html" title="Abstract class describing a TeamSpeak 3 node and all it's parameters. ">TeamSpeak3_Node_Abstract</a> $b)</div>
|
|
<div class="line"><a name="l02417"></a><span class="lineno"> 2417</span>  {</div>
|
|
<div class="line"><a name="l02418"></a><span class="lineno"> 2418</span>  <span class="keywordflow">if</span>(get_class($a) != get_class($b))</div>
|
|
<div class="line"><a name="l02419"></a><span class="lineno"> 2419</span>  {</div>
|
|
<div class="line"><a name="l02420"></a><span class="lineno"> 2420</span>  <span class="keywordflow">return</span> 0;</div>
|
|
<div class="line"><a name="l02421"></a><span class="lineno"> 2421</span> </div>
|
|
<div class="line"><a name="l02422"></a><span class="lineno"> 2422</span>  <span class="comment">/* workaround for PHP bug #50688 */</span></div>
|
|
<div class="line"><a name="l02423"></a><span class="lineno"> 2423</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid parameter"</span>, 0x602);</div>
|
|
<div class="line"><a name="l02424"></a><span class="lineno"> 2424</span>  }</div>
|
|
<div class="line"><a name="l02425"></a><span class="lineno"> 2425</span> </div>
|
|
<div class="line"><a name="l02426"></a><span class="lineno"> 2426</span>  <span class="keywordflow">if</span>(!$a instanceof <a class="code" href="class_team_speak3___node___servergroup.html" title="Class describing a TeamSpeak 3 server group and all it's parameters. ">TeamSpeak3_Node_Servergroup</a> && !$a instanceof <a class="code" href="class_team_speak3___node___channelgroup.html" title="Class describing a TeamSpeak 3 channel group and all it's parameters. ">TeamSpeak3_Node_Channelgroup</a>)</div>
|
|
<div class="line"><a name="l02427"></a><span class="lineno"> 2427</span>  {</div>
|
|
<div class="line"><a name="l02428"></a><span class="lineno"> 2428</span>  <span class="keywordflow">return</span> 0;</div>
|
|
<div class="line"><a name="l02429"></a><span class="lineno"> 2429</span> </div>
|
|
<div class="line"><a name="l02430"></a><span class="lineno"> 2430</span>  <span class="comment">/* workaround for PHP bug #50688 */</span></div>
|
|
<div class="line"><a name="l02431"></a><span class="lineno"> 2431</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"convert error"</span>, 0x604);</div>
|
|
<div class="line"><a name="l02432"></a><span class="lineno"> 2432</span>  }</div>
|
|
<div class="line"><a name="l02433"></a><span class="lineno"> 2433</span> </div>
|
|
<div class="line"><a name="l02434"></a><span class="lineno"> 2434</span>  <span class="keywordflow">if</span>($a-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"sortid"</span>, 0) != $b-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"sortid"</span>, 0) && $a-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"sortid"</span>, 0) != 0 && $b-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"sortid"</span>, 0) != 0)</div>
|
|
<div class="line"><a name="l02435"></a><span class="lineno"> 2435</span>  {</div>
|
|
<div class="line"><a name="l02436"></a><span class="lineno"> 2436</span>  <span class="keywordflow">return</span> ($a-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"sortid"</span>, 0) < $b-><a class="code" href="class_team_speak3___node___abstract.html#a585728537b56194aeab30b0316126b89" title="Returns the specified property or a pre-defined default value from the node info array. ">getProperty</a>(<span class="stringliteral">"sortid"</span>, 0)) ? -1 : 1;</div>
|
|
<div class="line"><a name="l02437"></a><span class="lineno"> 2437</span>  }</div>
|
|
<div class="line"><a name="l02438"></a><span class="lineno"> 2438</span> </div>
|
|
<div class="line"><a name="l02439"></a><span class="lineno"> 2439</span>  <span class="keywordflow">return</span> ($a-><a class="code" href="class_team_speak3___node___abstract.html#a4a0a5545abc2460d1d9b3d6b52d07cbe" title="Returns the primary ID of the current node. ">getId</a>() < $b-><a class="code" href="class_team_speak3___node___abstract.html#a4a0a5545abc2460d1d9b3d6b52d07cbe" title="Returns the primary ID of the current node. ">getId</a>()) ? -1 : 1;</div>
|
|
<div class="line"><a name="l02440"></a><span class="lineno"> 2440</span>  }</div>
|
|
<div class="line"><a name="l02441"></a><span class="lineno"> 2441</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02442"></a><span class="lineno"> 2442</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l02443"></a><span class="lineno"> 2443</span> <span class="comment"> * Internal callback funtion for sorting of file list items.</span></div>
|
|
<div class="line"><a name="l02444"></a><span class="lineno"> 2444</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02445"></a><span class="lineno"> 2445</span> <span class="comment"> * @param array $a</span></div>
|
|
<div class="line"><a name="l02446"></a><span class="lineno"> 2446</span> <span class="comment"> * @param array $b</span></div>
|
|
<div class="line"><a name="l02447"></a><span class="lineno"> 2447</span> <span class="comment"> * @return integer</span></div>
|
|
<div class="line"><a name="l02448"></a><span class="lineno"> 2448</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02449"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a3a630027cf54d62e6efad854d4e543c9"> 2449</a></span>  <span class="keyword">protected</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a3a630027cf54d62e6efad854d4e543c9" title="Internal callback funtion for sorting of file list items. ">sortFileList</a>(array $a, array $b)</div>
|
|
<div class="line"><a name="l02450"></a><span class="lineno"> 2450</span>  {</div>
|
|
<div class="line"><a name="l02451"></a><span class="lineno"> 2451</span>  <span class="keywordflow">if</span>(!array_key_exists(<span class="stringliteral">"src"</span>, $a) || !array_key_exists(<span class="stringliteral">"src"</span>, $b) || !array_key_exists(<span class="stringliteral">"type"</span>, $a) || !array_key_exists(<span class="stringliteral">"type"</span>, $b))</div>
|
|
<div class="line"><a name="l02452"></a><span class="lineno"> 2452</span>  {</div>
|
|
<div class="line"><a name="l02453"></a><span class="lineno"> 2453</span>  <span class="keywordflow">return</span> 0;</div>
|
|
<div class="line"><a name="l02454"></a><span class="lineno"> 2454</span> </div>
|
|
<div class="line"><a name="l02455"></a><span class="lineno"> 2455</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___server_query___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_ServerQuery objects. ">TeamSpeak3_Adapter_ServerQuery_Exception</a>(<span class="stringliteral">"invalid parameter"</span>, 0x602);</div>
|
|
<div class="line"><a name="l02456"></a><span class="lineno"> 2456</span>  }</div>
|
|
<div class="line"><a name="l02457"></a><span class="lineno"> 2457</span>  </div>
|
|
<div class="line"><a name="l02458"></a><span class="lineno"> 2458</span>  <span class="keywordflow">if</span>($a[<span class="stringliteral">"type"</span>] != $b[<span class="stringliteral">"type"</span>])</div>
|
|
<div class="line"><a name="l02459"></a><span class="lineno"> 2459</span>  {</div>
|
|
<div class="line"><a name="l02460"></a><span class="lineno"> 2460</span>  <span class="keywordflow">return</span> ($a[<span class="stringliteral">"type"</span>] < $b[<span class="stringliteral">"type"</span>]) ? -1 : 1;</div>
|
|
<div class="line"><a name="l02461"></a><span class="lineno"> 2461</span>  }</div>
|
|
<div class="line"><a name="l02462"></a><span class="lineno"> 2462</span> </div>
|
|
<div class="line"><a name="l02463"></a><span class="lineno"> 2463</span>  <span class="keywordflow">return</span> strcmp(strtolower($a[<span class="stringliteral">"src"</span>]), strtolower($b[<span class="stringliteral">"src"</span>]));</div>
|
|
<div class="line"><a name="l02464"></a><span class="lineno"> 2464</span>  }</div>
|
|
<div class="line"><a name="l02465"></a><span class="lineno"> 2465</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02466"></a><span class="lineno"> 2466</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02467"></a><span class="lineno"> 2467</span> <span class="comment"> * Returns TRUE if the virtual server is online.</span></div>
|
|
<div class="line"><a name="l02468"></a><span class="lineno"> 2468</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02469"></a><span class="lineno"> 2469</span> <span class="comment"> * @return boolean</span></div>
|
|
<div class="line"><a name="l02470"></a><span class="lineno"> 2470</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02471"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#adc8a77671ffbf1c7c699da1f3d4d0d12"> 2471</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#adc8a77671ffbf1c7c699da1f3d4d0d12" title="Returns TRUE if the virtual server is online. ">isOnline</a>()</div>
|
|
<div class="line"><a name="l02472"></a><span class="lineno"> 2472</span>  {</div>
|
|
<div class="line"><a name="l02473"></a><span class="lineno"> 2473</span>  <span class="keywordflow">return</span> ($this[<span class="stringliteral">"virtualserver_status"</span>] == <span class="stringliteral">"online"</span>) ? TRUE : FALSE;</div>
|
|
<div class="line"><a name="l02474"></a><span class="lineno"> 2474</span>  }</div>
|
|
<div class="line"><a name="l02475"></a><span class="lineno"> 2475</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02476"></a><span class="lineno"> 2476</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02477"></a><span class="lineno"> 2477</span> <span class="comment"> * Returns TRUE if the virtual server is offline.</span></div>
|
|
<div class="line"><a name="l02478"></a><span class="lineno"> 2478</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02479"></a><span class="lineno"> 2479</span> <span class="comment"> * @return boolean</span></div>
|
|
<div class="line"><a name="l02480"></a><span class="lineno"> 2480</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02481"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a55f06b4b0c636dcc41a877edc5a3a7d7"> 2481</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a55f06b4b0c636dcc41a877edc5a3a7d7" title="Returns TRUE if the virtual server is offline. ">isOffline</a>()</div>
|
|
<div class="line"><a name="l02482"></a><span class="lineno"> 2482</span>  {</div>
|
|
<div class="line"><a name="l02483"></a><span class="lineno"> 2483</span>  <span class="keywordflow">return</span> ($this[<span class="stringliteral">"virtualserver_status"</span>] == <span class="stringliteral">"offline"</span>) ? TRUE : FALSE;</div>
|
|
<div class="line"><a name="l02484"></a><span class="lineno"> 2484</span>  }</div>
|
|
<div class="line"><a name="l02485"></a><span class="lineno"> 2485</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02486"></a><span class="lineno"> 2486</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02487"></a><span class="lineno"> 2487</span> <span class="comment"> * Returns a unique identifier for the node which can be used as a HTML property.</span></div>
|
|
<div class="line"><a name="l02488"></a><span class="lineno"> 2488</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02489"></a><span class="lineno"> 2489</span> <span class="comment"> * @return string</span></div>
|
|
<div class="line"><a name="l02490"></a><span class="lineno"> 2490</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02491"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a175e7b6d81e8e6c363df445874e5932b"> 2491</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a175e7b6d81e8e6c363df445874e5932b" title="Returns a unique identifier for the node which can be used as a HTML property. ">getUniqueId</a>()</div>
|
|
<div class="line"><a name="l02492"></a><span class="lineno"> 2492</span>  {</div>
|
|
<div class="line"><a name="l02493"></a><span class="lineno"> 2493</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___node___abstract.html#a44618fb948562e89515330e65d08da9a" title="Returns the parent object of the current node. ">getParent</a>()->getUniqueId() . <span class="stringliteral">"_s"</span> . $this-><a class="code" href="class_team_speak3___node___abstract.html#a4a0a5545abc2460d1d9b3d6b52d07cbe" title="Returns the primary ID of the current node. ">getId</a>();</div>
|
|
<div class="line"><a name="l02494"></a><span class="lineno"> 2494</span>  }</div>
|
|
<div class="line"><a name="l02495"></a><span class="lineno"> 2495</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02496"></a><span class="lineno"> 2496</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02497"></a><span class="lineno"> 2497</span> <span class="comment"> * Returns the name of a possible icon to display the node object.</span></div>
|
|
<div class="line"><a name="l02498"></a><span class="lineno"> 2498</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02499"></a><span class="lineno"> 2499</span> <span class="comment"> * @return string</span></div>
|
|
<div class="line"><a name="l02500"></a><span class="lineno"> 2500</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02501"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#aa2d9831041f8a981349f4a5b92729efe"> 2501</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#aa2d9831041f8a981349f4a5b92729efe" title="Returns the name of a possible icon to display the node object. ">getIcon</a>()</div>
|
|
<div class="line"><a name="l02502"></a><span class="lineno"> 2502</span>  {</div>
|
|
<div class="line"><a name="l02503"></a><span class="lineno"> 2503</span>  <span class="keywordflow">if</span>($this[<span class="stringliteral">"virtualserver_clientsonline"</span>]-$this[<span class="stringliteral">"virtualserver_queryclientsonline"</span>] >= $this[<span class="stringliteral">"virtualserver_maxclients"</span>])</div>
|
|
<div class="line"><a name="l02504"></a><span class="lineno"> 2504</span>  {</div>
|
|
<div class="line"><a name="l02505"></a><span class="lineno"> 2505</span>  <span class="keywordflow">return</span> <span class="stringliteral">"server_full"</span>;</div>
|
|
<div class="line"><a name="l02506"></a><span class="lineno"> 2506</span>  }</div>
|
|
<div class="line"><a name="l02507"></a><span class="lineno"> 2507</span>  elseif($this[<span class="stringliteral">"virtualserver_flag_password"</span>])</div>
|
|
<div class="line"><a name="l02508"></a><span class="lineno"> 2508</span>  {</div>
|
|
<div class="line"><a name="l02509"></a><span class="lineno"> 2509</span>  <span class="keywordflow">return</span> <span class="stringliteral">"server_pass"</span>;</div>
|
|
<div class="line"><a name="l02510"></a><span class="lineno"> 2510</span>  }</div>
|
|
<div class="line"><a name="l02511"></a><span class="lineno"> 2511</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l02512"></a><span class="lineno"> 2512</span>  {</div>
|
|
<div class="line"><a name="l02513"></a><span class="lineno"> 2513</span>  <span class="keywordflow">return</span> <span class="stringliteral">"server_open"</span>;</div>
|
|
<div class="line"><a name="l02514"></a><span class="lineno"> 2514</span>  }</div>
|
|
<div class="line"><a name="l02515"></a><span class="lineno"> 2515</span>  }</div>
|
|
<div class="line"><a name="l02516"></a><span class="lineno"> 2516</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02517"></a><span class="lineno"> 2517</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02518"></a><span class="lineno"> 2518</span> <span class="comment"> * Returns a symbol representing the node.</span></div>
|
|
<div class="line"><a name="l02519"></a><span class="lineno"> 2519</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02520"></a><span class="lineno"> 2520</span> <span class="comment"> * @return string</span></div>
|
|
<div class="line"><a name="l02521"></a><span class="lineno"> 2521</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02522"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a1cc7958a2d747a65c877408a2e0772f2"> 2522</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a1cc7958a2d747a65c877408a2e0772f2" title="Returns a symbol representing the node. ">getSymbol</a>()</div>
|
|
<div class="line"><a name="l02523"></a><span class="lineno"> 2523</span>  {</div>
|
|
<div class="line"><a name="l02524"></a><span class="lineno"> 2524</span>  <span class="keywordflow">return</span> <span class="stringliteral">"$"</span>;</div>
|
|
<div class="line"><a name="l02525"></a><span class="lineno"> 2525</span>  }</div>
|
|
<div class="line"><a name="l02526"></a><span class="lineno"> 2526</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l02527"></a><span class="lineno"> 2527</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l02528"></a><span class="lineno"> 2528</span> <span class="comment"> * Returns a string representation of this node.</span></div>
|
|
<div class="line"><a name="l02529"></a><span class="lineno"> 2529</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l02530"></a><span class="lineno"> 2530</span> <span class="comment"> * @return string</span></div>
|
|
<div class="line"><a name="l02531"></a><span class="lineno"> 2531</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l02532"></a><span class="lineno"><a class="code" href="class_team_speak3___node___server.html#a50f029dcd7ba276c8b9c40c99c50f38d"> 2532</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3___node___server.html#a50f029dcd7ba276c8b9c40c99c50f38d" title="Returns a string representation of this node. ">__toString</a>()</div>
|
|
<div class="line"><a name="l02533"></a><span class="lineno"> 2533</span>  {</div>
|
|
<div class="line"><a name="l02534"></a><span class="lineno"> 2534</span>  <span class="keywordflow">return</span> (<span class="keywordtype">string</span>) $this[<span class="stringliteral">"virtualserver_name"</span>];</div>
|
|
<div class="line"><a name="l02535"></a><span class="lineno"> 2535</span>  }</div>
|
|
<div class="line"><a name="l02536"></a><span class="lineno"> 2536</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_3d7cd49b95def433e02a0e6f52be25f0.html">Node</a></li><li class="navelem"><a class="el" href="_server_8php.html">Server.php</a></li>
|
|
<li class="footer">Generated on Fri Oct 11 2013 23:35:43 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>
|