Helper class for URI handling. More...

Public Member Functions
	__construct ($uri)
	The TeamSpeak3_Helper_Uri constructor. More...

	checkFragment ($fragment=null)
	Returns TRUE if the fragment string is valid. More...

	checkHost ($host=null)
	Returns TRUE if the host is valid. More...

	checkPass ($password=null)
	Returns TRUE if the password is valid. More...

	checkPath ($path=null)
	Returns TRUE if the path is valid. More...

	checkPort ($port=null)
	Returns TRUE if the port is valid. More...

	checkQuery ($query=null)
	Returns TRUE if the query string is valid. More...

	checkUser ($username=null)
	Returns TRUE if the username is valid. More...

	getFragment ($default=null)
	Returns the fragment. More...

	getHost ($default=null)
	Returns the host. More...

	getPass ($default=null)
	Returns the password. More...

	getPath ($default=null)
	Returns the path. More...

	getPort ($default=null)
	Returns the port. More...

	getQuery ($default=array())
	Returns an array containing the query string elements. More...

	getQueryVar ($key, $default=null)
	Returns a single variable from the query string. More...

	getScheme ($default=null)
	Returns the scheme. More...

	getUser ($default=null)
	Returns the username. More...

	hasFragment ()
	Returns TRUE if the URI has a fragment string. More...

	hasHost ()
	Returns TRUE if the URI has a host. More...

	hasPass ()
	Returns TRUE if the URI has a password. More...

	hasPath ()
	Returns TRUE if the URI has a path. More...

	hasPort ()
	Returns TRUE if the URI has a port. More...

	hasQuery ()
	Returns TRUE if the URI has a query string. More...

	hasQueryVar ($key)
	Returns TRUE if the URI has a query variable. More...

	hasScheme ()
	Returns TRUE if the URI has a scheme. More...

	hasUser ()
	Returns TRUE if the URI has a username. More...

	isValid ()
	Validate the current URI from the instance variables. More...

Static Public Member Functions
static	check ($uri)
	Returns TRUE if a given URI is valid. More...

static	getBaseUri ()
	Returns the applications base address. More...

static	getFQDNParts ($hostname)
	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. More...

static	getHostParam ($key, $default=null)
	Returns a specified environment parameter from the $_SERVER array. More...

static	getHostUri ()
	Returns the applications host address. More...

static	getSessParam ($key, $default=null)
	Returns a specified session parameter from the $_SESSION array. More...

static	getUserParam ($key, $default=null)
	Returns a specified instance parameter from the $_REQUEST array. More...

Protected Member Functions
	parseUri ($uriString='')
	Parses the scheme-specific portion of the URI and place its parts into instance variables. More...

Static Protected Member Functions
static	stripslashesRecursive ($var)
	Strips slashes from each element of an array using stripslashes(). More...

Detailed Description

Helper class for URI handling.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $uri )

The TeamSpeak3_Helper_Uri constructor.

Parameters

string $uri

Exceptions

TeamSpeak3_Helper_Exception

Returns: TeamSpeak3_Helper_Uri

   {
     $uri = explode(":", strval($uri), 2);
 
     $this->scheme = strtolower($uri[0]);
     $uriString = isset($uri[1]) ? $uri[1] : "";
 
     if(!ctype_alnum($this->scheme))
     {
       throw new TeamSpeak3_Helper_Exception("invalid URI scheme '" . $this->scheme . "' supplied");
     }
 
     /* grammar rules for validation */
     $this->regex["alphanum"] = "[^\W_]";
     $this->regex["escaped"] = "(?:%[\da-fA-F]{2})";
     $this->regex["mark"] = "[-_.!~*'()\[\]]";
     $this->regex["reserved"] = "[;\/?:@&=+$,]";
     $this->regex["unreserved"] = "(?:" . $this->regex["alphanum"] . "|" . $this->regex["mark"] . ")";
     $this->regex["segment"] = "(?:(?:" . $this->regex["unreserved"] . "|" . $this->regex["escaped"] . "|[:@&=+$,;])*)";
     $this->regex["path"] = "(?:\/" . $this->regex["segment"] . "?)+";
     $this->regex["uric"] = "(?:" . $this->regex["reserved"] . "|" . $this->regex["unreserved"] . "|" . $this->regex["escaped"] . ")";
 
     if(strlen($uriString) > 0)
     {
       $this->parseUri($uriString);
     }
 
     if(!$this->isValid())
     {
       throw new TeamSpeak3_Helper_Exception("invalid URI supplied");
     }
   }

Member Function Documentation

◆ check()

static check ( $uri )

static

Returns TRUE if a given URI is valid.

Parameters

string $uri

Returns: boolean

   {
     try
     {
       $uri = new self(strval($uri));
     }
     catch(Exception $e)
     {
       return FALSE;
     }
 
     return $uri->valid();
   }

