1730 lines
121 KiB
HTML
1730 lines
121 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.4"/>
|
|
<title>TeamSpeak 3 PHP Framework: TeamSpeak3_Helper_Uri 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___helper___uri.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="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-static-methods">Static Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="class_team_speak3___helper___uri-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">TeamSpeak3_Helper_Uri Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Helper class for URI handling.
|
|
<a href="class_team_speak3___helper___uri.html#details">More...</a></p>
|
|
<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:a90842c65bae8ffcf088b1dd12def7ff1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a90842c65bae8ffcf088b1dd12def7ff1">__construct</a> ($uri)</td></tr>
|
|
<tr class="memdesc:a90842c65bae8ffcf088b1dd12def7ff1"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="class_team_speak3___helper___uri.html" title="Helper class for URI handling. ">TeamSpeak3_Helper_Uri</a> constructor. <a href="#a90842c65bae8ffcf088b1dd12def7ff1">More...</a><br/></td></tr>
|
|
<tr class="separator:a90842c65bae8ffcf088b1dd12def7ff1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32584b89b4cfeaaa09948b5b1fc67916"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a32584b89b4cfeaaa09948b5b1fc67916">isValid</a> ()</td></tr>
|
|
<tr class="memdesc:a32584b89b4cfeaaa09948b5b1fc67916"><td class="mdescLeft"> </td><td class="mdescRight">Validate the current URI from the instance variables. <a href="#a32584b89b4cfeaaa09948b5b1fc67916">More...</a><br/></td></tr>
|
|
<tr class="separator:a32584b89b4cfeaaa09948b5b1fc67916"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a489f79eec547a0c9ca9fc6befebcc0f3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a489f79eec547a0c9ca9fc6befebcc0f3">hasScheme</a> ()</td></tr>
|
|
<tr class="memdesc:a489f79eec547a0c9ca9fc6befebcc0f3"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the URI has a scheme. <a href="#a489f79eec547a0c9ca9fc6befebcc0f3">More...</a><br/></td></tr>
|
|
<tr class="separator:a489f79eec547a0c9ca9fc6befebcc0f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af47ad30cc5c9a600ee2a6c7de6e1aa83"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#af47ad30cc5c9a600ee2a6c7de6e1aa83">getScheme</a> ($default=null)</td></tr>
|
|
<tr class="memdesc:af47ad30cc5c9a600ee2a6c7de6e1aa83"><td class="mdescLeft"> </td><td class="mdescRight">Returns the scheme. <a href="#af47ad30cc5c9a600ee2a6c7de6e1aa83">More...</a><br/></td></tr>
|
|
<tr class="separator:af47ad30cc5c9a600ee2a6c7de6e1aa83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b8d5365651a38c00ba1393559ba9efd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a2b8d5365651a38c00ba1393559ba9efd">checkUser</a> ($username=null)</td></tr>
|
|
<tr class="memdesc:a2b8d5365651a38c00ba1393559ba9efd"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the username is valid. <a href="#a2b8d5365651a38c00ba1393559ba9efd">More...</a><br/></td></tr>
|
|
<tr class="separator:a2b8d5365651a38c00ba1393559ba9efd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24fab900cd8e2b43e253f85d6925f7b7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a24fab900cd8e2b43e253f85d6925f7b7">hasUser</a> ()</td></tr>
|
|
<tr class="memdesc:a24fab900cd8e2b43e253f85d6925f7b7"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the URI has a username. <a href="#a24fab900cd8e2b43e253f85d6925f7b7">More...</a><br/></td></tr>
|
|
<tr class="separator:a24fab900cd8e2b43e253f85d6925f7b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab685d3e39922aa170d2d6b06a6304084"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#ab685d3e39922aa170d2d6b06a6304084">getUser</a> ($default=null)</td></tr>
|
|
<tr class="memdesc:ab685d3e39922aa170d2d6b06a6304084"><td class="mdescLeft"> </td><td class="mdescRight">Returns the username. <a href="#ab685d3e39922aa170d2d6b06a6304084">More...</a><br/></td></tr>
|
|
<tr class="separator:ab685d3e39922aa170d2d6b06a6304084"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9dff5b48e963efca445427a2ec602ca"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#ac9dff5b48e963efca445427a2ec602ca">checkPass</a> ($password=null)</td></tr>
|
|
<tr class="memdesc:ac9dff5b48e963efca445427a2ec602ca"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the password is valid. <a href="#ac9dff5b48e963efca445427a2ec602ca">More...</a><br/></td></tr>
|
|
<tr class="separator:ac9dff5b48e963efca445427a2ec602ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa496602a698ed5690d48ec4326f8c793"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#aa496602a698ed5690d48ec4326f8c793">hasPass</a> ()</td></tr>
|
|
<tr class="memdesc:aa496602a698ed5690d48ec4326f8c793"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the URI has a password. <a href="#aa496602a698ed5690d48ec4326f8c793">More...</a><br/></td></tr>
|
|
<tr class="separator:aa496602a698ed5690d48ec4326f8c793"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d9477823c4f20b2daa98a9153326463"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a6d9477823c4f20b2daa98a9153326463">getPass</a> ($default=null)</td></tr>
|
|
<tr class="memdesc:a6d9477823c4f20b2daa98a9153326463"><td class="mdescLeft"> </td><td class="mdescRight">Returns the password. <a href="#a6d9477823c4f20b2daa98a9153326463">More...</a><br/></td></tr>
|
|
<tr class="separator:a6d9477823c4f20b2daa98a9153326463"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acaa2c62eecb695f7a7ea1e6484b4b169"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#acaa2c62eecb695f7a7ea1e6484b4b169">checkHost</a> ($host=null)</td></tr>
|
|
<tr class="memdesc:acaa2c62eecb695f7a7ea1e6484b4b169"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the host is valid. <a href="#acaa2c62eecb695f7a7ea1e6484b4b169">More...</a><br/></td></tr>
|
|
<tr class="separator:acaa2c62eecb695f7a7ea1e6484b4b169"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb9f6e1df57af8b47e94d6d581475eb1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#adb9f6e1df57af8b47e94d6d581475eb1">hasHost</a> ()</td></tr>
|
|
<tr class="memdesc:adb9f6e1df57af8b47e94d6d581475eb1"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the URI has a host. <a href="#adb9f6e1df57af8b47e94d6d581475eb1">More...</a><br/></td></tr>
|
|
<tr class="separator:adb9f6e1df57af8b47e94d6d581475eb1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca4bbb23cafa5833af4565d23f0b57c6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#aca4bbb23cafa5833af4565d23f0b57c6">getHost</a> ($default=null)</td></tr>
|
|
<tr class="memdesc:aca4bbb23cafa5833af4565d23f0b57c6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the host. <a href="#aca4bbb23cafa5833af4565d23f0b57c6">More...</a><br/></td></tr>
|
|
<tr class="separator:aca4bbb23cafa5833af4565d23f0b57c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9878d6f37ef25b9e0666cf8cd9043515"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a9878d6f37ef25b9e0666cf8cd9043515">checkPort</a> ($port=null)</td></tr>
|
|
<tr class="memdesc:a9878d6f37ef25b9e0666cf8cd9043515"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the port is valid. <a href="#a9878d6f37ef25b9e0666cf8cd9043515">More...</a><br/></td></tr>
|
|
<tr class="separator:a9878d6f37ef25b9e0666cf8cd9043515"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aada4ff6119919a87251a4569b54f3b4a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#aada4ff6119919a87251a4569b54f3b4a">hasPort</a> ()</td></tr>
|
|
<tr class="memdesc:aada4ff6119919a87251a4569b54f3b4a"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the URI has a port. <a href="#aada4ff6119919a87251a4569b54f3b4a">More...</a><br/></td></tr>
|
|
<tr class="separator:aada4ff6119919a87251a4569b54f3b4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa7b59f4a3528141842fcdda1af6920cc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#aa7b59f4a3528141842fcdda1af6920cc">getPort</a> ($default=null)</td></tr>
|
|
<tr class="memdesc:aa7b59f4a3528141842fcdda1af6920cc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the port. <a href="#aa7b59f4a3528141842fcdda1af6920cc">More...</a><br/></td></tr>
|
|
<tr class="separator:aa7b59f4a3528141842fcdda1af6920cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcfb777bab47406a328776f47f6a96a0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#abcfb777bab47406a328776f47f6a96a0">checkPath</a> ($path=null)</td></tr>
|
|
<tr class="memdesc:abcfb777bab47406a328776f47f6a96a0"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the path is valid. <a href="#abcfb777bab47406a328776f47f6a96a0">More...</a><br/></td></tr>
|
|
<tr class="separator:abcfb777bab47406a328776f47f6a96a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f72daa8e78e5cc5ca345af3602cc6a1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a0f72daa8e78e5cc5ca345af3602cc6a1">hasPath</a> ()</td></tr>
|
|
<tr class="memdesc:a0f72daa8e78e5cc5ca345af3602cc6a1"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the URI has a path. <a href="#a0f72daa8e78e5cc5ca345af3602cc6a1">More...</a><br/></td></tr>
|
|
<tr class="separator:a0f72daa8e78e5cc5ca345af3602cc6a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a848e4a9bd0caa493f064b98cf4e24906"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a848e4a9bd0caa493f064b98cf4e24906">getPath</a> ($default=null)</td></tr>
|
|
<tr class="memdesc:a848e4a9bd0caa493f064b98cf4e24906"><td class="mdescLeft"> </td><td class="mdescRight">Returns the path. <a href="#a848e4a9bd0caa493f064b98cf4e24906">More...</a><br/></td></tr>
|
|
<tr class="separator:a848e4a9bd0caa493f064b98cf4e24906"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36a08a673b6b108db27c880ad8d42031"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a36a08a673b6b108db27c880ad8d42031">checkQuery</a> ($query=null)</td></tr>
|
|
<tr class="memdesc:a36a08a673b6b108db27c880ad8d42031"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the query string is valid. <a href="#a36a08a673b6b108db27c880ad8d42031">More...</a><br/></td></tr>
|
|
<tr class="separator:a36a08a673b6b108db27c880ad8d42031"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad53c6db20a03e53f9568e8ca1ab91744"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#ad53c6db20a03e53f9568e8ca1ab91744">hasQuery</a> ()</td></tr>
|
|
<tr class="memdesc:ad53c6db20a03e53f9568e8ca1ab91744"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the URI has a query string. <a href="#ad53c6db20a03e53f9568e8ca1ab91744">More...</a><br/></td></tr>
|
|
<tr class="separator:ad53c6db20a03e53f9568e8ca1ab91744"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a56de9c6bd0fbf00098dc6b7db1840c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a0a56de9c6bd0fbf00098dc6b7db1840c">getQuery</a> ($default=array())</td></tr>
|
|
<tr class="memdesc:a0a56de9c6bd0fbf00098dc6b7db1840c"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array containing the query string elements. <a href="#a0a56de9c6bd0fbf00098dc6b7db1840c">More...</a><br/></td></tr>
|
|
<tr class="separator:a0a56de9c6bd0fbf00098dc6b7db1840c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a17cd4b5e0108e858bb51167e0046f0c4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a17cd4b5e0108e858bb51167e0046f0c4">hasQueryVar</a> ($key)</td></tr>
|
|
<tr class="memdesc:a17cd4b5e0108e858bb51167e0046f0c4"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the URI has a query variable. <a href="#a17cd4b5e0108e858bb51167e0046f0c4">More...</a><br/></td></tr>
|
|
<tr class="separator:a17cd4b5e0108e858bb51167e0046f0c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e23bd80c39a9cf8b286f08cf177331e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a7e23bd80c39a9cf8b286f08cf177331e">getQueryVar</a> ($key, $default=null)</td></tr>
|
|
<tr class="memdesc:a7e23bd80c39a9cf8b286f08cf177331e"><td class="mdescLeft"> </td><td class="mdescRight">Returns a single variable from the query string. <a href="#a7e23bd80c39a9cf8b286f08cf177331e">More...</a><br/></td></tr>
|
|
<tr class="separator:a7e23bd80c39a9cf8b286f08cf177331e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94c765c6262844caad188417a77adda8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a94c765c6262844caad188417a77adda8">checkFragment</a> ($fragment=null)</td></tr>
|
|
<tr class="memdesc:a94c765c6262844caad188417a77adda8"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the fragment string is valid. <a href="#a94c765c6262844caad188417a77adda8">More...</a><br/></td></tr>
|
|
<tr class="separator:a94c765c6262844caad188417a77adda8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91539b2925a03129637bd3f3efec42a6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a91539b2925a03129637bd3f3efec42a6">hasFragment</a> ()</td></tr>
|
|
<tr class="memdesc:a91539b2925a03129637bd3f3efec42a6"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the URI has a fragment string. <a href="#a91539b2925a03129637bd3f3efec42a6">More...</a><br/></td></tr>
|
|
<tr class="separator:a91539b2925a03129637bd3f3efec42a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad32a11cb34f078847033407ba3b95eb7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#ad32a11cb34f078847033407ba3b95eb7">getFragment</a> ($default=null)</td></tr>
|
|
<tr class="memdesc:ad32a11cb34f078847033407ba3b95eb7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the fragment. <a href="#ad32a11cb34f078847033407ba3b95eb7">More...</a><br/></td></tr>
|
|
<tr class="separator:ad32a11cb34f078847033407ba3b95eb7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ac156511bb872b762ea30940a46d1f3d1"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#ac156511bb872b762ea30940a46d1f3d1">check</a> ($uri)</td></tr>
|
|
<tr class="memdesc:ac156511bb872b762ea30940a46d1f3d1"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if a given URI is valid. <a href="#ac156511bb872b762ea30940a46d1f3d1">More...</a><br/></td></tr>
|
|
<tr class="separator:ac156511bb872b762ea30940a46d1f3d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acfcb54ee4aedfaca04b09151167041cf"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#acfcb54ee4aedfaca04b09151167041cf">getUserParam</a> ($key, $default=null)</td></tr>
|
|
<tr class="memdesc:acfcb54ee4aedfaca04b09151167041cf"><td class="mdescLeft"> </td><td class="mdescRight">Returns a specified instance parameter from the $_REQUEST array. <a href="#acfcb54ee4aedfaca04b09151167041cf">More...</a><br/></td></tr>
|
|
<tr class="separator:acfcb54ee4aedfaca04b09151167041cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a238c6f9d42bf87d768518a17474c9e3c"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a238c6f9d42bf87d768518a17474c9e3c">getHostParam</a> ($key, $default=null)</td></tr>
|
|
<tr class="memdesc:a238c6f9d42bf87d768518a17474c9e3c"><td class="mdescLeft"> </td><td class="mdescRight">Returns a specified environment parameter from the $_SERVER array. <a href="#a238c6f9d42bf87d768518a17474c9e3c">More...</a><br/></td></tr>
|
|
<tr class="separator:a238c6f9d42bf87d768518a17474c9e3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1f042efd1dce1734bac691a147edc00"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#ae1f042efd1dce1734bac691a147edc00">getSessParam</a> ($key, $default=null)</td></tr>
|
|
<tr class="memdesc:ae1f042efd1dce1734bac691a147edc00"><td class="mdescLeft"> </td><td class="mdescRight">Returns a specified session parameter from the $_SESSION array. <a href="#ae1f042efd1dce1734bac691a147edc00">More...</a><br/></td></tr>
|
|
<tr class="separator:ae1f042efd1dce1734bac691a147edc00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492df27bfd3856a754ab6aa146731813"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a492df27bfd3856a754ab6aa146731813">getFQDNParts</a> ($hostname)</td></tr>
|
|
<tr class="memdesc:a492df27bfd3856a754ab6aa146731813"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array containing the three main parts of a FQDN (Fully Qualified Domain Name), including the top-level domain, the second-level domains or hostname and the third-level domain. <a href="#a492df27bfd3856a754ab6aa146731813">More...</a><br/></td></tr>
|
|
<tr class="separator:a492df27bfd3856a754ab6aa146731813"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68713e4238661a758b2f8f18691d05b3"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a68713e4238661a758b2f8f18691d05b3">getHostUri</a> ()</td></tr>
|
|
<tr class="memdesc:a68713e4238661a758b2f8f18691d05b3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the applications host address. <a href="#a68713e4238661a758b2f8f18691d05b3">More...</a><br/></td></tr>
|
|
<tr class="separator:a68713e4238661a758b2f8f18691d05b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7159eaf5d227732ae7b3361dfbf0bfc"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#ad7159eaf5d227732ae7b3361dfbf0bfc">getBaseUri</a> ()</td></tr>
|
|
<tr class="memdesc:ad7159eaf5d227732ae7b3361dfbf0bfc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the applications base address. <a href="#ad7159eaf5d227732ae7b3361dfbf0bfc">More...</a><br/></td></tr>
|
|
<tr class="separator:ad7159eaf5d227732ae7b3361dfbf0bfc"><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:a7f6c35d4a2161270b8edcff45b48fda1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#a7f6c35d4a2161270b8edcff45b48fda1">parseUri</a> ($uriString= '')</td></tr>
|
|
<tr class="memdesc:a7f6c35d4a2161270b8edcff45b48fda1"><td class="mdescLeft"> </td><td class="mdescRight">Parses the scheme-specific portion of the URI and place its parts into instance variables. <a href="#a7f6c35d4a2161270b8edcff45b48fda1">More...</a><br/></td></tr>
|
|
<tr class="separator:a7f6c35d4a2161270b8edcff45b48fda1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
|
|
Static Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:aa0cf66fbafbd606bebdcc2c48e90158f"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_team_speak3___helper___uri.html#aa0cf66fbafbd606bebdcc2c48e90158f">stripslashesRecursive</a> ($var)</td></tr>
|
|
<tr class="memdesc:aa0cf66fbafbd606bebdcc2c48e90158f"><td class="mdescLeft"> </td><td class="mdescRight">Strips slashes from each element of an array using stripslashes(). <a href="#aa0cf66fbafbd606bebdcc2c48e90158f">More...</a><br/></td></tr>
|
|
<tr class="separator:aa0cf66fbafbd606bebdcc2c48e90158f"><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:af9c01d661b2be87a9c5dfc8575d8e698"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af9c01d661b2be87a9c5dfc8575d8e698"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$scheme</b> = null</td></tr>
|
|
<tr class="separator:af9c01d661b2be87a9c5dfc8575d8e698"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa60355cb6dee8fac8ad14a171c6b36ab"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa60355cb6dee8fac8ad14a171c6b36ab"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$user</b> = null</td></tr>
|
|
<tr class="separator:aa60355cb6dee8fac8ad14a171c6b36ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a459e667293a0266cd96fb6467b6501fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a459e667293a0266cd96fb6467b6501fe"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$pass</b> = null</td></tr>
|
|
<tr class="separator:a459e667293a0266cd96fb6467b6501fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49e5219ee9fc09dde979006b2a5a10fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a49e5219ee9fc09dde979006b2a5a10fd"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$host</b> = null</td></tr>
|
|
<tr class="separator:a49e5219ee9fc09dde979006b2a5a10fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe80af6ca2a866c8adc018665a1ebbf2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe80af6ca2a866c8adc018665a1ebbf2"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$port</b> = null</td></tr>
|
|
<tr class="separator:afe80af6ca2a866c8adc018665a1ebbf2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14310050ea38dcaad50edba0b67d9d1b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14310050ea38dcaad50edba0b67d9d1b"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$path</b> = null</td></tr>
|
|
<tr class="separator:a14310050ea38dcaad50edba0b67d9d1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af05706ac9c905ef59109cfa310b7af17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af05706ac9c905ef59109cfa310b7af17"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$query</b> = null</td></tr>
|
|
<tr class="separator:af05706ac9c905ef59109cfa310b7af17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66616fce653cffd2499e83438cc37e81"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66616fce653cffd2499e83438cc37e81"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$fragment</b> = null</td></tr>
|
|
<tr class="separator:a66616fce653cffd2499e83438cc37e81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9119d1fb0ecb143d0b8ef596c2bf3c76"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9119d1fb0ecb143d0b8ef596c2bf3c76"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>$regex</b> = array()</td></tr>
|
|
<tr class="separator:a9119d1fb0ecb143d0b8ef596c2bf3c76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Helper class for URI handling. </p>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00032">32</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a90842c65bae8ffcf088b1dd12def7ff1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::__construct </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$uri</em>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The <a class="el" href="class_team_speak3___helper___uri.html" title="Helper class for URI handling. ">TeamSpeak3_Helper_Uri</a> constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$uri</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___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_team_speak3___helper___uri.html" title="Helper class for URI handling. ">TeamSpeak3_Helper_Uri</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00104">104</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_uri_8php_source.html#l00178">isValid()</a>, and <a class="el" href="_uri_8php_source.html#l00143">parseUri()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  {</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  $uri = explode(<span class="stringliteral">":"</span>, strval($uri), 2);</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  $this->scheme = strtolower($uri[0]);</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  $uriString = isset($uri[1]) ? $uri[1] : <span class="stringliteral">""</span>;</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>  <span class="keywordflow">if</span>(!ctype_alnum($this->scheme))</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  {</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a>(<span class="stringliteral">"invalid URI scheme '"</span> . $this->scheme . <span class="stringliteral">"' supplied"</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> </div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="comment">/* grammar rules for validation */</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  $this->regex[<span class="stringliteral">"alphanum"</span>] = <span class="stringliteral">"[^\W_]"</span>;</div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  $this->regex[<span class="stringliteral">"escaped"</span>] = <span class="stringliteral">"(?:%[\da-fA-F]{2})"</span>;</div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  $this->regex[<span class="stringliteral">"mark"</span>] = <span class="stringliteral">"[-_.!~*'()\[\]]"</span>;</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  $this->regex[<span class="stringliteral">"reserved"</span>] = <span class="stringliteral">"[;\/?:@&=+$,]"</span>;</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  $this->regex[<span class="stringliteral">"unreserved"</span>] = <span class="stringliteral">"(?:"</span> . $this->regex[<span class="stringliteral">"alphanum"</span>] . <span class="stringliteral">"|"</span> . $this->regex[<span class="stringliteral">"mark"</span>] . <span class="stringliteral">")"</span>;</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  $this->regex[<span class="stringliteral">"segment"</span>] = <span class="stringliteral">"(?:(?:"</span> . $this->regex[<span class="stringliteral">"unreserved"</span>] . <span class="stringliteral">"|"</span> . $this->regex[<span class="stringliteral">"escaped"</span>] . <span class="stringliteral">"|[:@&=+$,;])*)"</span>;</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  $this->regex[<span class="stringliteral">"path"</span>] = <span class="stringliteral">"(?:\/"</span> . $this->regex[<span class="stringliteral">"segment"</span>] . <span class="stringliteral">"?)+"</span>;</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  $this->regex[<span class="stringliteral">"uric"</span>] = <span class="stringliteral">"(?:"</span> . $this->regex[<span class="stringliteral">"reserved"</span>] . <span class="stringliteral">"|"</span> . $this->regex[<span class="stringliteral">"unreserved"</span>] . <span class="stringliteral">"|"</span> . $this->regex[<span class="stringliteral">"escaped"</span>] . <span class="stringliteral">")"</span>;</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordflow">if</span>(strlen($uriString) > 0)</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>  $this-><a class="code" href="class_team_speak3___helper___uri.html#a7f6c35d4a2161270b8edcff45b48fda1" title="Parses the scheme-specific portion of the URI and place its parts into instance variables. ">parseUri</a>($uriString);</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  }</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordflow">if</span>(!$this-><a class="code" href="class_team_speak3___helper___uri.html#a32584b89b4cfeaaa09948b5b1fc67916" title="Validate the current URI from the instance variables. ">isValid</a>())</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___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a>(<span class="stringliteral">"invalid URI supplied"</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><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a7f6c35d4a2161270b8edcff45b48fda1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::parseUri </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$uriString</em> = <code>''</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parses the scheme-specific portion of the URI and place its parts into instance variables. </p>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="class_team_speak3___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_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="_uri_8php_source.html#l00143">143</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00104">__construct()</a>.</p>
|
|
<div class="fragment"><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>  $status = @preg_match(<span class="stringliteral">"~^((//)([^/?#]*))([^?#]*)(\?([^#]*))?(#(.*))?$~"</span>, $uriString, $matches);</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="keywordflow">if</span>($status === FALSE)</div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  {</div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a>(<span class="stringliteral">"URI scheme-specific decomposition failed"</span>);</div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  }</div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordflow">if</span>(!$status) <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  $this->path = (isset($matches[4])) ? $matches[4] : <span class="stringliteral">''</span>;</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  $this->query = (isset($matches[6])) ? $matches[6] : <span class="stringliteral">''</span>;</div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  $this->fragment = (isset($matches[8])) ? $matches[8] : <span class="stringliteral">''</span>;</div>
|
|
<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>  $status = @preg_match(<span class="stringliteral">"~^(([^:@]*)(:([^@]*))?@)?([^:]+)(:(.*))?$~"</span>, (isset($matches[3])) ? $matches[3] : <span class="stringliteral">""</span>, $matches);</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>($status === FALSE)</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>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a>(<span class="stringliteral">"URI scheme-specific authority decomposition failed"</span>);</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="keywordflow">if</span>(!$status) <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  $this->user = isset($matches[2]) ? $matches[2] : <span class="stringliteral">""</span>;</div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  $this->pass = isset($matches[4]) ? $matches[4] : <span class="stringliteral">""</span>;</div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  $this->host = isset($matches[5]) ? $matches[5] : <span class="stringliteral">""</span>;</div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  $this->port = isset($matches[7]) ? $matches[7] : <span class="stringliteral">""</span>;</div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a32584b89b4cfeaaa09948b5b1fc67916"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::isValid </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Validate the current URI from the instance variables. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00178">178</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_uri_8php_source.html#l00563">checkFragment()</a>, <a class="el" href="_uri_8php_source.html#l00331">checkHost()</a>, <a class="el" href="_uri_8php_source.html#l00282">checkPass()</a>, <a class="el" href="_uri_8php_source.html#l00406">checkPath()</a>, <a class="el" href="_uri_8php_source.html#l00368">checkPort()</a>, <a class="el" href="_uri_8php_source.html#l00457">checkQuery()</a>, and <a class="el" href="_uri_8php_source.html#l00231">checkUser()</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00104">__construct()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  {</div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordflow">return</span> ($this-><a class="code" href="class_team_speak3___helper___uri.html#a2b8d5365651a38c00ba1393559ba9efd" title="Returns TRUE if the username is valid. ">checkUser</a>() && $this-><a class="code" href="class_team_speak3___helper___uri.html#ac9dff5b48e963efca445427a2ec602ca" title="Returns TRUE if the password is valid. ">checkPass</a>() && $this-><a class="code" href="class_team_speak3___helper___uri.html#acaa2c62eecb695f7a7ea1e6484b4b169" title="Returns TRUE if the host is valid. ">checkHost</a>() && $this-><a class="code" href="class_team_speak3___helper___uri.html#a9878d6f37ef25b9e0666cf8cd9043515" title="Returns TRUE if the port is valid. ">checkPort</a>() && $this-><a class="code" href="class_team_speak3___helper___uri.html#abcfb777bab47406a328776f47f6a96a0" title="Returns TRUE if the path is valid. ">checkPath</a>() && $this-><a class="code" href="class_team_speak3___helper___uri.html#a36a08a673b6b108db27c880ad8d42031" title="Returns TRUE if the query string is valid. ">checkQuery</a>() && $this-><a class="code" href="class_team_speak3___helper___uri.html#a94c765c6262844caad188417a77adda8" title="Returns TRUE if the fragment string is valid. ">checkFragment</a>());</div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac156511bb872b762ea30940a46d1f3d1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static TeamSpeak3_Helper_Uri::check </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$uri</em>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if a given URI is valid. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$uri</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00189">189</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  {</div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="keywordflow">try</span></div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  {</div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  $uri = <span class="keyword">new</span> <span class="keyword">self</span>(strval($uri));</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  }</div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="keywordflow">catch</span>(Exception $e)</div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  {</div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keywordflow">return</span> FALSE;</div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  }</div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keywordflow">return</span> $uri->valid();</div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a489f79eec547a0c9ca9fc6befebcc0f3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::hasScheme </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the URI has a scheme. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00208">208</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00219">getScheme()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  {</div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <span class="keywordflow">return</span> strlen($this->scheme) ? TRUE : FALSE;</div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af47ad30cc5c9a600ee2a6c7de6e1aa83"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::getScheme </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$default</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the scheme. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mixed</td><td>default </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_team_speak3___helper___string.html" title="Helper class for string handling. ">TeamSpeak3_Helper_String</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00219">219</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_uri_8php_source.html#l00208">hasScheme()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  {</div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="keywordflow">return</span> ($this-><a class="code" href="class_team_speak3___helper___uri.html#a489f79eec547a0c9ca9fc6befebcc0f3" title="Returns TRUE if the URI has a scheme. ">hasScheme</a>()) ? <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>($this->scheme) : $default;</div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2b8d5365651a38c00ba1393559ba9efd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::checkUser </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$username</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the username is valid. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$username</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___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00231">231</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00178">isValid()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  {</div>
|
|
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keywordflow">if</span>($username === null)</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>  $username = $this->user;</div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  }</div>
|
|
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> </div>
|
|
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="keywordflow">if</span>(strlen($username) == 0)</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">return</span> TRUE;</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> </div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  $pattern = <span class="stringliteral">"/^("</span> . $this->regex[<span class="stringliteral">"alphanum"</span>] . <span class="stringliteral">"|"</span> . $this->regex[<span class="stringliteral">"mark"</span>] . <span class="stringliteral">"|"</span> . $this->regex[<span class="stringliteral">"escaped"</span>] . <span class="stringliteral">"|[;:&=+$,])+$/"</span>;</div>
|
|
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  $status = @preg_match($pattern, $username);</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">if</span>($status === FALSE)</div>
|
|
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  {</div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a>(<span class="stringliteral">"URI username validation failed"</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> </div>
|
|
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="keywordflow">return</span> ($status == 1);</div>
|
|
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a24fab900cd8e2b43e253f85d6925f7b7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::hasUser </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the URI has a username. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00259">259</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00270">getUser()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  {</div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="keywordflow">return</span> strlen($this->user) ? TRUE : FALSE;</div>
|
|
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab685d3e39922aa170d2d6b06a6304084"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::getUser </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$default</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the username. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mixed</td><td>default </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_team_speak3___helper___string.html" title="Helper class for string handling. ">TeamSpeak3_Helper_String</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00270">270</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_uri_8php_source.html#l00259">hasUser()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  {</div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  <span class="keywordflow">return</span> ($this-><a class="code" href="class_team_speak3___helper___uri.html#a24fab900cd8e2b43e253f85d6925f7b7" title="Returns TRUE if the URI has a username. ">hasUser</a>()) ? <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>($this->user) : $default;</div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac9dff5b48e963efca445427a2ec602ca"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::checkPass </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$password</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the password is valid. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$password</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___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00282">282</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00178">isValid()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  {</div>
|
|
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  <span class="keywordflow">if</span>($password === null) {</div>
|
|
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  $password = $this->pass;</div>
|
|
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  }</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">if</span>(strlen($password) == 0)</div>
|
|
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  {</div>
|
|
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  <span class="keywordflow">return</span> TRUE;</div>
|
|
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  }</div>
|
|
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> </div>
|
|
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  $pattern = <span class="stringliteral">"/^("</span> . $this->regex[<span class="stringliteral">"alphanum"</span>] . <span class="stringliteral">"|"</span> . $this->regex[<span class="stringliteral">"mark"</span>] . <span class="stringliteral">"|"</span> . $this->regex[<span class="stringliteral">"escaped"</span>] . <span class="stringliteral">"|[;:&=+$,])+$/"</span>;</div>
|
|
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  $status = @preg_match($pattern, $password);</div>
|
|
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> </div>
|
|
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  <span class="keywordflow">if</span>($status === FALSE)</div>
|
|
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  {</div>
|
|
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a>(<span class="stringliteral">"URI password validation failed"</span>);</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> </div>
|
|
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <span class="keywordflow">return</span> ($status == 1);</div>
|
|
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa496602a698ed5690d48ec4326f8c793"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::hasPass </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the URI has a password. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00309">309</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00320">getPass()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  {</div>
|
|
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  <span class="keywordflow">return</span> strlen($this->pass) ? TRUE : FALSE;</div>
|
|
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6d9477823c4f20b2daa98a9153326463"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::getPass </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$default</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the password. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mixed</td><td>default </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_team_speak3___helper___string.html" title="Helper class for string handling. ">TeamSpeak3_Helper_String</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00320">320</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_uri_8php_source.html#l00309">hasPass()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  {</div>
|
|
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  <span class="keywordflow">return</span> ($this-><a class="code" href="class_team_speak3___helper___uri.html#aa496602a698ed5690d48ec4326f8c793" title="Returns TRUE if the URI has a password. ">hasPass</a>()) ? <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>($this->pass) : $default;</div>
|
|
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acaa2c62eecb695f7a7ea1e6484b4b169"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::checkHost </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$host</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the host is valid. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$host</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00331">331</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00178">isValid()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  {</div>
|
|
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  <span class="keywordflow">if</span>($host === null)</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>  $host = $this->host;</div>
|
|
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  }</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>  <span class="keywordflow">return</span> TRUE;</div>
|
|
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adb9f6e1df57af8b47e94d6d581475eb1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::hasHost </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the URI has a host. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00346">346</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00357">getHost()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00347"></a><span class="lineno"> 347</span>  {</div>
|
|
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>  <span class="keywordflow">return</span> strlen($this->host) ? TRUE : FALSE;</div>
|
|
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aca4bbb23cafa5833af4565d23f0b57c6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::getHost </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$default</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the host. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mixed</td><td>default </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_team_speak3___helper___string.html" title="Helper class for string handling. ">TeamSpeak3_Helper_String</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00357">357</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_uri_8php_source.html#l00346">hasHost()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  {</div>
|
|
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  <span class="keywordflow">return</span> ($this-><a class="code" href="class_team_speak3___helper___uri.html#adb9f6e1df57af8b47e94d6d581475eb1" title="Returns TRUE if the URI has a host. ">hasHost</a>()) ? <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>($this->host) : $default;</div>
|
|
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9878d6f37ef25b9e0666cf8cd9043515"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::checkPort </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$port</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the port is valid. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">integer</td><td class="paramname">$port</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00368">368</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00178">isValid()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  {</div>
|
|
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  <span class="keywordflow">if</span>($port === null)</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>  $port = $this->port;</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> </div>
|
|
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>  <span class="keywordflow">return</span> TRUE;</div>
|
|
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aada4ff6119919a87251a4569b54f3b4a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::hasPort </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the URI has a port. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00383">383</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00394">getPort()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  {</div>
|
|
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  <span class="keywordflow">return</span> strlen($this->port) ? TRUE : FALSE;</div>
|
|
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa7b59f4a3528141842fcdda1af6920cc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::getPort </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$default</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the port. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mixed</td><td>default </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>integer </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00394">394</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_uri_8php_source.html#l00383">hasPort()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  {</div>
|
|
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>  <span class="keywordflow">return</span> ($this-><a class="code" href="class_team_speak3___helper___uri.html#aada4ff6119919a87251a4569b54f3b4a" title="Returns TRUE if the URI has a port. ">hasPort</a>()) ? intval($this->port) : $default;</div>
|
|
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abcfb777bab47406a328776f47f6a96a0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::checkPath </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$path</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the path is valid. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$path</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___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00406">406</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00178">isValid()</a>.</p>
|
|
<div class="fragment"><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="keywordflow">if</span>($path === null)</div>
|
|
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>  {</div>
|
|
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>  $path = $this->path;</div>
|
|
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span>  }</div>
|
|
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span> </div>
|
|
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span>  <span class="keywordflow">if</span>(strlen($path) == 0)</div>
|
|
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span>  {</div>
|
|
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>  <span class="keywordflow">return</span> TRUE;</div>
|
|
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span>  }</div>
|
|
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> </div>
|
|
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span>  $pattern = <span class="stringliteral">"/^"</span> . $this->regex[<span class="stringliteral">"path"</span>] . <span class="stringliteral">"$/"</span>;</div>
|
|
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>  $status = @preg_match($pattern, $path);</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>($status === FALSE)</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>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a>(<span class="stringliteral">"URI path validation failed"</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> </div>
|
|
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>  <span class="keywordflow">return</span> ($status == 1);</div>
|
|
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0f72daa8e78e5cc5ca345af3602cc6a1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::hasPath </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the URI has a path. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00434">434</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00445">getPath()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00435"></a><span class="lineno"> 435</span>  {</div>
|
|
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  <span class="keywordflow">return</span> strlen($this->path) ? TRUE : FALSE;</div>
|
|
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a848e4a9bd0caa493f064b98cf4e24906"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::getPath </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$default</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the path. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mixed</td><td>default </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_team_speak3___helper___string.html" title="Helper class for string handling. ">TeamSpeak3_Helper_String</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00445">445</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_uri_8php_source.html#l00434">hasPath()</a>.</p>
|
|
<div class="fragment"><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">return</span> ($this-><a class="code" href="class_team_speak3___helper___uri.html#a0f72daa8e78e5cc5ca345af3602cc6a1" title="Returns TRUE if the URI has a path. ">hasPath</a>()) ? <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>($this->path) : $default;</div>
|
|
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a36a08a673b6b108db27c880ad8d42031"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::checkQuery </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$query</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the query string is valid. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$query</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___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00457">457</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00178">isValid()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00458"></a><span class="lineno"> 458</span>  {</div>
|
|
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  <span class="keywordflow">if</span>($query === null)</div>
|
|
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>  {</div>
|
|
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>  $query = $this->query;</div>
|
|
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span>  }</div>
|
|
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span> </div>
|
|
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>  <span class="keywordflow">if</span>(strlen($query) == 0)</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>  <span class="keywordflow">return</span> TRUE;</div>
|
|
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  }</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>  $pattern = <span class="stringliteral">"/^"</span> . $this->regex[<span class="stringliteral">"uric"</span>] . <span class="stringliteral">"*$/"</span>;</div>
|
|
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span>  $status = @preg_match($pattern, $query);</div>
|
|
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span> </div>
|
|
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>  <span class="keywordflow">if</span>($status === FALSE)</div>
|
|
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span>  {</div>
|
|
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a>(<span class="stringliteral">"URI query string validation failed"</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> </div>
|
|
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  <span class="keywordflow">return</span> ($status == 1);</div>
|
|
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad53c6db20a03e53f9568e8ca1ab91744"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::hasQuery </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the URI has a query string. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00485">485</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00496">getQuery()</a>, <a class="el" href="_uri_8php_source.html#l00529">getQueryVar()</a>, and <a class="el" href="_uri_8php_source.html#l00513">hasQueryVar()</a>.</p>
|
|
<div class="fragment"><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>  <span class="keywordflow">return</span> strlen($this->query) ? TRUE : FALSE;</div>
|
|
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0a56de9c6bd0fbf00098dc6b7db1840c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::getQuery </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$default</em> = <code>array()</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an array containing the query string elements. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">mixed</td><td class="paramname">$default</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>array </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00496">496</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_uri_8php_source.html#l00485">hasQuery()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00497"></a><span class="lineno"> 497</span>  {</div>
|
|
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  <span class="keywordflow">if</span>(!$this-><a class="code" href="class_team_speak3___helper___uri.html#ad53c6db20a03e53f9568e8ca1ab91744" title="Returns TRUE if the URI has a query string. ">hasQuery</a>())</div>
|
|
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span>  {</div>
|
|
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span>  <span class="keywordflow">return</span> $default;</div>
|
|
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>  }</div>
|
|
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span> </div>
|
|
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  parse_str($this->query, $queryArray);</div>
|
|
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span> </div>
|
|
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>  <span class="keywordflow">return</span> $queryArray;</div>
|
|
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a17cd4b5e0108e858bb51167e0046f0c4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::hasQueryVar </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$key</em>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the URI has a query variable. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00513">513</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_uri_8php_source.html#l00485">hasQuery()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00514"></a><span class="lineno"> 514</span>  {</div>
|
|
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span>  <span class="keywordflow">if</span>(!$this-><a class="code" href="class_team_speak3___helper___uri.html#ad53c6db20a03e53f9568e8ca1ab91744" title="Returns TRUE if the URI has a query string. ">hasQuery</a>()) <span class="keywordflow">return</span> FALSE;</div>
|
|
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span> </div>
|
|
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span>  parse_str($this->query, $queryArray);</div>
|
|
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> </div>
|
|
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span>  <span class="keywordflow">return</span> array_key_exists($key, $queryArray) ? TRUE : FALSE;</div>
|
|
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7e23bd80c39a9cf8b286f08cf177331e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::getQueryVar </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$default</em> = <code>null</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a single variable from the query string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$key</td><td></td></tr>
|
|
<tr><td class="paramtype">mixed</td><td class="paramname">$default</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00529">529</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_uri_8php_source.html#l00485">hasQuery()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00530"></a><span class="lineno"> 530</span>  {</div>
|
|
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span>  <span class="keywordflow">if</span>(!$this-><a class="code" href="class_team_speak3___helper___uri.html#ad53c6db20a03e53f9568e8ca1ab91744" title="Returns TRUE if the URI has a query string. ">hasQuery</a>()) <span class="keywordflow">return</span> $default;</div>
|
|
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span> </div>
|
|
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span>  parse_str($this->query, $queryArray);</div>
|
|
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span> </div>
|
|
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span>  <span class="keywordflow">if</span>(array_key_exists($key, $queryArray))</div>
|
|
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span>  {</div>
|
|
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span>  $val = $queryArray[$key];</div>
|
|
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span> </div>
|
|
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span>  <span class="keywordflow">if</span>(ctype_digit($val))</div>
|
|
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span>  {</div>
|
|
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span>  <span class="keywordflow">return</span> intval($val);</div>
|
|
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span>  }</div>
|
|
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span>  elseif(is_string($val))</div>
|
|
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>  {</div>
|
|
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span>  <span class="keywordflow">return</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>($val);</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>  <span class="keywordflow">else</span></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="keywordflow">return</span> $val;</div>
|
|
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>  }</div>
|
|
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>  }</div>
|
|
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span> </div>
|
|
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span>  <span class="keywordflow">return</span> $default;</div>
|
|
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a94c765c6262844caad188417a77adda8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::checkFragment </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$fragment</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the fragment string is valid. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$fragment</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___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00563">563</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00178">isValid()</a>.</p>
|
|
<div class="fragment"><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>  <span class="keywordflow">if</span>($fragment === null)</div>
|
|
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span>  {</div>
|
|
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>  $fragment = $this->fragment;</div>
|
|
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span>  }</div>
|
|
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span> </div>
|
|
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span>  <span class="keywordflow">if</span>(strlen($fragment) == 0)</div>
|
|
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span>  {</div>
|
|
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span>  <span class="keywordflow">return</span> TRUE;</div>
|
|
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span>  }</div>
|
|
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span> </div>
|
|
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span>  $pattern = <span class="stringliteral">"/^"</span> . $this->regex[<span class="stringliteral">"uric"</span>] . <span class="stringliteral">"*$/"</span>;</div>
|
|
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span>  $status = @preg_match($pattern, $fragment);</div>
|
|
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span> </div>
|
|
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span>  <span class="keywordflow">if</span>($status === FALSE)</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">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___helper___exception.html" title="Enhanced exception class for TeamSpeak3_Helper_* objects. ">TeamSpeak3_Helper_Exception</a>(<span class="stringliteral">"URI fragment validation failed"</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> </div>
|
|
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span>  <span class="keywordflow">return</span> ($status == 1);</div>
|
|
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a91539b2925a03129637bd3f3efec42a6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::hasFragment </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns TRUE if the URI has a fragment string. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>boolean </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00591">591</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_uri_8php_source.html#l00602">getFragment()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00592"></a><span class="lineno"> 592</span>  {</div>
|
|
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span>  <span class="keywordflow">return</span> strlen($this->fragment) ? TRUE : FALSE;</div>
|
|
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad32a11cb34f078847033407ba3b95eb7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TeamSpeak3_Helper_Uri::getFragment </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$default</em> = <code>null</code>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the fragment. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mixed</td><td>default </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_team_speak3___helper___string.html" title="Helper class for string handling. ">TeamSpeak3_Helper_String</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00602">602</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>References <a class="el" href="_uri_8php_source.html#l00591">hasFragment()</a>.</p>
|
|
<div class="fragment"><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="keywordflow">return</span> ($this-><a class="code" href="class_team_speak3___helper___uri.html#a91539b2925a03129637bd3f3efec42a6" title="Returns TRUE if the URI has a fragment string. ">hasFragment</a>()) ? <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>($this->fragment) : $default;</div>
|
|
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acfcb54ee4aedfaca04b09151167041cf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static TeamSpeak3_Helper_Uri::getUserParam </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$default</em> = <code>null</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a specified instance parameter from the $_REQUEST array. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$key</td><td></td></tr>
|
|
<tr><td class="paramtype">mixed</td><td class="paramname">$default</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00614">614</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
<div class="fragment"><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">return</span> (array_key_exists($key, $_REQUEST) && !empty($_REQUEST[$key])) ? self::stripslashesRecursive($_REQUEST[$key]) : $default;</div>
|
|
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a238c6f9d42bf87d768518a17474c9e3c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static TeamSpeak3_Helper_Uri::getHostParam </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$default</em> = <code>null</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a specified environment parameter from the $_SERVER array. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$key</td><td></td></tr>
|
|
<tr><td class="paramtype">mixed</td><td class="paramname">$default</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00626">626</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00627"></a><span class="lineno"> 627</span>  {</div>
|
|
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span>  <span class="keywordflow">return</span> (array_key_exists($key, $_SERVER) && !empty($_SERVER[$key])) ? $_SERVER[$key] : $default;</div>
|
|
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae1f042efd1dce1734bac691a147edc00"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static TeamSpeak3_Helper_Uri::getSessParam </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$default</em> = <code>null</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a specified session parameter from the $_SESSION array. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$key</td><td></td></tr>
|
|
<tr><td class="paramtype">mixed</td><td class="paramname">$default</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00638">638</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
<div class="fragment"><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>  <span class="keywordflow">return</span> (array_key_exists($key, $_SESSION) && !empty($_SESSION[$key])) ? $_SESSION[$key] : $default;</div>
|
|
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a492df27bfd3856a754ab6aa146731813"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static TeamSpeak3_Helper_Uri::getFQDNParts </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$hostname</em>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an array containing the three main parts of a FQDN (Fully Qualified Domain Name), including the top-level domain, the second-level domains or hostname and the third-level domain. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">string</td><td class="paramname">$hostname</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>array </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00650">650</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="_host_8php_source.html#l00319">TeamSpeak3_Node_Host\serverGetByTSDNS()</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00651"></a><span class="lineno"> 651</span>  {</div>
|
|
<div class="line"><a name="l00652"></a><span class="lineno"> 652</span>  <span class="keywordflow">if</span>(!preg_match(<span class="stringliteral">"/^([a-z0-9][a-z0-9-]{0,62}\.)*([a-z0-9][a-z0-9-]{0,62}\.)+([a-z]{2,6})$/i"</span>, $hostname, $matches))</div>
|
|
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span>  {</div>
|
|
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span>  <span class="keywordflow">return</span> array();</div>
|
|
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span>  }</div>
|
|
<div class="line"><a name="l00656"></a><span class="lineno"> 656</span> </div>
|
|
<div class="line"><a name="l00657"></a><span class="lineno"> 657</span>  $parts[<span class="stringliteral">"tld"</span>] = $matches[3];</div>
|
|
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span>  $parts[<span class="stringliteral">"2nd"</span>] = $matches[2];</div>
|
|
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span>  $parts[<span class="stringliteral">"3rd"</span>] = $matches[1];</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="keywordflow">return</span> $parts;</div>
|
|
<div class="line"><a name="l00662"></a><span class="lineno"> 662</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a68713e4238661a758b2f8f18691d05b3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static TeamSpeak3_Helper_Uri::getHostUri </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the applications host address. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_team_speak3___helper___string.html" title="Helper class for string handling. ">TeamSpeak3_Helper_String</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00669">669</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00670"></a><span class="lineno"> 670</span>  {</div>
|
|
<div class="line"><a name="l00671"></a><span class="lineno"> 671</span>  $sheme = (self::getHostParam(<span class="stringliteral">"HTTPS"</span>) == <span class="stringliteral">"on"</span>) ? <span class="stringliteral">"https"</span> : <span class="stringliteral">"http"</span>;</div>
|
|
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span> </div>
|
|
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span>  $serverName = <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>(self::getHostParam(<span class="stringliteral">"HTTP_HOST"</span>));</div>
|
|
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span>  $serverPort = self::getHostParam(<span class="stringliteral">"SERVER_PORT"</span>);</div>
|
|
<div class="line"><a name="l00675"></a><span class="lineno"> 675</span>  $serverPort = ($serverPort != 80 && $serverPort != 443) ? <span class="stringliteral">":"</span> . $serverPort : <span class="stringliteral">""</span>;</div>
|
|
<div class="line"><a name="l00676"></a><span class="lineno"> 676</span> </div>
|
|
<div class="line"><a name="l00677"></a><span class="lineno"> 677</span>  <span class="keywordflow">if</span>($serverName->endsWith($serverPort))</div>
|
|
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span>  {</div>
|
|
<div class="line"><a name="l00679"></a><span class="lineno"> 679</span>  $serverName = $serverName->replace($serverPort, <span class="stringliteral">""</span>);</div>
|
|
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span>  }</div>
|
|
<div class="line"><a name="l00681"></a><span class="lineno"> 681</span> </div>
|
|
<div class="line"><a name="l00682"></a><span class="lineno"> 682</span>  <span class="keywordflow">return</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>($sheme . <span class="stringliteral">"://"</span> . $serverName . $serverPort);</div>
|
|
<div class="line"><a name="l00683"></a><span class="lineno"> 683</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad7159eaf5d227732ae7b3361dfbf0bfc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static TeamSpeak3_Helper_Uri::getBaseUri </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the applications base address. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00690">690</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00691"></a><span class="lineno"> 691</span>  {</div>
|
|
<div class="line"><a name="l00692"></a><span class="lineno"> 692</span>  $scriptPath = <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>(dirname(self::getHostParam(<span class="stringliteral">"SCRIPT_NAME"</span>)));</div>
|
|
<div class="line"><a name="l00693"></a><span class="lineno"> 693</span> </div>
|
|
<div class="line"><a name="l00694"></a><span class="lineno"> 694</span>  <span class="keywordflow">return</span> self::getHostUri()->append(($scriptPath == DIRECTORY_SEPARATOR ? <span class="stringliteral">""</span> : $scriptPath) . <span class="stringliteral">"/"</span>);</div>
|
|
<div class="line"><a name="l00695"></a><span class="lineno"> 695</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa0cf66fbafbd606bebdcc2c48e90158f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static TeamSpeak3_Helper_Uri::stripslashesRecursive </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>$var</em>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Strips slashes from each element of an array using stripslashes(). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramtype">mixed</td><td class="paramname">$var</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>mixed </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_uri_8php_source.html#l00703">703</a> of file <a class="el" href="_uri_8php_source.html">Uri.php</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00704"></a><span class="lineno"> 704</span>  {</div>
|
|
<div class="line"><a name="l00705"></a><span class="lineno"> 705</span>  <span class="keywordflow">if</span>(!is_array($var))</div>
|
|
<div class="line"><a name="l00706"></a><span class="lineno"> 706</span>  {</div>
|
|
<div class="line"><a name="l00707"></a><span class="lineno"> 707</span>  <span class="keywordflow">return</span> stripslashes(strval($var));</div>
|
|
<div class="line"><a name="l00708"></a><span class="lineno"> 708</span>  }</div>
|
|
<div class="line"><a name="l00709"></a><span class="lineno"> 709</span> </div>
|
|
<div class="line"><a name="l00710"></a><span class="lineno"> 710</span>  <span class="keywordflow">foreach</span>($var as $key => $val)</div>
|
|
<div class="line"><a name="l00711"></a><span class="lineno"> 711</span>  {</div>
|
|
<div class="line"><a name="l00712"></a><span class="lineno"> 712</span>  $var[$key] = (is_array($val)) ? <a class="code" href="class_team_speak3___helper___uri.html#aa0cf66fbafbd606bebdcc2c48e90158f" title="Strips slashes from each element of an array using stripslashes(). ">stripslashesRecursive</a>($val) : stripslashes(strval($val));</div>
|
|
<div class="line"><a name="l00713"></a><span class="lineno"> 713</span>  }</div>
|
|
<div class="line"><a name="l00714"></a><span class="lineno"> 714</span> </div>
|
|
<div class="line"><a name="l00715"></a><span class="lineno"> 715</span>  <span class="keywordflow">return</span> $var;</div>
|
|
<div class="line"><a name="l00716"></a><span class="lineno"> 716</span>  }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>TeamSpeak3/Helper/<a class="el" href="_uri_8php_source.html">Uri.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___helper___uri.html">TeamSpeak3_Helper_Uri</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>
|