809 lines
61 KiB
HTML
809 lines
61 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_Adapter_Update Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><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="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</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('class_team_speak3___adapter___update.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="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="class_team_speak3___adapter___update-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">TeamSpeak3_Adapter_Update Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Provides methods to query the latest TeamSpeak 3 build numbers from the master server.
|
|
<a href="class_team_speak3___adapter___update.html#details">More...</a></p>
|
|
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for TeamSpeak3_Adapter_Update:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<div class="center">
|
|
<img src="class_team_speak3___adapter___update.png" usemap="#TeamSpeak3_Adapter_Update_map" alt=""/>
|
|
<map id="TeamSpeak3_Adapter_Update_map" name="TeamSpeak3_Adapter_Update_map">
|
|
<area href="class_team_speak3___adapter___abstract.html" title="Provides low-level methods for concrete adapters to communicate with a TeamSpeak 3 Server..." alt="TeamSpeak3_Adapter_Abstract" shape="rect" coords="0,0,190,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aff480ecd1d746c8014242bee9ff15a42"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___update.html#aff480ecd1d746c8014242bee9ff15a42">syn</a> ()</td></tr>
|
|
<tr class="memdesc:aff480ecd1d746c8014242bee9ff15a42"><td class="mdescLeft"> </td><td class="mdescRight">Connects the <a class="el" href="class_team_speak3___transport___abstract.html" title="Abstract class for connecting to a TeamSpeak 3 Server through different ways of transport. ">TeamSpeak3_Transport_Abstract</a> object and performs initial actions on the remote server. <a href="#aff480ecd1d746c8014242bee9ff15a42">More...</a><br/></td></tr>
|
|
<tr class="separator:aff480ecd1d746c8014242bee9ff15a42"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a09d4e6b18f2475adfc1f5a74c6478421"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___update.html#a09d4e6b18f2475adfc1f5a74c6478421">__destruct</a> ()</td></tr>
|
|
<tr class="memdesc:a09d4e6b18f2475adfc1f5a74c6478421"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="class_team_speak3___adapter___update.html" title="Provides methods to query the latest TeamSpeak 3 build numbers from the master server. ">TeamSpeak3_Adapter_Update</a> destructor. <a href="#a09d4e6b18f2475adfc1f5a74c6478421">More...</a><br/></td></tr>
|
|
<tr class="separator:a09d4e6b18f2475adfc1f5a74c6478421"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacf23e72f0978884a9b44c7e6679a06d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___update.html#aacf23e72f0978884a9b44c7e6679a06d">getRev</a> ($channel="stable")</td></tr>
|
|
<tr class="memdesc:aacf23e72f0978884a9b44c7e6679a06d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current build number for a specified update channel. <a href="#aacf23e72f0978884a9b44c7e6679a06d">More...</a><br/></td></tr>
|
|
<tr class="separator:aacf23e72f0978884a9b44c7e6679a06d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac25205f46f31a8de30454d499e6aaa04"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___update.html#ac25205f46f31a8de30454d499e6aaa04">getVersion</a> ($channel="stable")</td></tr>
|
|
<tr class="memdesc:ac25205f46f31a8de30454d499e6aaa04"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current version string for a specified update channel. <a href="#ac25205f46f31a8de30454d499e6aaa04">More...</a><br/></td></tr>
|
|
<tr class="separator:ac25205f46f31a8de30454d499e6aaa04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af42f2e98ffbecdbc375304737a54a4a0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___update.html#af42f2e98ffbecdbc375304737a54a4a0">getClientRev</a> ()</td></tr>
|
|
<tr class="memdesc:af42f2e98ffbecdbc375304737a54a4a0"><td class="mdescLeft"> </td><td class="mdescRight">Alias for <a class="el" href="class_team_speak3___adapter___update.html#aacf23e72f0978884a9b44c7e6679a06d" title="Returns the current build number for a specified update channel. ">getRev()</a> using the 'stable' update channel. <a href="#af42f2e98ffbecdbc375304737a54a4a0">More...</a><br/></td></tr>
|
|
<tr class="separator:af42f2e98ffbecdbc375304737a54a4a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e1f0776fc33efb9ac61336ae59faa80"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___update.html#a3e1f0776fc33efb9ac61336ae59faa80">getServerRev</a> ()</td></tr>
|
|
<tr class="memdesc:a3e1f0776fc33efb9ac61336ae59faa80"><td class="mdescLeft"> </td><td class="mdescRight">Alias for <a class="el" href="class_team_speak3___adapter___update.html#aacf23e72f0978884a9b44c7e6679a06d" title="Returns the current build number for a specified update channel. ">getRev()</a> using the 'server' update channel. <a href="#a3e1f0776fc33efb9ac61336ae59faa80">More...</a><br/></td></tr>
|
|
<tr class="separator:a3e1f0776fc33efb9ac61336ae59faa80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa1c205259b8912526ad533ed17acd564"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___update.html#aa1c205259b8912526ad533ed17acd564">getClientVersion</a> ()</td></tr>
|
|
<tr class="memdesc:aa1c205259b8912526ad533ed17acd564"><td class="mdescLeft"> </td><td class="mdescRight">Alias for <a class="el" href="class_team_speak3___adapter___update.html#ac25205f46f31a8de30454d499e6aaa04" title="Returns the current version string for a specified update channel. ">getVersion()</a> using the 'stable' update channel. <a href="#aa1c205259b8912526ad533ed17acd564">More...</a><br/></td></tr>
|
|
<tr class="separator:aa1c205259b8912526ad533ed17acd564"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a116864fefa2a1cf7fb5fef1847320e60"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___update.html#a116864fefa2a1cf7fb5fef1847320e60">getServerVersion</a> ()</td></tr>
|
|
<tr class="memdesc:a116864fefa2a1cf7fb5fef1847320e60"><td class="mdescLeft"> </td><td class="mdescRight">Alias for <a class="el" href="class_team_speak3___adapter___update.html#ac25205f46f31a8de30454d499e6aaa04" title="Returns the current version string for a specified update channel. ">getVersion()</a> using the 'server' update channel. <a href="#a116864fefa2a1cf7fb5fef1847320e60">More...</a><br/></td></tr>
|
|
<tr class="separator:a116864fefa2a1cf7fb5fef1847320e60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa29be26280db12e38aef59d90f7c6ac"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___abstract.html#afa29be26280db12e38aef59d90f7c6ac">__sleep</a> ()</td></tr>
|
|
<tr class="memdesc:afa29be26280db12e38aef59d90f7c6ac"><td class="mdescLeft"> </td><td class="mdescRight">Commit pending data. <a href="#afa29be26280db12e38aef59d90f7c6ac">More...</a><br/></td></tr>
|
|
<tr class="separator:afa29be26280db12e38aef59d90f7c6ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa3c73f10edd73494087a7a523726a89"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___abstract.html#aaa3c73f10edd73494087a7a523726a89">__wakeup</a> ()</td></tr>
|
|
<tr class="memdesc:aaa3c73f10edd73494087a7a523726a89"><td class="mdescLeft"> </td><td class="mdescRight">Reconnects to the remote server. <a href="#aaa3c73f10edd73494087a7a523726a89">More...</a><br/></td></tr>
|
|
<tr class="separator:aaa3c73f10edd73494087a7a523726a89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1bd002b22a8121e8efa5ab4ccd36fa5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___abstract.html#ab1bd002b22a8121e8efa5ab4ccd36fa5">getProfiler</a> ()</td></tr>
|
|
<tr class="memdesc:ab1bd002b22a8121e8efa5ab4ccd36fa5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the profiler timer used for this connection adapter. <a href="#ab1bd002b22a8121e8efa5ab4ccd36fa5">More...</a><br/></td></tr>
|
|
<tr class="separator:ab1bd002b22a8121e8efa5ab4ccd36fa5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a538e98e6dcc6a2ad7fdcb4913f6f7c52"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___abstract.html#a538e98e6dcc6a2ad7fdcb4913f6f7c52">getTransport</a> ()</td></tr>
|
|
<tr class="memdesc:a538e98e6dcc6a2ad7fdcb4913f6f7c52"><td class="mdescLeft"> </td><td class="mdescRight">Returns the transport object used for this connection adapter. <a href="#a538e98e6dcc6a2ad7fdcb4913f6f7c52">More...</a><br/></td></tr>
|
|
<tr class="separator:a538e98e6dcc6a2ad7fdcb4913f6f7c52"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adcf5e760b6d6d3e42f11d8b1bc5d87cc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___abstract.html#adcf5e760b6d6d3e42f11d8b1bc5d87cc">getTransportHost</a> ()</td></tr>
|
|
<tr class="memdesc:adcf5e760b6d6d3e42f11d8b1bc5d87cc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the hostname or IPv4 address the underlying <a class="el" href="class_team_speak3___transport___abstract.html" title="Abstract class for connecting to a TeamSpeak 3 Server through different ways of transport. ">TeamSpeak3_Transport_Abstract</a> object is connected to. <a href="#adcf5e760b6d6d3e42f11d8b1bc5d87cc">More...</a><br/></td></tr>
|
|
<tr class="separator:adcf5e760b6d6d3e42f11d8b1bc5d87cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5eb0b19787ec6f719d8f19bcd7182461"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___abstract.html#a5eb0b19787ec6f719d8f19bcd7182461">getTransportPort</a> ()</td></tr>
|
|
<tr class="memdesc:a5eb0b19787ec6f719d8f19bcd7182461"><td class="mdescLeft"> </td><td class="mdescRight">Returns the port number of the server the underlying <a class="el" href="class_team_speak3___transport___abstract.html" title="Abstract class for connecting to a TeamSpeak 3 Server through different ways of transport. ">TeamSpeak3_Transport_Abstract</a> object is connected to. <a href="#a5eb0b19787ec6f719d8f19bcd7182461">More...</a><br/></td></tr>
|
|
<tr class="separator:a5eb0b19787ec6f719d8f19bcd7182461"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a87920747e1eb4a25396c5b5e5567094b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___adapter___abstract.html#a87920747e1eb4a25396c5b5e5567094b">initTransport</a> ($options, $transport="TeamSpeak3_Transport_TCP")</td></tr>
|
|
<tr class="memdesc:a87920747e1eb4a25396c5b5e5567094b"><td class="mdescLeft"> </td><td class="mdescRight">Loads the transport object object used for the connection adapter and passes a given set of options. <a href="#a87920747e1eb4a25396c5b5e5567094b">More...</a><br/></td></tr>
|
|
<tr class="separator:a87920747e1eb4a25396c5b5e5567094b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:aff0d4389ef94200093e46352325b662d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff0d4389ef94200093e46352325b662d"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$default_host</b> = "update.teamspeak.com"</td></tr>
|
|
<tr class="separator:aff0d4389ef94200093e46352325b662d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97aee7ab17ceb200cbda0e044722067e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97aee7ab17ceb200cbda0e044722067e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$default_port</b> = 17384</td></tr>
|
|
<tr class="separator:a97aee7ab17ceb200cbda0e044722067e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a54aadf28b42c9ae4443c03ae1ab80a0d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54aadf28b42c9ae4443c03ae1ab80a0d"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$build_datetimes</b> = null</td></tr>
|
|
<tr class="separator:a54aadf28b42c9ae4443c03ae1ab80a0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a172f895cafdc41dc38d0d3dcad40daf4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a172f895cafdc41dc38d0d3dcad40daf4"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$version_strings</b> = null</td></tr>
|
|
<tr class="separator:a172f895cafdc41dc38d0d3dcad40daf4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94b75d4f99ef639e5cb39e900d38e56a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94b75d4f99ef639e5cb39e900d38e56a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$options</b> = null</td></tr>
|
|
<tr class="separator:a94b75d4f99ef639e5cb39e900d38e56a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a257acaf2793889d1e75364d40e7fa15d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a257acaf2793889d1e75364d40e7fa15d"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$transport</b> = null</td></tr>
|
|
<tr class="separator:a257acaf2793889d1e75364d40e7fa15d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Provides methods to query the latest TeamSpeak 3 build numbers from the master server. </p>
|
|
|
|
<p>Definition at line <a class="el" href="_update_8php_source.html#l00032">32</a> of file <a class="el" href="_update_8php_source.html">Update.php</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a09d4e6b18f2475adfc1f5a74c6478421"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Update::__destruct </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The <a class="el" href="class_team_speak3___adapter___update.html" title="Provides methods to query the latest TeamSpeak 3 build numbers from the master server. ">TeamSpeak3_Adapter_Update</a> destructor. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_update_8php_source.html#l00097">97</a> of file <a class="el" href="_update_8php_source.html">Update.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_adapter_2_abstract_8php_source.html#l00115">TeamSpeak3_Adapter_Abstract\getTransport()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  {</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">if</span>($this-><a class="code" href="class_team_speak3___adapter___abstract.html#a538e98e6dcc6a2ad7fdcb4913f6f7c52" title="Returns the transport object used for this connection adapter. ">getTransport</a>() instanceof <a class="code" href="class_team_speak3___transport___abstract.html" title="Abstract class for connecting to a TeamSpeak 3 Server through different ways of transport. ">TeamSpeak3_Transport_Abstract</a> && $this-><a class="code" href="class_team_speak3___adapter___abstract.html#a538e98e6dcc6a2ad7fdcb4913f6f7c52" title="Returns the transport object used for this connection adapter. ">getTransport</a>()->isConnected())</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>  $this-><a class="code" href="class_team_speak3___adapter___abstract.html#a538e98e6dcc6a2ad7fdcb4913f6f7c52" title="Returns the transport object used for this connection adapter. ">getTransport</a>()->disconnect();</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>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="aff480ecd1d746c8014242bee9ff15a42"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Update::syn </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Connects the <a class="el" href="class_team_speak3___transport___abstract.html" title="Abstract class for connecting to a TeamSpeak 3 Server through different ways of transport. ">TeamSpeak3_Transport_Abstract</a> object and performs initial actions on the remote server. </p>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="class_team_speak3___adapter___update___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_Update objects. ">TeamSpeak3_Adapter_Update_Exception</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_update_8php_source.html#l00069">69</a> of file <a class="el" href="_update_8php_source.html">Update.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_string_8php_source.html#l00526">TeamSpeak3_Helper_String\fromHex()</a>, <a class="el" href="_signal_8php_source.html#l00204">TeamSpeak3_Helper_Signal\getInstance()</a>, <a class="el" href="_adapter_2_abstract_8php_source.html#l00115">TeamSpeak3_Adapter_Abstract\getTransport()</a>, <a class="el" href="_profiler_8php_source.html#l00047">TeamSpeak3_Helper_Profiler\init()</a>, and <a class="el" href="_adapter_2_abstract_8php_source.html#l00129">TeamSpeak3_Adapter_Abstract\initTransport()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  {</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">if</span>(!isset($this->options[<span class="stringliteral">"host"</span>]) || empty($this->options[<span class="stringliteral">"host"</span>])) $this->options[<span class="stringliteral">"host"</span>] = $this->default_host;</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">if</span>(!isset($this->options[<span class="stringliteral">"port"</span>]) || empty($this->options[<span class="stringliteral">"port"</span>])) $this->options[<span class="stringliteral">"port"</span>] = $this->default_port;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  $this-><a class="code" href="class_team_speak3___adapter___abstract.html#a87920747e1eb4a25396c5b5e5567094b" title="Loads the transport object object used for the connection adapter and passes a given set of options...">initTransport</a>($this->options, <span class="stringliteral">"TeamSpeak3_Transport_UDP"</span>);</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  $this->transport->setAdapter($this);</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="class_team_speak3___helper___profiler.html#a7761d609ec2deda6d278709293f01d22" title="Inits a timer. ">TeamSpeak3_Helper_Profiler::init</a>(spl_object_hash($this));</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  $this-><a class="code" href="class_team_speak3___adapter___abstract.html#a538e98e6dcc6a2ad7fdcb4913f6f7c52" title="Returns the transport object used for this connection adapter. ">getTransport</a>()->send(<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>(33));</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">if</span>(!preg_match_all(<span class="stringliteral">"/,?(\d+)#([0-9a-zA-Z\._-]+),?/"</span>, $this-><a class="code" href="class_team_speak3___adapter___abstract.html#a538e98e6dcc6a2ad7fdcb4913f6f7c52" title="Returns the transport object used for this connection adapter. ">getTransport</a>()->read(96), $matches) || !isset($matches[1]) || !isset($matches[2]))</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  {</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___update___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_Update objects. ">TeamSpeak3_Adapter_Update_Exception</a>(<span class="stringliteral">"invalid reply from the server"</span>);</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> </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  $this->build_datetimes = $matches[1];</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  $this->version_strings = $matches[2];</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>  <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">"updateConnected"</span>, $this);</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aacf23e72f0978884a9b44c7e6679a06d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Update::getRev </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$channel</em> = <code>"stable"</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the current build number for a specified update channel. </p>
|
|
<p>Note that since version 3.0.0, the build number represents an integer timestamp. $channel must be set to one of the following values:</p>
|
|
<ul>
|
|
<li>stable</li>
|
|
<li>beta</li>
|
|
<li>alpha</li>
|
|
<li>server</li>
|
|
</ul>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$channel</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="class_team_speak3___adapter___update___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_Update objects. ">TeamSpeak3_Adapter_Update_Exception</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>integer </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_update_8php_source.html#l00119">119</a> of file <a class="el" href="_update_8php_source.html">Update.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_update_8php_source.html#l00180">getClientRev()</a>, and <a class="el" href="_update_8php_source.html#l00191">getServerRev()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  {</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordflow">switch</span>($channel)</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  {</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordflow">case</span> <span class="stringliteral">"stable"</span>:</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordflow">return</span> isset($this->build_datetimes[0]) ? $this->build_datetimes[0] : null;</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordflow">case</span> <span class="stringliteral">"beta"</span>:</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordflow">return</span> isset($this->build_datetimes[1]) ? $this->build_datetimes[1] : null;</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordflow">case</span> <span class="stringliteral">"alpha"</span>:</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordflow">return</span> isset($this->build_datetimes[2]) ? $this->build_datetimes[2] : null;</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordflow">case</span> <span class="stringliteral">"server"</span>:</div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordflow">return</span> isset($this->build_datetimes[3]) ? $this->build_datetimes[3] : null;</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordflow">default</span>:</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___update___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_Update objects. ">TeamSpeak3_Adapter_Update_Exception</a>(<span class="stringliteral">"invalid update channel identifier ("</span> . $channel . <span class="stringliteral">")"</span>);</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac25205f46f31a8de30454d499e6aaa04"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Update::getVersion </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$channel</em> = <code>"stable"</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the current version string for a specified update channel. </p>
|
|
<p>$channel must be set to one of the following values:</p>
|
|
<ul>
|
|
<li>stable</li>
|
|
<li>beta</li>
|
|
<li>alpha</li>
|
|
<li>server</li>
|
|
</ul>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$channel</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="class_team_speak3___adapter___update___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_Update objects. ">TeamSpeak3_Adapter_Update_Exception</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>integer </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_update_8php_source.html#l00153">153</a> of file <a class="el" href="_update_8php_source.html">Update.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_update_8php_source.html#l00202">getClientVersion()</a>, and <a class="el" href="_update_8php_source.html#l00213">getServerVersion()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  {</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordflow">switch</span>($channel)</div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  {</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordflow">case</span> <span class="stringliteral">"stable"</span>:</div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordflow">return</span> isset($this->version_strings[0]) ? $this->version_strings[0] : null;</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">case</span> <span class="stringliteral">"beta"</span>:</div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordflow">return</span> isset($this->version_strings[1]) ? $this->version_strings[1] : null;</div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keywordflow">case</span> <span class="stringliteral">"alpha"</span>:</div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keywordflow">return</span> isset($this->version_strings[2]) ? $this->version_strings[2] : null;</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordflow">case</span> <span class="stringliteral">"server"</span>:</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keywordflow">return</span> isset($this->version_strings[3]) ? $this->version_strings[3] : null;</div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordflow">default</span>:</div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___update___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_Update objects. ">TeamSpeak3_Adapter_Update_Exception</a>(<span class="stringliteral">"invalid update channel identifier ("</span> . $channel . <span class="stringliteral">")"</span>);</div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  }</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af42f2e98ffbecdbc375304737a54a4a0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Update::getClientRev </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Alias for <a class="el" href="class_team_speak3___adapter___update.html#aacf23e72f0978884a9b44c7e6679a06d" title="Returns the current build number for a specified update channel. ">getRev()</a> using the 'stable' update channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$channel</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>integer </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_update_8php_source.html#l00180">180</a> of file <a class="el" href="_update_8php_source.html">Update.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_update_8php_source.html#l00119">getRev()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  {</div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___adapter___update.html#aacf23e72f0978884a9b44c7e6679a06d" title="Returns the current build number for a specified update channel. ">getRev</a>(<span class="stringliteral">"stable"</span>);</div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3e1f0776fc33efb9ac61336ae59faa80"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Update::getServerRev </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Alias for <a class="el" href="class_team_speak3___adapter___update.html#aacf23e72f0978884a9b44c7e6679a06d" title="Returns the current build number for a specified update channel. ">getRev()</a> using the 'server' update channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$channel</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>integer </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_update_8php_source.html#l00191">191</a> of file <a class="el" href="_update_8php_source.html">Update.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_update_8php_source.html#l00119">getRev()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  {</div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___adapter___update.html#aacf23e72f0978884a9b44c7e6679a06d" title="Returns the current build number for a specified update channel. ">getRev</a>(<span class="stringliteral">"server"</span>);</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa1c205259b8912526ad533ed17acd564"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Update::getClientVersion </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Alias for <a class="el" href="class_team_speak3___adapter___update.html#ac25205f46f31a8de30454d499e6aaa04" title="Returns the current version string for a specified update channel. ">getVersion()</a> using the 'stable' update channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$channel</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>integer </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_update_8php_source.html#l00202">202</a> of file <a class="el" href="_update_8php_source.html">Update.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_update_8php_source.html#l00153">getVersion()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  {</div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___adapter___update.html#ac25205f46f31a8de30454d499e6aaa04" title="Returns the current version string for a specified update channel. ">getVersion</a>(<span class="stringliteral">"stable"</span>);</div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a116864fefa2a1cf7fb5fef1847320e60"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Update::getServerVersion </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Alias for <a class="el" href="class_team_speak3___adapter___update.html#ac25205f46f31a8de30454d499e6aaa04" title="Returns the current version string for a specified update channel. ">getVersion()</a> using the 'server' update channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$channel</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>integer </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_update_8php_source.html#l00213">213</a> of file <a class="el" href="_update_8php_source.html">Update.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_update_8php_source.html#l00153">getVersion()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  {</div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___adapter___update.html#ac25205f46f31a8de30454d499e6aaa04" title="Returns the current version string for a specified update channel. ">getVersion</a>(<span class="stringliteral">"server"</span>);</div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afa29be26280db12e38aef59d90f7c6ac"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Abstract::__sleep </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Commit pending data. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>array </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_adapter_2_abstract_8php_source.html#l00085">85</a> of file <a class="el" href="_adapter_2_abstract_8php_source.html">Abstract.php</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  {</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">return</span> array(<span class="stringliteral">"options"</span>);</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aaa3c73f10edd73494087a7a523726a89"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Abstract::__wakeup </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reconnects to the remote server. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_adapter_2_abstract_8php_source.html#l00095">95</a> of file <a class="el" href="_adapter_2_abstract_8php_source.html">Abstract.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="class_team_speak3___adapter___abstract.html#aa57e551da82adf543957163f0a6d1c6e">TeamSpeak3_Adapter_Abstract\syn()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  {</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  $this-><a class="code" href="class_team_speak3___adapter___abstract.html#aa57e551da82adf543957163f0a6d1c6e" title="Connects the TeamSpeak3_Transport_Abstract object and performs initial actions on the remote server...">syn</a>();</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab1bd002b22a8121e8efa5ab4ccd36fa5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Abstract::getProfiler </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the profiler timer used for this connection adapter. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_team_speak3___helper___profiler___timer.html" title="Helper class providing profiler timers. ">TeamSpeak3_Helper_Profiler_Timer</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_adapter_2_abstract_8php_source.html#l00105">105</a> of file <a class="el" href="_adapter_2_abstract_8php_source.html">Abstract.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_profiler_8php_source.html#l00092">TeamSpeak3_Helper_Profiler\get()</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_file_transfer_8php_source.html#l00134">TeamSpeak3_Adapter_FileTransfer\download()</a>, <a class="el" href="_server_query_8php_source.html#l00242">TeamSpeak3_Adapter_ServerQuery\getQueryRuntime()</a>, <a class="el" href="_file_transfer_8php_source.html#l00071">TeamSpeak3_Adapter_FileTransfer\init()</a>, <a class="el" href="_server_query_8php_source.html#l00112">TeamSpeak3_Adapter_ServerQuery\request()</a>, and <a class="el" href="_file_transfer_8php_source.html#l00093">TeamSpeak3_Adapter_FileTransfer\upload()</a>.</p>
|
|
<div class="fragment"><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">return</span> <a class="code" href="class_team_speak3___helper___profiler.html#abac13a094b11882d102d24857dd2f678" title="Returns a timer. ">TeamSpeak3_Helper_Profiler::get</a>(spl_object_hash($this));</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a538e98e6dcc6a2ad7fdcb4913f6f7c52"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Abstract::getTransport </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the transport object used for this connection adapter. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_team_speak3___transport___abstract.html" title="Abstract class for connecting to a TeamSpeak 3 Server through different ways of transport. ">TeamSpeak3_Transport_Abstract</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_adapter_2_abstract_8php_source.html#l00115">115</a> of file <a class="el" href="_adapter_2_abstract_8php_source.html">Abstract.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_file_transfer_8php_source.html#l00056">TeamSpeak3_Adapter_FileTransfer\__destruct()</a>, <a class="el" href="_t_s_d_n_s_8php_source.html#l00065">TeamSpeak3_Adapter_TSDNS\__destruct()</a>, <a class="el" href="_blacklist_8php_source.html#l00079">TeamSpeak3_Adapter_Blacklist\__destruct()</a>, <a class="el" href="_server_query_8php_source.html#l00089">TeamSpeak3_Adapter_ServerQuery\__destruct()</a>, <a class="el" href="_update_8php_source.html#l00097">__destruct()</a>, <a class="el" href="_file_transfer_8php_source.html#l00134">TeamSpeak3_Adapter_FileTransfer\download()</a>, <a class="el" href="_adapter_2_abstract_8php_source.html#l00145">TeamSpeak3_Adapter_Abstract\getTransportHost()</a>, <a class="el" href="_adapter_2_abstract_8php_source.html#l00156">TeamSpeak3_Adapter_Abstract\getTransportPort()</a>, <a class="el" href="_file_transfer_8php_source.html#l00071">TeamSpeak3_Adapter_FileTransfer\init()</a>, <a class="el" href="_blacklist_8php_source.html#l00094">TeamSpeak3_Adapter_Blacklist\isBlacklisted()</a>, <a class="el" href="_file_transfer_8php_source.html#l00181">TeamSpeak3_Adapter_FileTransfer\passthru()</a>, <a class="el" href="_server_query_8php_source.html#l00112">TeamSpeak3_Adapter_ServerQuery\request()</a>, <a class="el" href="_t_s_d_n_s_8php_source.html#l00080">TeamSpeak3_Adapter_TSDNS\resolve()</a>, <a class="el" href="_update_8php_source.html#l00069">syn()</a>, <a class="el" href="_server_query_8php_source.html#l00069">TeamSpeak3_Adapter_ServerQuery\syn()</a>, <a class="el" href="_file_transfer_8php_source.html#l00093">TeamSpeak3_Adapter_FileTransfer\upload()</a>, and <a class="el" href="_server_query_8php_source.html#l00154">TeamSpeak3_Adapter_ServerQuery\wait()</a>.</p>
|
|
<div class="fragment"><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="keywordflow">return</span> $this->transport;</div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a87920747e1eb4a25396c5b5e5567094b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Abstract::initTransport </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$options</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$transport</em> = <code>"TeamSpeak3_Transport_TCP"</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Loads the transport object object used for the connection adapter and passes a given set of options. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">array</td><td class="paramname">$options</td><td></td></tr>
|
|
<tr><td class="paramtype">string</td><td class="paramname">$transport</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="class_team_speak3___adapter___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_Abstract objects. ">TeamSpeak3_Adapter_Exception</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_adapter_2_abstract_8php_source.html#l00129">129</a> of file <a class="el" href="_adapter_2_abstract_8php_source.html">Abstract.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_file_transfer_8php_source.html#l00041">TeamSpeak3_Adapter_FileTransfer\syn()</a>, <a class="el" href="_t_s_d_n_s_8php_source.html#l00048">TeamSpeak3_Adapter_TSDNS\syn()</a>, <a class="el" href="_blacklist_8php_source.html#l00061">TeamSpeak3_Adapter_Blacklist\syn()</a>, <a class="el" href="_server_query_8php_source.html#l00069">TeamSpeak3_Adapter_ServerQuery\syn()</a>, and <a class="el" href="_update_8php_source.html#l00069">syn()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  {</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordflow">if</span>(!is_array($options))</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  {</div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_Abstract objects. ">TeamSpeak3_Adapter_Exception</a>(<span class="stringliteral">"transport parameters must provided in an array"</span>);</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  }</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  $this->transport = <span class="keyword">new</span> $transport($options);</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adcf5e760b6d6d3e42f11d8b1bc5d87cc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Abstract::getTransportHost </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the hostname or IPv4 address the underlying <a class="el" href="class_team_speak3___transport___abstract.html" title="Abstract class for connecting to a TeamSpeak 3 Server through different ways of transport. ">TeamSpeak3_Transport_Abstract</a> object is connected to. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_adapter_2_abstract_8php_source.html#l00145">145</a> of file <a class="el" href="_adapter_2_abstract_8php_source.html">Abstract.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_adapter_2_abstract_8php_source.html#l00115">TeamSpeak3_Adapter_Abstract\getTransport()</a>.</p>
|
|
<div class="fragment"><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="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___adapter___abstract.html#a538e98e6dcc6a2ad7fdcb4913f6f7c52" title="Returns the transport object used for this connection adapter. ">getTransport</a>()->getConfig(<span class="stringliteral">"host"</span>, <span class="stringliteral">"0.0.0.0"</span>);</div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5eb0b19787ec6f719d8f19bcd7182461"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Adapter_Abstract::getTransportPort </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the port number of the server the underlying <a class="el" href="class_team_speak3___transport___abstract.html" title="Abstract class for connecting to a TeamSpeak 3 Server through different ways of transport. ">TeamSpeak3_Transport_Abstract</a> object is connected to. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_adapter_2_abstract_8php_source.html#l00156">156</a> of file <a class="el" href="_adapter_2_abstract_8php_source.html">Abstract.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_adapter_2_abstract_8php_source.html#l00115">TeamSpeak3_Adapter_Abstract\getTransport()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  {</div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordflow">return</span> $this-><a class="code" href="class_team_speak3___adapter___abstract.html#a538e98e6dcc6a2ad7fdcb4913f6f7c52" title="Returns the transport object used for this connection adapter. ">getTransport</a>()->getConfig(<span class="stringliteral">"port"</span>, <span class="stringliteral">"0"</span>);</div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>TeamSpeak3/Adapter/<a class="el" href="_update_8php_source.html">Update.php</a></li>
|
|
</ul>
|
|
</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="class_team_speak3___adapter___update.html">TeamSpeak3_Adapter_Update</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>
|