◆ checkFragment()

checkFragment ( $fragment = null )

Returns TRUE if the fragment string is valid.

Parameters

string $fragment

Exceptions

TeamSpeak3_Helper_Exception

Returns: boolean

   {
     if($fragment === null)
     {
       $fragment = $this->fragment;
     }
 
     if(strlen($fragment) == 0)
     {
       return TRUE;
     }
 
     $pattern = "/^" . $this->regex["uric"] . "*$/";
     $status = @preg_match($pattern, $fragment);
 
     if($status === FALSE)
     {
       throw new TeamSpeak3_Helper_Exception("URI fragment validation failed");
     }
 
     return ($status == 1);
   }

◆ checkHost()

checkHost ( $host = null )

Returns TRUE if the host is valid.

Parameters

string $host

Returns: boolean

   {
     if($host === null)
     {
       $host = $this->host;
     }
 
     return TRUE;
   }

◆ checkPass()

checkPass ( $password = null )

Returns TRUE if the password is valid.

Parameters

string $password

Exceptions

TeamSpeak3_Helper_Exception

Returns: boolean

   {
     if($password === null) {
       $password = $this->pass;
     }
 
     if(strlen($password) == 0)
     {
       return TRUE;
     }
 
     $pattern = "/^(" . $this->regex["alphanum"]  . "|" . $this->regex["mark"] . "|" . $this->regex["escaped"] . "|[;:&=+$,])+$/";
     $status = @preg_match($pattern, $password);
 
     if($status === FALSE)
     {
       throw new TeamSpeak3_Helper_Exception("URI password validation failed");
     }
 
     return ($status == 1);
   }

◆ checkPath()

checkPath ( $path = null )

Returns TRUE if the path is valid.

Parameters

string $path

Exceptions

TeamSpeak3_Helper_Exception

Returns: boolean

   {
     if($path === null)
     {
       $path = $this->path;
     }
 
     if(strlen($path) == 0)
     {
       return TRUE;
     }
 
     $pattern = "/^" . $this->regex["path"] . "$/";
     $status = @preg_match($pattern, $path);
 
     if($status === FALSE)
     {
       throw new TeamSpeak3_Helper_Exception("URI path validation failed");
     }
 
     return ($status == 1);
   }

◆ checkPort()

checkPort ( $port = null )

Returns TRUE if the port is valid.

Parameters

integer $port

Returns: boolean

   {
     if($port === null)
     {
       $port = $this->port;
     }
 
     return TRUE;
   }

◆ checkQuery()

checkQuery ( $query = null )

Returns TRUE if the query string is valid.

Parameters

string $query

Exceptions

TeamSpeak3_Helper_Exception

Returns: boolean

   {
     if($query === null)
     {
       $query = $this->query;
     }
 
     if(strlen($query) == 0)
     {
       return TRUE;
     }
 
     $pattern = "/^" . $this->regex["uric"] . "*$/";
     $status = @preg_match($pattern, $query);
 
     if($status === FALSE)
     {
       throw new TeamSpeak3_Helper_Exception("URI query string validation failed");
     }
 
     return ($status == 1);
   }

◆ checkUser()

checkUser ( $username = null )

Returns TRUE if the username is valid.

Parameters

string $username

Exceptions

TeamSpeak3_Helper_Exception

Returns: boolean

   {
     if($username === null)
     {
       $username = $this->user;
     }
 
     if(strlen($username) == 0)
     {
       return TRUE;
     }
 
     $pattern = "/^(" . $this->regex["alphanum"]  . "|" . $this->regex["mark"] . "|" . $this->regex["escaped"] . "|[;:&=+$,])+$/";
     $status = @preg_match($pattern, $username);
 
     if($status === FALSE)
     {
       throw new TeamSpeak3_Helper_Exception("URI username validation failed");
     }
 
     return ($status == 1);
   }

◆ getBaseUri()

static getBaseUri ( )

static

Returns the applications base address.

Returns: string

   {
     $scriptPath = new TeamSpeak3_Helper_String(dirname(self::getHostParam("SCRIPT_NAME")));
 
     return self::getHostUri()->append(($scriptPath == DIRECTORY_SEPARATOR ? "" : $scriptPath) . "/");
   }

◆ getFQDNParts()

static getFQDNParts ( $hostname )

static

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.

Parameters

string $hostname

Returns: array

   {
     if(!preg_match("/^([a-z0-9][a-z0-9-]{0,62}\.)*([a-z0-9][a-z0-9-]{0,62}\.)+([a-z]{2,6})$/i", $hostname, $matches))
     {
       return array();
     }
 
     $parts["tld"] = $matches[3];
     $parts["2nd"] = $matches[2];
     $parts["3rd"] = $matches[1];
 
     return $parts;
   }

◆ getFragment()

getFragment ( $default = null )

Returns the fragment.

Parameters

mixed default

Returns: TeamSpeak3_Helper_String

   {
     return ($this->hasFragment()) ? new TeamSpeak3_Helper_String(rawurldecode($this->fragment)) : $default;
   }

◆ getHost()

getHost ( $default = null )

Returns the host.

Parameters

mixed default

Returns: TeamSpeak3_Helper_String

   {
     return ($this->hasHost()) ? new TeamSpeak3_Helper_String(rawurldecode($this->host)) : $default;
   }

◆ getHostParam()

static getHostParam	(	$key,
		$default = `null`
	)

static

Returns a specified environment parameter from the $_SERVER array.

Parameters

string	$key
mixed	$default

Returns: mixed

   {
     return (array_key_exists($key, $_SERVER) && !empty($_SERVER[$key])) ? $_SERVER[$key] : $default;
   }

◆ getHostUri()

static getHostUri ( )

static

Returns the applications host address.

Returns: TeamSpeak3_Helper_String

   {
     $sheme = (self::getHostParam("HTTPS") == "on") ? "https" : "http";
 
     $serverName = new TeamSpeak3_Helper_String(self::getHostParam("HTTP_HOST"));
     $serverPort = self::getHostParam("SERVER_PORT");
     $serverPort = ($serverPort != 80 && $serverPort != 443) ? ":" . $serverPort : "";
 
     if($serverName->endsWith($serverPort))
     {
       $serverName = $serverName->replace($serverPort, "");
     }
 
     return new TeamSpeak3_Helper_String($sheme . "://" . $serverName . $serverPort);
   }

◆ getPass()

getPass ( $default = null )

Returns the password.

Parameters

mixed default

Returns: TeamSpeak3_Helper_String

   {
     return ($this->hasPass()) ? new TeamSpeak3_Helper_String(urldecode($this->pass)) : $default;
   }

◆ getPath()

getPath ( $default = null )

Returns the path.

Parameters

mixed default

Returns: TeamSpeak3_Helper_String

   {
     return ($this->hasPath()) ? new TeamSpeak3_Helper_String(rawurldecode($this->path)) : $default;
   }

◆ getPort()

getPort ( $default = null )

Returns the port.

Parameters

mixed default

Returns: integer

   {
     return ($this->hasPort()) ? intval($this->port) : $default;
   }

◆ getQuery()

getQuery ( $default = array() )

Returns an array containing the query string elements.

Parameters

mixed $default

Returns: array

   {
     if(!$this->hasQuery())
     {
       return $default;
     }
 
     parse_str(rawurldecode($this->query), $queryArray);
 
     return $queryArray;
   }

◆ getQueryVar()

getQueryVar	(	$key,
		$default = `null`
	)

Returns a single variable from the query string.

Parameters

string	$key
mixed	$default

Returns: mixed

   {
     if(!$this->hasQuery()) return $default;
 
     parse_str(rawurldecode($this->query), $queryArray);
 
     if(array_key_exists($key, $queryArray))
     {
       $val = $queryArray[$key];
 
       if(ctype_digit($val))
       {
         return intval($val);
       }
       elseif(is_string($val))
       {
         return new TeamSpeak3_Helper_String($val);
       }
       else
       {
         return $val;
       }
     }
 
     return $default;
   }

◆ getScheme()

getScheme ( $default = null )

Returns the scheme.

Parameters

mixed default

Returns: TeamSpeak3_Helper_String

   {
     return ($this->hasScheme()) ? new TeamSpeak3_Helper_String($this->scheme) : $default;
   }

◆ getSessParam()

static getSessParam	(	$key,
		$default = `null`
	)

static

Returns a specified session parameter from the $_SESSION array.

Parameters

string	$key
mixed	$default

Returns: mixed

   {
     return (array_key_exists($key, $_SESSION) && !empty($_SESSION[$key])) ? $_SESSION[$key] : $default;
   }

◆ getUser()

getUser ( $default = null )

Returns the username.

Parameters

mixed default

Returns: TeamSpeak3_Helper_String

   {
     return ($this->hasUser()) ? new TeamSpeak3_Helper_String(urldecode($this->user)) : $default;
   }

◆ getUserParam()

static getUserParam	(	$key,
		$default = `null`
	)

static

Returns a specified instance parameter from the $_REQUEST array.

Parameters

string	$key
mixed	$default

Returns: mixed

   {
     return (array_key_exists($key, $_REQUEST) && !empty($_REQUEST[$key])) ? self::stripslashesRecursive($_REQUEST[$key]) : $default;
   }

◆ hasFragment()

hasFragment ( )

Returns TRUE if the URI has a fragment string.

Returns: boolean

   {
     return strlen($this->fragment) ? TRUE : FALSE;
   }

◆ hasHost()

hasHost ( )

Returns TRUE if the URI has a host.

Returns: boolean

   {
     return strlen($this->host) ? TRUE : FALSE;
   }

◆ hasPass()

hasPass ( )

Returns TRUE if the URI has a password.

Returns: boolean

   {
     return strlen($this->pass) ? TRUE : FALSE;
   }

◆ hasPath()

hasPath ( )

Returns TRUE if the URI has a path.

Returns: boolean

   {
     return strlen($this->path) ? TRUE : FALSE;
   }

◆ hasPort()

hasPort ( )

Returns TRUE if the URI has a port.

Returns: boolean

   {
     return strlen($this->port) ? TRUE : FALSE;
   }

◆ hasQuery()

hasQuery ( )

Returns TRUE if the URI has a query string.

Returns: boolean

   {
     return strlen($this->query) ? TRUE : FALSE;
   }

◆ hasQueryVar()

hasQueryVar ( $key )

Returns TRUE if the URI has a query variable.

Returns: boolean

   {
     if(!$this->hasQuery()) return FALSE;
 
     parse_str($this->query, $queryArray);
 
     return array_key_exists($key, $queryArray) ? TRUE : FALSE;
   }

◆ hasScheme()

hasScheme ( )

Returns TRUE if the URI has a scheme.

Returns: boolean

   {
     return strlen($this->scheme) ? TRUE : FALSE;
   }

◆ hasUser()

hasUser ( )

Returns TRUE if the URI has a username.

Returns: boolean

   {
     return strlen($this->user) ? TRUE : FALSE;
   }

◆ isValid()

isValid ( )

Validate the current URI from the instance variables.

Returns: boolean

   {
     return ($this->checkUser() && $this->checkPass() && $this->checkHost() && $this->checkPort() && $this->checkPath() && $this->checkQuery() && $this->checkFragment());
   }

◆ parseUri()

parseUri ( $uriString = '' )

protected

Parses the scheme-specific portion of the URI and place its parts into instance variables.

Exceptions

TeamSpeak3_Helper_Exception

Returns: void

   {
     $status = @preg_match("~^((//)([^/?#]*))([^?#]*)(\?([^#]*))?(#(.*))?$~", $uriString, $matches);
 
     if($status === FALSE)
     {
       throw new TeamSpeak3_Helper_Exception("URI scheme-specific decomposition failed");
     }
 
     if(!$status) return;
 
     $this->path = (isset($matches[4])) ? $matches[4] : '';
     $this->query = (isset($matches[6])) ? $matches[6] : '';
     $this->fragment = (isset($matches[8])) ? $matches[8] : '';
 
     $status = @preg_match("~^(([^:@]*)(:([^@]*))?@)?((?(?=[[])[[][^]]+[]]|[^:]+))(:(.*))?$~", (isset($matches[3])) ? $matches[3] : "", $matches);
 
     if($status === FALSE)
     {
       throw new TeamSpeak3_Helper_Exception("URI scheme-specific authority decomposition failed");
     }
 
     if(!$status) return;
 
     $this->user = isset($matches[2]) ? $matches[2] : "";
     $this->pass = isset($matches[4]) ? $matches[4] : "";
     $this->host = isset($matches[5]) === TRUE ? preg_replace('~^\[([^]]+)\]$~', '\1', $matches[5]) : "";
     $this->port = isset($matches[7]) ? $matches[7] : "";
   }

◆ stripslashesRecursive()

static stripslashesRecursive ( $var )

staticprotected

Strips slashes from each element of an array using stripslashes().

Parameters

mixed $var

Returns: mixed

   {
     if(!is_array($var))
     {
       return stripslashes(strval($var));
     }
 
     foreach($var as $key => $val)
     {
       $var[$key] = (is_array($val)) ? stripslashesRecursive($val) : stripslashes(strval($val));
     }
 
     return $var;
   }

The documentation for this class was generated from the following file:

/Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Helper/Uri.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ check()

◆ checkFragment()

◆ checkHost()

◆ checkPass()

◆ checkPath()

◆ checkPort()

◆ checkQuery()

◆ checkUser()

◆ getBaseUri()

◆ getFQDNParts()

◆ getFragment()

◆ getHost()

◆ getHostParam()

◆ getHostUri()

◆ getPass()

◆ getPath()

◆ getPort()

◆ getQuery()

◆ getQueryVar()

◆ getScheme()

◆ getSessParam()

◆ getUser()

◆ getUserParam()

◆ hasFragment()

◆ hasHost()

◆ hasPass()

◆ hasPath()

◆ hasPort()

◆ hasQuery()

◆ hasQueryVar()

◆ hasScheme()

◆ hasUser()

◆ isValid()

◆ parseUri()

◆ stripslashesRecursive()